recurify 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a343e37a72dc1fc5319317532fe1af000e31c41e
-  data.tar.gz: d50087d4a127bce77547365be1b4b2a2f694b640
+  metadata.gz: f67467f617bc9f0301b2adea071f0399f6764157
+  data.tar.gz: b1406f9990dc5ce45a8b176b623f7ade80d0c2de
 SHA512:
-  metadata.gz: 93687456b41c7422e1731da5205dc337664e2ddf205b3210f80421b9a0c81940b185db9f05835b5422bfcf2d787fb9be99c5a90b2edeb44652a35993ddd3838c
-  data.tar.gz: 14ce0c66d4a0e9c77c2ee94fd50c59b0c73cd78f5c97239f30d103338444f60b5cb2254002a0b3582a131e2c79341d021152cebfd7231a6b923c0cff4b64d6b9
+  metadata.gz: 2866e6d97a2077b9161075adb1212aa83c6524f06a241b3803dd069c4c9c8a8c2e1d897834ffa612482689c662db88518fbf201174e0733d484320ae87b661c2
+  data.tar.gz: 41175f2ce891a1dbc2e3b522ebdba54f0d10cacfbbed277fd2454fe6ab4776cd2ccf36a6d9f49f0592c5322c12561b01791ce559a5170426187581aa2f18b107

data/lib/recurify/rule.rb

@@ -1,31 +1,40 @@
+require 'date'
+
+require_relative 'rule_validation'
 require_relative 'rule_analysis'
 require_relative 'rule_translation'
 
 module Recurify
   # Represents a Recurrence Rule. Note that +Rule+ objects are *immutable* once
   # they are instantiated (i.e. they are value objects).
-  #
-  # @!attribute [r] frequency
-  #   @return [String]
-  # @!attribute [r] interval
-  #   @return [Fixnum]
-  # @!attribute [r] count
-  #   @return [Fixnum, nil]
-  # @!attribute [r] starts_on
-  #   @return [Date]
-  # @!attribute [r] ends_on
-  #   @return [Date, nil]
   class Rule
+    include RuleValidation
     include RuleAnalysis
     include RuleTranslation
 
     BASE_FREQUENCIES      = %w(daily monthly).freeze
     SUGAR_FREQUENCIES     = %w(weekly quarterly yearly).freeze
     SUPPORTED_FREQUENCIES = (BASE_FREQUENCIES + SUGAR_FREQUENCIES).freeze
-    MIN_INTERVAL          = 1
-    MIN_COUNT             = 1
 
-    attr_reader :frequency, :interval, :count, :starts_on, :ends_on
+    attr_reader :frequency
+    # @!attribute [r] frequency
+    #   @return [String]
+
+    attr_reader :interval
+    # @!attribute [r] interval
+    #   @return [Fixnum]
+
+    attr_reader :count
+    # @!attribute [r] count
+    #   @return [Fixnum, nil]
+
+    attr_reader :starts_on
+    # @!attribute [r] starts_on
+    #   @return [Date]
+
+    attr_reader :ends_on
+    # @!attribute [r] ends_on
+    #   @return [Date, nil]
 
     # Returns a new instance of +Rule+.
     #
@@ -87,46 +96,16 @@ module Recurify
       {
         frequency: SUPPORTED_FREQUENCIES.first,
         interval:  MIN_INTERVAL,
-        count:     nil,
-        starts_on: Date.today,
-        ends_on:   nil
+        starts_on: Date.today
       }
     end
 
