lib/MooseX/Types/DateTimeX.pm

   1 package MooseX::Types::DateTimeX;
   2 use strict;
   3 use warnings;
   4
   5 use DateTime;
   6 use DateTime::Duration;
   7 use DateTimeX::Easy;
   8 use Time::Duration::Parse qw(parse_duration);
   9 use MooseX::Types::DateTime ();
  10 use MooseX::Types::Moose qw/Num HashRef Str/;
  11
  12 use namespace::clean;
  13
  14 our $VERSION = '0.06';
  15
  16 use MooseX::Types -declare => [qw( DateTime Duration)];
  17
  18 subtype DateTime, as MooseX::Types::DateTime::DateTime;
  19 coerce( DateTime,
  20     @{ $MooseX::Types::DateTime::coercions{DateTime} },
  21     from Str, via { DateTimeX::Easy->new($_) },
  22 );
  23
  24 subtype Duration, as MooseX::Types::DateTime::Duration;
  25 coerce( Duration,
  26     @{ $MooseX::Types::DateTime::coercions{"DateTime::Duration"} },
  27     from Str, via {
  28         DateTime::Duration->new(
  29             seconds => parse_duration($_)
  30         );
  31     },
  32 );
  33
  34 1;
  35
  36 __END__
  37
  38 =head1 NAME
  39
  40 MooseX::Types::DateTimeX - Extensions to L<MooseX::Types::DateTime>
  41
  42 =head1 SYNOPSIS
  43
  44     package MyApp::MyClass;
  45
  46     use MooseX::Types::DateTimeX qw( DateTime );
  47
  48     has created => (
  49         isa => DateTime,
  50         is => "rw",
  51         coerce => 1,
  52     );
  53
  54     my $instance = MyApp::MyClass->new(created=>'January 1, 1980');
  55     print $instance->created->year; # is 1980
  56
  57     ## Coercions from the base type continue to work as normal.
  58     my $instance = MyApp::MyClass->new(created=>{year=>2000,month=>1,day=>10});
  59
  60 Please see the test case for more example usage.
  61
  62 =head1 DESCRIPTION
  63
  64 This module builds on L<MooseX::Types::DateTime> to add additional custom types and coercions.  Since it builds on an existing type, all coercions and constraints are inherited.
  65
  66 The package name is left as is for legacy reasons: this module is really a Type with coercions for L<DateTimeX::Easy>. DateTimeX is just a namespace for non-core or less-official L<DateTime> modules.
  67
  68 =head1 SUBTYPES
  69
  70 This module defines the following additional subtypes.
  71
  72 =head2 DateTime
  73
  74 Subtype of 'DateTime'.  Adds an additional coercion from strings.
  75
  76 Uses L<DateTimeX::Easy> to try and convert strings, like "yesterday" into a valid L<DateTime> object.  Please note that due to ambiguity with how different systems might localize their timezone, string parsing may not always return the most expected value.  IN general we try to localize to UTC whenever possible.  Feedback welcomed!
  77
  78 =head2 Duration
  79
  80 Subtype of 'DateTime::Duration' that coerces from a string.  We use the module L<Time::Duration::Parse> to attempt this.
  81
  82 =head1 CAVEATS
  83
  84 Firstly, this module uses L<DateTimeX::Easy> which is way to more DWIM than any sane person would desire. L<DateTimeX::Easy> works by falling back until something makes sense, this is variable. Furthermore, all the modules that L<DateTimeX::Easy> *can* use aren't required for "proper" function of L<DateTimeX::Easy>. What does this mean? Simple, your mileage may vary in your coercions because L<DateTimeX::Easy> is installation specific.
  85
  86 =head1 SEE ALSO
  87
  88 =over 4
  89
  90 =item * L<MooseX::Types::DateTime> Replacement for this module -- coercions with less voodoo
  91
  92 =item * L<DateTimeX::Easy> Backend of this module
  93
  94 =back
  95
  96 =head1 AUTHOR
  97
  98 John Napiorkowski E<lt>jjn1056 at yahoo.comE<gt>
  99
 100 Broken into a seperate package from L<MooseX::Types::DateTime> by Evan Carroll.
 101
 102 =head1 LICENSE
 103
 104     Copyright (c) 2008 John Napiorkowski.
 105
 106     This program is free software; you can redistribute
 107     it and/or modify it under the same terms as Perl itself.