ice_cube 0.16.4 → 0.17.0

data/lib/ice_cube/time_util.rb

@@ -1,31 +1,30 @@
-require 'date'
-require 'time'
+require "date"
+require "time"
 
 module IceCube
   module TimeUtil
-
     extend Deprecated
 
     DAYS = {
-      :sunday => 0, :monday => 1, :tuesday => 2, :wednesday => 3,
-      :thursday => 4, :friday => 5, :saturday => 6
+      sunday: 0, monday: 1, tuesday: 2, wednesday: 3,
+      thursday: 4, friday: 5, saturday: 6
     }
 
     ICAL_DAYS = {
-      'SU' => :sunday, 'MO' => :monday, 'TU' => :tuesday, 'WE' => :wednesday,
-      'TH' => :thursday, 'FR' => :friday, 'SA' => :saturday
+      "SU" => :sunday, "MO" => :monday, "TU" => :tuesday, "WE" => :wednesday,
+      "TH" => :thursday, "FR" => :friday, "SA" => :saturday
     }
 
     MONTHS = {
-      :january => 1, :february => 2, :march => 3, :april => 4, :may => 5,
-      :june => 6, :july => 7, :august => 8, :september => 9, :october => 10,
-      :november => 11, :december => 12
+      january: 1, february: 2, march: 3, april: 4, may: 5,
+      june: 6, july: 7, august: 8, september: 9, october: 10,
+      november: 11, december: 12
     }
 
     CLOCK_VALUES = [:year, :month, :day, :hour, :min, :sec]
 
     # Provides a Time.now without the usec, in the reference zone or utc offset
-    def self.now(reference=Time.now)
+    def self.now(reference = Time.now)
       match_zone(Time.at(Time.now.to_i), reference)
     end
 
@@ -42,18 +41,16 @@ module IceCube
     end
 
     def self.match_zone(input_time, reference)
-      return unless time = ensure_time(input_time, reference)
+      return unless (time = ensure_time(input_time, reference))
       time = if reference.respond_to? :time_zone
-               time.in_time_zone(reference.time_zone)
-             else
-               if reference.utc?
-                 time.getgm
-               elsif reference.zone
-                 time.getlocal
-               else
-                 time.getlocal(reference.utc_offset)
-               end
-             end
+        time.in_time_zone(reference.time_zone)
+      elsif reference.utc?
+        time.getgm
+      elsif reference.zone
+        time.getlocal
+      else
+        time.getlocal(reference.utc_offset)
+      end
       (Date === input_time) ? beginning_of_date(time, reference) : time
     end
 
@@ -61,17 +58,15 @@ module IceCube
     def self.ensure_time(time, reference = nil, date_eod = false)
       case time
       when DateTime
-        warn "IceCube: DateTime support is deprecated (please use Time) at: #{ caller[2] }"
+        warn "IceCube: DateTime support is deprecated (please use Time) at: #{caller(3..3).first}"
         Time.local(time.year, time.month, time.day, time.hour, time.min, time.sec)
       when Date
         if date_eod
           end_of_date(time, reference)
+        elsif reference
+          build_in_zone([time.year, time.month, time.day], reference)
         else
-          if reference
-            build_in_zone([time.year, time.month, time.day], reference)
-          else
-            time.to_time
-          end
+          time.to_time
         end
       else
         time
@@ -83,7 +78,7 @@ module IceCube
       case date
       when Date then date
       else
-        return Date.new(date.year, date.month, date.day)
+        Date.new(date.year, date.month, date.day)
       end
     end
 
@@ -92,7 +87,7 @@ module IceCube
       case time
       when Time, Date
         if time.respond_to?(:time_zone)
-          {:time => time.utc, :zone => time.time_zone.name}
+          {time: time.utc, zone: time.time_zone.name}
         else
           time
         end
@@ -133,18 +128,18 @@ module IceCube
     # will lose the zone and not support DST.
     def self.restore_deserialized_offset(time, orig_offset_str)
       return time if time.respond_to?(:time_zone) ||
-                     time.getlocal(orig_offset_str).utc_offset == time.utc_offset
-      warn "IceCube: parsed Time from nonlocal TZ. Use ActiveSupport to fix DST at: #{ caller[0] }"
+        time.getlocal(orig_offset_str).utc_offset == time.utc_offset
+      warn "IceCube: parsed Time from nonlocal TZ. Use ActiveSupport to fix DST at: #{caller(1..1).first}"
       time.localtime(orig_offset_str)
     end
 
     # Get the beginning of a date
