X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FInflateColumn%2FDateTime.pm;h=b284a640a2ceb8d84e4c5bd3e00b544615bddd84;hb=591df363660658ed30e60438c5251ca480925a6f;hp=2b40608952090cbc8623a96cbfa88abeacd64e16;hpb=f568d83bc887edbb5a7dbf36ee38150db3eb994a;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/InflateColumn/DateTime.pm b/lib/DBIx/Class/InflateColumn/DateTime.pm index 2b40608..b284a64 100644 --- a/lib/DBIx/Class/InflateColumn/DateTime.pm +++ b/lib/DBIx/Class/InflateColumn/DateTime.pm @@ -3,7 +3,10 @@ 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 DBIx::Class::_Util 'dbic_internal_try'; +use Try::Tiny; +use namespace::clean; =head1 NAME @@ -11,30 +14,36 @@ 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 ". $event->starts_when->month_name(); -If you want to set a specific timezone and locale for that field, use: +If you want to set a specific time zone and locale for that field, use: __PACKAGE__->add_columns( - starts_when => { data_type => 'datetime', timezone => "America/Chicago", locale => "de_DE" } + starts_when => { data_type => 'datetime', time_zone => "America/Chicago", locale => "de_DE" } ); +Note: DBIC before 0.082900 only accepted C, and silently discarded +any C arguments. For backwards compatibility, C will +continue being accepted as a synonym for C, and the value will +continue to be available in the +L<< C hash|DBIx::Class::ResultSource/column_info >> +under both names. + If you want to inflate no matter what data_type your column is, use inflate_datetime or inflate_date: @@ -63,22 +72,22 @@ use C thusly: =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 +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. +be used as a fallback. See L +for more information on date formatting. For more help with using components, see L. @@ -108,97 +117,95 @@ 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}; + # this bailout is intentional + return unless $info->{$key}; - $type = $_; - last; + $requested_type = $_; + last; + } } - 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"; - } elsif ($type eq "timestamp without time zone") { - $type = "timestamp"; - $info->{_ic_dt_method} ||= "timestamp_without_timezone"; - } elsif ($type eq "smalldatetime") { - $type = "datetime"; - $info->{_ic_dt_method} ||= "datetime"; - } + 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 $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}; + if ($info->{extra}) { + for my $slot (qw/time_zone 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}; + } + } } - 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}; + # Store the time zone under both 'timezone' for backwards compatibility and + # 'time_zone' for DateTime ecosystem consistency + if ( defined $info->{timezone} ) { + $self->throw_exception("Conflicting 'timezone' and 'time_zone' values in '$column' column defintion.") + if defined $info->{time_zone} and $info->{time_zone} ne $info->{timezone}; + $info->{time_zone} = $info->{timezone}; + } + elsif ( defined $info->{time_zone} ) { + $info->{timezone} = $info->{time_zone}; } - $locale = $info->{locale} if defined $info->{locale}; - $timezone = $info->{timezone} if defined $info->{timezone}; + # shallow copy to avoid unfounded(?) Devel::Cycle complaints + my $infcopy = {%$info}; - my $undef_if_invalid = $info->{datetime_undef_if_invalid}; + $self->inflate_column( + $column => + { + inflate => sub { + my ($value, $obj) = @_; - 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 } ); + # propagate for error reporting + $infcopy->{__dbic_colname} = $column; - 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}; - } + my $dt = $obj->_inflate_to_datetime( $value, $infcopy ); - $self->inflate_column( - $column => - { - inflate => sub { - my ($value, $obj) = @_; - - my $dt = eval { $obj->_inflate_to_datetime( $value, \%info ) }; - if (my $err = $@ ) { - return undef if ($undef_if_invalid); - $self->throw_exception ("Error while inflating ${value} for ${column} on ${self}: $err"); - } - - $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 ); - }, - } - ); - } + 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 @@ -207,8 +214,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 dbic_internal_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 { @@ -222,7 +237,34 @@ sub _deflate_from_datetime { } sub _datetime_parser { - shift->result_source->storage->datetime_parser (@_); + shift->result_source->schema->storage->datetime_parser (@_); +} + +sub _post_inflate_datetime { + my( $self, $dt, $info ) = @_; + + $dt->set_time_zone($info->{time_zone}) if defined $info->{time_zone}; + $dt->set_locale($info->{locale}) if defined $info->{locale}; + + return $dt; +} + +sub _pre_deflate_datetime { + my( $self, $dt, $info ) = @_; + + if (defined $info->{time_zone}) { + carp "You're using a floating time zone, 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->{time_zone}); + } + + $dt->set_locale($info->{locale}) if defined $info->{locale}; + + return $dt; } 1; @@ -230,13 +272,13 @@ __END__ =head1 USAGE NOTES -If you have a datetime column with an associated C, and subsequently +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 +time zone, you will get a warning (as there is a very good chance this will not have the result you expect). For example: __PACKAGE__->add_columns( - starts_when => { data_type => 'datetime', timezone => "America/Chicago" } + starts_when => { data_type => 'datetime', time_zone => "America/Chicago" } ); my $event = $schema->resultset('EventTZ')->create({ @@ -249,7 +291,7 @@ The warning can be avoided in several ways: =item Fix your broken code -When calling C on a Floating DateTime object, the timezone is simply +When calling C on a Floating DateTime object, the time zone is simply set to the requested value, and B. It is always a good idea to be supply explicit times to the database: @@ -260,7 +302,7 @@ to be supply explicit times to the database: =item Suppress the check on per-column basis __PACKAGE__->add_columns( - starts_when => { data_type => 'datetime', timezone => "America/Chicago", floating_tz_ok => 1 } + starts_when => { data_type => 'datetime', time_zone => "America/Chicago", floating_tz_ok => 1 } ); =item Suppress the check globally @@ -269,7 +311,7 @@ Set the environment variable DBIC_FLOATING_TZ_OK to some true value. =back -Putting extra attributes like timezone, locale or floating_tz_ok into extra => {} has been +Putting extra attributes like time_zone, locale or floating_tz_ok into extra => {} has been B because this gets you into trouble using L. Instead put it directly into the columns definition like in the examples above. If you still use the old way you'll see a warning - please fix your code then! @@ -278,24 +320,22 @@ 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 +=item Further discussion of problems inherent to the Floating time zone: + L and L<< $dt->set_time_zone|DateTime/"Set" Methods >> =back -=head1 AUTHOR - -Matt S. Trout - -=head1 CONTRIBUTORS - -Aran Deltac +=head1 FURTHER QUESTIONS? -=head1 LICENSE +Check the list of L. -You may distribute this code under the same terms as Perl itself. +=head1 COPYRIGHT AND LICENSE +This module is free software L +by the L. You can +redistribute it and/or modify it under the same terms as the +L.