DBIx/Class/InflateColumn/DateTime.pm

filter: Statementstmt 70.6% 53 / 75 Branchbran 55.5% 20 / 36 Conditioncond 29.4% 5 / 17 MC/DCmcdc 10.0% 1 / 10 Subroutinesub 64.7% 11 / 17 Podpod 100% 1 / 1 totaltotal 58.3% 91 / 156 CC 27 SCAR 27.0
CC
27
Cov
61%
_pre_deflate_datetime
42.0
register_column
18.5
_post_inflate_datetime
12.0
CRAP 14.9
« DBIx/Class/Storage/DBI/ODBC/ACCESS.pm ↑ Summary DBIx/Class/Relationship/BelongsTo.pm »
1 package DBIx::Class::InflateColumn::DateTime;
2  
3 333 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 333 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 333 ▶use base qw/DBIx::Class/;
Subroutine BEGIN: called CC=1 SCAR=0.0
6 333 ▶use DBIx::Class::Carp;
Subroutine BEGIN: called CC=1 SCAR=0.0
7 333 ▶use Try::Tiny;
Subroutine BEGIN: called CC=1 SCAR=0.0
8 333 ▶use namespace::clean;
Subroutine BEGIN: called CC=1 SCAR=0.0
9  
10 =head1 NAME
11  
12 DBIx::Class::InflateColumn::DateTime - Auto-create DateTime objects from date and datetime columns.
13  
14 =head1 SYNOPSIS
15  
16 Load this component and then declare one or more
17 columns to be of the datetime, timestamp or date datatype.
18  
19 package Event;
20 use base 'DBIx::Class::Core';
21  
22 __PACKAGE__->load_components(qw/InflateColumn::DateTime/);
23 __PACKAGE__->add_columns(
24 starts_when => { data_type => 'datetime' }
25 create_date => { data_type => 'date' }
26 );
27  
28 Then you can treat the specified column as a L<DateTime> object.
29  
30 print "This event starts the month of ".
31 $event->starts_when->month_name();
32  
33 If you want to set a specific timezone and locale for that field, use:
34  
35 __PACKAGE__->add_columns(
36 starts_when => { data_type => 'datetime', timezone => "America/Chicago", locale => "de_DE" }
37 );
38  
39 If you want to inflate no matter what data_type your column is,
40 use inflate_datetime or inflate_date:
41  
42 __PACKAGE__->add_columns(
43 starts_when => { data_type => 'varchar', inflate_datetime => 1 }
44 );
45  
46 __PACKAGE__->add_columns(
47 starts_when => { data_type => 'varchar', inflate_date => 1 }
48 );
49  
50 It's also possible to explicitly skip inflation:
51  
52 __PACKAGE__->add_columns(
53 starts_when => { data_type => 'datetime', inflate_datetime => 0 }
54 );
55  
56 NOTE: Don't rely on C<InflateColumn::DateTime> to parse date strings for you.
57 The column is set directly for any non-references and C<InflateColumn::DateTime>
58 is completely bypassed. Instead, use an input parser to create a DateTime
59 object. For instance, if your user input comes as a 'YYYY-MM-DD' string, you can
60 use C<DateTime::Format::ISO8601> thusly:
61  
62 use DateTime::Format::ISO8601;
63 my $dt = DateTime::Format::ISO8601->parse_datetime('YYYY-MM-DD');
64  
65 =head1 DESCRIPTION
66  
67 This module figures out the type of DateTime::Format::* class to
68 inflate/deflate with based on the type of DBIx::Class::Storage::DBI::*
69 that you are using. If you switch from one database to a different
70 one your code should continue to work without modification (though note
71 that this feature is new as of 0.07, so it may not be perfect yet - bug
72 reports to the list very much welcome).
73  
74 If the data_type of a field is C<date>, C<datetime> or C<timestamp> (or
75 a derivative of these datatypes, e.g. C<timestamp with timezone>), this
76 module will automatically call the appropriate parse/format method for
77 deflation/inflation as defined in the storage class. For instance, for
78 a C<datetime> field the methods C<parse_datetime> and C<format_datetime>
79 would be called on deflation/inflation. If the storage class does not
80 provide a specialized inflator/deflator, C<[parse|format]_datetime> will
81 be used as a fallback. See L<DateTime/Formatters And Stringification>
82 for more information on date formatting.
83  
84 For more help with using components, see L<DBIx::Class::Manual::Component/USING>.
85  
86 =cut
87  
88 333 __PACKAGE__->load_components(qw/InflateColumn/);
89  
90 =head2 register_column
91  
92 Chains with the L<DBIx::Class::Row/register_column> method, and sets
93 up datetime columns appropriately. This would not normally be
94 directly called by end users.
95  
96 In the case of an invalid date, L<DateTime> will throw an exception. To
97 bypass these exceptions and just have the inflation return undef, use
98 the C<datetime_undef_if_invalid> option in the column info:
99  
100 "broken_date",
101 {
102 data_type => "datetime",
103 default_value => '0000-00-00',
104 is_nullable => 1,
105 datetime_undef_if_invalid => 1
106 }
107  
108 =cut
109  
110 5882 ▶sub register_column {
Subroutine register_column: called CC=17 SCAR=29.2
Pod documented
111 5882 my ($self, $column, $info, @rest) = @_;
112  
113 5882 $self->next::method($column, $info, @rest);
114  
115 5882 my $requested_type;
116 5882 for (qw/datetime timestamp date/) {
117 16342 my $key = "inflate_${_}";
118 16342 ▶ if (exists $info->{$key}) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $info->{$key}) 977 15365 16342
119  
120 # this bailout is intentional
121 977 ▶ return unless $info->{$key};
Branch: 1 branch
BranchTrueFalseTotal
unless $info->{$key} 325 652 977
122  
123 652 $requested_type = $_;
124 652 last;
125 }
126 }
127  
128 5557 ▶ return if (!$requested_type and !$info->{data_type});
Branch: 1 branch
BranchTrueFalseTotal
unless $requested_type or $info->{"data_type"} 0 5557 5557
Condition66%2/3
$requested_type or $info->{"data_type"}
l!l&&r!l&&!r
65249050
MC/DC0%0/2
$requested_type or $info->{"data_type"}
$requested_type $info->{"data_type"}
Truth table66%2/3
A or B
A= $requested_typeB= $info->{"data_type"}
ABresult
1X1
011
000
129  
130 5557 ▶ my $data_type = lc( $info->{data_type} || '' );
Condition50%1/2
$info->{'data_type'} || ''
l!l
55570
MC/DC0%0/1
$info->{'data_type'} || ''
$info->{'data_type'}
Truth table50%1/2
A
A= $info->{'data_type'}
Aresult
11
00
131  
132 # _ic_dt_method will follow whatever the registration requests
133 # thus = instead of ||=
134 5557 ▶ if ($data_type eq 'timestamp with time zone' || $data_type eq 'timestamptz') {
Branch: 5 branches
BranchTrueFalseTotal
if ($data_type eq 'timestamp with time zone' or $data_type eq 'timestamptz') { } 2 5555 5557
elsif ($data_type eq 'timestamp without time zone') { } 4 5551 5555
elsif ($data_type eq 'smalldatetime') { } 2 5549 5551
elsif ($data_type =~ /^ (?: date | datetime | timestamp ) $/x) { } 2285 3264 5549
elsif ($requested_type) { } 650 2614 3264
Condition66%2/3
$data_type eq "timestamp with time zone" or $data_type eq "timestamptz"
l!l&&r!l&&!r
205555
MC/DC50%1/2
$data_type eq "timestamp with time zone" or $data_type eq "timestamptz"
$data_type eq "timestamp with time zone" $data_type eq "timestamptz"
Truth table66%2/3
A or B
A= $data_type eq "timestamp with time zone"B= $data_type eq "timestamptz"
ABresult
1X1
011
000
135 2 $info->{_ic_dt_method} = 'timestamp_with_timezone';
136 }
137 elsif ($data_type eq 'timestamp without time zone') {
138 4 $info->{_ic_dt_method} = 'timestamp_without_timezone';
139 }
140 elsif ($data_type eq 'smalldatetime') {
141 2 $info->{_ic_dt_method} = 'smalldatetime';
142 }
143 elsif ($data_type =~ /^ (?: date | datetime | timestamp ) $/x) {
144 2285 $info->{_ic_dt_method} = $data_type;
145 }
146 elsif ($requested_type) {
147 650 $info->{_ic_dt_method} = $requested_type;
148 }
149 else {
150 2614 return;
151 }
152  
153 2943 ▶ if ($info->{extra}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($info->{"extra"}) 4 2939 2943
154 4 for my $slot (qw/timezone locale floating_tz_ok/) {
155 12 ▶ if ( defined $info->{extra}{$slot} ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $info->{"extra"}{$slot}) 8 4 12
156 8 carp "Putting $slot into extra => { $slot => '...' } has been deprecated, ".
157 "please put it directly into the '$column' column definition.";
158 8 ▶ $info->{$slot} = $info->{extra}{$slot} unless defined $info->{$slot};
Branch: 1 branch
BranchTrueFalseTotal
unless defined $info->{$slot} 8 0 8
159 }
160 }
161 }
162  
163 # shallow copy to avoid unfounded(?) Devel::Cycle complaints
164 2943 my $infcopy = {%$info};
165  
166 $self->inflate_column(
167 $column =>
168 {
169 1 ▶ inflate => sub {
Subroutine __ANON__: called CC=2 SCAR=9.2
170 1 my ($value, $obj) = @_;
171  
172 # propagate for error reporting
173 1 $infcopy->{__dbic_colname} = $column;
174  
175 1 my $dt = $obj->_inflate_to_datetime( $value, $infcopy );
176  
177 0 ▶ return (defined $dt)
Branch: 1 branch
BranchTrueFalseTotal
defined $dt ? : 0 0 0
178 ? $obj->_post_inflate_datetime( $dt, $infcopy )
179 : undef
180 ;
181 },
182 0 ▶ deflate => sub {
Subroutine __ANON__: not called CC=1 SCAR=6.9
183 0 my ($value, $obj) = @_;
184  
185 0 $value = $obj->_pre_deflate_datetime( $value, $infcopy );
186 0 $obj->_deflate_from_datetime( $value, $infcopy );
187 },
188 }
189 2943 );
190 }
191  
192 sub _flate_or_fallback
193 1 ▶{
Subroutine _flate_or_fallback: called CC=2 SCAR=14.9
194 1 my( $self, $value, $info, $method_fmt ) = @_;
195  
196 1 my $parser = $self->_datetime_parser;
197 0 my $preferred_method = sprintf($method_fmt, $info->{ _ic_dt_method });
198 0 ▶ my $method = $parser->can($preferred_method) || sprintf($method_fmt, 'datetime');
Condition0%0/3
$parser->can($preferred_method) || sprintf($method_fmt, 'datetime')
l!l&&r!l&&!r
000
MC/DC0%0/2
$parser->can($preferred_method) || sprintf($method_fmt, 'datetime')
$parser->can($preferred_method) sprintf($method_fmt, 'datetime')
Truth table0%0/3
A || B
A= $parser->can($preferred_method)B= sprintf($method_fmt, 'datetime')
ABresult
1X1
011
000
199  
200 0 ▶ return try {
Subroutine __ANON__: not called CC=1 SCAR=6.9
201 0 $parser->$method($value);
202 }
203 0 ▶ catch {
Subroutine __ANON__: not called CC=2 SCAR=17.9
204 $self->throw_exception ("Error while inflating '$value' for $info->{__dbic_colname} on ${self}: $_")
205 0 ▶ unless $info->{datetime_undef_if_invalid};
Branch: 1 branch
BranchTrueFalseTotal
unless $info->{"datetime_undef_if_invalid"} 0 0 0
206 0 undef; # rv
207 0 };
208 }
209  
210 1 ▶sub _inflate_to_datetime {
Subroutine _inflate_to_datetime: called CC=1 SCAR=0.0
211 1 my( $self, $value, $info ) = @_;
212 1 return $self->_flate_or_fallback( $value, $info, 'parse_%s' );
213 }
214  
215 0 ▶sub _deflate_from_datetime {
Subroutine _deflate_from_datetime: not called CC=1 SCAR=6.9
216 0 my( $self, $value, $info ) = @_;
217 0 return $self->_flate_or_fallback( $value, $info, 'format_%s' );
218 }
219  
220 1 ▶sub _datetime_parser {
Subroutine _datetime_parser: called CC=1 SCAR=0.0
221 1 shift->result_source->storage->datetime_parser (@_);
222 }
223  
224 0 ▶sub _post_inflate_datetime {
Subroutine _post_inflate_datetime: not called CC=3 SCAR=24.8
225 0 my( $self, $dt, $info ) = @_;
226  
227 0 ▶ $dt->set_time_zone($info->{timezone}) if defined $info->{timezone};
Branch: 1 branch
BranchTrueFalseTotal
if defined $info->{"timezone"} 0 0 0
228 0 ▶ $dt->set_locale($info->{locale}) if defined $info->{locale};
Branch: 1 branch
BranchTrueFalseTotal
if defined $info->{"locale"} 0 0 0
229  
230 0 return $dt;
231 }
232  
233 0 ▶sub _pre_deflate_datetime {
Subroutine _pre_deflate_datetime: not called CC=6 SCAR=37.4
234 0 my( $self, $dt, $info ) = @_;
235  
236 0 ▶ if (defined $info->{timezone}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $info->{"timezone"}) 0 0 0
237 carp "You're using a floating timezone, please see the documentation of"
238 . " DBIx::Class::InflateColumn::DateTime for an explanation"
239 if ref( $dt->time_zone ) eq 'DateTime::TimeZone::Floating'
240 and not $info->{floating_tz_ok}
241 0 ▶ and not $ENV{DBIC_FLOATING_TZ_OK};
Branch: 1 branch
BranchTrueFalseTotal
if ref $dt->time_zone eq "DateTime::TimeZone::Floating" and not $info->{"floating_tz_ok"} and not $ENV{"DBIC_FLOATING_TZ_OK"} 0 0 0
Condition0%0/6
ref $dt->time_zone eq "DateTime::TimeZone::Floating" and not $info->{"floating_tz_ok"} and not $ENV{"DBIC_FLOATING_TZ_OK"}
!ll&&!rl&&r
000
ref $dt->time_zone eq "DateTime::TimeZone::Floating" and not $info->{"floating_tz_ok"}
!ll&&!rl&&r
000
MC/DC0%0/3
ref $dt->time_zone eq "DateTime::TimeZone::Floating" and not $info->{"floating_tz_ok"} and not $ENV{"DBIC_FLOATING_TZ_OK"}
ref $dt->time_zone eq "DateTime::TimeZone::Floating" not $info->{"floating_tz_ok"} not $ENV{"DBIC_FLOATING_TZ_OK"}
Truth table0%0/4
A and not(B) and not(C)
A= ref $dt->time_zone eq "DateTime::TimeZone::Floating"B= not $info->{"floating_tz_ok"}C= not $ENV{"DBIC_FLOATING_TZ_OK"}
ABCresult
0XX0
10X0
1100
1111
242  
243 0 $dt->set_time_zone($info->{timezone});
244 }
245  
246 0 ▶ $dt->set_locale($info->{locale}) if defined $info->{locale};
Branch: 1 branch
BranchTrueFalseTotal
if defined $info->{"locale"} 0 0 0
247  
248 0 return $dt;
249 }
250  
251 333 1;
252 __END__
« DBIx/Class/Storage/DBI/ODBC/ACCESS.pm ↑ Summary DBIx/Class/Relationship/BelongsTo.pm »