tempr 0.1.1 → 0.1.2

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.1.2 / 2012-02-19
+
+- add `within?`, `subsume?`, `intersection_with`, `intersects?`
+
 ## 0.1.1 / 2012-02-18
 
 - add `SubRangeIterator#cover?` shortcut

data/lib/tempr/date_time_range.rb

@@ -473,11 +473,61 @@ module Tempr
       end
     end
     
+    # ---
+    
+    # Set-like operations on two ranges
+    
+    # true iff self.begin <= other.begin and self.end >= other.end
+    # (with accomodations for exclusive-end ranges)
+    def within?(other)
+      range_within_other?(self,other)
+    end
+    
+    # true iff other.begin <= self.begin and other.end >= self.end
+    # (with accomodations for exclusive-end ranges)
+    def subsume?(other)
+      range_within_other?(other,self)
+    end
+    
+    # the range intersection of self and other
+    # note: returns nil if no intersection
+    def intersection_with(other)
+      max_begin = [self.begin,other.begin].max
+      min_end   = [self.end,other.end].min
+      excl = ( self.end == min_end && 
+               self.respond_to?(:exclude_end?) && self.exclude_end?
+             ) ||
+             ( other.end == min_end && 
+               other.respond_to?(:exclude_end?) && other.exclude_end?
+             )
+      unless max_begin > min_end
+        Range.new(max_begin, min_end, excl).extend(DateTimeRange)
+      end
+    end
+    
+    # true iff there is a range intersection of self and other
+    def intersects?(other)
+      !!intersection_with(other)
+    end
+    
+    # ---
+    
     # convenience wrapper for SubRangeIterator.new(self) { ... }
     def build_subrange(&builder)
       SubRangeIterator.new(self, &builder)
     end
     
+    private
+    
+    def range_within_other?(r1,r2)      
+      if  r2.respond_to?(:exclude_end?) && r2.exclude_end? &&
+         !(r1.respond_to?(:exclude_end?) && r1.exclude_end?)
+        r1.begin >= r2.begin && r1.end < r2.end
+      else
+        r1.begin >= r2.begin && r1.end <= r2.end
+      end
+    end
+    
     # ---
     
     # Iterators are defined by

data/lib/tempr/version.rb

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

data/test/range_intersection.rb

