ice_cube 0.11.0 → 0.11.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0cf51eea4a5e3f9a8c15eedc224978494d2a79df
+  data.tar.gz: 8daed67d6ab9f6e610ea40c08e7e032a96552e47
+SHA512:
+  metadata.gz: 7acfe2a1546d074b0b43a9250ce4e937f339f084fd3abf9a04b840cc529849140d224b4d2bdd134254ecf1088c19e6845fce195b9440eea2fddbb31baa25ca2b
+  data.tar.gz: d722e7ef0d0ee4fb2bfaaf5e28b330df6898ad49f183f2cb0ab43e6115bcf91be64cd07755df568318dd83deffe94439b83ec8ba0c60f2b06711d39a3c174534

data/lib/ice_cube.rb

@@ -1,13 +1,6 @@
 require 'date'
 require 'ice_cube/deprecated'
 
-# Use psych if we can
-begin
-  require 'psych'
-rescue LoadError
-  require 'yaml'
-end
-
 module IceCube
 
   autoload :VERSION, 'ice_cube/version'
@@ -71,10 +64,6 @@ module IceCube
   ONE_DAY =    ONE_HOUR   * 24
   ONE_WEEK =   ONE_DAY    * 7
 
-  def self.use_psych?
-    @use_psych ||= defined?(Psych) && defined?(Psych::VERSION)
-  end
-
   # Defines the format used by IceCube when printing out Schedule#to_s.
   # Defaults to '%B %e, %Y'
   def self.to_s_time_format

data/lib/ice_cube/builders/string_builder.rb

@@ -13,32 +13,26 @@ module IceCube
     end
 
     def to_s
-      str = @base || ''
-      res = @types.map do |type, segments|
+      @types.each_with_object(@base || '') do |(type, segments), str|
         if f = self.class.formatter(type)
-          str << ' ' + f.call(segments)
+          str << ' ' << f.call(segments)
         else
           next if segments.empty?
-          str << ' ' + self.class.sentence(segments)
+          str << ' ' << self.class.sentence(segments)
         end
       end
-      str
     end
 
-    class << self
-
-      def formatter(type)
-        @formatters[type]
-      end
-
-      def register_formatter(type, &formatter)
-        @formatters ||= {}
-        @formatters[type] = formatter
-      end
+    def self.formatter(type)
+      @formatters[type]
+    end
 
+    def self.register_formatter(type, &formatter)
+      @formatters ||= {}
+      @formatters[type] = formatter
     end
 
-    class << self
+    module Helpers
 
       NUMBER_SUFFIX = ['th', 'st', 'nd', 'rd', 'th', 'th', 'th', 'th', 'th', 'th']
       SPECIAL_SUFFIX = { 11 => 'th', 12 => 'th', 13 => 'th', 14 => 'th' }
@@ -54,21 +48,19 @@ module IceCube
       end
 
       def nice_number(number)
-        if number == -1
-          'last'
-        elsif number < -1
-          suffix = SPECIAL_SUFFIX.include?(number) ?
-            SPECIAL_SUFFIX[number] : NUMBER_SUFFIX[number.abs % 10]
+        return 'last' if number == -1
+        suffix = SPECIAL_SUFFIX[number] || NUMBER_SUFFIX[number.abs % 10]
+        if number < -1
           number.abs.to_s << suffix << ' to last'
         else
-          suffix = SPECIAL_SUFFIX.include?(number) ?
-            SPECIAL_SUFFIX[number] : NUMBER_SUFFIX[number.abs % 10]
           number.to_s << suffix
         end
       end
 
     end
 
+    extend Helpers
+
   end
 
 end

data/lib/ice_cube/deprecated.rb

@@ -1,28 +1,30 @@
-module Deprecated
+module IceCube
+	module Deprecated
 
-  # Define a deprecated alias for a method
-  # @param [Symbol] name - name of method to define
-  # @param [Symbol] replacement - name of method to replace (alias)
-  def deprecated_alias(name, replacement)
-    # Create a wrapped version
-    define_method(name) do |*args, &block|
-      warn "IceCube: ##{name} deprecated (please use ##{replacement})"
-      send replacement, *args, &block
-    end
-  end
+		# Define a deprecated alias for a method
+		# @param [Symbol] name - name of method to define
+		# @param [Symbol] replacement - name of method to replace (alias)
+		def deprecated_alias(name, replacement)
+			# Create a wrapped version
+			define_method(name) do |*args, &block|
+				warn "IceCube: ##{name} deprecated (please use ##{replacement})"
+				send replacement, *args, &block
+			end
+		end
 