-    def self.beginning_of_date(date, reference=Time.now)
+    def self.beginning_of_date(date, reference = Time.now)
       build_in_zone([date.year, date.month, date.day, 0, 0, 0], reference)
     end
 
     # Get the end of a date
-    def self.end_of_date(date, reference=Time.now)
+    def self.end_of_date(date, reference = Time.now)
       build_in_zone([date.year, date.month, date.day, 23, 59, 59], reference)
     end
 
@@ -152,8 +147,8 @@ module IceCube
     def self.sym_to_month(sym)
       MONTHS.fetch(sym) do |k|
         MONTHS.values.detect { |i| i.to_s == k.to_s } or
-        raise ArgumentError, "Expecting Integer or Symbol value for month. " \
-                             "No such month: #{k.inspect}"
+          raise ArgumentError, "Expecting Integer or Symbol value for month. " \
+                               "No such month: #{k.inspect}"
       end
     end
     deprecated_alias :symbol_to_month, :sym_to_month
@@ -162,15 +157,15 @@ module IceCube
     def self.sym_to_wday(sym)
       DAYS.fetch(sym) do |k|
         DAYS.values.detect { |i| i.to_s == k.to_s } or
-        raise ArgumentError, "Expecting Integer or Symbol value for weekday. " \
-                             "No such weekday: #{k.inspect}"
+          raise ArgumentError, "Expecting Integer or Symbol value for weekday. " \
+                               "No such weekday: #{k.inspect}"
       end
     end
     deprecated_alias :symbol_to_day, :sym_to_wday
 
     # Convert wday number to day symbol
     def self.wday_to_sym(wday)
-      return wday if DAYS.keys.include? wday
+      return wday if DAYS.key? wday
       DAYS.invert.fetch(wday) do |i|
         raise ArgumentError, "Expecting Integer value for weekday. " \
                              "No such wday number: #{i.inspect}"
@@ -270,14 +265,13 @@ module IceCube
 
     # A utility class for safely moving time around
     class TimeWrapper
-
       def initialize(time, dst_adjust = true)
         @dst_adjust = dst_adjust
         @base = time
-        if dst_adjust
-          @time = Time.utc(time.year, time.month, time.day, time.hour, time.min, time.sec + TimeUtil.subsec(time))
+        @time = if dst_adjust
+          Time.utc(time.year, time.month, time.day, time.hour, time.min, time.sec + TimeUtil.subsec(time))
         else
-          @time = time
+          time
         end
       end
 
@@ -292,13 +286,13 @@ module IceCube
       def add(type, val)
         type = :day if type == :wday
         @time += case type
-                 when :year then TimeUtil.days_in_n_years(@time, val) * ONE_DAY
-                 when :month then TimeUtil.days_in_n_months(@time, val) * ONE_DAY
-                 when :day  then val * ONE_DAY
-                 when :hour then val * ONE_HOUR
-                 when :min  then val * ONE_MINUTE
-                 when :sec  then val
-                 end
+        when :year then TimeUtil.days_in_n_years(@time, val) * ONE_DAY
+        when :month then TimeUtil.days_in_n_months(@time, val) * ONE_DAY
+        when :day then val * ONE_DAY
+        when :hour then val * ONE_HOUR
+        when :min then val * ONE_MINUTE
+        when :sec then val
+        end
       end
 
       # Clear everything below a certain type
@@ -320,24 +314,24 @@ module IceCube
       end
 
       def sec=(value)
-        @time += (value) - (@time.sec)
+        @time += value - @time.sec
       end
 
       def clear_sec
-        @time.sec > 0 ? @time -= @time.sec : @time
+        (@time.sec > 0) ? @time -= @time.sec : @time
       end
 
       def clear_min
-        @time.min > 0 ? @time -= (@time.min * ONE_MINUTE) : @time
+        (@time.min > 0) ? @time -= (@time.min * ONE_MINUTE) : @time
       end
 
       def clear_hour
-        @time.hour > 0 ? @time -= (@time.hour * ONE_HOUR) : @time
+        (@time.hour > 0) ? @time -= (@time.hour * ONE_HOUR) : @time
       end
 
       # Move to the first of the month, 0 hours
       def clear_day
