ice_cube 0.10.1 → 0.11.0

data/lib/ice_cube/enumerator.rb

@@ -0,0 +1,65 @@
+module IceCube
+  class Enumerator < ::Enumerator
+
+    def initialize(schedule, from_time, to_time)
+      @schedule  = schedule
+      @from_time = TimeUtil.ensure_time(from_time)
+      @to_time   = TimeUtil.ensure_time(to_time)
+      align_start_time
+      @cursor = @from_time
+    end
+
+    def each
+      while res = self.find_next && @to_time.nil? || res <= @to_time
+        yield Occurrence.new(res, res + schedule.duration)
+      end
+      raise StopIteration
+    end
+
+    def find_next
+      loop do
+        min_time = recurrence_rules.reduce(nil) do |min_time, rule|
+          begin
+            new_time = rule.next_time(time, schedule, min_time || @to_time)
+            [min_time, new_time].compact.min
+          rescue CountExceeded, UntilExceeded
+            min_time
+          end
+        end
+        break nil unless min_time
+        @cursor = min_time + 1
+        next if exception_time?(min_time)
+        break min_time
+      end
+    end
+
+    private
+
+    def align_start_time
+      if @from_time <= schedule.start_time || full_required?
+        @from_time = schedule.start_time
+      else
+        @from_time += @schedule.start_time.subsec - @from_time.subsec rescue 0
+      end
+    end
+
+    # Return a boolean indicating if any rule needs to be run from the start of time
+    def full_required?
+      recurrence_rules.any?(&:full_required?) ||
+      exception_rules.any?(&:full_required?)
+    end
+
+    def exception_rules
+      schedule.instance_variable_get(:@all_exception_rules)
+    end
+
+    def recurrence_rules
+      @recurrence_rules ||= if recurrence_rules.empty?
+        [SingleOccurrenceRule.new(schedule.start_time)].concat schedule.instance_variable_get(:@all_recurrence_rules)
+      else
+        schedule.instance_variable_get(:@all_recurrence_rules)
+      end
+    end
+
+  end
+end

data/lib/ice_cube/occurrence.rb

@@ -28,7 +28,7 @@ module IceCube
 
     # Optimize for common methods to avoid method_missing
     extend Forwardable
-    def_delegators :start_time, :to_s, :to_i, :<=>, :==
+    def_delegators :start_time, :to_i, :<=>, :==
     def_delegators :to_range, :cover?, :include?, :each, :first, :last
 
     attr_reader :start_time, :end_time
@@ -79,12 +79,17 @@ module IceCube
       start_time
     end
 
-    def to_s
-      if duration > 0
-        "#{start_time} - #{end_time}"
+    # Shows both the start and end time if there is a duration.
+    # Optional format argument (e.g. :long, :short) supports Rails
+    # time formats and is only used when ActiveSupport is available.
+    #
+    def to_s(format=nil)
+      if format && to_time.public_method(:to_s).arity > 0
+        t0, t1 = start_time.to_s(format), end_time.to_s(format)
       else
-        "#{start_time}"
+        t0, t1 = start_time.to_s, end_time.to_s
       end
+      duration > 0 ? "#{t0} - #{t1}" : t0
     end
 
     def overnight?

data/lib/ice_cube/schedule.rb

@@ -172,6 +172,18 @@ module IceCube
       find_occurrences(from + 1, nil, 1).first
     end
 
+    # The previous occurrence from a given time
+    def previous_occurrence(from)
+      return nil if from <= start_time
+      find_occurrences(start_time, from - 1, nil, 1).last
+    end
+
+    # The previous n occurrences before a given time
+    def previous_occurrences(num, from)
+      return [] if from <= start_time
+      find_occurrences(start_time, from - 1, nil, num)
+    end
+
     # The remaining occurrences (same requirements as all_occurrences)
     def remaining_occurrences(from = nil)
       require_terminating_rules
@@ -268,6 +280,14 @@ module IceCube
       n.nil? ? occurrences.first : occurrences
     end
 
+    # Get the final n occurrences of a terminating schedule
+    # or the final one if no n is given
+    def last(n = nil)
+      require_terminating_rules
+      occurrences = find_occurrences(start_time, nil, nil, n || 1)
+      n.nil? ? occurrences.last : occurrences[-n..-1]
+    end
+
     # String serialization
     def to_s
       pieces = []
@@ -371,7 +391,7 @@ module IceCube
 
     # Find all of the occurrences for the schedule between opening_time
     # and closing_time
-    def find_occurrences(opening_time, closing_time = nil, limit = nil, &block)
+    def find_occurrences(opening_time, closing_time = nil, limit = nil, tail_limit = nil, &block)
       opening_time = TimeUtil.ensure_time opening_time
       closing_time = TimeUtil.ensure_time closing_time
       opening_time += start_time.subsec - opening_time.subsec rescue 0
@@ -388,6 +408,7 @@ module IceCube
         break if closing_time && res > closing_time
         if res >= opening_time
           block_given? ? block.call(res) : (answers << res)
+          answers.shift if tail_limit && answers.length > tail_limit
           break if limit && answers.length == limit
         end
         time = res + 1
@@ -433,7 +454,7 @@ module IceCube
       raise ArgumentError, "All recurrence rules must specify .until or .count to use #{method_name}"
     end
 
-    def implicit_start_occurrence
+    def implicit_start_occurrence_rule
       SingleOccurrenceRule.new(start_time)
     end
 
@@ -442,8 +463,8 @@ module IceCube
     end
 
     def recurrence_times_with_start_time
-      if (recurrence_rules).empty?
-        [start_time] + recurrence_times_without_start_time
+      if recurrence_rules.empty?
+        [start_time].concat recurrence_times_without_start_time
       else
         recurrence_times
       end
@@ -451,7 +472,7 @@ module IceCube
 
     def recurrence_rules_with_implicit_start_occurrence
       if recurrence_rules.empty?
-        [implicit_start_occurrence] + @all_recurrence_rules
+        [implicit_start_occurrence_rule].concat @all_recurrence_rules
       else
         @all_recurrence_rules
       end

data/lib/ice_cube/version.rb

@@ -1,5 +1,5 @@
 module IceCube
 
-  VERSION = '0.10.1'
+  VERSION = '0.11.0'
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ice_cube
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
+date: 2013-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -86,6 +86,7 @@ files:
 - lib/ice_cube/builders/ical_builder.rb
 - lib/ice_cube/builders/string_builder.rb
 - lib/ice_cube/deprecated.rb
+- lib/ice_cube/enumerator.rb
 - lib/ice_cube/errors/count_exceeded.rb
 - lib/ice_cube/errors/until_exceeded.rb
 - lib/ice_cube/flexible_hash.rb
@@ -140,7 +141,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2800901123420442900
+      hash: 3343770401458335569
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -149,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2800901123420442900
+      hash: 3343770401458335569
 requirements: []
 rubyforge_project: ice-cube
 rubygems_version: 1.8.25