ice_cube 0.11.0 → 0.11.1

data/lib/ice_cube/validations/daily_interval.rb

@@ -10,8 +10,6 @@ module IceCube
       self
     end
 
-    # A validation for checking to make sure that a time
-    # is inside of a certain DailyInterval
     class Validation
 
       attr_reader :interval
@@ -20,6 +18,18 @@ module IceCube
         @interval = interval
       end
 
+      def type
+        :day
+      end
+
+      def validate(step_time, schedule)
+        t0, t1 = schedule.start_time, step_time
+        days = Date.new(t1.year, t1.month, t1.day) -
+               Date.new(t0.year, t0.month, t0.day)
+        offset = (days % interval).nonzero?
+        interval - offset if offset
+      end
+
       def build_s(builder)
         builder.base = interval == 1 ? 'Daily' : "Every #{interval} days"
       end
@@ -30,22 +40,7 @@ module IceCube
 
       def build_ical(builder)
         builder['FREQ'] << 'DAILY'
-        unless interval == 1
-          builder['INTERVAL'] << interval
-        end
-      end
-
-      def type
-        :day
-      end
-
-      def validate(time, schedule)
-        time_date = Date.new(time.year, time.month, time.day)
-        start_date = Date.new(schedule.start_time.year, schedule.start_time.month, schedule.start_time.day)
-        days = time_date - start_date
-        unless days % interval === 0
-          interval - (days % interval)
-        end
+        builder['INTERVAL'] << interval unless interval == 1
       end
 
     end

data/lib/ice_cube/validations/day.rb

@@ -27,6 +27,10 @@ module IceCube
         @day = day
       end
 
+      def type
+        :wday
+      end
+
       def build_s(builder)
         builder.piece(:day) << day
       end
@@ -43,10 +47,6 @@ module IceCube
         end
       end
 
-      def type
-        :wday
-      end
-
       StringBuilder.register_formatter(:day) do |validation_days|
         # sort the days
         validation_days.sort!

data/lib/ice_cube/validations/day_of_month.rb

@@ -2,8 +2,6 @@ module IceCube
 
   module Validations::DayOfMonth
 
-    include Validations::Lock
-
     def day_of_month(*days)
       days.flatten.each do |day|
         unless day.is_a?(Fixnum)
@@ -19,12 +17,6 @@ module IceCube
 
       include Validations::Lock
 
-      StringBuilder.register_formatter(:day_of_month) do |entries|
-        str = "on the #{StringBuilder.sentence(entries)} "
-        str << (entries.size == 1 ? 'day of the month' : 'days of the month')
-        str
-      end
-
       attr_reader :day
       alias :value :day
 
@@ -32,6 +24,10 @@ module IceCube
         @day = day
       end
 
+      def type
+        :day
+      end
+
       def build_s(builder)
         builder.piece(:day_of_month) << StringBuilder.nice_number(day)
       end
@@ -44,8 +40,10 @@ module IceCube
         builder['BYMONTHDAY'] << day
       end
 
-      def type
-        :day
+      StringBuilder.register_formatter(:day_of_month) do |entries|
+        str = "on the #{StringBuilder.sentence(entries)} "
+        str << (entries.size == 1 ? 'day of the month' : 'days of the month')
+        str
       end
 
     end

data/lib/ice_cube/validations/day_of_week.rb

@@ -17,23 +17,31 @@ module IceCube
 
       attr_reader :day, :occ
 
-      StringBuilder.register_formatter(:day_of_week) do |segments|
-        'on the ' + segments.join(' and ')
+      def initialize(day, occ)
+        @day = day
+        @occ = occ
       end
 
       def type
         :day
       end
 
-      def build_s(builder)
-        builder.piece(:day_of_week) << "#{StringBuilder.nice_number(occ)} #{Date::DAYNAMES[day]}"
+      def validate(step_time, schedule)
+        wday = step_time.wday
+        offset = (day < wday) ? (7 - wday + day) : (day - wday)
+        wrapper = TimeUtil::TimeWrapper.new(step_time)
+        wrapper.add :day, offset
+        loop do
+          which_occ, num_occ = TimeUtil.which_occurrence_in_month(wrapper.to_time, day)
+          this_occ = (occ < 0) ? (num_occ + occ + 1) : (occ)
+          break offset if which_occ == this_occ
+          wrapper.add :day, 7
+          offset += 7
+        end
       end
 
-      def build_ical(builder)
-        ical_day = IcalBuilder.fixnum_to_ical_day(day)
-        # Delete any with this day and no occ first
-        builder['BYDAY'].delete_if { |d| d == ical_day }
-        builder['BYDAY'] << "#{occ}#{ical_day}"
+      def build_s(builder)
+        builder.piece(:day_of_week) << "#{StringBuilder.nice_number(occ)} #{Date::DAYNAMES[day]}"
       end
 
       def build_hash(builder)
@@ -42,25 +50,15 @@ module IceCube
         arr << occ
       end
 
