hiccup 0.4.0 → 0.4.1

data/lib/hiccup/enumerable.rb

@@ -11,17 +11,13 @@ module Hiccup
     
     
     def enumerator
-      @enumerator ||= "Hiccup::Enumerable::#{kind.to_s.classify}Enumerator".constantize
-    end
-    
-    def kind=(value)
-      super
-      @enumerator = nil
+      "Hiccup::Enumerable::#{kind.to_s.classify}Enumerator".constantize
     end
     
     
     
     def occurrences_during_month(year, month)
+      puts "DEPRECATED: `occurrences_during_month` will be removed in 0.5.0. Use `occurrences_between` instead"
       date1 = Date.new(year, month, 1)
       date2 = Date.new(year, month, -1)
       occurrences_between(date1, date2)
@@ -30,8 +26,6 @@ module Hiccup
     
     
     def occurrences_between(earlier_date, later_date)
-      earlier_date = start_date if earlier_date < start_date
-      
       occurrences = []
       enum = enumerator.new(self, earlier_date)
       while (occurrence = enum.next) && (occurrence <= later_date)
@@ -43,42 +37,41 @@ module Hiccup
     
     
     def first_occurrence_on_or_after(date)
-      date = start_date if (date < start_date)
+      return nil if ends? && date > end_date
       enumerator.new(self, date).next
     end
     
-    def next_occurrence_after(date)
-      first_occurrence_on_or_after(date + 1)
+    def first_occurrence_after(date)
+      first_occurrence_on_or_after(date.to_date + 1)
     end
+    alias :next_occurrence_after :first_occurrence_after
     
     
     
     def first_occurrence_on_or_before(date)
-      date = end_date if (ends? && date > end_date)
+      return nil if date < start_date
       enumerator.new(self, date).prev
     end
     
     def first_occurrence_before(date)
-      first_occurrence_on_or_before(date - 1)
+      first_occurrence_on_or_before(date.to_date - 1)
     end
     
     
     
     def occurs_on(date)
       date = date.to_date
-      first_occurrence_on_or_after(date).eql?(date)
+      date == first_occurrence_on_or_after(date)
     end
     alias :contains? :occurs_on
     
     
     
     def n_occurrences_before(limit, date)
-      n_occurrences_on_or_before(limit, date - 1)
+      n_occurrences_on_or_before(limit, date.to_date - 1)
     end
     
     def n_occurrences_on_or_before(limit, date)
-      date = end_date if (ends? && date > end_date)
-      
       occurrences = []
       enum = enumerator.new(self, date)
       while (occurrence = enum.prev) && occurrences.length < limit

data/lib/hiccup/enumerable/schedule_enumerator.rb

@@ -7,6 +7,8 @@ module Hiccup
         @schedule = schedule
         @date = date
         @date = @date.to_date if @date.respond_to?(:to_date)
+        @date = start_date if (@date < start_date)
+        @date = end_date if (ends? && @date > end_date)
         @current_date = nil
       end
       

data/lib/hiccup/enumerable/weekly_enumerator.rb

@@ -23,7 +23,7 @@ module Hiccup
       end
       
       
-      def first_occurrence_on_or_after(date)        
+      def first_occurrence_on_or_after(date)
         result = nil
         wday = date.wday
         weekly_pattern.each do |weekday|

data/lib/hiccup/humanizable.rb

@@ -10,7 +10,7 @@ module Hiccup
     
     def humanize
       case kind
-      when :never;      ""
+      when :never;      start_date.to_s
       when :weekly;     weekly_humanize
       when :monthly;    monthly_humanize
       when :annually;   yearly_humanize

data/lib/hiccup/inferable.rb

@@ -12,48 +12,89 @@ module Hiccup
     module ClassMethods
       
       def infer(dates, options={})
-        dates = extract_array_of_dates!(dates)
+        allow_null_schedules = options.fetch(:allow_null_schedules, false)
+        verbosity = options.fetch(:verbosity, (options[:verbose] ? 1 : 0)) # 0, 1, or 2
         
+        dates = extract_array_of_dates!(dates)
         enumerator = DatesEnumerator.new(dates)
-        guesser = Guesser.new(self, options)
+        guesser = Guesser.new(self, {verbose: verbosity >= 2})
+        schedules = []
+        
         confidences = []
