File Coverage

blib/lib/Time/Duration/Concise/Localize.pm

Criterion	Covered	Total	%
statement	51	53	96.2
branch	13	20	65.0
condition			n/a
subroutine	11	11	100.0
pod	3	3	100.0
total	78	87	89.6

package Time::Duration::Concise::Localize;

use 5.006;
use strict;
use warnings FATAL => 'all';
use utf8;

use Carp;
use base qw(Time::Duration::Concise);
use Module::Pluggable
  search_path => 'Time::Duration::Concise::Locale',
  sub_name    => 'translation_classes',
  require     => 1;

our $VERSION = '2.6';

=head1 NAME

Time::Duration::Concise::Localize - localize concise time duration string representation.

=head1 DESCRIPTION

Time::Duration::Concise provides localize concise time duration string representation.

=head1 VERSION

Version 2.6

=head1 SYNOPSIS

    use Time::Duration::Concise::Localize;

    my $duration = Time::Duration::Concise::Localize->new(

        # concise time interval
        'interval' => '1.5h',

        # Locale for translation
        'locale' => 'en'
    );

    $duration->as_string;

=head1 FIELDS

=head2 interval (REQUIRED)

concise interval string

=head2 locale

Get and set the locale for translation

=cut

sub locale {
    my ( $self, $locale ) = @_;
    $self->{'locale'} = lc $locale if $locale;
    return $self->{'locale'};
}

=head1 METHODS

=head2 as_string

Localized duration string

=cut

# Map self and plurals for English default. Should use KNOWN_UNITS...
my %locale_cache = (en => +{map { $_ => $_ } map { ($_, $_ . 's') } qw(second minute hour day)});

sub _load_translation {
    my ($self, $req_locale) = @_;

    # If locale already cached do not load
    my $cached = exists $locale_cache{$req_locale};

    if (!$cached) {
        foreach my $locale_module ($self->translation_classes) {
            my $load_locale = (split('::', $locale_module))[-1];
            next if (exists $locale_cache{$load_locale});    # Got this one already.
            next unless ($locale_module->can('translation'));    # Chocolate in our peanut butter.
            $locale_cache{$load_locale} = $locale_module->translation();
            $cached = 1 if ($load_locale eq $req_locale);        # Good news, everyone!
        }
    }

    return ($cached) ? $locale_cache{$req_locale} : $locale_cache{en};    # English default.
}

sub as_string {
    my ($self, $precision) = @_;

    my $translation = $self->_load_translation($self->locale);

    return join(' ', map { join ' ', ($_->{'value'}, $translation->{$_->{'unit'}}) } @{$self->duration_array($precision)});
}

=head2 new

Object constructor

=cut

sub new {
    my $class = shift;
    my %params_ref = ref( $_[0] ) ? %{ $_[0] } : @_;

    my $interval = $params_ref{'interval'};

    my $whatsit = ref($interval);

    if ($whatsit eq __PACKAGE__) {
        $interval = $interval->seconds;
    }

    if (not defined $interval) {
        confess "Missing required arguments";
    }

    my $self = $class->SUPER::new( interval => $interval );

    # Set default locale as english
    $self->{'locale'} = 'en';
    if ( exists $params_ref{'locale'} ) {
        $self->{'locale'} = lc $params_ref{'locale'};
    }

    my $obj = bless $self, $class;
    return $obj;
}

=head1 AUTHOR

Binary.com, C<<  >>

=head1 BUGS

Please report any bugs or feature requests to C, or through
the web interface at L.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.

=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Time::Duration::Concise::Localize


You can also look for information at:

=over 4

=item * RT: CPAN's request tracker (report bugs here)

L

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * Search CPAN

L

=back


=head1 LICENSE AND COPYRIGHT

Copyright 2014 Binary.com.

This program is free software; you can redistribute it and/or modify it
under the terms of the the Artistic License (2.0). You may obtain a
copy of the full license at:

L

Any use, modification, and distribution of the Standard or Modified
Versions is governed by this Artistic License. By using, modifying or
distributing the Package, you accept this license. Do not use, modify,
or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made
by someone other than you, you are nevertheless required to ensure that
your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service
mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge
patent license to make, have made, use, offer to sell, sell, import and
otherwise transfer the Package with respect to any patent claims
licensable by the Copyright Holder that are necessarily infringed by the
Package. If you institute patent litigation (including a cross-claim or
counterclaim) against any party alleging that the Package constitutes
direct or contributory patent infringement, then this Artistic License
to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


=cut

1;    # End of Time::Duration::Concise::Localize