recurrence 0.1.1 → 0.1.2

data/lib/recurrence/event.rb

@@ -1,78 +1,9 @@
-class Recurrence::Event
-  CARDINALS = %w(first second third fourth fifth)
-  DAYS = %w(sunday monday tuesday wednesday thursday friday saturday)
-
-  attr_accessor :start_date
-
-  def initialize(options={})
-    every, options = nil, every if every.is_a?(Hash)
-
-    @options    = options
-    @date       = options[:starts]
-    @finished   = false
-
-    validate
-    raise ArgumentError, 'interval should be greater than zero' if @options[:interval] <= 0
-
-    prepare!
+class Recurrence
+  module Event
+    autoload :Base,     "recurrence/event/base"
+    autoload :Daily,    "recurrence/event/daily"
+    autoload :Monthly,  "recurrence/event/monthly"
+    autoload :Weekly,   "recurrence/event/weekly"
+    autoload :Yearly,   "recurrence/event/yearly"
   end
-
-  def next!
-    return nil if finished?
-    return @date = @start_date if @start_date && @date.nil?
-
-    @date = next_in_recurrence
-
-    @finished, @date = true, nil if @date > @options[:until]
-    @date
-  end
-
-  def next
-    return nil if finished?
-    @date || @start_date
-  end
-
-  def reset!
-    @date = nil
-  end
-
-  def finished?
-    @finished
-  end
-
-  private
-
-    def initialized?
-      !!@start_date
-    end
-
-    def prepare!
-      @start_date = next!
-      @date       = nil
-    end
-
-    def validate
-      # Inject custom validations
-    end
-
-    # Common validation for inherited classes.
-    #
-    def valid_month_day?(day) #:nodoc:
-      raise ArgumentError, "invalid day #{day}" unless (1..31).include?(day)
-    end
-
-    # Check if the given key has a valid weekday (0 upto 6) or a valid weekday
-    # name (defined in the DAYS constant). If a weekday name (String) is given,
-    # convert it to a weekday (Integer).
-    #
-    def valid_weekday_or_weekday_name?(value)
-      if value.kind_of?(Numeric)
-        raise ArgumentError, "invalid day #{value}" unless (0..6).include?(value)
-        value
-      else
-        raise ArgumentError, "invalid weekday #{value}" unless DAYS.include?(value.to_s)
-        DAYS.index(value.to_s)
-      end
-    end
-
 end

data/lib/recurrence/event/base.rb

@@ -0,0 +1,80 @@
+class Recurrence
+  module Event
+    class Base
+      CARDINALS = %w(first second third fourth fifth)
+      DAYS = %w(sunday monday tuesday wednesday thursday friday saturday)
+
+      attr_accessor :start_date
+
+      def initialize(options={})
+        every, options = nil, every if every.is_a?(Hash)
+
+        @options    = options
+        @date       = options[:starts]
+        @finished   = false
+
+        validate
+        raise ArgumentError, "interval should be greater than zero" if @options[:interval] <= 0
+
+        prepare!
+      end
+
+      def next!
+        return nil if finished?
+        return @date = @start_date if @start_date && @date.nil?
+
+        @date = next_in_recurrence
+
+        @finished, @date = true, nil if @date > @options[:until]
+        @date
+      end
+
+      def next
+        return nil if finished?
+        @date || @start_date
+      end
+
+      def reset!
+        @date = nil
+      end
+
+      def finished?
+        @finished
+      end
+
+      private
+      def initialized?
+        !!@start_date
+      end
+
+      def prepare!
+        @start_date = next!
+        @date       = nil
+      end
+
+      def validate
+        # Inject custom validations
+      end
+
+      # Common validation for inherited classes.
+      #
+      def valid_month_day?(day) #:nodoc:
+        raise ArgumentError, "invalid day #{day}" unless (1..31).include?(day)
+      end
+
+      # Check if the given key has a valid weekday (0 upto 6) or a valid weekday
+      # name (defined in the DAYS constant). If a weekday name (String) is given,
+      # convert it to a weekday (Integer).
+      #
+      def valid_weekday_or_weekday_name?(value)
+        if value.kind_of?(Numeric)
+          raise ArgumentError, "invalid day #{value}" unless (0..6).include?(value)
+          value
+        else
+          raise ArgumentError, "invalid weekday #{value}" unless DAYS.include?(value.to_s)
+          DAYS.index(value.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/recurrence/event/daily.rb

@@ -1,10 +1,12 @@
-class Recurrence::Event::Daily < Recurrence::Event
-
-  protected
-    def next_in_recurrence
-      date  = @date.to_date
-      date += @options[:interval] if initialized?
-      date
+class Recurrence
+  module Event
+    class Daily < Base
+      protected
+      def next_in_recurrence
+        date  = @date.to_date
+        date += @options[:interval] if initialized?
+        date
+      end
     end
-
+  end
 end

data/lib/recurrence/event/monthly.rb

@@ -1,102 +1,103 @@
-class Recurrence::Event::Monthly < Recurrence::Event
-  INTERVALS = {
-    :monthly => 1,
-    :bimonthly => 2,
-    :quarterly => 3,
-    :semesterly => 6
-  }
-
-  protected
-
-    def validate
-      if @options.key?(:weekday)
-
-        # Allow :on => :last, :weekday => :thursday contruction.
-        if @options[:on].to_s == 'last'
-          @options[:on] = 5 
-        elsif @options[:on].kind_of?(Numeric)
-          valid_week?(@options[:on])
+class Recurrence
+  module Event
+    class Monthly < Base
+      INTERVALS = {
+        :monthly => 1,
+        :bimonthly => 2,
+        :quarterly => 3,
+        :semesterly => 6
+      }
+
+      protected
+      def validate
+        if @options.key?(:weekday)
+
+          # Allow :on => :last, :weekday => :thursday contruction.
+          if @options[:on].to_s == "last"
+            @options[:on] = 5
+          elsif @options[:on].kind_of?(Numeric)
+            valid_week?(@options[:on])
+          else
+            valid_cardinal?(@options[:on])
+            @options[:on] = CARDINALS.index(@options[:on].to_s) + 1
+          end
+
+          @options[:weekday] = valid_weekday_or_weekday_name?(@options[:weekday])
         else
-          valid_cardinal?(@options[:on])
-          @options[:on] = CARDINALS.index(@options[:on].to_s) + 1
+          valid_month_day?(@options[:on])
         end
 
-        @options[:weekday] = valid_weekday_or_weekday_name?(@options[:weekday])
-      else
-        valid_month_day?(@options[:on])
-      end
-
-      if @options[:interval].is_a?(Symbol)
-        valid_interval?(@options[:interval])
-        @options[:interval] = INTERVALS[@options[:interval]]
+        if @options[:interval].is_a?(Symbol)
+          valid_interval?(@options[:interval])
+          @options[:interval] = INTERVALS[@options[:interval]]
+        end
       end
-    end
 
-    def next_in_recurrence
-      return next_month if self.respond_to?(:next_month)
-      type = @options.key?(:weekday) ? :weekday : :monthday
-
-      class_eval <<-METHOD
-        def next_month
-          if initialized?
-            advance_to_month_by_#{type}(@date)
-          else
-            new_date = advance_to_month_by_#{type}(@date, 0)
-            new_date = advance_to_month_by_#{type}(new_date) if @date > new_date
-            new_date
+      def next_in_recurrence
+        return next_month if self.respond_to?(:next_month)
+        type = @options.key?(:weekday) ? :weekday : :monthday
+
+        class_eval <<-METHOD
+          def next_month
+            if initialized?
+              advance_to_month_by_#{type}(@date)
+            else
+              new_date = advance_to_month_by_#{type}(@date, 0)
+              new_date = advance_to_month_by_#{type}(new_date) if @date > new_date
+              new_date
+            end
           end
-        end
-      METHOD
+        METHOD
 
-      next_month
-    end
+        next_month
+      end
 
-    def advance_to_month_by_monthday(date, interval=@options[:interval])
-      # Have a raw month from 0 to 11 interval
-      raw_month  = date.month + interval - 1
+      def advance_to_month_by_monthday(date, interval=@options[:interval])
+        # Have a raw month from 0 to 11 interval
+        raw_month  = date.month + interval - 1
 
-      next_year  = date.year + raw_month / 12
-      next_month = (raw_month % 12) + 1 # change back to ruby interval
-      next_day   = [ @options[:on], Time.days_in_month(next_month, next_year) ].min
+        next_year  = date.year + raw_month / 12
+        next_month = (raw_month % 12) + 1 # change back to ruby interval
+        next_day   = [ @options[:on], Time.days_in_month(next_month, next_year) ].min
 
-      Date.new(next_year, next_month, next_day)
-    end
-
-    def advance_to_month_by_weekday(date, interval=@options[:interval])
-      raw_month  = date.month + interval - 1
-      next_year  = date.year + raw_month / 12
-      next_month = (raw_month % 12) + 1 # change back to ruby interval
-      date       = Date.new(next_year, next_month, 1)
+        Date.new(next_year, next_month, next_day)
+      end
 
-      weekday, month = @options[:weekday], date.month
+      def advance_to_month_by_weekday(date, interval=@options[:interval])
+        raw_month  = date.month + interval - 1
+        next_year  = date.year + raw_month / 12
+        next_month = (raw_month % 12) + 1 # change back to ruby interval
+        date       = Date.new(next_year, next_month, 1)
 
-      # Adjust week day
-      to_add  = weekday - date.wday
-      to_add += 7 if to_add < 0
-      to_add += (@options[:on] - 1) * 7
-      date   += to_add
+        weekday, month = @options[:weekday], date.month
 
-      # Go to the previous month if we lost it
-      if date.month != month
-        weeks = (date.day - 1) / 7 + 1
-        date -= weeks * 7
-      end
+        # Adjust week day
+        to_add  = weekday - date.wday
+        to_add += 7 if to_add < 0
+        to_add += (@options[:on] - 1) * 7
+        date   += to_add
 
-      date
-    end
+        # Go to the previous month if we lost it
+        if date.month != month
+          weeks = (date.day - 1) / 7 + 1
+          date -= weeks * 7
+        end
 
-  private
+        date
+      end
 
-    def valid_cardinal?(cardinal) #:nodoc:
-      raise ArgumentError, "invalid cardinal #{cardinal}" unless CARDINALS.include?(cardinal.to_s)
-    end
+      private
+      def valid_cardinal?(cardinal) #:nodoc:
+        raise ArgumentError, "invalid cardinal #{cardinal}" unless CARDINALS.include?(cardinal.to_s)
+      end
 
-    def valid_interval?(interval) #:nodoc:
-      raise ArgumentError, "invalid cardinal #{interval}" unless INTERVALS.key?(interval)
-    end
+      def valid_interval?(interval) #:nodoc:
+        raise ArgumentError, "invalid cardinal #{interval}" unless INTERVALS.key?(interval)
+      end
 
-    def valid_week?(week) #:nodoc:
-      raise ArgumentError, "invalid week #{week}" unless (1..5).include?(week)
+      def valid_week?(week) #:nodoc:
+        raise ArgumentError, "invalid week #{week}" unless (1..5).include?(week)
+      end
     end
-
+  end
 end

data/lib/recurrence/event/weekly.rb

@@ -1,27 +1,28 @@
-class Recurrence::Event::Weekly < Recurrence::Event
+class Recurrence
+  module Event
+    class Weekly < Base
+      protected
+      def validate
+        @options[:on] = Array.wrap(@options[:on]).inject([]) do |days, value|
+          days << valid_weekday_or_weekday_name?(value)
+        end
 
-  protected
-
-    def validate
-      @options[:on] = Array.wrap(@options[:on]).inject([]) do |days, value|
-        days << valid_weekday_or_weekday_name?(value)
+        @options[:on].sort!
       end
 
-      @options[:on].sort!
-    end
+      def next_in_recurrence
+        return @date if !initialized? && @options[:on].include?(@date.wday)
 
-    def next_in_recurrence
-      return @date if !initialized? && @options[:on].include?(@date.wday)
+        if next_day = @options[:on].find { |day| day > @date.wday }
+          to_add = next_day - @date.wday
+        else
+          to_add = (7 - @date.wday)                # Move to next week
+          to_add += (@options[:interval] - 1) * 7  # Add extra intervals
+          to_add += @options[:on].first            # Go to first required day
+        end
 
-      if next_day = @options[:on].find { |day| day > @date.wday }
-        to_add = next_day - @date.wday
-      else 
-        to_add = (7 - @date.wday)                # Move to next week
-        to_add += (@options[:interval] - 1) * 7  # Add extra intervals
-        to_add += @options[:on].first            # Go to first required day
+        @date.to_date + to_add
       end
-
-      @date.to_date + to_add
     end
-
+  end
 end

data/lib/recurrence/event/yearly.rb

@@ -1,58 +1,59 @@
-class Recurrence::Event::Yearly < Recurrence::Event
-  MONTHS = {
-    "jan" => 1, "january" => 1,
-    "feb" => 2, "february" => 2,
-    "mar" => 3, "march" => 3,
-    "apr" => 4, "april" => 4,
-    "may" => 5,
-    "jun" => 6, "june" => 6,
-    "jul" => 7, "july" => 7,
-    "aug" => 8, "august" => 8,
-    "sep" => 9, "september" => 9,
-    "oct" => 10, "october" => 10,
-    "nov" => 11, "november" => 11,
-    "dec" => 12, "december" => 12
-  }
-
-  protected
-
-    def validate
-      valid_month_day?(@options[:on].last)
-
-      if @options[:on].first.kind_of?(Numeric)
-        valid_month?(@options[:on].first)
-      else
-        valid_month_name?(@options[:on].first)
-        @options[:on] = [ MONTHS[@options[:on].first.to_s], @options.last ]
+class Recurrence
+  module Event
+    class Yearly < Base
+      MONTHS = {
+        "jan" => 1, "january" => 1,
+        "feb" => 2, "february" => 2,
+        "mar" => 3, "march" => 3,
+        "apr" => 4, "april" => 4,
+        "may" => 5,
+        "jun" => 6, "june" => 6,
+        "jul" => 7, "july" => 7,
+        "aug" => 8, "august" => 8,
+        "sep" => 9, "september" => 9,
+        "oct" => 10, "october" => 10,
+        "nov" => 11, "november" => 11,
+        "dec" => 12, "december" => 12
+      }
+
+      protected
+      def validate
+        valid_month_day?(@options[:on].last)
+
+        if @options[:on].first.kind_of?(Numeric)
+          valid_month?(@options[:on].first)
+        else
+          valid_month_name?(@options[:on].first)
+          @options[:on] = [ MONTHS[@options[:on].first.to_s], @options.last ]
+        end
       end
-    end
 
-    def next_in_recurrence
-      if initialized?
-        advance_to_year(@date)
-      else
-        new_date = advance_to_year(@date, 0)
-        new_date = advance_to_year(new_date) if @date > new_date
-        new_date
+      def next_in_recurrence
+        if initialized?
+          advance_to_year(@date)
+        else
+          new_date = advance_to_year(@date, 0)
+          new_date = advance_to_year(new_date) if @date > new_date
+          new_date
+        end
       end
-    end
-
-    def advance_to_year(date, interval=@options[:interval])
-      next_year  = date.year + interval
-      next_month = @options[:on].first
-      next_day   = [ @options[:on].last, Time.days_in_month(next_month, next_year) ].min
 
-      Date.new(next_year, next_month, next_day)
-    end
+      def advance_to_year(date, interval=@options[:interval])
+        next_year  = date.year + interval
+        next_month = @options[:on].first
+        next_day   = [ @options[:on].last, Time.days_in_month(next_month, next_year) ].min
 
-  private
+        Date.new(next_year, next_month, next_day)
+      end
 
-    def valid_month?(month) #:nodoc:
-      raise ArgumentError, "invalid month #{month}" unless (1..12).include?(month)
-    end
+      private
+      def valid_month?(month) #:nodoc:
+        raise ArgumentError, "invalid month #{month}" unless (1..12).include?(month)
+      end
 
-    def valid_month_name?(month) #:nodoc:
-      raise ArgumentError, "invalid month #{month}" unless MONTHS.keys.include?(month.to_s)
+      def valid_month_name?(month) #:nodoc:
+        raise ArgumentError, "invalid month #{month}" unless MONTHS.keys.include?(month.to_s)
+      end
     end
-
+  end
 end