-  # Deprecate a defined method
-  # @param [Symbol] name - name of deprecated method
-  # @param [Symbol] replacement - name of the desired replacement
-  def deprecated(name, replacement)
-    # Replace old method
-    old_name = :"#{name}_without_deprecation"
-    alias_method old_name, name
-    # And replace it with a wrapped version
-    define_method(name) do |*args, &block|
-      warn "IceCube: ##{name} deprecated (please use ##{replacement})"
-      send old_name, *args, &block
-    end
-  end
+		# Deprecate a defined method
+		# @param [Symbol] name - name of deprecated method
+		# @param [Symbol] replacement - name of the desired replacement
+		def deprecated(name, replacement)
+			# Replace old method
+			old_name = :"#{name}_without_deprecation"
+			alias_method old_name, name
+			# And replace it with a wrapped version
+			define_method(name) do |*args, &block|
+				warn "IceCube: ##{name} deprecated (please use ##{replacement})"
+				send old_name, *args, &block
+			end
+		end
 
+	end
 end

data/lib/ice_cube/enumerator.rb

@@ -19,11 +19,9 @@ module IceCube
     def find_next
       loop do
         min_time = recurrence_rules.reduce(nil) do |min_time, rule|
-          begin
+          catch :limit do
             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

data/lib/ice_cube/hash_input.rb

@@ -0,0 +1,71 @@
+module IceCube
+  class HashInput
+
+    class Mash
+      def initialize(hash)
+        @hash = hash
+      end
+
+      # Fetch values indifferently by symbol or string key without symbolizing
+      # arbitrary string input
+      #
+      def [](key)
+        @hash.fetch(key) do |key|
+          str_key = key.to_s
+          @hash.each_pair.detect do |sym_key, value|
+            return value if sym_key.to_s == str_key
+          end
+        end
+      end
+    end
+
+    def initialize(hash)
+      @input = Mash.new(hash)
+    end
+
+    def [](key)
+      @input[key]
+    end
+
+    def to_rule
+      return nil unless rule_class
+      rule = rule_class.new(interval, week_start)
+      rule.until(limit_time) if limit_time
+      rule.count(limit_count) if limit_count
+      validations.each do |validation, args|
+        rule.send(validation, *args)
+      end
+    end
+
+    def rule_class
+      return @rule_class if @rule_class
+      match = @input[:rule_type].match(/::(\w+Rule)$/)
+      @rule_class = IceCube.const_get(match[1]) if match
+    end
+
+    def interval
+      @input[:interval] || 1
+    end
+
+    def week_start
+      @input[:week_start] || :sunday
+    end
+
+    def limit_time
+      @limit_time ||= TimeUtil.deserialize_time(@input[:until])
+    end
+
+    def limit_count
+      @input[:count]
+    end
+
+    def validations
+      input_validations = Mash.new(@input[:validations] || {})
+      ValidatedRule::VALIDATION_ORDER.each_with_object({}) do |key, output_validations|
+        args = input_validations[key]
+        output_validations[key] = Array(args) if args
+      end
+    end
+
+  end
+end

data/lib/ice_cube/rule.rb

@@ -23,24 +23,22 @@ module IceCube
       h.nil? ? super : h.hash
     end
 
-    # Expected to be overridden by subclasses
     def to_ical
-      nil
+      raise MethodNotImplemented, "Expected to be overrridden by subclasses"
     end
 
     # Yaml implementation
     def to_yaml(*args)
-      IceCube::use_psych? ? Psych::dump(to_hash) : YAML::dump(to_hash, *args)
+      YAML::dump(to_hash, *args)
     end
 
     # From yaml
     def self.from_yaml(yaml)
-      from_hash IceCube::use_psych? ? Psych::load(yaml) : YAML::load(yaml)
+      from_hash YAML::load(yaml)
     end
 
-    # Expected to be overridden by subclasses
     def to_hash
-      nil
+      raise MethodNotImplemented, "Expected to be overridden by subclasses"
     end
 
     # Convert from a hash and create a rule

data/lib/ice_cube/rules/daily_rule.rb

@@ -4,7 +4,7 @@ module IceCube
 
     include Validations::DailyInterval
 
-    def initialize(interval = 1)
+    def initialize(interval = 1, week_start = :sunday)
       super
       interval(interval)
       schedule_lock(:hour, :min, :sec)

data/lib/ice_cube/rules/hourly_rule.rb

@@ -4,7 +4,7 @@ module IceCube
 
     include Validations::HourlyInterval
 
-    def initialize(interval = 1)
+    def initialize(interval = 1, week_start = :sunday)
       super
       interval(interval)
       schedule_lock(:min, :sec)

data/lib/ice_cube/rules/minutely_rule.rb

@@ -4,7 +4,7 @@ module IceCube
 
     include Validations::MinutelyInterval
 
-    def initialize(interval = 1)
+    def initialize(interval = 1, week_start = :sunday)
       super
       interval(interval)
       schedule_lock(:sec)

data/lib/ice_cube/rules/monthly_rule.rb

@@ -4,7 +4,7 @@ module IceCube
 
     include Validations::MonthlyInterval
 
-    def initialize(interval = 1)
+    def initialize(interval = 1, week_start = :sunday)
       super
       interval(interval)
       schedule_lock(:day, :hour, :min, :sec)

data/lib/ice_cube/rules/secondly_rule.rb