@@ -0,0 +1,125 @@
+require File.expand_path('test_helper', File.dirname(__FILE__))
+
+module RangeIntersectionTests
+
+  Fixtures = [ 
+    {
+      :case     => "inclusive 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),
+      :expected => Date.civil(2012,2,13)..Date.civil(2012,2,17)
+    },
+    {
+      :case     => "inclusive 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),
+      :expected => Date.civil(2012,2,13)..Date.civil(2012,2,16)
+    },
+    {
+      :case     => "inclusive ranges, self within other",
+      :subject  => (Date.civil(2012,2,13)..
+                    Date.civil(2012,2,17)).extend(Tempr::DateTimeRange),
+      :other    => Date.civil(2012,2,13)..Date.civil(2012,2,18),
+      :expected => Date.civil(2012,2,13)..Date.civil(2012,2,17)
+    },    
+    {
+      :case     => "inclusive ranges, self intersects but not within other",
+      :subject  => (Date.civil(2012,2,13)..
+                    Date.civil(2012,2,17)).extend(Tempr::DateTimeRange),
+      :other    => Date.civil(2012,2,14)..Date.civil(2012,2,18),
+      :expected => Date.civil(2012,2,14)..Date.civil(2012,2,17)
+    },  
+    {
+      :case     => "inclusive ranges, self does not intersect 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,19),
+      :expected => nil
+    },
+    {
+      :case     => "exclusive ranges, same endpoint, both exclusive",
+      :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),
+      :expected => Date.civil(2012,2,13)...Date.civil(2012,2,17),
+      :exclusive => true
+    },
+    {
+      :case     => "exclusive ranges, same endpoint, other is non-exclusive, self is exclusive",
+      :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),
+      :expected => Date.civil(2012,2,13)...Date.civil(2012,2,17),
+      :exclusive => true
+    },
+    {
+      :case     => "exclusive ranges, same endpoint, other is exclusive, self is non-exclusive",
+      :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),
+      :expected => Date.civil(2012,2,13)...Date.civil(2012,2,17),
+      :exclusive => true
+    },     
+    {
+      :case     => "exclusive ranges, different endpoint, both exclusive",
+      :subject  => (Date.civil(2012,2,13)...
+                    Date.civil(2012,2,17)).extend(Tempr::DateTimeRange),
+      :other    => Date.civil(2012,2,14)...Date.civil(2012,2,18),
+      :expected => Date.civil(2012,2,14)...Date.civil(2012,2,17),
+      :exclusive => true
+    },
+    {
+      :case     => "exclusive ranges, different endpoint, other is non-exclusive, self is exclusive",
+      :subject  => (Date.civil(2012,2,13)...
+                    Date.civil(2012,2,17)).extend(Tempr::DateTimeRange),
+      :other    => Date.civil(2012,2,12)..Date.civil(2012,2,16),
+      :expected => Date.civil(2012,2,13)..Date.civil(2012,2,16),
+      :exclusive => true
+    },
+    {
+      :case     => "exclusive ranges, different endpoint, other is exclusive, self is non-exclusive",
+      :subject  => (Date.civil(2012,2,13)..
+                    Date.civil(2012,2,17)).extend(Tempr::DateTimeRange),
+      :other    => Date.civil(2012,2,11)...Date.civil(2012,2,15),
+      :expected => Date.civil(2012,2,13)...Date.civil(2012,2,15),
+      :exclusive => 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) { fixture[:expected] }
+        
+        it 'should return expected range' do
+          actual = subject.intersection_with(other)
+          if expected.nil?
+            assert_nil actual
+          else
+            assert_equal expected.begin, actual.begin
+            assert_equal expected.end,   actual.end
+          end
+        end
+       
+        if fixture[:exclusive]
+          it 'should return expected exclusivity' do
+            actual = subject.intersection_with(other)
+            assert_equal expected.exclude_end?, actual.exclude_end?
+          end
+        end
+        
+      end
+    
+    end
+    
+  end
+
+end

data/test/range_within_other.rb

