File Coverage

blib/lib/Date/Tiny.pm

Criterion	Covered	Total	%
statement	29	40	72.5
branch	2	4	50.0
condition	1	3	33.3
subroutine	12	17	70.5
pod	9	9	100.0
total	53	73	72.6

use strict;
use warnings;
package Date::Tiny;
# ABSTRACT: A date object, with as little code as possible

our $VERSION = '1.07';

use overload 'bool' => sub () { 1 };
use overload '""'   => 'as_string';
use overload 'eq'   => sub { "$_[0]" eq "$_[1]" };
use overload 'ne'   => sub { "$_[0]" ne "$_[1]" };





#####################################################################
# Constructor and Accessors

#pod =pod
#pod
#pod =method new
#pod
#pod   my $date = Date::Tiny->new(
#pod       year  => 2006,
#pod       month => 12,
#pod       day   => 31,
#pod       );
#pod
#pod The C constructor creates a new B object.
#pod
#pod It takes three named parameters. C should be the day of the month (1-31),
#pod C should be the month of the year (1-12), C as a 4 digit year.
#pod
#pod These are the only parameters accepted.
#pod
#pod Returns a new B object.
#pod
#pod =cut

sub new {
	my $class = shift;
	bless { @_ }, $class;
}

#pod =pod
#pod
#pod =method now
#pod
#pod   my $current_date = Date::Tiny->now;
#pod
#pod The C method creates a new date object for the current date.
#pod
#pod The date created will be based on localtime, despite the fact that
#pod the date is created in the floating time zone.
#pod
#pod Returns a new B object.
#pod
#pod =cut

sub now {
	my @t = localtime time;
	shift->new(
		year  => $t[5] + 1900,
		month => $t[4] + 1,
		day   => $t[3],
	);
}

#pod =pod
#pod
#pod =method year
#pod
#pod The C accessor returns the 4-digit year for the date.
#pod
#pod =cut

sub year {
	$_[0]->{year};
}

#pod =pod
#pod
#pod =method month
#pod
#pod The C accessor returns the 1-12 month of the year for the date.
#pod
#pod =cut

sub month {
	$_[0]->{month};
}

#pod =pod
#pod
#pod =method day
#pod
#pod The C accessor returns the 1-31 day of the month for the date.
#pod
#pod =cut

sub day {
	$_[0]->{day};
}

#pod =pod
#pod
#pod =method ymd
#pod
#pod The C method returns the most common and accurate stringified date
#pod format, which returns in the form "2006-04-12".
#pod
#pod =cut

sub ymd {
	sprintf( "%04u-%02u-%02u",
		$_[0]->year,
		$_[0]->month,
		$_[0]->day,
	);
}





#####################################################################
# Type Conversion

#pod =pod
#pod
#pod =method as_string
#pod
#pod The C method converts the date to the default string, which
#pod at present is the same as that returned by the C method above.
#pod
#pod This string matches the ISO 8601 standard for the encoding of a date as
#pod a string.
#pod
#pod =cut

sub as_string {
	$_[0]->ymd;
}

#pod =pod
#pod
#pod =method from_string
#pod
#pod The C method creates a new B object from a string.
#pod
#pod The string is expected to be a "yyyy-mm-dd" ISO 8601 time string.
#pod
#pod   my $almost_christmas = Date::Tiny->from_string( '2006-12-23' );
#pod
#pod Returns a new B object, or throws an exception on error.
#pod
#pod =cut

sub from_string {
	my $string = $_[1];
	unless ( defined $string and ! ref $string ) {
		require Carp;
		Carp::croak("Did not provide a string to from_string");
	}
	unless ( $string =~ /^(\d\d\d\d)-(\d\d)-(\d\d)$/ ) {
		require Carp;
		Carp::croak("Invalid time format (does not match ISO 8601 yyyy-mm-dd)");
	}
	$_[0]->new(
		year  => $1 + 0,
		month => $2 + 0,
		day   => $3 + 0,
	);
}

#pod =pod
#pod
#pod =method DateTime
#pod
#pod The C method is used to create a L object
#pod that is equivalent to the B object, for use in
#pod conversions and calculations.
#pod
#pod As mentioned earlier, the object will be set to the 'C' locate,
#pod and the 'floating' time zone.
#pod
#pod If installed, the L module will be loaded automatically.
#pod
#pod Returns a L object, or throws an exception if L
#pod is not installed on the current host.
#pod
#pod =cut

sub DateTime {
	require DateTime;
	my $self = shift;
	DateTime->new(
		day       => $self->day,
		month     => $self->month,
		year      => $self->year,
		locale    => 'C',
		time_zone => 'floating',
		@_,
	);
}

1;

__END__