-    def attributes=(attributes)
-      @frequency = attributes[:frequency].to_s
-      @interval = attributes[:interval].to_i
-      @count = attributes[:count].nil? ? nil : attributes[:count].to_i
-      @starts_on = attributes[:starts_on].to_date
-      @ends_on = attributes[:ends_on].nil? ? nil : attributes[:ends_on].to_date
-    end
-
-    # @return [void]
-    def validate!
-      validate_frequency!
-      validate_interval!
-      validate_count!
-    end
-
-    # @raise [InvalidRuleFrequency]
-    # @return [void]
-    def validate_frequency!
-      return if SUPPORTED_FREQUENCIES.include?(frequency)
-      fail InvalidRuleFrequency, "'#{frequency}' is not supported"
-    end
-
-    # @raise [InvalidRuleInterval]
-    # @return [void]
-    def validate_interval!
-      return if interval >= MIN_INTERVAL
-      fail InvalidRuleInterval, "'#{interval}' is not supported"
-    end
-
-    # @raise [InvalidRuleCount]
-    # @return [void]
-    def validate_count!
-      return if count.nil? || count >= MIN_COUNT
-      fail InvalidRuleCount, "'#{count}' is not supported"
+    def attributes=(attrs)
+      @frequency = attrs[:frequency].to_s
+      @interval  = attrs[:interval].to_i
+      @count     = attrs[:count].nil? ? nil : attrs[:count].to_i
+      @starts_on = attrs[:starts_on].to_date
+      @ends_on   = attrs[:ends_on].nil? ? nil : attrs[:ends_on].to_date
     end
   end
 end

data/lib/recurify/rule_analysis.rb

@@ -27,7 +27,9 @@ module Recurify
     #
     # @retrun [Boolean]
     def finite?
-      !count.nil? || !ends_on.nil?
+      # @todo Checking of the #count is not needed anymore, once #normalize
+      #   supports minifying of #ends_on.
+      !count.nil? || !normalized_ends_on.nil?
     end
 
     # Returns +true+ if +self+ is infinite. By definition, a +Rule+ is infinite
@@ -39,5 +41,107 @@ module Recurify
     def infinite?
       !finite?
     end
+
+    # Returns +true+ if +self+ starts before or on +upper+. If +upper == nil+,
+    # it is interpreted as "positive infinity". In that case, +#starts_before?+
+    # always returns +true+, because all +Rule+ objects must have a finite
+    # +#starts_on+ attribute.
+    #
+    # @param upper [#to_date, nil]
+    #
+    # @return [Boolean]
+    def starts_before?(upper)
+      upper.nil? || starts_on <= upper.to_date
+    end
+
+    # Returns +true+ if +self+ starts after or on +lower+. If +lower == nil+, it
+    # is interpreted as "negative infinity". In that case, +#starts_after?+
+    # always returns +true+, because all +Rule+ objects must have a finite
+    # +#starts_on+ attribute.
+    #
+    # @param lower [#to_date, nil]
+    #
+    # @return [Boolean]
+    def starts_after?(lower)
+      lower.nil? || starts_on >= lower.to_date
+    end
+
+    # Returns +true+ if +self+ starts after +lower+ *and* starts before
+    # +upper+ (including boundaries).
+    #
+    # @see #starts_before?
+    # @see #starts_after?
+    #
+    # @param lower [#to_date, nil]
+    # @param upper [#to_date, nil]
+    #
+    # @return [Boolean]
+    def starts_between?(lower: nil, upper: nil)
+      starts_after?(lower) && starts_before?(upper)
+    end
+
+    # Returns +true+ if +self+ ends before or on +upper+. If +upper == nil+, it
+    # is interpreted as "positive infinity". In that case, +#ends_before?+
+    # always returns +true+.
+    #
+    # @param upper [#to_date, nil]
+    #
+    # @return [Boolean]
+    def ends_before?(upper)
+      false ||
+        # Case (1): [anything] <= 'infinite' ==> true
+        upper.nil? ||
+        # Case (2): 'finite' <= 'finite' ==> depends on actual comparison
+        !normalized_ends_on.nil? && normalized_ends_on <= upper.to_date
+    end
+
+    # Returns +true+ if +self+ ends after or on +lower+. If +lower == nil+, it
+    # is interpreted as "negative infinity". In that case, +#ends_after?+ always
+    # returns +true+.
+    #
+    # @param lower [#to_date, nil]
+    #
+    # @return [Boolean]
+    def ends_after?(lower)
+      false ||
+        # Case (1): 'infinite' >= [anything] ==> true
+        normalized_ends_on.nil? ||
+        # Case (2): 'finite' >= 'infinite' ==> true
+        lower.nil? ||
+        # Case (3): 'finite' >= 'finite' ==> depends on actual comparison
+        normalized_ends_on >= lower.to_date
+    end
+
+    # Returns +true+ if +self+ ends after +lower+ *and* ends before +upper+
+    # (including boundaries).
+    #
+    # @see #ends_before?
+    # @see #ends_after?
+    #
+    # @param lower [#to_date, nil]
+    # @param upper [#to_date, nil]
+    #
+    # @return [Boolean]
+    def ends_between?(lower: nil, upper: nil)
+      ends_after?(lower) && ends_before?(upper)
+    end
+
+    # Returns +true+ if +self+ starts *and/or* ends between +lower+ and +upper+
+    # (including boundaries).
+    #
+    # @see #starts_between?
+    # @see #ends_between?
+    #
+    # @param lower [#to_date, nil]
+    # @param upper [#to_date, nil]
+    #
+    # @return [Boolean]
+    def overlaps?(lower: nil, upper: nil)
+      false ||
+        # Case (1): +lower+ <= starts_on <= +upper+ ==> true
+        starts_between?(lower: lower, upper: upper) ||
+        # Case (2): +lower+ <= normalized_ends_on <= +upper+ ==> true
+        ends_between?(lower: lower, upper: upper)
+    end
   end
 end