-      def initialize(day, occ)
-        @day = day
-        @occ = occ
+      def build_ical(builder)
+        ical_day = IcalBuilder.fixnum_to_ical_day(day)
+        # Delete any with this day and no occ first
+        builder['BYDAY'].delete_if { |d| d == ical_day }
+        builder['BYDAY'] << "#{occ}#{ical_day}"
       end
 
-      def validate(time, schedule)
-        # count the days to the weekday
-        sum = day >= time.wday ? day - time.wday : 7 - time.wday + day
-        wrapper = TimeUtil::TimeWrapper.new(time)
-        wrapper.add :day, sum
-        # and then count the week until a viable occ
-        loop do
-          which_occ, num_occ = TimeUtil.which_occurrence_in_month(wrapper.to_time, day)
-          this_occ = occ < 0 ? num_occ + occ + 1 : occ
-          break if which_occ == this_occ
-          sum += 7
-          wrapper.add :day, 7 # one week
-        end
-        sum
+      StringBuilder.register_formatter(:day_of_week) do |segments|
+        'on the ' + segments.join(' and ')
       end
 
     end

data/lib/ice_cube/validations/day_of_year.rb

@@ -17,12 +17,6 @@ module IceCube
 
       attr_reader :day
 
-      StringBuilder.register_formatter(:day_of_year) do |entries|
-        str = "on the #{StringBuilder.sentence(entries)} "
-        str << (entries.size == 1 ? 'day of the year' : 'days of the year')
-        str
-      end
-
       def initialize(day)
         @day = day
       end
@@ -31,6 +25,13 @@ module IceCube
         :day
       end
 
+      def validate(step_time, schedule)
+        days_in_year = TimeUtil.days_in_year(step_time)
+        yday = day < 0 ? day + days_in_year : day
+        offset = yday - step_time.yday
+        offset >= 0 ? offset : offset + days_in_year
+      end
+
       def build_s(builder)
         builder.piece(:day_of_year) << StringBuilder.nice_number(day)
       end
@@ -43,12 +44,10 @@ module IceCube
         builder['BYYEARDAY'] << day
       end
 
-      def validate(time, schedule)
-        days_in_year = TimeUtil.days_in_year(time)
-        the_day = day < 0 ? day + days_in_year : day
-        # compute the diff
-        diff = the_day - time.yday
-        diff >= 0 ? diff : diff + days_in_year
+      StringBuilder.register_formatter(:day_of_year) do |entries|
+        str = "on the #{StringBuilder.sentence(entries)} "
+        str << (entries.size == 1 ? 'day of the year' : 'days of the year')
+        str
       end
 
     end

data/lib/ice_cube/validations/hour_of_day.rb

@@ -2,8 +2,6 @@ module IceCube
 
   module Validations::HourOfDay
 
-    include Validations::Lock
-
     # Add hour of day validations
     def hour_of_day(*hours)
       hours.flatten.each do |hour|
@@ -20,11 +18,6 @@ module IceCube
 
       include Validations::Lock
 
-      StringBuilder.register_formatter(:hour_of_day) do |segments|
-        str = "on the #{StringBuilder.sentence(segments)} "
-        str << (segments.size == 1 ? 'hour of the day' : 'hours of the day')
-      end
-
       attr_reader :hour
       alias :value :hour
 
@@ -32,14 +25,14 @@ module IceCube
         @hour = hour
       end
 
-      def build_s(builder)
-        builder.piece(:hour_of_day) << StringBuilder.nice_number(hour)
-      end
-
       def type
         :hour
       end
 
+      def build_s(builder)
+        builder.piece(:hour_of_day) << StringBuilder.nice_number(hour)
+      end
+
       def build_hash(builder)
         builder.validations_array(:hour_of_day) << hour
       end
@@ -48,6 +41,11 @@ module IceCube
         builder['BYHOUR'] << hour
       end
 
+      StringBuilder.register_formatter(:hour_of_day) do |segments|
+        str = "on the #{StringBuilder.sentence(segments)} "
+        str << (segments.size == 1 ? 'hour of the day' : 'hours of the day')
+      end
+
     end
 
   end

data/lib/ice_cube/validations/hourly_interval.rb

@@ -13,10 +13,27 @@ module IceCube
 
       attr_reader :interval
 
+      def initialize(interval)
+        @interval = interval
+      end
+
       def type
         :hour
       end
 
+      def dst_adjust?
+        false
+      end
+
+      def validate(step_time, schedule)
+        t0, t1 = schedule.start_time.to_i, step_time.to_i
+        sec = (t1 - t1 % ONE_HOUR) -
+              (t0 - t0 % ONE_HOUR)
+        hours = sec / ONE_HOUR
+        offset = (hours % interval).nonzero?
+        interval - offset if offset
+      end
+
       def build_s(builder)
         builder.base = interval == 1 ? 'Hourly' : "Every #{interval} hours"
       end
@@ -27,27 +44,7 @@ module IceCube
 
       def build_ical(builder)
         builder['FREQ'] << 'HOURLY'
