tempr 0.1.3 → 0.1.4

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.1.4 / 2012-02-20
+
+- add range adjacency methods (`precedes?`, `succeeds?`, `adjacent_to?`)
+
 ## 0.1.3 / 2012-02-19
 
 - convert date to time ranges for date <-> time comparisons in `within?/subsume?/intersection_with`

data/lib/tempr/date_time_range.rb

@@ -31,6 +31,10 @@ module Tempr
   #
   # Or check for inclusion of a date/time:
   #
+  #     subrange.cover? Time.parse("2012-05-17 2:30pm")
+  #
+  # which is a shortcut for
+  #
   #     subrange.any? {|r| r.cover?(Time.parse("2012-05-17 2:30pm")) }
   #
   # Note that the order of the chained rules is important, they must be defined
@@ -511,6 +515,22 @@ module Tempr
       !!intersection_with(other)
     end
     
+    # true iff self immediately precedes other range
+    def precedes?(other)
+      range_precedes(self, other)
+    end
+    
+    # true iff self immediately succeeds (follows) other range
+    def succeeds?(other)
+      range_precedes(other, self)
+    end
+    alias follows? succeeds?
+    
+    # true iff self either succeeds or follows other range
+    def adjacent_to?(other)
+      succeeds?(other) || precedes?(other)
+    end
+    
     # ---
     
     # convenience wrapper for SubRangeIterator.new(self) { ... }
@@ -539,6 +559,18 @@ module Tempr
       end
     end
     
+    # note that date ranges will always be adjusted to exclude the end,
+    # so only inclusive time ranges will need to add +1 second to check adjacency
+    def range_precedes(rng,oth)
+      r1, r2 = matched_range_types(rng,oth)
+      diff = if r1.respond_to?(:exclude_end?) && r1.exclude_end?
+               0
+             else
+               1
+             end
+      (r1.end + diff) == r2.begin
+    end
+    
     # ---
     
     # Iterators are defined by

data/lib/tempr/version.rb

@@ -3,7 +3,7 @@ module Tempr
   module Version
     MAJOR  = 0
     MINOR  = 1
-    TINY   = 3
+    TINY   = 4
     STRING = "#{MAJOR}.#{MINOR}.#{TINY}"
   end
 end

data/test/range_adjacency.rb