-        @time.day > 1 ? @time -= (@time.day - 1) * ONE_DAY : @time
+        (@time.day > 1) ? @time -= (@time.day - 1) * ONE_DAY : @time
       end
 
       # Clear to january 1st
@@ -348,8 +342,6 @@ module IceCube
         end
         @time += ONE_DAY
       end
-
     end
-
   end
 end

data/lib/ice_cube/validated_rule.rb

@@ -1,9 +1,7 @@
-require 'ice_cube/input_alignment'
+require "ice_cube/input_alignment"
 
 module IceCube
-
   class ValidatedRule < Rule
-
     include Validations::ScheduleLock
 
     include Validations::Count
@@ -26,7 +24,7 @@ module IceCube
     attr_reader :validations
 
     def initialize(interval = 1)
-      @validations = Hash.new
+      @validations = {}
     end
 
     # Reset the uses on the rule to 0
@@ -48,10 +46,8 @@ module IceCube
     # to the given start time
     def next_time(time, start_time, closing_time)
       @time = time
-      unless @start_time
-        @start_time = realign(time, start_time)
-        @time = @start_time if @time < @start_time
-      end
+      @start_time ||= realign(time, start_time)
+      @time = @start_time if @time < @start_time
 
       return nil unless find_acceptable_time_before(closing_time)
 
@@ -183,7 +179,5 @@ module IceCube
         yield error
       end
     end
-
   end
-
 end

data/lib/ice_cube/validations/count.rb

@@ -1,7 +1,5 @@
 module IceCube
-
   module Validations::Count
-
     # Value reader for limit
     def occurrence_count
       (arr = @validations[:count]) && (val = arr[0]) && val.count
@@ -16,7 +14,6 @@ module IceCube
     end
 
     class Validation
-
       attr_reader :rule, :count
 
       def initialize(count, rule)
@@ -45,16 +42,13 @@ module IceCube
       end
 
       def build_ical(builder)
-        builder['COUNT'] << count
+        builder["COUNT"] << count
       end
 
       StringBuilder.register_formatter(:count) do |segments|
         count = segments.first
-        IceCube::I18n.t('ice_cube.times', count: count)
+        IceCube::I18n.t("ice_cube.times", count: count)
       end
-
     end
-
   end
-
 end

data/lib/ice_cube/validations/daily_interval.rb

@@ -1,12 +1,10 @@
 module IceCube
-
   module Validations::DailyInterval
-
     # Add a new interval validation
     def interval(interval)
       interval = normalized_interval(interval)
       verify_alignment(interval, :wday, :interval) { |error| raise error }
-      verify_alignment(interval, :day, :interval)  { |error| raise error }
+      verify_alignment(interval, :day, :interval) { |error| raise error }
 
       @interval = interval
       replace_validations_for(:interval, [Validation.new(@interval)])
@@ -15,7 +13,6 @@ module IceCube
     end
 
     class Validation
-
       attr_reader :interval
 
       def initialize(interval)
@@ -33,13 +30,13 @@ module IceCube
       def validate(step_time, start_time)
         t0, t1 = start_time, step_time
         days = Date.new(t1.year, t1.month, t1.day) -
-               Date.new(t0.year, t0.month, t0.day)
+          Date.new(t0.year, t0.month, t0.day)
         offset = (days % interval).nonzero?
         interval - offset if offset
       end
 
       def build_s(builder)
-        builder.base = IceCube::I18n.t('ice_cube.each_day', count: interval)
+        builder.base = IceCube::I18n.t("ice_cube.each_day", count: interval)
       end
 
       def build_hash(builder)
@@ -47,12 +44,9 @@ module IceCube
       end
 
       def build_ical(builder)
-        builder['FREQ'] << 'DAILY'
-        builder['INTERVAL'] << interval unless interval == 1
+        builder["FREQ"] << "DAILY"
+        builder["INTERVAL"] << interval unless interval == 1
       end
-
     end
-
   end
-
 end

data/lib/ice_cube/validations/day.rb

@@ -1,7 +1,5 @@
 module IceCube
-
   module Validations::Day
-
     def day(*days)
       days = days.flatten
       return self if days.empty?
@@ -19,9 +17,8 @@ module IceCube
     end
 
     class Validation < Validations::FixedValue
-
       attr_reader :day
-      alias :value :day
+      alias_method :value, :day
 
       def initialize(day)
         @day = day