data/lib/recurify/rule_translation.rb

@@ -1,5 +1,9 @@
+require 'forwardable'
+
 module Recurify
   module RuleTranslation # :nodoc:
+    extend Forwardable
+
     NORMALIZATION_MATRIX = {
       # Normalization is a no-op for base-frequencies ...
       'daily' =>     { target_frequency: 'daily',   interval_multiplier:  1 },
@@ -13,27 +17,27 @@ module Recurify
     DENORMALIZATION_MATRIX = {
       'daily' => [
         # Applicable denormalizitions ordered by decreasing preferability ...
-        { target_frequency: 'weekly',    interval_divsor:  7 },
-        { target_frequency: 'daily',     interval_divsor:  1 }
+        { target_frequency: 'weekly',    interval_divisor:  7 },
+        { target_frequency: 'daily',     interval_divisor:  1 }
       ],
       'weekly' => [
         # Applicable denormalizitions ordered by decreasing preferability ...
-        { target_frequency: 'weekly',    interval_divsor:  1 }
+        { target_frequency: 'weekly',    interval_divisor:  1 }
       ],
       'monthly' => [
         # Applicable denormalizitions ordered by decreasing preferability ...
-        { target_frequency: 'yearly',    interval_divsor: 12 },
-        { target_frequency: 'quarterly', interval_divsor:  3 },
-        { target_frequency: 'monthly',   interval_divsor:  1 }
+        { target_frequency: 'yearly',    interval_divisor: 12 },
+        { target_frequency: 'quarterly', interval_divisor:  3 },
+        { target_frequency: 'monthly',   interval_divisor:  1 }
       ],
       'quarterly' => [
         # Applicable denormalizitions ordered by decreasing preferability ...
-        { target_frequency: 'yearly',    interval_divsor:  4 },
-        { target_frequency: 'quarterly', interval_divsor:  1 }
+        { target_frequency: 'yearly',    interval_divisor:  4 },
+        { target_frequency: 'quarterly', interval_divisor:  1 }
       ],
       'yearly' => [
         # Applicable denormalizitions ordered by decreasing preferability ...
-        { target_frequency: 'yearly',    interval_divsor:  1 }
+        { target_frequency: 'yearly',    interval_divisor:  1 }
       ]
     }.freeze
 
@@ -47,6 +51,9 @@ module Recurify
     #
     # Additional translations may be added in the future.
     #
+    # @todo This method is not yet complete, because +#normalize+ should also
+    #   minify the +#ends_on+ and +#count+ attributes (if possible).
+    #
     # @return [Rule]
     def normalize
       @_normalized_rule ||= begin
@@ -59,6 +66,30 @@ module Recurify
       end
     end
 
+    # @!method normalized_frequency
+    #   @see Rule#frequency
+    #   @see #normalize
+    #   @return [String]
+    def_delegator :normalize, :frequency, :normalized_frequency
+
+    # @!method normalized_interval
+    #   @see Rule#interval
+    #   @see #normalize
+    #   @return [Fixnum]
+    def_delegator :normalize, :interval, :normalized_interval
+
+    # @!method normalized_count
+    #   @see Rule#count
+    #   @see #normalize
+    #   @return [Fixnum, nil]
+    def_delegator :normalize, :count, :normalized_count
+
+    # @!method normalized_ends_on
+    #   @see Rule#ends_on
+    #   @see #normalize
+    #   @return [Date, nil]
+    def_delegator :normalize, :ends_on, :normalized_ends_on
+
     # Creates a new +Rule+, similar to +self+, but denormalized. Note that
     # +#denormalized+ is idempotent.
     #
@@ -80,19 +111,42 @@ module Recurify
 
         substitute(
           frequency: translate_with[:target_frequency],
-          interval:  interval / translate_with[:interval_divsor]
+          interval:  interval / translate_with[:interval_divisor]
         )
       end
     end
 
+    # @!method denormalized_frequency
+    #   @see Rule#frequency
+    #   @see #denormalize
+    #   @return [String]
+    def_delegator :denormalize, :frequency, :denormalized_frequency
+
+    # @!method denormalized_interval
+    #   @see Rule#interval
+    #   @see #denormalize
+    #   @return [Fixnum]
+    def_delegator :denormalize, :interval, :denormalized_interval
+
+    # @!method denormalized_count
+    #   @see Rule#count
+    #   @see #denormalize
+    #   @return [Fixnum, nil]
+    def_delegator :denormalize, :count, :denormalized_count
+
+    # @!method denormalized_ends_on
+    #   @see Rule#ends_on
+    #   @see #denormalize
+    #   @return [Date, nil]
+    def_delegator :denormalize, :ends_on, :denormalized_ends_on
+
     private
 
     # @see DENORMALIZATION_MATRIX
     # @return [Hash<Symbol, Object>]
     def find_best_denormalization
-      contenders = DENORMALIZATION_MATRIX[frequency]
-      contenders.find do |contender|
-        normalize.interval % contender[:interval_divsor] == 0
+      DENORMALIZATION_MATRIX[frequency].find do |contender|
+        normalize.interval % contender[:interval_divisor] == 0
       end
     end
   end

data/lib/recurify/rule_validation.rb

@@ -0,0 +1,36 @@
+module Recurify
+  module RuleValidation # :nodoc:
+    MIN_INTERVAL = 1
+    MIN_COUNT    = 1
+
+    private
+
+    # @return [void]
+    def validate!
+      validate_frequency!
+      validate_interval!
+      validate_count!
+    end
+
+    # @raise [InvalidRuleFrequency]
+    # @return [void]
+    def validate_frequency!
+      return if Rule::SUPPORTED_FREQUENCIES.include?(frequency)
+      fail InvalidRuleFrequency, "'#{frequency}' is not supported"
+    end
+
+    # @raise [InvalidRuleInterval]
+    # @return [void]
+    def validate_interval!
+      return if interval >= MIN_INTERVAL
+      fail InvalidRuleInterval, "'#{interval}' is not supported"
+    end
+
+    # @raise [InvalidRuleCount]
+    # @return [void]
+    def validate_count!
+      return if count.nil? || count >= MIN_COUNT
+      fail InvalidRuleCount, "'#{count}' is not supported"
+    end
+  end
+end

data/lib/recurify/version.rb

@@ -1,3 +1,3 @@
 module Recurify # :nodoc:
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurify
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Christoph Schiessl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-01 00:00:00.000000000 Z
+date: 2015-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
 description: 
 email: cs@proactive.cc
 executables: []
@@ -79,6 +93,7 @@ files:
 - lib/recurify/rule.rb
 - lib/recurify/rule_analysis.rb
 - lib/recurify/rule_translation.rb
+- lib/recurify/rule_validation.rb
 - lib/recurify/version.rb
 homepage: https://github.com/cs/recurify
 licenses: