File Coverage

blib/lib/Time/Duration/Object.pm

Criterion	Covered	Total	%
statement	32	32	100.0
branch	2	2	100.0
condition			n/a
subroutine	11	11	100.0
pod	2	2	100.0
total	47	47	100.0

use strict;
use warnings;
package Time::Duration::Object 0.302;
# ABSTRACT: Time::Duration, but an object

use Time::Duration 1.02;

#pod =head1 SYNOPSIS
#pod
#pod  use Time::Duration::Object;
#pod
#pod  my $duration = Time::Duration::Object->new($end_time - $start_time);
#pod
#pod =head1 DESCRIPTION
#pod
#pod This module provides an object-oriented interface to Time::Duration.  Sure,
#pod it's overkill, and Time::Duration is plenty useful without OO, but this
#pod interface makes it easy to use Time::Duration with Class::DBI, and that's a
#pod good thing.
#pod
#pod =head1 METHODS
#pod
#pod =head2 C< new($seconds) >
#pod
#pod This returns a new Time::Duration::Object for the given number of seconds.
#pod
#pod =cut

sub new {
	my ($class, $duration) = @_;
	return unless defined $duration;
	bless \$duration => $class;
}

#pod =head2 C< seconds >
#pod
#pod This returns the number of seconds in the duration (i.e., the argument you
#pod passed to your call to C.)
#pod
#pod =cut

sub seconds {
	return ${(shift)};
}

#pod =head2 C
#pod
#pod =head2 C
#pod
#pod =head2 C
#pod
#pod =head2 C
#pod
#pod =head2 C
#pod
#pod =head2 C
#pod
#pod =head2 C
#pod
#pod =head2 C
#pod
#pod =head2 C
#pod
#pod =head2 C
#pod
#pod These methods all perform the function of the same name from Time::Duration.
#pod
#pod =cut

{
  ## no critic (ProhibitNoStrict ProhibitNoWarnings)
  no strict 'refs';
  no warnings 'redefine';
  my @methods = map { $_, "$_\_exact" } qw(duration ago from_now later earlier);
  for (@methods) {
    my $method = \&{"Time::Duration::$_"};
    *{$_} = sub {
      unshift @_, ${(shift)};
      my $result = &$method(@_);
      bless \$result => 'Time::Duration::_Result';
    }
  }
}

package Time::Duration::_Result 0.302;

#pod =head2 as_string
#pod
#pod Time::Duration::Object methods don't return strings, they return an object that
#pod stringifies.  If you can't deal with that and don't want to stringify by
#pod concatenating an empty string, you can call C instead.
#pod
#pod  my $duration = Time::Duration::Object->new(8000);
#pod  print $duration->ago->as_string; # 2 hours and 13 minutes ago
#pod
#pod =cut

sub as_string { ${ $_[0] } }

#pod =head2 concise
#pod
#pod This method can be called on the result of the above methods, trimming down the
#pod ouput.  For example:
#pod
#pod  my $duration = Time::Duration::Object->new(8000);
#pod  print $duration->ago; # 2 hours and 13 minutes ago
#pod  print $duration->ago->concise # 2hr13m ago
#pod
#pod =cut

sub concise {
	my $self = shift;
	Time::Duration::concise(${$self});
}

use overload
	'""' => 'as_string',
	fallback => 1;

#pod =head1 SEE ALSO
#pod
#pod Obviously, this module would be useless without Sean Burke's super-useful
#pod L.  There are those, I'm sure, who will think that even I
#pod that module...
#pod
#pod =cut

1;

__END__