X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FInflateColumn%2FDateTime.pm;h=0e2d0588634104fa5d5e5b8872a1bef1313936e7;hb=9361b05d319e60314bf2caff1e96ff3c388a50bb;hp=d006e55be0407c0c38e1172bce9cf7139deff527;hpb=6c9d0c63a0bc370d25f7995ecf8f7a1c380e7963;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/InflateColumn/DateTime.pm b/lib/DBIx/Class/InflateColumn/DateTime.pm index d006e55..0e2d058 100644 --- a/lib/DBIx/Class/InflateColumn/DateTime.pm +++ b/lib/DBIx/Class/InflateColumn/DateTime.pm @@ -3,7 +3,9 @@ package DBIx::Class::InflateColumn::DateTime; use strict; use warnings; use base qw/DBIx::Class/; -use Carp::Clan qw/^DBIx::Class/; +use DBIx::Class::Carp; +use Try::Tiny; +use namespace::clean; =head1 NAME @@ -11,18 +13,18 @@ DBIx::Class::InflateColumn::DateTime - Auto-create DateTime objects from date an =head1 SYNOPSIS -Load this component and then declare one or more +Load this component and then declare one or more columns to be of the datetime, timestamp or date datatype. package Event; - __PACKAGE__->load_components(qw/InflateColumn::DateTime Core/); + use base 'DBIx::Class::Core'; + + __PACKAGE__->load_components(qw/InflateColumn::DateTime/); __PACKAGE__->add_columns( starts_when => { data_type => 'datetime' } + create_date => { data_type => 'date' } ); -NOTE: You B load C B C. See -L for details. - Then you can treat the specified column as a L object. print "This event starts the month of ". @@ -40,34 +42,51 @@ use inflate_datetime or inflate_date: __PACKAGE__->add_columns( starts_when => { data_type => 'varchar', inflate_datetime => 1 } ); - + __PACKAGE__->add_columns( starts_when => { data_type => 'varchar', inflate_date => 1 } ); It's also possible to explicitly skip inflation: - + __PACKAGE__->add_columns( starts_when => { data_type => 'datetime', inflate_datetime => 0 } ); +NOTE: Don't rely on C to parse date strings for you. +The column is set directly for any non-references and C +is completely bypassed. Instead, use an input parser to create a DateTime +object. For instance, if your user input comes as a 'YYYY-MM-DD' string, you can +use C thusly: + + use DateTime::Format::ISO8601; + my $dt = DateTime::Format::ISO8601->parse_datetime('YYYY-MM-DD'); + =head1 DESCRIPTION -This module figures out the type of DateTime::Format::* class to -inflate/deflate with based on the type of DBIx::Class::Storage::DBI::* -that you are using. If you switch from one database to a different +This module figures out the type of DateTime::Format::* class to +inflate/deflate with based on the type of DBIx::Class::Storage::DBI::* +that you are using. If you switch from one database to a different one your code should continue to work without modification (though note that this feature is new as of 0.07, so it may not be perfect yet - bug reports to the list very much welcome). +If the data_type of a field is C, C or C (or +a derivative of these datatypes, e.g. C), this +module will automatically call the appropriate parse/format method for +deflation/inflation as defined in the storage class. For instance, for +a C field the methods C and C +would be called on deflation/inflation. If the storage class does not +provide a specialized inflator/deflator, C<[parse|format]_datetime> will +be used as a fallback. See L for more information on +date formatting. + For more help with using components, see L. =cut __PACKAGE__->load_components(qw/InflateColumn/); -__PACKAGE__->mk_group_accessors('simple' => '__datetime_parser'); - =head2 register_column Chains with the L method, and sets @@ -77,7 +96,7 @@ directly called by end users. In the case of an invalid date, L will throw an exception. To bypass these exceptions and just have the inflation return undef, use the C option in the column info: - + "broken_date", { data_type => "datetime", @@ -90,87 +109,84 @@ the C option in the column info: sub register_column { my ($self, $column, $info, @rest) = @_; - $self->next::method($column, $info, @rest); - return unless defined($info->{data_type}); - my $type; + $self->next::method($column, $info, @rest); - for (qw/date datetime timestamp/) { + my $requested_type; + for (qw/datetime timestamp date/) { my $key = "inflate_${_}"; + if (exists $info->{$key}) { - next unless exists $info->{$key}; - return unless $info->{$key}; - - $type = $_; - last; - } + # this bailout is intentional + return unless $info->{$key}; - unless ($type) { - $type = lc($info->{data_type}); - if ($type eq "timestamp with time zone" || $type eq "timestamptz") { - $type = "timestamp"; - $info->{_ic_dt_method} ||= "timestamp_with_timezone"; + $requested_type = $_; + last; } } - my $timezone; - if ( defined $info->{extra}{timezone} ) { - carp "Putting timezone into extra => { timezone => '...' } has been deprecated, ". - "please put it directly into the '$column' column definition."; - $timezone = $info->{extra}{timezone}; + return if (!$requested_type and !$info->{data_type}); + + my $data_type = lc( $info->{data_type} || '' ); + + # _ic_dt_method will follow whatever the registration requests + # thus = instead of ||= + if ($data_type eq 'timestamp with time zone' || $data_type eq 'timestamptz') { + $info->{_ic_dt_method} = 'timestamp_with_timezone'; + } + elsif ($data_type eq 'timestamp without time zone') { + $info->{_ic_dt_method} = 'timestamp_without_timezone'; + } + elsif ($data_type eq 'smalldatetime') { + $info->{_ic_dt_method} = 'smalldatetime'; + } + elsif ($data_type =~ /^ (?: date | datetime | timestamp ) $/x) { + $info->{_ic_dt_method} = $data_type; + } + elsif ($requested_type) { + $info->{_ic_dt_method} = $requested_type; + } + else { + return; } - my $locale; - if ( defined $info->{extra}{locale} ) { - carp "Putting locale into extra => { locale => '...' } has been deprecated, ". - "please put it directly into the '$column' column definition."; - $locale = $info->{extra}{locale}; + if ($info->{extra}) { + for my $slot (qw/timezone locale floating_tz_ok/) { + if ( defined $info->{extra}{$slot} ) { + carp "Putting $slot into extra => { $slot => '...' } has been deprecated, ". + "please put it directly into the '$column' column definition."; + $info->{$slot} = $info->{extra}{$slot} unless defined $info->{$slot}; + } + } } - - $locale = $info->{locale} if defined $info->{locale}; - $timezone = $info->{timezone} if defined $info->{timezone}; - my $undef_if_invalid = $info->{datetime_undef_if_invalid}; + # shallow copy to avoid unfounded(?) Devel::Cycle complaints + my $infcopy = {%$info}; - if ($type eq 'datetime' || $type eq 'date' || $type eq 'timestamp') { - # This shallow copy of %info avoids t/52_cycle.t treating - # the resulting deflator as a circular reference. - my %info = ( '_ic_dt_method' => $type , %{ $info } ); + $self->inflate_column( + $column => + { + inflate => sub { + my ($value, $obj) = @_; - if (defined $info->{extra}{floating_tz_ok}) { - carp "Putting floating_tz_ok into extra => { floating_tz_ok => 1 } has been deprecated, ". - "please put it directly into the '$column' column definition."; - $info{floating_tz_ok} = $info->{extra}{floating_tz_ok}; - } + # propagate for error reporting + $infcopy->{__dbic_colname} = $column; - $self->inflate_column( - $column => - { - inflate => sub { - my ($value, $obj) = @_; - my $dt = eval { $obj->_inflate_to_datetime( $value, \%info ) }; - $self->throw_exception ("Error while inflating ${value} for ${column} on ${self}: $@") - if $@ and not $undef_if_invalid; - $dt->set_time_zone($timezone) if $timezone; - $dt->set_locale($locale) if $locale; - return $dt; - }, - deflate => sub { - my ($value, $obj) = @_; - if ($timezone) { - carp "You're using a floating timezone, please see the documentation of" - . " DBIx::Class::InflateColumn::DateTime for an explanation" - if ref( $value->time_zone ) eq 'DateTime::TimeZone::Floating' - and not $info{floating_tz_ok} - and not $ENV{DBIC_FLOATING_TZ_OK}; - $value->set_time_zone($timezone); - $value->set_locale($locale) if $locale; - } - $obj->_deflate_from_datetime( $value, \%info ); - }, - } - ); - } + my $dt = $obj->_inflate_to_datetime( $value, $infcopy ); + + return (defined $dt) + ? $obj->_post_inflate_datetime( $dt, $infcopy ) + : undef + ; + }, + deflate => sub { + my ($value, $obj) = @_; + + $value = $obj->_pre_deflate_datetime( $value, $infcopy ); + $obj->_deflate_from_datetime( $value, $infcopy ); + }, + } + ); } sub _flate_or_fallback @@ -179,8 +195,16 @@ sub _flate_or_fallback my $parser = $self->_datetime_parser; my $preferred_method = sprintf($method_fmt, $info->{ _ic_dt_method }); - my $method = $parser->can($preferred_method) ? $preferred_method : sprintf($method_fmt, 'datetime'); - return $parser->$method($value); + my $method = $parser->can($preferred_method) || sprintf($method_fmt, 'datetime'); + + return try { + $parser->$method($value); + } + catch { + $self->throw_exception ("Error while inflating ${value} for $info->{__dbic_colname} on ${self}: $_") + unless $info->{datetime_undef_if_invalid}; + undef; # rv + }; } sub _inflate_to_datetime { @@ -194,12 +218,34 @@ sub _deflate_from_datetime { } sub _datetime_parser { - my $self = shift; - if (my $parser = $self->__datetime_parser) { - return $parser; + shift->result_source->storage->datetime_parser (@_); +} + +sub _post_inflate_datetime { + my( $self, $dt, $info ) = @_; + + $dt->set_time_zone($info->{timezone}) if defined $info->{timezone}; + $dt->set_locale($info->{locale}) if defined $info->{locale}; + + return $dt; +} + +sub _pre_deflate_datetime { + my( $self, $dt, $info ) = @_; + + if (defined $info->{timezone}) { + carp "You're using a floating timezone, please see the documentation of" + . " DBIx::Class::InflateColumn::DateTime for an explanation" + if ref( $dt->time_zone ) eq 'DateTime::TimeZone::Floating' + and not $info->{floating_tz_ok} + and not $ENV{DBIC_FLOATING_TZ_OK}; + + $dt->set_time_zone($info->{timezone}); } - my $parser = $self->result_source->storage->datetime_parser(@_); - return $self->__datetime_parser($parser); + + $dt->set_locale($info->{locale}) if defined $info->{locale}; + + return $dt; } 1; @@ -207,7 +253,7 @@ __END__ =head1 USAGE NOTES -If you have a datetime column with the C extra setting, and subsenquently +If you have a datetime column with an associated C, and subsequently create/update this column with a DateTime object in the L timezone, you will get a warning (as there is a very good chance this will not have the result you expect). For example: @@ -255,11 +301,11 @@ use the old way you'll see a warning - please fix your code then! =over 4 -=item More information about the add_columns method, and column metadata, +=item More information about the add_columns method, and column metadata, can be found in the documentation for L. =item Further discussion of problems inherent to the Floating timezone: - L + L and L<< $dt->set_time_zone|DateTime/"Set" Methods >> =back