@@ -50,8 +47,8 @@ module IceCube
       def build_ical(builder)
         ical_day = IcalBuilder.fixnum_to_ical_day(day)
         # Only add if there aren't others from day_of_week that override
-        if builder['BYDAY'].none? { |b| b.end_with?(ical_day) }
-          builder['BYDAY'] << ical_day
+        if builder["BYDAY"].none? { |b| b.end_with?(ical_day) }
+          builder["BYDAY"] << ical_day
         end
       end
 
@@ -60,18 +57,15 @@ module IceCube
         validation_days.sort!
         # pick the right shortening, if applicable
         if validation_days == [0, 6]
-          IceCube::I18n.t('ice_cube.on_weekends')
+          IceCube::I18n.t("ice_cube.on_weekends")
         elsif validation_days == (1..5).to_a
-          IceCube::I18n.t('ice_cube.on_weekdays')
+          IceCube::I18n.t("ice_cube.on_weekdays")
         else
-          day_names = ->(d){ "#{IceCube::I18n.t("ice_cube.days_on")[d]}" }
+          day_names = ->(d) { (IceCube::I18n.t("ice_cube.days_on")[d]).to_s }
           segments = validation_days.map(&day_names)
-          IceCube::I18n.t('ice_cube.on_days', days: StringBuilder.sentence(segments))
+          IceCube::I18n.t("ice_cube.on_days", days: StringBuilder.sentence(segments))
         end
       end
-
     end
-
   end
-
 end

data/lib/ice_cube/validations/day_of_month.rb

@@ -1,7 +1,5 @@
 module IceCube
-
   module Validations::DayOfMonth
-
     def day_of_month(*days)
       days.flatten.each do |day|
         unless day.is_a?(Integer)
@@ -15,9 +13,8 @@ module IceCube
     end
 
     class Validation < Validations::FixedValue
-
       attr_reader :day
-      alias :value :day
+      alias_method :value, :day
 
       def initialize(day)
         @day = day
@@ -44,17 +41,14 @@ module IceCube
       end
 
       def build_ical(builder)
-        builder['BYMONTHDAY'] << day
+        builder["BYMONTHDAY"] << day
       end
 
       StringBuilder.register_formatter(:day_of_month) do |entries|
         sentence = StringBuilder.sentence(entries)
-        str = IceCube::I18n.t('ice_cube.days_of_month', count: entries.size, segments: sentence)
-        IceCube::I18n.t('ice_cube.on', sentence: str)
+        str = IceCube::I18n.t("ice_cube.days_of_month", count: entries.size, segments: sentence)
+        IceCube::I18n.t("ice_cube.on", sentence: str)
       end
-
     end
-
   end
-
 end

data/lib/ice_cube/validations/day_of_week.rb

@@ -1,7 +1,5 @@
 module IceCube
-
   module Validations::DayOfWeek
-
     def day_of_week(dows)
       dows.each do |day, occs|
         occs.each do |occ|
@@ -14,10 +12,12 @@ module IceCube
     end
 
     class Validation
-
       attr_reader :day, :occ
 
       def initialize(day, occ)
+        raise ArgumentError, "Integer occurrence value required" unless occ.is_a?(Integer)
+        raise ArgumentError, "Invalid day_of_week occurrence: #{occ.inspect}" if occ.zero? || occ.abs > 5
+
         @day = day
         @occ = occ
       end
@@ -37,7 +37,7 @@ module IceCube
         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)
+          this_occ = (occ < 0) ? (num_occ + occ + 1) : occ
           break offset if which_occ == this_occ
           wrapper.add :day, 7
           offset += 7
@@ -46,9 +46,9 @@ module IceCube
 
       def build_s(builder)
         builder.piece(:day_of_week) << IceCube::I18n.t(
-          'ice_cube.days_of_week',
+          "ice_cube.days_of_week",
           segments: StringBuilder.nice_number(occ),
-          day: IceCube::I18n.t('date.day_names')[day]
+          day: IceCube::I18n.t("date.day_names")[day]
         )
       end
 
@@ -61,17 +61,14 @@ module IceCube
       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}"
+        builder["BYDAY"].delete_if { |d| d == ical_day }
+        builder["BYDAY"] << "#{occ}#{ical_day}"
       end
 
       StringBuilder.register_formatter(:day_of_week) do |segments|
