tempr 0.1.0 → 0.1.1

data/CHANGELOG.markdown

@@ -0,0 +1,14 @@
+# Changelog
+
+## 0.1.1 / 2012-02-18
+
+- add `SubRangeIterator#cover?` shortcut
+- add `between_times`
+- `on_day` renamed `each_day_of_month`; deprecation warning
+- `at_time` renamed `each_time_of_day`; deprecation warning
+- add utc_offset param to `each_time_of_day`, `time_range`
+- fix error where time subranges forced to local time
+
+## 0.1.0 / 2012-02-16
+
+- Initial gem release

data/README.markdown

@@ -2,4 +2,15 @@
 ## a Ruby temporal expressions library
 
 
-This is a work in progress. See date_time_range.rb for usage examples.
+This is a work in progress. See date_time_range.rb for usage examples.
+
+
+### License:
+
+Copyright (c) 2012 Eric Gjertsen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/tempr/date_time_range.rb

@@ -103,9 +103,9 @@ module Tempr
       build_subrange do |s|
         s.step    = n
         s.adjust_range { |r| time_range(r) }
-        s.offset       { |tm|   tm.to_time + offset }
-        s.increment    { |tm,i| tm.to_time + i }
-        s.span         { |tm| tm.to_time + dur }
+        s.offset       { |tm|   tm + offset }
+        s.increment    { |tm,i| tm + i }
+        s.span         { |tm| tm + dur }
       end
     end
     alias each_second each_seconds
@@ -353,7 +353,7 @@ module Tempr
     #
     # if no +dur+ parameter passed,
     #   "every +nday+th day of the month, grouped into one-day intervals"
-    def on_day(nday,dur=1)
+    def each_day_of_month(nday,dur=1)
       build_subrange do |s|
         s.step   = 1
         s.adjust_range   { |r| day_range(r) }
@@ -366,28 +366,61 @@ module Tempr
       end
     end
     
+    def on_day(nday,dur=1)
+      warn "Note #on_day is deprecated and will be removed in 0.2.0; use #each_day_of_month instead"
+      each_day_of_month(nday,dur)
+    end
+    
     # time-of-day iterator:
-    # "every day at +tm+, grouped into +dur+ second intervals"
+    # "every day at +tm+, grouped into +dur+ second intervals, in +utc_offset+"
     #
-    # +tm+ is any string that can be Time.parse'd. Note the date portion is ignored, if given.
+    # +tm+ is any string that can be Time.parse'd - relative to the local time and zone. 
+    # (Note the date portion is ignored, if given.)
     #
-    # if no +dur+ parameter passed, intervals are 'instantaneous' time ranges
-    def at_time(tm,dur=0)
+    # if no +dur+ passed, intervals are 'instantaneous' time ranges
+    # if no +utc_offset+ passed, process-local timezone is used.
+    def each_time_of_day(tm,dur=0,utc_offset=nil)
       tm_p = Time.parse(tm)
       build_subrange do |s|
         s.step    = 60*60*24
-        s.adjust_range    { |r| time_range(r) }        
-        s.offset          do |tm| 
+        s.adjust_range    { |r| time_range(r,utc_offset) }        
+        s.offset          do |t| 
                                Time.new( 
-                                 tm.year,   tm.month, tm.day,
-                                 tm_p.hour, tm_p.min, tm_p.sec, (tm + s.step).utc_offset
+                                 t.year,   t.month, t.day,
+                                 tm_p.hour, tm_p.min, tm_p.sec, 
+                                 (t + s.step).utc_offset
                                )
                           end
-        s.increment       { |tm,i| tm.to_time + i }
-        s.span            { |tm| tm.to_time + dur }
+        s.increment       { |t,i| t + i }
+        s.span            { |t|   t + dur }
       end
     end
-      
+    
+    def at_time(tm,dur=0,utc_offset=nil) 
+      warn "Note #at_time is deprecated and will be removed in 0.2.0; use #each_time_of_day instead"
+      each_time_of_day(tm,dur,utc_offset)
+    end
+    
+    # time-of-day iterator specifying time range:
+    # "every day between +tm0+ and +tm1+, in +utc_offset+"
+    #
+    # parameters are any string that can be Time.parse'd - relative to the local time and zone. 
+    # (Note the date portion is ignored, if given.)
+    #
+    # if +tm1+ < +tm0+, ranges are interpreted to go into the next day, e.g. 
+    #   `between_times "23:00", "01:00"`
+    def between_times(tm0,tm1,utc_offset=nil)
+      tm0_p = Time.parse(tm0)
+      tm1_p = Time.parse(tm1)
+      dur = if tm0_p <= tm1_p
+              tm1_p - tm0_p 
+            else
+              dur = 60*60*24 - (tm0_p - tm1_p)
+            end
+      each_time_of_day(tm0, dur, utc_offset)
+    end
+    
+    
     # ---
     
     # Helper methods - these are a bit hacky and possibly buggy.
@@ -415,17 +448,28 @@ module Tempr
     
     # unless already a time range,
     # convert to exclusive date range, and then to time range
+    #
+    # Times are local time unless +utc_offset+ is passed
+    #
     # For example,
     #
-    #   `2012-02-01..2012-02-29`   becomes
-    #   `2012-02-01 00:00:00 UTC...2012-03-01 00:00:00 UTC`
+    #   `time_range(2012-02-01..2012-02-29,'00:00')`   
+    #   #=> `2012-02-01 00:00:00 +00:00...2012-03-01 00:00:00 +00:00`
     #
-    def time_range(rng=self)
+    def time_range(rng=self,utc_offset=nil)
       if rng.begin.respond_to?(:sec) && rng.end.respond_to?(:sec)
-        rng.dup
+        utc_offset ||= rng.begin.utc_offset
+        Range.new( rng.begin.getlocal(utc_offset),
+                   rng.end.getlocal(utc_offset),
+                   rng.respond_to?(:exclude_end?) && rng.exclude_end?
+                 )
       else
         adj_rng = day_range(rng)
-        Range.new(adj_rng.begin.to_time, adj_rng.end.to_time, true)
+        b,e = adj_rng.begin, adj_rng.end
+        Range.new( Time.new(b.year,b.month,b.day,0,0,0,utc_offset), 
+                   Time.new(e.year,e.month,e.day,0,0,0,utc_offset), 
+                   true
+                 )
       end
     end
     
@@ -511,6 +555,10 @@ module Tempr
         self
       end
       
+      def cover?(dt)
+        any? {|r| r.cover?(dt)}
+      end
+      
       # Recursive madness...
       # note this could possibly use cached results stored by #all method,
       # similar to Sequel
@@ -593,8 +641,18 @@ if $0 == __FILE__
   require 'pp'
   
    range = (Date.civil(2012,1,1)...Date.civil(2013,1,1)).extend(Tempr::DateTimeRange)
-   subrange = range.each_month.thursday(2).at_time('2:00pm',60*60)
+   subrange = range.each_month.thursday(2).each_time_of_day('2:00pm',60*60)
 
+   puts "base range time_range"
+   pp range.time_range(range,"+00:00")
+   
    pp subrange.to_a
+   puts
+      
+   subrange2 = range.each_month.thursday(2).between_times('2:00pm','3:00pm')
+   
+   puts "between_times"
+   pp subrange2.to_a
+   puts
    
 end

data/lib/tempr/version.rb

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

data/test/each_time_of_day.rb

@@ -0,0 +1,94 @@
+require File.expand_path('test_helper', File.dirname(__FILE__))
+
+module EachTimeOfDayTests
+  module Fixtures
+
+    BaseRanges = {:year  => Date.civil(2012,01,01)...
+                            Date.civil(2013,01,01)
+                 }
+                
+  end
+
+  describe 'DateTimeRange#each_time_of_day' do
+
+    describe "specified time zone" do
+      let(:subject) { Fixtures::BaseRanges[:year].extend(Tempr::DateTimeRange) }
+      let(:offset_string)  { '+09:00' }
+      let(:offset) { 9*60*60 }
+      
+      it 'subranges should have the specified timezone offset' do
+        subject.each_day.each_time_of_day("11:20pm",60*60,offset_string).each do |range|
+          assert_equal offset, range.begin.utc_offset
+          assert_equal offset, range.end.utc_offset
+        end
+      end
+    end
+            
+    describe "across daylight savings time boundaries" do
+      let(:subject) { Fixtures::BaseRanges[:year].extend(Tempr::DateTimeRange) }
+      let(:time_string)      { "2:00pm" }
+      let(:begin_hour_min)   { [14,0] }
+      let(:end_hour_min)     { [15,0] }
+      
+      it 'should be at the same time of day regardless of time zone' do
+        subject.each_day.each_time_of_day(time_string,60*60).each do |range|
+          offset = range.begin.utc_offset
+          actual_begin = range.begin.getlocal(offset)
+          actual_end   = range.end.getlocal(offset)
+          #puts "#{range.inspect}"
+          assert_equal begin_hour_min, 
+                       [actual_begin.hour, actual_begin.min], 
+                       "for range: #{range}"
+          assert_equal end_hour_min, 
+                       [actual_end.hour, actual_end.min],   
+                       "for range: #{range}"
+        end
+      end
+      
+    end
+      
+  end
+  
+  describe 'DateTimeRange#between_times' do
+ 
+    let(:subject) { Fixtures::BaseRanges[:year].extend(Tempr::DateTimeRange) }
+    
+    def assert_range_matches( exp_begin, exp_end, range )
+      offset = range.begin.utc_offset
+      actual_begin = range.begin.getlocal(offset)
+      actual_end   = range.end.getlocal(offset)       
+      assert_equal exp_begin, 
+                   [actual_begin.hour, actual_begin.min], 
+                   "for range: #{range}"
+      assert_equal exp_end, 
+                   [actual_end.hour, actual_end.min],   
+                   "for range: #{range}"                          
+    end
+    
+    it 'should return correct ranges within a single day' do
+      begin_hour_min = [16,45]
+      end_hour_min   = [19,35]
+      begin_string   = "#{begin_hour_min[0]}:#{begin_hour_min[1]}"
+      end_string     = "#{end_hour_min[0]}:#{end_hour_min[1]}"
+      
+      subject.each_day.between_times(begin_string, end_string).each do |range|
+        assert_range_matches begin_hour_min, end_hour_min, range
+      end
+    end
+    
+    it 'should return correct ranges across days' do
+      begin_hour_min = [23,30]
+      end_hour_min   = [02,17]
+      begin_string   = "#{begin_hour_min[0]}:#{begin_hour_min[1]}"
+      end_string     = "#{end_hour_min[0]}:#{end_hour_min[1]}"
+      
+      subject.each_day.between_times(begin_string, end_string).each do |range|
+        assert_range_matches begin_hour_min, end_hour_min, range
+        assert_equal 1, (range.end.to_date - range.begin.to_date), 
+                     "for range: #{range}"
+      end
+    end
+    
+  end
+
+end  # namespace

data/test/suite.rb

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

data/test/time_subrange.rb

@@ -215,7 +215,7 @@ module TimeSubRangeTests
                      last_result
       end
 
-      it 'each_minutes must return ranges starting up to 23:00:00 of the end date' do
+      it 'each_hours must return ranges starting up to 23:00:00 of the end date' do
         last_result = subject.each_hours.to_a.last
         assert_equal ( (Fixtures::ExclusiveDateRange.end.to_time - 60*60)...
                        Fixtures::ExclusiveDateRange.end.to_time ), 
@@ -242,7 +242,7 @@ module TimeSubRangeTests
                      last_result
       end
 
-      it 'each_minutes must return ranges starting up to 23:00:00 of the end date + 1' do
+      it 'each_hours must return ranges starting up to 23:00:00 of the end date + 1' do
         last_result = subject.each_hours.to_a.last
         assert_equal ( ((Fixtures::NonExclusiveDateRange.end+1).to_time - 60*60)...
                        (Fixtures::NonExclusiveDateRange.end+1).to_time ), 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tempr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-16 00:00:00.000000000Z
+date: 2012-02-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &16129140 !ruby/object:Gem::Requirement
+  requirement: &10703460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16129140
+  version_requirements: *10703460
 description: ''
 email:
 - ericgj72@gmail.com
@@ -30,12 +30,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.markdown
 - Gemfile
 - README.markdown
 - lib/tempr.rb
 - lib/tempr/date_time_range.rb
 - lib/tempr/version.rb
-- test/at_time.rb
+- test/each_time_of_day.rb
 - test/suite.rb
 - test/test_helper.rb
 - test/time_subrange.rb

data/test/at_time.rb

@@ -1,36 +0,0 @@
-require File.expand_path('test_helper', File.dirname(__FILE__))
-
-module AtTimeTests
-  module Fixtures
-
-    BaseRanges = {:local => Time.parse('2012-01-01 00:00:00 -0500')...
-                            Time.parse('2013-01-01 00:00:00 -0500'),
-                  :utc   => Time.parse('2012-01-01 00:00:00 UTC')...
-                            Time.parse('2013-01-01 00:00:00 UTC')
-                 }
-                
-  end
-
-  describe 'DateTimeRange#at_time' do
-
-    [:local, :utc].each do |time_type|
-    
-      describe "across daylight savings time boundaries for #{time_type} times" do
-      
-        let(:subject) { Fixtures::BaseRanges[time_type].extend(Tempr::DateTimeRange) }
-        
-        it 'should be at the same time of day regardless of time zone' do
-          subject.each_day.at_time("2:00pm",60*60).each do |range|
-            offset = range.begin.utc_offset
-            actual = range.begin.getlocal(offset).hour
-            #puts "#{range}"
-            assert_equal 14, actual, "for range: #{range}"
-          end
-        end
-        
-      end
-      
-    end
-  end
-
-end  # namespace