File Coverage

lib/Net/API/Stripe/TimeZone.pm

Criterion	Covered	Total	%
statement	37	153	24.1
branch	0	124	0.0
condition	0	34	0.0
subroutine	13	22	59.0
pod	2	2	100.0
total	52	335	15.5

##----------------------------------------------------------------------------
## Stripe API - ~/lib/Net/API/Stripe/TimeZone.pm
## Version v0.100.0
## Copyright(c) 2019 DEGUEST Pte. Ltd.
## Author: Jacques Deguest <[e-mail]>
## Created 2019/11/02
## Modified 2020/05/15
##
##----------------------------------------------------------------------------
package Net::API::Stripe::TimeZone;
BEGIN
{
    use strict;
    use warnings;
    use vars qw( $VERSION );
    use parent qw( Module::Generic );
    use DateTime::TimeZone;
    use Nice::Try;
    use overload ('""'     => 'name',
                  '=='     => sub { _obj_eq(@_) },
                  '!='     => sub { !_obj_eq(@_) },
                  fallback => 1,
                 );
    our( $VERSION ) = 'v0.100.0';
};

use strict;
use warnings;

sub init
{
    my $self = shift( @_ );
    my $init = shift( @_ );
    my $value = shift( @_ );
    my $tz;
    try
    {
        $tz = DateTime::TimeZone->new( name => $value, @_ );
    }
    catch( $e )
    {
        return( $self->error( "Invalid time zone '${tz}': $e" ) );
    }
    $self->{tz} = $tz;
    return( $self->SUPER::init( @_ ) );
}

sub name { return( shift->{tz}->name ); }

sub _obj_eq
{
    # return overload::StrVal( $_[0] ) eq overload::StrVal( $_[1] );
    no overloading;
    my $self = shift( @_ );
    my $other = shift( @_ );
    return( 0 ) if( !ref( $other ) || !$other->isa( 'Net::API::Stripe::TimeZone' ) );
    my $name = $self->{tz}->name;
    my $name2 = $other->{tz}->name;
    return( 0 ) if( $name ne $name2 );
    use overloading;
    return( 1 );
}

AUTOLOAD
{
    my( $method ) = our $AUTOLOAD =~ /([^:]+)$/;
    my $self = shift( @_ );
    return( $self->{tz}->$method( @_ ) );
};

DESTROY {};

1;
# NOTE: POD
__END__

=encoding utf8

=head1 NAME

Net::API::Stripe::TimeZone - A Time Zone Object

=head1 SYNOPSIS

    # or one can pass just 'local' just like for DateTime::TineZone
    my $tz = $stripe->account->settings->dashboard->timezone( 'Asia/Tokyo' );
    print( $tz->name, "\n" );
    # Asia/Tokyo
    print( "Time zone is $tz\n" );
    # produces: Time zone is Asia/Tokyo

    my $tz2 = $stripe->account->settings->dashboard->timezone( 'local' );
    print( "$tz is same as $tz2? ", $tz eq $tz2 ? 'yes' : 'no', "\n" );

=head1 VERSION

    v0.100.0

=head1 DESCRIPTION

This is a wrapper around L<DateTime::TimeZone> to provide stringification. L<Net::API::Stripe::TimeZone> does not inherit from L<DateTime::TimeZone> but all method of L<DateTime::TimeZone> are accessible via the module B<AUTOLOAD>

=head1 CONSTRUCTOR

=head2 new( hash init, timezone )

Creates a new L<Net::API::Stripe::TimeZone> object.

=head1 METHODS

=head2 name

This is read only. It returns the current value of the time zone.

For all other methods, see the manual page of L<DateTime::TimeZone>

=head1 HISTORY

=head2 v0.1

Initial version

=head1 AUTHOR

Jacques Deguest E<lt>F<[e-mail]>E<gt>

=head1 SEE ALSO

Stripe API documentation:

L<DateTime::TimeZone>

=head1 COPYRIGHT & LICENSE

Copyright (c) 2019-2020 DEGUEST Pte. Ltd.

You can use, copy, modify and redistribute this package and associated
files under the same terms as Perl itself.

=cut