@@ -0,0 +1,141 @@
+require File.expand_path('test_helper', File.dirname(__FILE__))
+
+module RangeWithinOtherTests
+
+  describe "DateTimeRange#within, non-exclusive date ranges" do
+    
+    describe "other equals self" do
+      let(:subject) {  (Date.civil(2012,2,13)..
+                        Date.civil(2012,2,17)).extend(Tempr::DateTimeRange)
+                    }
+      let(:other)   {   Date.civil(2012,2,13)..Date.civil(2012,2,17) }
+      
+      it "within should return true" do
+        assert_equal true, subject.within?(other)
+      end
+   
+      it "subsume should return true" do
+        assert_equal true, subject.subsume?(other)
+      end
+      
+    end
+    
+    describe "other within self" do
+      let(:subject) {  (Date.civil(2012,2,13)..
+                        Date.civil(2012,2,17)).extend(Tempr::DateTimeRange)
+                    }
+      let(:other)   {   Date.civil(2012,2,13)..Date.civil(2012,2,16) }
+      
+      it "within should return false" do
+        assert_equal false, subject.within?(other)
+      end
+      
+      it "subsume should return true" do
+        assert_equal true, subject.subsume?(other)
+      end
+      
+    end
+    
+    describe "self within other" do
+      let(:subject) {  (Date.civil(2012,2,13)..
+                        Date.civil(2012,2,17)).extend(Tempr::DateTimeRange)
+                    }
+      let(:other)   {   Date.civil(2012,2,13)..Date.civil(2012,2,18) }
+      
+      it "within should return true" do
+        assert_equal true, subject.within?(other)
+      end
+    
+      it "subsume should return false" do
+        assert_equal false, subject.subsume?(other)
+      end
+      
+    end
+    
+    describe "self intersects but not within other" do
+      let(:subject) {  (Date.civil(2012,2,13)..
+                        Date.civil(2012,2,17)).extend(Tempr::DateTimeRange)
+                    }
+      let(:other)   {   Date.civil(2012,2,14)..Date.civil(2012,2,18) }
+      
+      it "within should return false" do
+        assert_equal false, subject.within?(other)
+      end
+    
+      it "subsume should return false" do
+        assert_equal false, subject.subsume?(other)
+      end
+      
+    end
+    
+    describe "self does not intersect other" do
+      let(:subject) {  (Date.civil(2012,2,13)..
+                        Date.civil(2012,2,17)).extend(Tempr::DateTimeRange)
+                    }
+      let(:other)   {   Date.civil(2012,2,18)..Date.civil(2012,2,19) }
+      
+      it "within should return false" do
+        assert_equal false, subject.within?(other)
+      end
+    
+      it "subsume should return false" do
+        assert_equal false, subject.subsume?(other)
+      end
+      
+    end
+    
+  end
+  
+  describe "DateTimeRange#within, exclusive date ranges" do
+
+    describe "same endpoint, both exclusive" do
+      let(:subject) {  (Date.civil(2012,2,13)...
+                        Date.civil(2012,2,17)).extend(Tempr::DateTimeRange)
+                    }
+      let(:other)   {   Date.civil(2012,2,13)...Date.civil(2012,2,17) }
+      
+      it "within should return true" do
+        assert_equal true, subject.within?(other)
+      end
+   
+      it "subsume should return true" do
+        assert_equal true, subject.subsume?(other)
+      end
+      
+    end
+    
+    describe "same endpoint, other is non-exclusive, self is exclusive" do
+      let(:subject) {  (Date.civil(2012,2,13)...
+                        Date.civil(2012,2,17)).extend(Tempr::DateTimeRange)
+                    }
+      let(:other)   {   Date.civil(2012,2,13)..Date.civil(2012,2,17) }
+      
+      it "within should return true" do
+        assert_equal true, subject.within?(other)
+      end
+      
+      it "subsume should return false" do
+        assert_equal false, subject.subsume?(other)
+      end
+      
+    end
+    
+    describe "same endpoint, other is exclusive, self is non-exclusive" do
+      let(:subject) {  (Date.civil(2012,2,13)..
+                        Date.civil(2012,2,17)).extend(Tempr::DateTimeRange)
+                    }
+      let(:other)   {   Date.civil(2012,2,13)...Date.civil(2012,2,17) }
+      
+      it "within should return false" do
+        assert_equal false, subject.within?(other)
+      end
+    
+      it "subsume should return true" do
+        assert_equal true, subject.subsume?(other)
+      end
+      
+    end
+      
+  end
+  
+end

data/test/suite.rb

@@ -1,3 +1,7 @@
-%w[ time_subrange each_time_of_day ].each do |test|
-  require File.expand_path(test,File.dirname(__FILE__))
-end
+%w[ time_subrange 
+    each_time_of_day 
+    range_within_other
+    range_intersection
+  ].each do |test|
+      require File.expand_path(test,File.dirname(__FILE__))
+    end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tempr
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &10703460 !ruby/object:Gem::Requirement
+  requirement: &9985020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10703460
+  version_requirements: *9985020
 description: ''
 email:
 - ericgj72@gmail.com
@@ -37,6 +37,8 @@ files:
 - lib/tempr/date_time_range.rb
 - lib/tempr/version.rb
 - test/each_time_of_day.rb
+- test/range_intersection.rb
+- test/range_within_other.rb
 - test/suite.rb
 - test/test_helper.rb
 - test/time_subrange.rb