@@ -0,0 +1,257 @@
+require File.expand_path('test_helper', File.dirname(__FILE__))
+
+module RangeAdjacencyTests
+
+  Fixtures = [ 
+    {
+      :case     => "inclusive date ranges, other equals self",
+      :subject  => (Date.civil(2012,2,13)..
+                    Date.civil(2012,2,17)).extend(Tempr::DateTimeRange),
+      :other    => Date.civil(2012,2,13)..Date.civil(2012,2,17),
+      :precedes => false,
+      :succeeds => false,
+      :adjacent => false
+    },
+    {
+      :case     => "inclusive date ranges, other within self",
+      :subject  => (Date.civil(2012,2,13)..
+                    Date.civil(2012,2,17)).extend(Tempr::DateTimeRange),
+      :other    => Date.civil(2012,2,13)..Date.civil(2012,2,16),
+      :precedes => false,
+      :succeeds => false,
+      :adjacent => false
+    },
+    {
+      :case     => "inclusive date ranges, other precedes self",
+      :subject  => (Date.civil(2012,2,13)..
+                    Date.civil(2012,2,17)).extend(Tempr::DateTimeRange),
+      :other    => Date.civil(2012,2,1)..Date.civil(2012,2,12),
+      :precedes => false,
+      :succeeds => true,
+      :adjacent => true
+    },
+    {
+      :case     => "inclusive date ranges, self precedes other",
+      :subject  => (Date.civil(2012,2,13)..
+                    Date.civil(2012,2,17)).extend(Tempr::DateTimeRange),
+      :other    => Date.civil(2012,2,18)..Date.civil(2012,2,25),
+      :precedes => true,
+      :succeeds => false,
+      :adjacent => true
+    },
+    {
+      :case     => "exclusive date ranges, other equals self",
+      :subject  => (Date.civil(2012,2,13)...
+                    Date.civil(2012,2,18)).extend(Tempr::DateTimeRange),
+      :other    => Date.civil(2012,2,13)...Date.civil(2012,2,18),
+      :precedes => false,
+      :succeeds => false,
+      :adjacent => false
+    },
+    {
+      :case     => "exclusive date ranges, other within self",
+      :subject  => (Date.civil(2012,2,13)...
+                    Date.civil(2012,2,18)).extend(Tempr::DateTimeRange),
+      :other    => Date.civil(2012,2,13)...Date.civil(2012,2,17),
+      :precedes => false,
+      :succeeds => false,
+      :adjacent => false
+    },
+    {
+      :case     => "exclusive date ranges, other precedes self",
+      :subject  => (Date.civil(2012,2,13)...
+                    Date.civil(2012,2,18)).extend(Tempr::DateTimeRange),
+      :other    => Date.civil(2012,2,1)...Date.civil(2012,2,13),
+      :precedes => false,
+      :succeeds => true,
+      :adjacent => true
+    },
+    {
+      :case     => "exclusive date ranges, self precedes other",
+      :subject  => (Date.civil(2012,2,13)...
+                    Date.civil(2012,2,18)).extend(Tempr::DateTimeRange),
+      :other    => Date.civil(2012,2,18)...Date.civil(2012,2,25),
+      :precedes => true,
+      :succeeds => false,
+      :adjacent => true
+    },
+    
+  #---------- time range cases
+        
+    {
+      :case     => "inclusive time ranges, other equals self",
+      :subject  => (Time.new(2012,2,13,12,11,10)..
+                    Time.new(2012,2,17,16,15,14)).extend(Tempr::DateTimeRange),
+      :other    => (Time.new(2012,2,13,12,11,10)..
+                    Time.new(2012,2,17,16,15,14)),
+      :precedes => false,
+      :succeeds => false,
+      :adjacent => false
+    },
+    {
+      :case     => "inclusive time ranges, other within self",
+      :subject  => (Time.new(2012,2,13,12,11,10)..
+                    Time.new(2012,2,17,16,15,14)).extend(Tempr::DateTimeRange),
+      :other    => (Time.new(2012,2,13,12,11,10)..
+                    Time.new(2012,2,17,16,15,13)),
+      :precedes => false,
+      :succeeds => false,
+      :adjacent => false
+    },
+    {
+      :case     => "inclusive time ranges, self precedes other",
+      :subject  => (Time.new(2012,2,13,12,11,10)..
+                    Time.new(2012,2,17,16,15,14)).extend(Tempr::DateTimeRange),
+      :other    => (Time.new(2012,2,17,16,15,15)..
+                    Time.new(2012,2,17,16,15,16)),
+      :precedes => true,
+      :succeeds => false,
+      :adjacent => true
+    },
+    {
+      :case     => "inclusive time ranges, other precedes self",
+      :subject  => (Time.new(2012,2,13,0,0,0)..
+                    Time.new(2012,2,17,0,0,0)).extend(Tempr::DateTimeRange),
+      :other    => (Time.new(2012,2,1,0,0,0)..
+                    Time.new(2012,2,12,23,59,59)),
+      :precedes => false,
+      :succeeds => true,
+      :adjacent => true
+    },
+    {
+      :case     => "exclusive time ranges, other equals self",
+      :subject  => (Time.new(2012,2,13,12,11,10)...
+                    Time.new(2012,2,17,16,15,14)).extend(Tempr::DateTimeRange),
+      :other    => (Time.new(2012,2,13,12,11,10)...
+                    Time.new(2012,2,17,16,15,14)),
+      :precedes => false,
+      :succeeds => false,
+      :adjacent => false
+    },
+    {
+      :case     => "inclusive time ranges, other within self",
+      :subject  => (Time.new(2012,2,13,12,11,10)...
+                    Time.new(2012,2,17,16,15,14)).extend(Tempr::DateTimeRange),
+      :other    => (Time.new(2012,2,13,12,11,10)...
+                    Time.new(2012,2,17,16,15,13)),
+      :precedes => false,
+      :succeeds => false,
+      :adjacent => false
+    },
+    {
+      :case     => "inclusive time ranges, self precedes other",
+      :subject  => (Time.new(2012,2,13,12,11,10)...
+                    Time.new(2012,2,17,16,15,14)).extend(Tempr::DateTimeRange),
+      :other    => (Time.new(2012,2,17,16,15,14)..
+                    Time.new(2012,2,17,16,15,16)),
+      :precedes => true,
+      :succeeds => false,
+      :adjacent => true
+    },
+    {
+      :case     => "inclusive time ranges, other precedes self",
+      :subject  => (Time.new(2012,2,13,0,0,0)..
+                    Time.new(2012,2,17,0,0,0)).extend(Tempr::DateTimeRange),
+      :other    => (Time.new(2012,2,1,0,0,0)...
+                    Time.new(2012,2,13,0,0,0)),
+      :precedes => false,
+      :succeeds => true,
+      :adjacent => true
+    },
+  #---------- date/time range cases
+
+    {
+      :case     => "date range intersects other time range, other equivalent to self",
+      :subject  => (Date.civil(2012,2,13)..
+                    Date.civil(2012,2,17)).extend(Tempr::DateTimeRange),
+      :other    => (Time.new(2012,2,13,0,0,0)...
+                    Time.new(2012,2,18,0,0,0)),
+      :precedes => false,
+      :succeeds => false,
+      :adjacent => false
+    },
+    {
+      :case     => "time range compared to other date range, other within self",
+      :subject  => (Time.new(2012,2,13,0,0,0)...
+                    Time.new(2012,2,18,0,0,0)).extend(Tempr::DateTimeRange),
+      :other    => (Date.civil(2012,2,13)..
+                    Date.civil(2012,2,16)),
+      :precedes => false,
+      :succeeds => false,
+      :adjacent => false
+    },
+    {
+      :case     => "date range compared to other time range, self precedes other",
+      :subject  => (Date.civil(2012,2,13)..
+                    Date.civil(2012,2,17)).extend(Tempr::DateTimeRange),
+      :other    => (Time.new(2012,2,18,0,0,0)...
+                    Time.new(2012,2,19,0,0,0)),
+      :precedes => true,
+      :succeeds => false,
+      :adjacent => true
+    },
+    {
+      :case     => "time range compared to other date range, self precedes other",
+      :subject  => (Time.new(2012,2,13,0,0,0)...
+                    Time.new(2012,2,18,0,0,0)).extend(Tempr::DateTimeRange),
+      :other    => (Date.civil(2012,2,18)..
+                    Date.civil(2012,2,19)),
+      :precedes => true,
+      :succeeds => false,
+      :adjacent => true
+    },    
+    {
+      :case     => "date range compared to other time range, other precedes self",
+      :subject  => (Date.civil(2012,2,13)..
+                    Date.civil(2012,2,17)).extend(Tempr::DateTimeRange),
+      :other    => (Time.new(2012,2,1,0,0,0)...
+                    Time.new(2012,2,13,0,0,0)),
+      :precedes => false,
+      :succeeds => true,
+      :adjacent => true
+    },
+    {
+      :case     => "time range compared to other date range, other precedes self",
+      :subject  => (Time.new(2012,2,13,0,0,0)...
+                    Time.new(2012,2,18,0,0,0)).extend(Tempr::DateTimeRange),
+      :other    => (Date.civil(2012,2,1)..
+                    Date.civil(2012,2,12)),
+      :precedes => false,
+      :succeeds => true,
+      :adjacent => true
+    }
+  ]
+  
+  describe "DateTimeRange#intersection_with, date ranges" do
+
+    Fixtures.each do |fixture|
+    
+      describe fixture[:case] do
+        let(:subject)  { fixture[:subject]  }
+        let(:other)    { fixture[:other]    }
+        let(:expected_precedes) { fixture[:precedes] }
+        let(:expected_succeeds) { fixture[:succeeds] }
+        let(:expected_adjacent) { fixture[:adjacent] }
+        
+        it 'should return expected precedes status' do
+          actual = subject.precedes?(other)
+          assert_equal expected_precedes, actual
+        end
+       
+        it 'should return expected succeeds status' do
+          actual = subject.succeeds?(other)
+          assert_equal expected_succeeds, actual
+        end
+        
+        it 'should return expected adjacent_to status' do
+          actual = subject.adjacent_to?(other)
+          assert_equal expected_adjacent, actual
+        end
+
+      end
+    
+    end
+    
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tempr
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-19 00:00:00.000000000Z
+date: 2012-02-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &13275580 !ruby/object:Gem::Requirement
+  requirement: &11232140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13275580
+  version_requirements: *11232140
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &13275120 !ruby/object:Gem::Requirement
+  requirement: &11231560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13275120
+  version_requirements: *11231560
 description: ''
 email:
 - ericgj72@gmail.com
@@ -49,6 +49,7 @@ files:
 - lib/tempr/date_time_range.rb
 - lib/tempr/version.rb
 - test/each_time_of_day.rb
+- test/range_adjacency.rb
 - test/range_intersection.rb
 - test/range_within_other.rb
 - test/suite.rb