-        sentence = segments.join(IceCube::I18n.t('ice_cube.array.two_words_connector'))
-        IceCube::I18n.t('ice_cube.on', sentence: sentence)
+        sentence = segments.join(IceCube::I18n.t("ice_cube.array.two_words_connector"))
+        IceCube::I18n.t("ice_cube.on", sentence: sentence)
       end
-
     end
-
   end
-
 end

data/lib/ice_cube/validations/day_of_year.rb

@@ -1,7 +1,5 @@
 module IceCube
-
   module Validations::DayOfYear
-
     def day_of_year(*days)
       days.flatten.each do |day|
         unless day.is_a?(Integer)
@@ -14,7 +12,6 @@ module IceCube
     end
 
     class Validation
-
       attr_reader :day
 
       def initialize(day)
@@ -31,9 +28,9 @@ module IceCube
 
       def validate(step_time, start_time)
         days_in_year = TimeUtil.days_in_year(step_time)
-        yday = day < 0 ? day + days_in_year + 1 : day
+        yday = (day < 0) ? day + days_in_year + 1 : day
         offset = yday - step_time.yday
-        offset >= 0 ? offset : offset + days_in_year
+        (offset >= 0) ? offset : offset + days_in_year
       end
 
       def build_s(builder)
@@ -45,17 +42,14 @@ module IceCube
       end
 
       def build_ical(builder)
-        builder['BYYEARDAY'] << day
+        builder["BYYEARDAY"] << day
       end
 
       StringBuilder.register_formatter(:day_of_year) do |entries|
-        str =  StringBuilder.sentence(entries)
-        sentence = IceCube::I18n.t('ice_cube.days_of_year', count: entries.size, segments: str)
-        IceCube::I18n.t('ice_cube.on', sentence: sentence)
+        str = StringBuilder.sentence(entries)
+        sentence = IceCube::I18n.t("ice_cube.days_of_year", count: entries.size, segments: str)
+        IceCube::I18n.t("ice_cube.on", sentence: sentence)
       end
-
     end
-
   end
-
 end

data/lib/ice_cube/validations/fixed_value.rb

@@ -1,5 +1,4 @@
 module IceCube
-
   # This abstract validation class 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 module like the others.
@@ -9,12 +8,11 @@ module IceCube
   # start_time
   #
   class Validations::FixedValue
-
-    INTERVALS = {:min => 60, :sec => 60, :hour => 24, :month => 12, :wday => 7}
+    INTERVALS = {min: 60, sec: 60, hour: 24, month: 12, wday: 7}
 
     def validate(time, start_time)
       case type
-      when :day  then validate_day_lock(time, start_time)
+      when :day then validate_day_lock(time, start_time)
       when :hour then validate_hour_lock(time, start_time)
       else validate_interval_lock(time, start_time)
       end
@@ -28,7 +26,7 @@ module IceCube
     def validate_interval_lock(time, start_time)
       t0 = starting_unit(start_time)
       t1 = time.send(type)
-      t0 >= t1 ? t0 - t1 : INTERVALS[type] - t1 + t0
+      (t0 >= t1) ? t0 - t1 : INTERVALS[type] - t1 + t0
     end
 
     # Lock the hour if explicitly set by hour_of_day, but allow for the nearest
@@ -39,12 +37,10 @@ module IceCube
       h1 = time.hour
       if h0 >= h1
         h0 - h1
+      elsif (dst_offset = TimeUtil.dst_change(time))
+        h0 - h1 + dst_offset
       else
-        if dst_offset = TimeUtil.dst_change(time)
-          h0 - h1 + dst_offset
-        else
-          24 - h1 + h0
-        end
+        24 - h1 + h0
       end
     end
 
@@ -77,19 +73,17 @@ module IceCube
       if value && value > 0
         until_next_month = days_in_month + sleeps
       else
-        until_next_month = start < 28 ? days_in_month : TimeUtil.days_to_next_month(date)
+        until_next_month = (start < 28) ? days_in_month : TimeUtil.days_to_next_month(date)
         until_next_month += sleeps - month_overflow
       end
 
-      sleeps >= 0 ? sleeps : until_next_month
+      (sleeps >= 0) ? sleeps : until_next_month
     end
 
     def starting_unit(start_time)
       start = value || start_time.send(type)
-      start = start % INTERVALS[type] if start < 0
+      start %= INTERVALS[type] if start < 0
       start
     end
-
   end
-
 end