@@ -4,7 +4,7 @@ module IceCube
 
     include Validations::SecondlyInterval
 
-    def initialize(interval = 1)
+    def initialize(interval = 1, week_start = :sunday)
       super
       interval(interval)
       reset

data/lib/ice_cube/rules/yearly_rule.rb

@@ -4,7 +4,7 @@ module IceCube
 
     include Validations::YearlyInterval
 
-    def initialize(interval = 1)
+    def initialize(interval = 1, week_start = :sunday)
       super
       interval(interval)
       schedule_lock(:month, :day, :hour, :min, :sec)

data/lib/ice_cube/schedule.rb

@@ -4,7 +4,7 @@ module IceCube
 
   class Schedule
 
-    extend ::Deprecated
+    extend Deprecated
 
     # Get the start time
     attr_reader :start_time
@@ -237,7 +237,7 @@ module IceCube
     def conflicts_with?(other_schedule, closing_time = nil)
       closing_time = TimeUtil.ensure_time closing_time
       unless terminating? || other_schedule.terminating? || closing_time
-        raise ArgumentError.new 'At least one schedule must be terminating to use #conflicts_with?'
+        raise ArgumentError, "One or both schedules must be terminating to use #conflicts_with?"
       end
       # Pick the terminating schedule, and other schedule
       # No need to reverse if terminating? or there is a closing time
@@ -313,12 +313,12 @@ module IceCube
 
     # Convert the schedule to yaml
     def to_yaml(*args)
-      IceCube::use_psych? ? Psych::dump(to_hash, *args) : YAML::dump(to_hash, *args)
+      YAML::dump(to_hash, *args)
     end
 
     # Load the schedule from yaml
     def self.from_yaml(yaml, options = {})
-      hash = IceCube::use_psych? ? Psych::load(yaml) : YAML::load(yaml)
+      hash = YAML::load(yaml)
       if match = yaml.match(/start_date: .+((?:-|\+)\d{2}:\d{2})$/)
         TimeUtil.restore_deserialized_offset(hash[:start_date], match[1])
       end

data/lib/ice_cube/string_helpers.rb

@@ -0,0 +1,10 @@
+module IceCube
+  module StringHelpers
+
+    module_function
+
+    def nice_number(number)
+    end
+
+  end
+end

data/lib/ice_cube/time_util.rb

@@ -3,7 +3,7 @@ require 'date'
 module IceCube
   module TimeUtil
 
-    extend ::Deprecated
+    extend Deprecated
 
     DAYS = {
       :sunday => 0, :monday => 1, :tuesday => 2, :wednesday => 3,
@@ -82,7 +82,7 @@ module IceCube
     # keep it.  If it was serialized with a different offset than local TZ it
     # 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) or
+      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'
       time.localtime(orig_offset_str)
@@ -113,21 +113,30 @@ module IceCube
     # Convert a symbol to a numeric month
     def self.sym_to_month(sym)
       return wday = sym if (1..12).include? sym
-      MONTHS.fetch(sym) { |k| raise KeyError, "No such month: #{k}" }
+      MONTHS.fetch(sym) do |k|
+        raise ArgumentError, "Expecting Fixnum or Symbol value for month. " \
+                             "No such month: #{k.inspect}"
+      end
     end
     deprecated_alias :symbol_to_month, :sym_to_month
 
     # Convert a symbol to a wday number
     def self.sym_to_wday(sym)
       return sym if (0..6).include? sym
-      DAYS.fetch(sym) { |k| raise KeyError, "No such weekday: #{k}" }
+      DAYS.fetch(sym) do |k|
+        raise ArgumentError, "Expecting Fixnum 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 sym = wday if DAYS.keys.include? wday
-      DAYS.invert.fetch(wday) { |i| raise KeyError, "No such wday number: #{i}" }
+      DAYS.invert.fetch(wday) do |i|
+        raise ArgumentError, "Expecting Fixnum value for weekday. " \
+                             "No such wday number: #{i.inspect}"
+      end
     end
 
     # Convert weekday from base sunday to the schedule's week start.

data/lib/ice_cube/validations/count.rb

@@ -2,7 +2,7 @@ module IceCube
 
   module Validations::Count
 
-    # accessor
+    # Value reader for limit
     def occurrence_count
       @count
     end
@@ -12,7 +12,7 @@ module IceCube
         raise ArgumentError, "Expecting Fixnum or nil value for count, got #{max.inspect}"
       end
       @count = max
-      replace_validations_for(:count, [Validation.new(max, self)])
+      replace_validations_for(:count, max && [Validation.new(max, self)])
       self
     end
 
@@ -26,13 +26,11 @@ module IceCube
       end
 
       def type
-        :dealbreaker
+        :limit
       end
 
       def validate(time, schedule)
-        if rule.uses && rule.uses >= count
-          raise CountExceeded
-        end
+        raise CountExceeded if rule.uses && rule.uses >= count
       end
 
       def build_s(builder)