-        confidence_threshold = 0.6
-        rewind_by = 0
+        high_confidence_threshold = 0.6
+        min_confidence_threshold  = 0.35
+        
+        last_confident_schedule = nil
+        iterations_since_last_confident_schedule = 0
         
         until enumerator.done?
           date = enumerator.next
           guesser << date
-          confidences << guesser.confidence.to_f
+          confidence = guesser.confidence.to_f
+          confidences << confidence
+          predicted = guesser.predicted?(date)
+          
+          # if the last two confidences are both below a certain
+          # threshhold and both declining, back up to where we
+          # started to go wrong and start a new schedule.
+          
+          confident = !(confidences.length >= 3 && (
+                        (confidences[-1] < high_confidence_threshold &&
+                         confidences[-2] < high_confidence_threshold &&
+                         confidences[-1] < confidences[-2] &&
+                         confidences[-2] < confidences[-3]) ||
+                        (confidences[-1] < min_confidence_threshold &&
+                         confidences[-2] < min_confidence_threshold)))
           
-          if guesser.predicted?(date)
-            rewind_by = 0
+          if predicted && confidence >= min_confidence_threshold
+            iterations_since_last_confident_schedule = 0
+            last_confident_schedule = guesser.schedule
           else
-            rewind_by += 1
+            iterations_since_last_confident_schedule += 1
           end
           
-          # puts "date: #{date}, confidences: #{confidences}, rewind_by: #{rewind_by}" if options[:verbose]
+          rewind_by = iterations_since_last_confident_schedule == guesser.count ? iterations_since_last_confident_schedule - 1 : iterations_since_last_confident_schedule
           
-          # if the last two confidences are both below a certain
-          # threshhold and both declining, back up to where we
-          # started to go wrong and start a new schedule.
           
