v0.37 - alias methods start/min and end/max

Author: fglock

Changes

@@ -1,5 +1,9 @@
 Changes for DateTime::Set
 
+0.3700 2016-05-17
+- end() / max() and start() / min() are aliases to the same method in all classes.
+  Added docs and tests. Reported by Vincent Berger.
+
 0.3600 2015-11-11
 - move t/22intersects.t to DT::Event::Recurrence module
 

MANIFEST

@@ -28,6 +28,7 @@ t/18as_list_empty.t
 t/19spanset_daylight_savings.t       
 t/20spanset_week_wrapped_recurrence.t
 t/21from_recurrence.t
+t/22start_end.t
 lib/DateTime/Set.pm
 lib/DateTime/Span.pm
 lib/DateTime/SpanSet.pm

lib/DateTime/Set.pm

@@ -15,7 +15,7 @@ use constant INFINITY     =>       100 ** 100 ** 100 ;
 use constant NEG_INFINITY => -1 * (100 ** 100 ** 100);
 
 BEGIN {
-    $VERSION = '0.3600';
+    $VERSION = '0.3700';
 }
 
 
@@ -620,14 +620,18 @@ sub complement {
     return $tmp;
 }
 
-sub min { 
+sub start {
     return _fix_datetime( $_[0]->{set}->min );
 }
 
-sub max { 
+*min = \&start;
+
+sub end { 
     return _fix_datetime( $_[0]->{set}->max );
 }
 
+*max = \&end;
+
 # returns a DateTime::Span
 sub span {
   my $set = $_[0]->{set}->span;
@@ -901,18 +905,22 @@ datetime in the set.
 
 This method can be used to change the C<locale> of a datetime set.
 
-=item * min
 
-=item * max
+=item * start, min
+
+=item * end, max
 
-The first and last C<DateTime> in the set.  These methods may return
-C<undef> if the set is empty.  It is also possible that these methods
-may return a C<DateTime::Infinite::Past> or
-C<DateTime::Infinite::Future> object.
+The first and last C<DateTime> in the set.
 
-These methods return just a I<copy> of the actual boundary value.
+These methods may return C<undef> if the set is empty.
+
+It is also possible that these methods
+may return a C<DateTime::Infinite::Past> or C<DateTime::Infinite::Future> object.
+
+These methods return just a I<copy> of the actual value.
 If you modify the result, the set will not be modified.
 
+
 =item * span
 
 Returns the total span of the set, as a C<DateTime::Span> object.

lib/DateTime/Span.pm

@@ -423,9 +423,9 @@ scalar containing infinity.
 
 Also available as C<size()>.
 
-=item * start
+=item * start, min
 
-=item * end
+=item * end, max
 
 First or last dates in the span.
 
@@ -435,6 +435,9 @@ C<DateTime::Infinite::Future> or a C<DateTime::Infinite::Past>xs object.
 If the set ends C<before> a date C<$dt>, it returns C<$dt>. Note that
 in this case C<$dt> is not a set element - but it is a set boundary.
 
+These methods return just a I<copy> of the actual boundary value.
+If you modify the result, the set will not be modified.
+
 =cut
 
 # scalar containing either negative infinity

lib/DateTime/SpanSet.pm

@@ -502,14 +502,18 @@ sub complement {
     return $tmp;
 }
 
-sub min {
+sub start {
     return DateTime::Set::_fix_datetime( $_[0]->{set}->min );
 }
 
-sub max { 
+*min = \&start;
+
+sub end { 
     return DateTime::Set::_fix_datetime( $_[0]->{set}->max );
 }
 
+*max = \&end;
+
 # returns a DateTime::Span
 sub span { 
     my $set = $_[0]->{set}->span;
@@ -646,13 +650,24 @@ the local time are made, except to account for leap seconds.  If the
 new time zone is floating, then the I<UTC> time is adjusted in order
 to leave the local time untouched.
 
-=item * min
 
-=item * max
+=item * start, min
+
+=item * end, max
+
+First or last dates in the set.
+
+It is possible that the return value from these methods may be a
+C<DateTime::Infinite::Future> or a C<DateTime::Infinite::Past> object.
+
+If the set ends C<before> a date C<$dt>, it returns C<$dt>. Note that
+in this case C<$dt> is not a set element - but it is a set boundary.
+
+These methods may return C<undef> if the set is empty.
+
+These methods return just a I<copy> of the actual boundary value.
+If you modify the result, the set will not be modified.
 
-First or last dates in the set.  These methods may return C<undef> if
-the set is empty.  It is also possible that these methods may return a
-scalar containing infinity or negative infinity.
 
 =item * duration
 

t/22start_end.t

@@ -0,0 +1,102 @@
+#!/usr/bin/perl -w
+
+use strict;
+
+use Test::More;
+plan tests => 34;
+
+use DateTime;
+use DateTime::Set;
+
+my $future = DateTime::Infinite::Future->new();
+my $past   = DateTime::Infinite::Past->new();
+my $t1     = new DateTime( year => '1810', month => '11', day => '22' );
+my $t2     = new DateTime( year => '1900', month => '11', day => '22' );
+
+# Set tests
+
+{
+    my $set1 = DateTime::Set->from_datetimes( dates => [ $t1, $t2 ] );
+
+    ok( $set1->min->ymd eq '1810-11-22',   'min is ' . $set1->min->ymd );
+    ok( $set1->max->ymd eq '1900-11-22',   'max is ' . $set1->max->ymd );
+    ok( $set1->start->ymd eq '1810-11-22', 'start is ' . $set1->start->ymd );
+    ok( $set1->end->ymd eq '1900-11-22',   'end is ' . $set1->end->ymd );
+}
+
+{
+    my $set1 = DateTime::Set->from_datetimes( dates => [ $past, $future ] );
+
+    ok( $set1->min->is_infinite,   'min is infinite' );
+    ok( $set1->max->is_infinite,   'max is infinite' );
+    ok( $set1->start->is_infinite, 'start is infinite' );
+    ok( $set1->end->is_infinite,   'end is infinite' );
+}
+
+{
+    my $set1 = DateTime::Set->from_datetimes( dates => [] );
+
+    ok( !defined $set1->min,   'min is undef' );
+    ok( !defined $set1->max,   'max is undef' );
+    ok( !defined $set1->start, 'start is undef' );
+    ok( !defined $set1->end,   'end is undef' );
+}
+
+# Span tests
+
+{
+    my $set1 = DateTime::Span->from_datetimes( start => $t1, end => $t2  );
+
+    ok( $set1->min->ymd eq '1810-11-22',   'min is ' . $set1->min->ymd );
+    ok( $set1->max->ymd eq '1900-11-22',   'max is ' . $set1->max->ymd );
+    ok( $set1->start->ymd eq '1810-11-22', 'start is ' . $set1->start->ymd );
+    ok( $set1->end->ymd eq '1900-11-22',   'end is ' . $set1->end->ymd );
+}
+
+{
+    my $set1 = DateTime::Span->from_datetimes( start => $past, end => $future  );
+
+    ok( $set1->min->is_infinite,   'min is infinite' );
+    ok( $set1->max->is_infinite,   'max is infinite' );
+    ok( $set1->start->is_infinite, 'start is infinite' );
+    ok( $set1->end->is_infinite,   'end is infinite' );
+}
+
+{
+    my $set1 = DateTime::Span->from_datetimes( start => $past );
+
+    ok( $set1->max->is_infinite,   'max is infinite' );
+    ok( $set1->end->is_infinite,   'end is infinite' );
+}
+
+# SpanSet tests
+
+{
+    my $set1 = DateTime::SpanSet->from_spans( spans => [ DateTime::Set->from_datetimes( dates => [ $t1, $t2 ] ) ] );
+
+    ok( $set1->min->ymd eq '1810-11-22',   'min is ' . $set1->min->ymd );
+    ok( $set1->max->ymd eq '1900-11-22',   'max is ' . $set1->max->ymd );
+    ok( $set1->start->ymd eq '1810-11-22', 'start is ' . $set1->start->ymd );
+    ok( $set1->end->ymd eq '1900-11-22',   'end is ' . $set1->end->ymd );
+}
+
+{
+    my $set1 = DateTime::SpanSet->from_spans( spans => [ DateTime::Set->from_datetimes( dates => [ $past, $future ] ) ] );
+
+    ok( $set1->min->is_infinite,   'min is infinite' );
+    ok( $set1->max->is_infinite,   'max is infinite' );
+    ok( $set1->start->is_infinite, 'start is infinite' );
+    ok( $set1->end->is_infinite,   'end is infinite' );
+}
+
+{
+    my $set1 = DateTime::SpanSet->from_spans( spans => [ ] );
+
+    ok( !defined $set1->min,   'min is undef' );
+    ok( !defined $set1->max,   'max is undef' );
+    ok( !defined $set1->start, 'start is undef' );
+    ok( !defined $set1->end,   'end is undef' );
+}
+
+1;
+