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=d2597ac555ae9d467826c54d4dd5c1211897ffb9;hpb=dceeddc7fed4011e79c6f79f47b16742fc3f043e;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/InflateColumn/DateTime.pm b/lib/DBIx/Class/InflateColumn/DateTime.pm index d2597ac..b284a64 100644 --- a/lib/DBIx/Class/InflateColumn/DateTime.pm +++ b/lib/DBIx/Class/InflateColumn/DateTime.pm @@ -3,6 +3,10 @@ package DBIx::Class::InflateColumn::DateTime; use strict; use warnings; use base qw/DBIx::Class/; +use DBIx::Class::Carp; +use DBIx::Class::_Util 'dbic_internal_try'; +use Try::Tiny; +use namespace::clean; =head1 NAME @@ -10,13 +14,16 @@ 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' } ); Then you can treat the specified column as a L object. @@ -24,29 +31,70 @@ 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 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', 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: + + __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', extra => { timezone => "America/Chicago" } } + 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 @@ -56,7 +104,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", @@ -69,70 +117,225 @@ 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 = lc($info->{data_type}); - $type = 'datetime' if ($type =~ /^timestamp/); - my $timezone; - if ( exists $info->{extra} and exists $info->{extra}{timezone} and defined $info->{extra}{timezone} ) { - $timezone = $info->{extra}{timezone}; + + my $requested_type; + for (qw/datetime timestamp date/) { + my $key = "inflate_${_}"; + if (exists $info->{$key}) { + + # this bailout is intentional + return unless $info->{$key}; + + $requested_type = $_; + last; + } + } + + 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; + } + + 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}; + } + } + } + + # 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}; + } + + # shallow copy to avoid unfounded(?) Devel::Cycle complaints + my $infcopy = {%$info}; + + $self->inflate_column( + $column => + { + inflate => sub { + my ($value, $obj) = @_; + + # propagate for error reporting + $infcopy->{__dbic_colname} = $column; + + my $dt = $obj->_inflate_to_datetime( $value, $infcopy ); + + return (defined $dt) + ? $obj->_post_inflate_datetime( $dt, $infcopy ) + : undef + ; + }, + deflate => sub { + my ($value, $obj) = @_; - my $undef_if_invalid = $info->{datetime_undef_if_invalid}; - - if ($type eq 'datetime' || $type eq 'date') { - my ($parse, $format) = ("parse_${type}", "format_${type}"); - $self->inflate_column( - $column => - { - inflate => sub { - my ($value, $obj) = @_; - my $dt = eval { $obj->_datetime_parser->$parse($value); }; - die "Error while inflating ${value} for ${column} on ${self}: $@" - if $@ and not $undef_if_invalid; - $dt->set_time_zone($timezone) if $timezone; - return $dt; - }, - deflate => sub { - my ($value, $obj) = @_; - $value->set_time_zone($timezone) if $timezone; - $obj->_datetime_parser->$format($value); - }, - } - ); + $value = $obj->_pre_deflate_datetime( $value, $infcopy ); + $obj->_deflate_from_datetime( $value, $infcopy ); + }, + } + ); +} + +sub _flate_or_fallback +{ + my( $self, $value, $info, $method_fmt ) = @_; + + my $parser = $self->_datetime_parser; + my $preferred_method = sprintf($method_fmt, $info->{ _ic_dt_method }); + 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 { + my( $self, $value, $info ) = @_; + return $self->_flate_or_fallback( $value, $info, 'parse_%s' ); +} + +sub _deflate_from_datetime { + my( $self, $value, $info ) = @_; + return $self->_flate_or_fallback( $value, $info, 'format_%s' ); } sub _datetime_parser { - my $self = shift; - if (my $parser = $self->__datetime_parser) { - return $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}); } - 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; __END__ -=head1 SEE ALSO +=head1 USAGE NOTES -=over 4 +If you have a datetime column with an associated C, and subsequently +create/update this column with a DateTime object in the L +time zone, you will get a warning (as there is a very good chance this will not have the +result you expect). For example: -=item More information about the add_columns method, and column metadata, - can be found in the documentation for L. + __PACKAGE__->add_columns( + starts_when => { data_type => 'datetime', time_zone => "America/Chicago" } + ); + + my $event = $schema->resultset('EventTZ')->create({ + starts_at => DateTime->new(year=>2007, month=>12, day=>31, ), + }); + +The warning can be avoided in several ways: + +=over + +=item Fix your broken code + +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: + + my $event = $schema->resultset('EventTZ')->create({ + starts_at => DateTime->new(year=>2007, month=>12, day=>31, time_zone => "America/Chicago" ), + }); + +=item Suppress the check on per-column basis + + __PACKAGE__->add_columns( + starts_when => { data_type => 'datetime', time_zone => "America/Chicago", floating_tz_ok => 1 } + ); + +=item Suppress the check globally + +Set the environment variable DBIC_FLOATING_TZ_OK to some true value. =back -=head1 AUTHOR +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! + +=head1 SEE ALSO + +=over 4 -Matt S. Trout +=item More information about the add_columns method, and column metadata, + can be found in the documentation for L. -=head1 CONTRIBUTORS +=item Further discussion of problems inherent to the Floating time zone: + L + and L<< $dt->set_time_zone|DateTime/"Set" Methods >> + +=back -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.