-          if confidences.length >= 3 &&
-             confidences[-1] < confidence_threshold &&
-             confidences[-2] < confidence_threshold &&
-             confidences[-1] < confidences[-2] &&
-             confidences[-2] < confidences[-3]
+          
+          if verbosity >= 1
+            output = "  #{enumerator.index.to_s.rjust(3)} #{date}"
+            output << " #{"[#{guesser.count}]".rjust(5)}  =>  "
+            output << "~#{(guesser.confidence.to_f * 100).to_i.to_s.rjust(2, "0")} @ "
+            output << guesser.schedule.humanize.ljust(130)
+            output << "  :( move back #{rewind_by}" unless confident
+            puts output
+          end
+          
+          
+          
+          unless confident
+            
+            if last_confident_schedule
+              schedules << last_confident_schedule
+            elsif allow_null_schedules
+              guesser.dates.take(guesser.count - rewind_by).each do |date|
+                schedules << self.new(:kind => :never, :start_date => date)
+              end
+            end
             
-            rewind_by -= 1 if rewind_by == guesser.count
             enumerator.rewind_by(rewind_by)
             guesser.restart!
             confidences = []
-            rewind_by = 0
+            iterations_since_last_confident_schedule = 0
+            last_confident_schedule = nil
           end
         end
         
-        guesser.stop!
+        if last_confident_schedule
+          schedules << last_confident_schedule
+        elsif allow_null_schedules
+          guesser.dates.each do |date|
+            schedules << self.new(:kind => :never, :start_date => date)
+          end
+        end
         
-        guesser.guesses
+        schedules
       end
       
       
@@ -83,37 +124,25 @@ module Hiccup
       def initialize(klass, options={})
         @klass = klass
         @verbose = options.fetch(:verbose, false)
-        @guesses = []
         start!
       end
       
-      attr_reader :guesses, :confidence
+      attr_reader :confidence, :schedule, :dates
       
       def start!
-        save_current_guess!
-        reset_growing_understanding!
-      end
-      alias :restart! :start!
-      
-      def stop!
-        start!
-      end
-      
-      def save_current_guess!
-        @guesses << @schedule if @schedule
-      end
-      
-      def reset_growing_understanding!
         @dates = []
         @schedule = nil
         @confidence = 0
       end
+      alias :restart! :start!
+      
       
       
       
       def <<(date)
         @dates << date
         @schedule, @confidence = best_schedule_for(@dates)
+        date
       end
       
       def count
@@ -149,7 +178,7 @@ module Hiccup
         highest_popularity = patterns_by_popularity.keys.max # => 5
         most_popular = patterns_by_popularity[highest_popularity].first # => a
         start_date = Date.new(@start_date.year, *most_popular)
-
+        
         [].tap do |guesses|
           (1...5).each do |skip|
             guesses << @klass.new.tap do |schedule|
@@ -267,7 +296,7 @@ module Hiccup
           puts ""
         end
         
-        scored_guesses.reject { |(guess, score)| score.to_f < 0.333 }.first
+        scored_guesses.first
       end
       
       def score_guess(guess, input_dates)
@@ -349,6 +378,8 @@ module Hiccup
         @index = -1
       end
       
+      attr_reader :index
+      
       def done?
         @index == @last_index
       end

data/lib/hiccup/version.rb

@@ -1,3 +1,3 @@
 module Hiccup
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/test/enumerable_test.rb

@@ -189,6 +189,43 @@ class EnumerableTest < ActiveSupport::TestCase
   
   
   
+  test "should not predict dates before the beginning of a schedule" do
+    schedule = Schedule.new({
+      :kind => :weekly,
+      :weekly_pattern => %w{Monday},
+      :start_date => Date.new(2011, 1, 3),
+      :ends => true,
+      :end_date => Date.new(2011, 1, 31)})
+    assert_equal nil, schedule.first_occurrence_before(Date.new(2011,1,3))
+    assert_equal nil, schedule.first_occurrence_on_or_before(Date.new(2011,1,2))
+  end
+  
+  test "should not predict dates after the end of a schedule" do
+    schedule = Schedule.new({
+      :kind => :weekly,
+      :weekly_pattern => %w{Monday},
+      :start_date => Date.new(2011, 1, 3),
+      :ends => true,
+      :end_date => Date.new(2011, 1, 31)})
+    assert_equal nil, schedule.first_occurrence_after(Date.new(2011,1,31))
+    assert_equal nil, schedule.first_occurrence_on_or_after(Date.new(2011,2, 1))
+  end
+  
+  
+  
+  test "all methods should take any kind of date as an argument" do
+    schedule = Schedule.new({
+      :kind => :weekly,
+      :weekly_pattern => %w{Monday},
+      :start_date => Date.new(2011, 1, 1),
+      :ends => true,
+      :end_date => Date.new(2011, 1, 31)})
+    assert_equal Date.new(2011, 1, 17), schedule.first_occurrence_after(Time.new(2011, 1, 10))
+    assert_equal Date.new(2011, 1, 3), schedule.first_occurrence_before(Time.new(2011, 1, 10))
+  end
+  
+  
+  
   def test_weekly_recurrence_and_skip
     schedule = Schedule.new({
       :kind => :weekly,

data/test/inferrable_test.rb

@@ -230,13 +230,20 @@ class InferableTest < ActiveSupport::TestCase
     end
   end
   
+  test "should create one non-recurring schedule for each break if asked" do
+    dates = %w{2012-03-05 2012-11-28 2012-12-05 2012-12-12} # a random Monday, then three Wednesdays
+    schedules = Schedule.infer(dates, allow_null_schedules: true)
+    
+    assert_equal ["2012-03-05", "Every Wednesday"], schedules.map(&:humanize)
+  end
+  
   
   
   test "should infer multiple schedules from mixed input" do
     dates = %w{2012-11-05 2012-11-12 2012-11-19 2012-11-28 2012-12-05 2012-12-12} # three Mondays then three Wednesdays
     schedules = Schedule.infer(dates)
-    assert_equal ["Every Monday", "Every Wednesday"],
-      schedules.map(&:humanize)
+    
+    assert_equal ["Every Monday", "Every Wednesday"], schedules.map(&:humanize)
   end
   
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hiccup
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-12 00:00:00.000000000 Z
+date: 2012-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -179,7 +179,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1083227062532008741
+      hash: -1495672392285233886
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -188,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1083227062532008741
+      hash: -1495672392285233886
 requirements: []
 rubyforge_project: hiccup
 rubygems_version: 1.8.24