-        unless interval == 1
-          builder['INTERVAL'] << interval
-        end
-      end
-
-      def initialize(interval)
-        @interval = interval
-      end
-
-      def dst_adjust?
-        false
-      end
-
-      def validate(time, schedule)
-        start_time = schedule.start_time
-        sec = (time.to_i - time.to_i % ONE_HOUR) -
-          (start_time.to_i - start_time.to_i % ONE_HOUR)
-        hours = sec / ONE_HOUR
-        unless hours % interval == 0
-          interval - (hours % interval)
-        end
+        builder['INTERVAL'] << interval unless interval == 1
       end
 
     end

data/lib/ice_cube/validations/lock.rb

@@ -1,34 +1,49 @@
 module IceCube
 
-  # A validation mixin that will lock the +type field to
-  # +value or +schedule.start_time.send(type) if value is nil
-
+  # This validation mixin is used by the various "fixed-time" (e.g. day,
+  # day_of_month, hour_of_day) Validation and ScheduleLock::Validation modules.
+  # It is not a standalone rule validation like the others.
+  #
+  # Given the including Validation's defined +type+ field, it will lock
+  # to the specified +value+ or else the corresponding time unit from the
+  # schedule's start_time
+  #
   module Validations::Lock
 
-    INTERVALS = {:min => 60, :sec => 60, :month => 12, :wday => 7}
+    INTERVALS = {:min => 60, :sec => 60, :hour => 24, :month => 12, :wday => 7}
 
     def validate(time, schedule)
-      return send(:"validate_#{type}_lock", time, schedule) unless INTERVALS[type]
-      start = value || schedule.start_time.send(type)
-      start = INTERVALS[type] + start if start < 0 # handle negative values
-      start >= time.send(type) ? start - time.send(type) : INTERVALS[type] - time.send(type) + start
+      case type
+      when :day  then validate_day_lock(time, schedule)
+      when :hour then validate_hour_lock(time, schedule)
+      else validate_interval_lock(time, schedule)
+      end
     end
 
     private
 
+    # Validate if the current time unit matches the same unit from the schedule
+    # start time, returning the difference to the interval
+    #
+    def validate_interval_lock(time, schedule)
+      t0 = starting_unit(schedule.start_time)
+      t1 = time.send(type)
+      t0 >= t1 ? t0 - t1 : INTERVALS[type] - t1 + t0
+    end
+
     # Lock the hour if explicitly set by hour_of_day, but allow for the nearest
     # hour during DST start to keep the correct interval.
     #
     def validate_hour_lock(time, schedule)
-      hour = value || schedule.start_time.send(type)
-      hour = 24 + hour if hour < 0
-      if hour >= time.hour
-        hour - time.hour
+      h0 = starting_unit(schedule.start_time)
+      h1 = time.hour
+      if h0 >= h1
+        h0 - h1
       else
         if dst_offset = TimeUtil.dst_change(time)
-          hour - time.hour + dst_offset
+          h0 - h1 + dst_offset
         else
-          24 - time.hour + hour
+          24 - h1 + h0
         end
       end
     end
@@ -69,6 +84,12 @@ module IceCube
       sleeps >= 0 ? sleeps : until_next_month
     end
 
+    def starting_unit(start_time)
+      start = value || start_time.send(type)
+      start += INTERVALS[type] while start < 0
+      start
+    end
+
   end
 
 end

data/lib/ice_cube/validations/minute_of_hour.rb

@@ -2,8 +2,6 @@ module IceCube
 
   module Validations::MinuteOfHour
 
-    include Validations::Lock
-
     def minute_of_hour(*minutes)
       minutes.flatten.each do |minute|
         unless minute.is_a?(Fixnum)
@@ -19,11 +17,6 @@ module IceCube
 
       include Validations::Lock
 
-      StringBuilder.register_formatter(:minute_of_hour) do |segments|
-        str = "on the #{StringBuilder.sentence(segments)} "
-        str << (segments.size == 1 ? 'minute of the hour' : 'minutes of the hour')
-      end
-
       attr_reader :minute
       alias :value :minute
 
@@ -31,14 +24,14 @@ module IceCube
         @minute = minute
       end
 
-      def build_s(builder)
-        builder.piece(:minute_of_hour) << StringBuilder.nice_number(minute)
-      end
-
       def type
         :min
       end
 
+      def build_s(builder)
+        builder.piece(:minute_of_hour) << StringBuilder.nice_number(minute)
+      end
+
       def build_hash(builder)
         builder.validations_array(:minute_of_hour) << minute
       end
@@ -47,6 +40,11 @@ module IceCube
         builder['BYMINUTE'] << minute
       end
 
+      StringBuilder.register_formatter(:minute_of_hour) do |segments|
+        str = "on the #{StringBuilder.sentence(segments)} "
+        str << (segments.size == 1 ? 'minute of the hour' : 'minutes of the hour')
+      end
+
     end
 
   end