File Coverage

blib/lib/Data/Sah/Coerce/perl/To_date/From_str/natural.pm

Criterion	Covered	Total	%
statement	17	17	100.0
branch	5	6	83.3
condition	3	4	75.0
subroutine	5	5	100.0
pod	0	2	0.0
total	30	34	88.2

package Data::Sah::Coerce::perl::To_date::From_str::natural;

use 5.010001;
use strict;
use warnings;

# AUTHOR
our $DATE = '2021-09-07'; # DATE
our $DIST = 'Data-Sah-Coerce-perl-To_date-From_str-natural'; # DIST
our $VERSION = '0.014'; # VERSION

sub meta {
    +{
        v => 4,
        summary => 'Coerce date from string parsed by DateTime::Format::Natural (UTC time zone)',
        might_fail => 1,
        prio => 60, # a bit lower than normal
        precludes => [qr/\A(From_str::alami(_.+)?|From_str::flexible(_.+)?)\z/],
    };
}

sub coerce {
    my %args = @_;

    my $dt = $args{data_term};
    my $coerce_to = $args{coerce_to} // 'float(epoch)';

    my $res = {};

    $res->{expr_match} = "!ref($dt)";
    $res->{modules}{"DateTime::Format::Natural"} //= 0;
    $res->{expr_coerce} = join(
        "",
        "do { my \$p = DateTime::Format::Natural->new(time_zone => 'UTC'); my \$datetime = \$p->parse_datetime($dt)->set_time_zone('UTC'); ",
        "if (!\$p->success) { [\$p->error] } else { ",
        ($coerce_to eq 'float(epoch)' ? "[undef, \$datetime->epoch] " :
             $coerce_to eq 'Time::Moment' ? "[undef, Time::Moment->from_object(\$datetime)] " :
             $coerce_to eq 'DateTime' ? "[undef, \$datetime] " :
             (die "BUG: Unknown coerce_to '$coerce_to'")),
        "} }",
    );

    $res;
}

1;
# ABSTRACT: Coerce date from string parsed by DateTime::Format::Natural (UTC time zone)

__END__

=pod

=encoding UTF-8

=head1 NAME

Data::Sah::Coerce::perl::To_date::From_str::natural - Coerce date from string parsed by DateTime::Format::Natural (UTC time zone)

=head1 VERSION

This document describes version 0.014 of Data::Sah::Coerce::perl::To_date::From_str::natural (from Perl distribution Data-Sah-Coerce-perl-To_date-From_str-natural), released on 2021-09-07.

=head1 SYNOPSIS

To use in a Sah schema:

 ["date",{"x.perl.coerce_rules"=>["From_str::natural"]}]

=head1 DESCRIPTION

To clarify your intent, please use
L<Data::Sah::Coerce::perl::To_date::From_str::natural_utc> instead.

=for Pod::Coverage ^(meta|coerce)$

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/Data-Sah-Coerce-perl-To_date-From_str-natural>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-Data-Sah-Coerce-perl-To_date-From_str-natural>.

=head1 SEE ALSO

L<DateTime::Format::Natural> - the backend used to parse date strings.

L<Data::Sah::Coerce::perl::To_date::From_str::natural_utc>

L<Data::Sah::Coerce::perl::To_date::From_str::natural_local>

L<Data::Sah::Coerce::perl::To_date::From_str::flexible>

=head1 AUTHOR

perlancar <[e-mail]>

=head1 CONTRIBUTING


To contribute, you can send patches by email/via RT, or send pull requests on
GitHub.

Most of the time, you don't need to build the distribution yourself. You can
simply modify the code, then test via:

 % prove -l

If you want to build the distribution (e.g. to try to install it locally on your
system), you can install L<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>, and sometimes one or two other
Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required
beyond that are considered a bug and can be reported to me.

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2019, 2018, 2016 by perlancar <[e-mail]>.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=Data-Sah-Coerce-perl-To_date-From_str-natural>

When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.

=cut