File Coverage

blib/lib/Catmandu/Fix/expand_date.pm

Criterion	Covered	Total	%
statement	19	19	100.0
branch	5	8	62.5
condition			n/a
subroutine	5	5	100.0
pod	0	1	0.0
total	29	33	87.8

package Catmandu::Fix::expand_date;

use Catmandu::Sane;

our $VERSION = '1.2020';

use Moo;
use namespace::clean;
use Catmandu::Fix::Has;

my $DATE_REGEX = qr{
        ^([0-9]{4})
                (?: [:-] ([0-9]{1,2})
                        (?: [:-] ([0-9]{1,2}) )?
                )?
}x;

with 'Catmandu::Fix::Inlineable';

has date_field => (fix_arg => 1, default => sub {'date'});

sub fix {
    my ($self, $data) = @_;
    if (my $date = $data->{$self->date_field}) {
        if (my ($y, $m, $d) = $date =~ $DATE_REGEX) {
            $data->{year}  = $y;
            $data->{month} = 1 * $m if $m;
            $data->{day}   = 1 * $d if $d;
        }
    }
    $data;
}

1;

__END__

=pod

=head1 NAME

Catmandu::Fix::expand_date - expand a date field into year, month and date

=head1 NOTE

This package is DEPRECATED and will be removed in the future.
Please use L<Catmandu::Fix::split_date>.

Reasons:

=over 4

=item

it writes directly in the root of the hash, which is a different
behaviour compared to all the other fixes (sum, count, hash, array ..)

=item

it adds the new keys in a different location, instead of "in place".

=item

its behaviour cannot be changed without breaking its current use

=back

=head1 SYNOPSIS

    # {date => "2001-09-11"}
    expand_date()
    # => {year => 2001, month => "9", day => "11", date => "2001-09-11"}

    # {datestamp => "2001:09"}
    expand_date(datestamp)
    # => {year => 2001, month => "9", datestamp => "2001:09"}

=head1 DESCRIPTION

The date field is expanded if it contains a year, optionally followed by
numeric month and day, each separated by C<-> or C<:>.


=cut