chronic 0.4.1 → 0.6.5

data/lib/chronic/mini_date.rb

@@ -2,17 +2,27 @@ module Chronic
   class MiniDate
     attr_accessor :month, :day
 
+    def self.from_time(time)
+      new(time.month, time.day)
+    end
+
     def initialize(month, day)
-      raise(InvalidArgumentException, "1..12 are valid months") unless (1..12).include?(month)
+      unless (1..12).include?(month)
+        raise ArgumentError, "1..12 are valid months"
+      end
+
       @month = month
       @day = day
     end
 
     def is_between?(md_start, md_end)
-      return false if (@month==md_start.month && @month==md_end.month && (@day < md_start.day || @day > md_end.day))
-      return true if (@month == md_start.month and @day >= md_start.day) ||
-                     (@month == md_end.month and @day <= md_end.day)
+      return false if (@month == md_start.month && @month == md_end.month) &&
+                      (@day < md_start.day || @day > md_end.day)
+      return true if (@month == md_start.month && @day >= md_start.day) ||
+                     (@month == md_end.month && @day <= md_end.day)
+
       i = (md_start.month % 12) + 1
+
       until i == md_end.month
         return true if @month == i
         i = (i % 12) + 1
@@ -22,7 +32,7 @@ module Chronic
     end
 
     def equals?(other)
-      @month == other.month and day == other.day
+      @month == other.month and @day == other.day
     end
   end
 end

data/lib/chronic/numerizer.rb

@@ -107,14 +107,15 @@ module Chronic
 
       def andition(string)
         sc = StringScanner.new(string)
-        while(sc.scan_until(/<num>(\d+)( | and )<num>(\d+)(?=[^\w]|$)/i))
+
+        while sc.scan_until(/<num>(\d+)( | and )<num>(\d+)(?=[^\w]|$)/i)
           if sc[2] =~ /and/ || sc[1].size > sc[3].size
             string[(sc.pos - sc.matched_size)..(sc.pos-1)] = '<num>' + (sc[1].to_i + sc[3].to_i).to_s
             sc.reset
           end
         end
       end
-    end
 
+    end
   end
 end

data/lib/chronic/ordinal.rb

@@ -1,16 +1,27 @@
 module Chronic
-  class Ordinal < Tag #:nodoc:
+  class Ordinal < Tag
+
+    # Scan an Array of {Token}s and apply any necessary Ordinal tags to
+    # each token
+    #
+    # @param [Array<Token>] tokens Array of tokens to scan
+    # @param [Hash] options Options specified in {Chronic.parse}
+    # @return [Array] list of tokens
     def self.scan(tokens, options)
-      tokens.each_index do |i|
-        if t = scan_for_ordinals(tokens[i]) then tokens[i].tag(t) end
-        if t = scan_for_days(tokens[i]) then tokens[i].tag(t) end
+      tokens.each do |token|
+        if t = scan_for_ordinals(token) then token.tag(t) end
+        if t = scan_for_days(token) then token.tag(t) end
       end
     end
 
+    # @param [Token] token
+    # @return [Ordinal, nil]
     def self.scan_for_ordinals(token)
       Ordinal.new($1.to_i) if token.word =~ /^(\d*)(st|nd|rd|th)$/
     end
 
+    # @param [Token] token
+    # @return [OrdinalDay, nil]
     def self.scan_for_days(token)
       if token.word =~ /^(\d*)(st|nd|rd|th)$/
         unless $1.to_i > 31 || $1.to_i < 1

data/lib/chronic/pointer.rb

@@ -1,17 +1,25 @@
 module Chronic
-  class Pointer < Tag #:nodoc:
+  class Pointer < Tag
+
+    # Scan an Array of {Token}s and apply any necessary Pointer tags to
+    # each token
+    #
+    # @param [Array<Token>] tokens Array of tokens to scan
+    # @param [Hash] options Options specified in {Chronic.parse}
+    # @return [Array] list of tokens
     def self.scan(tokens, options)
-      tokens.each_index do |i|
-        if t = scan_for_all(tokens[i]) then tokens[i].tag(t) end
+      tokens.each do |token|
+        if t = scan_for_all(token) then token.tag(t) end
       end
     end
 
+    # @param [Token] token
+    # @return [Pointer, nil]
     def self.scan_for_all(token)
       scan_for token, self,
       {
         /\bpast\b/ => :past,
-        /\bfuture\b/ => :future,
-        /\bin\b/ => :future
+        /\b(?:future|in)\b/ => :future,
       }
     end
 

data/lib/chronic/repeater.rb

@@ -1,16 +1,25 @@
 module Chronic
-  class Repeater < Tag #:nodoc:
+  class Repeater < Tag
+
+    # Scan an Array of {Token}s and apply any necessary Repeater tags to
+    # each token
+    #
+    # @param [Array<Token>] tokens Array of tokens to scan
+    # @param [Hash] options Options specified in {Chronic.parse}
+    # @return [Array] list of tokens
     def self.scan(tokens, options)
-      tokens.each_index do |i|
-        if t = scan_for_season_names(tokens[i]) then tokens[i].tag(t); next end
-        if t = scan_for_month_names(tokens[i]) then tokens[i].tag(t); next end
-        if t = scan_for_day_names(tokens[i]) then tokens[i].tag(t); next end
-        if t = scan_for_day_portions(tokens[i]) then tokens[i].tag(t); next end
-        if t = scan_for_times(tokens[i]) then tokens[i].tag(t); next end
-        if t = scan_for_units(tokens[i]) then tokens[i].tag(t); next end
+      tokens.each do |token|
+        if t = scan_for_season_names(token) then token.tag(t); next end
+        if t = scan_for_month_names(token) then token.tag(t); next end
+        if t = scan_for_day_names(token) then token.tag(t); next end
+        if t = scan_for_day_portions(token) then token.tag(t); next end
+        if t = scan_for_times(token) then token.tag(t); next end
+        if t = scan_for_units(token) then token.tag(t); next end
       end
     end
 
+    # @param [Token] token
+    # @return [RepeaterSeasonName, nil]
     def self.scan_for_season_names(token)
       scan_for token, RepeaterSeasonName,
       {
@@ -21,6 +30,8 @@ module Chronic
       }
     end
 
+    # @param [Token] token
+    # @return [RepeaterMonthName, nil]
     def self.scan_for_month_names(token)
       scan_for token, RepeaterMonthName,
       {
@@ -39,22 +50,23 @@ module Chronic
       }
     end
 
+    # @param [Token] token
+    # @return [RepeaterDayName, nil]
     def self.scan_for_day_names(token)
       scan_for token, RepeaterDayName,
       {
         /^m[ou]n(day)?$/ => :monday,
-        /^t(ue|eu|oo|u|)s(day)?$/ => :tuesday,
-        /^tue$/ => :tuesday,
-        /^we(dnes|nds|nns)day$/ => :wednesday,
-        /^wed$/ => :wednesday,
-        /^th(urs|ers)day$/ => :thursday,
-        /^thu(rs)?$/ => :thursday,
+        /^t(ue|eu|oo|u|)s?(day)?$/ => :tuesday,
+        /^we(d|dnes|nds|nns)(day)?$/ => :wednesday,
+        /^th(u(?:rs)?|ers)(day)?$/ => :thursday,
         /^fr[iy](day)?$/ => :friday,
         /^sat(t?[ue]rday)?$/ => :saturday,
         /^su[nm](day)?$/ => :sunday
       }
     end
 
+    # @param [Token] token
+    # @return [RepeaterDayPortion, nil]
     def self.scan_for_day_portions(token)
       scan_for token, RepeaterDayPortion,
       {
@@ -67,10 +79,14 @@ module Chronic
       }
     end
 
+    # @param [Token] token
+    # @return [RepeaterTime, nil]
     def self.scan_for_times(token)
       scan_for token, RepeaterTime, /^\d{1,2}(:?\d{2})?([\.:]?\d{2})?$/
     end
 
+    # @param [Token] token
+    # @return [Repeater] A new instance of a subclass of Repeater
     def self.scan_for_units(token)
       {
         /^years?$/ => :year,
@@ -100,7 +116,7 @@ module Chronic
 
     # returns the width (in seconds or months) of this repeatable.
     def width
-      raise("Repeatable#width must be overridden in subclasses")
+      raise("Repeater#width must be overridden in subclasses")
     end
 
     # returns the next occurance of this repeatable.

data/lib/chronic/repeaters/repeater_day.rb

@@ -4,7 +4,6 @@ module Chronic
 
     def initialize(type)
       super
-      @current_day_start = nil
     end
 
     def next(pointer)
@@ -25,14 +24,14 @@ module Chronic
 
       case pointer
       when :future
-        day_begin = Time.construct(@now.year, @now.month, @now.day, @now.hour)
-        day_end = Time.construct(@now.year, @now.month, @now.day) + DAY_SECONDS
+        day_begin = Chronic.construct(@now.year, @now.month, @now.day, @now.hour)
+        day_end = Chronic.construct(@now.year, @now.month, @now.day) + DAY_SECONDS
       when :past
-        day_begin = Time.construct(@now.year, @now.month, @now.day)
-        day_end = Time.construct(@now.year, @now.month, @now.day, @now.hour)
+        day_begin = Chronic.construct(@now.year, @now.month, @now.day)
+        day_end = Chronic.construct(@now.year, @now.month, @now.day, @now.hour)
       when :none
-        day_begin = Time.construct(@now.year, @now.month, @now.day)
-        day_end = Time.construct(@now.year, @now.month, @now.day) + DAY_SECONDS
+        day_begin = Chronic.construct(@now.year, @now.month, @now.day)
+        day_end = Chronic.construct(@now.year, @now.month, @now.day) + DAY_SECONDS
       end
 
       Span.new(day_begin, day_end)

data/lib/chronic/repeaters/repeater_day_name.rb

@@ -4,7 +4,6 @@ module Chronic
 
     def initialize(type)
       super
-      @current_day_start = nil
     end
 
     def next(pointer)
@@ -25,7 +24,7 @@ module Chronic
         @current_date += direction * 7
       end
       next_date = @current_date.succ
-      Span.new(Time.construct(@current_date.year, @current_date.month, @current_date.day), Time.construct(next_date.year, next_date.month, next_date.day))
+      Span.new(Chronic.construct(@current_date.year, @current_date.month, @current_date.day), Chronic.construct(next_date.year, next_date.month, next_date.day))
     end
 
     def this(pointer = :future)

data/lib/chronic/repeaters/repeater_day_portion.rb

@@ -3,15 +3,14 @@ module Chronic
     PORTIONS = {
       :am => 0..(12 * 60 * 60 - 1),
       :pm => (12 * 60 * 60)..(24 * 60 * 60 - 1),
-      :morning => (6 * 60 * 60)..(12 * 60 * 60),   # 6am-12am,
-      :afternoon =>(13 * 60 * 60)..(17 * 60 * 60), # 1pm-5pm,
-      :evening => (17 * 60 * 60)..(20 * 60 * 60),  # 5pm-8pm,
-      :night =>(20 * 60 * 60)..(24 * 60 * 60),     # 8pm-12pm
+      :morning => (6 * 60 * 60)..(12 * 60 * 60),    # 6am-12am,
+      :afternoon => (13 * 60 * 60)..(17 * 60 * 60), # 1pm-5pm,
+      :evening => (17 * 60 * 60)..(20 * 60 * 60),   # 5pm-8pm,
+      :night => (20 * 60 * 60)..(24 * 60 * 60),     # 8pm-12pm
     }
 
     def initialize(type)
       super
-      @current_span = nil
 
       if type.kind_of? Integer
         @range = (@type * 60 * 60)..((@type + 12) * 60 * 60)
@@ -29,27 +28,27 @@ module Chronic
       full_day = 60 * 60 * 24
 
       if !@current_span
-        now_seconds = @now - Time.construct(@now.year, @now.month, @now.day)
+        now_seconds = @now - Chronic.construct(@now.year, @now.month, @now.day)
         if now_seconds < @range.begin
           case pointer
           when :future
-            range_start = Time.construct(@now.year, @now.month, @now.day) + @range.begin
+            range_start = Chronic.construct(@now.year, @now.month, @now.day) + @range.begin
           when :past
-            range_start = Time.construct(@now.year, @now.month, @now.day) - full_day + @range.begin
+            range_start = Chronic.construct(@now.year, @now.month, @now.day) - full_day + @range.begin
           end
         elsif now_seconds > @range.end
           case pointer
           when :future
-            range_start = Time.construct(@now.year, @now.month, @now.day) + full_day + @range.begin
+            range_start = Chronic.construct(@now.year, @now.month, @now.day) + full_day + @range.begin
           when :past
-            range_start = Time.construct(@now.year, @now.month, @now.day) + @range.begin
+            range_start = Chronic.construct(@now.year, @now.month, @now.day) + @range.begin
           end
         else
           case pointer
           when :future
-            range_start = Time.construct(@now.year, @now.month, @now.day) + full_day + @range.begin
+            range_start = Chronic.construct(@now.year, @now.month, @now.day) + full_day + @range.begin
           when :past
-            range_start = Time.construct(@now.year, @now.month, @now.day) - full_day + @range.begin
+            range_start = Chronic.construct(@now.year, @now.month, @now.day) - full_day + @range.begin
           end
         end
 
@@ -67,7 +66,7 @@ module Chronic
     def this(context = :future)
       super
 
-      range_start = Time.construct(@now.year, @now.month, @now.day) + @range.begin
+      range_start = Chronic.construct(@now.year, @now.month, @now.day) + @range.begin
       @current_span = Span.new(range_start, range_start + (@range.end - @range.begin))
     end
 

data/lib/chronic/repeaters/repeater_fortnight.rb

@@ -4,7 +4,6 @@ module Chronic
 
     def initialize(type)
       super
-      @current_fortnight_start = nil
     end
 
     def next(pointer)
@@ -39,7 +38,7 @@ module Chronic
 
       case pointer
       when :future
-        this_fortnight_start = Time.construct(@now.year, @now.month, @now.day, @now.hour) + RepeaterHour::HOUR_SECONDS
+        this_fortnight_start = Chronic.construct(@now.year, @now.month, @now.day, @now.hour) + RepeaterHour::HOUR_SECONDS
         sunday_repeater = RepeaterDayName.new(:sunday)
         sunday_repeater.start = @now
         sunday_repeater.this(:future)
@@ -47,7 +46,7 @@ module Chronic
         this_fortnight_end = this_sunday_span.begin
         Span.new(this_fortnight_start, this_fortnight_end)
       when :past
-        this_fortnight_end = Time.construct(@now.year, @now.month, @now.day, @now.hour)
+        this_fortnight_end = Chronic.construct(@now.year, @now.month, @now.day, @now.hour)
         sunday_repeater = RepeaterDayName.new(:sunday)
         sunday_repeater.start = @now
         last_sunday_span = sunday_repeater.next(:past)

data/lib/chronic/repeaters/repeater_hour.rb

@@ -4,7 +4,6 @@ module Chronic
 
     def initialize(type)
       super
-      @current_hour_start = nil
     end
 
     def next(pointer)
@@ -13,9 +12,9 @@ module Chronic
       if !@current_hour_start
         case pointer
         when :future
-          @current_hour_start = Time.construct(@now.year, @now.month, @now.day, @now.hour + 1)
+          @current_hour_start = Chronic.construct(@now.year, @now.month, @now.day, @now.hour + 1)
         when :past
-          @current_hour_start = Time.construct(@now.year, @now.month, @now.day, @now.hour - 1)
+          @current_hour_start = Chronic.construct(@now.year, @now.month, @now.day, @now.hour - 1)
         end
       else
         direction = pointer == :future ? 1 : -1
@@ -30,13 +29,13 @@ module Chronic
 
       case pointer
       when :future
-        hour_start = Time.construct(@now.year, @now.month, @now.day, @now.hour, @now.min + 1)
-        hour_end = Time.construct(@now.year, @now.month, @now.day, @now.hour + 1)
+        hour_start = Chronic.construct(@now.year, @now.month, @now.day, @now.hour, @now.min + 1)
+        hour_end = Chronic.construct(@now.year, @now.month, @now.day, @now.hour + 1)
       when :past
-        hour_start = Time.construct(@now.year, @now.month, @now.day, @now.hour)
-        hour_end = Time.construct(@now.year, @now.month, @now.day, @now.hour, @now.min)
+        hour_start = Chronic.construct(@now.year, @now.month, @now.day, @now.hour)
+        hour_end = Chronic.construct(@now.year, @now.month, @now.day, @now.hour, @now.min)
       when :none
-        hour_start = Time.construct(@now.year, @now.month, @now.day, @now.hour)
+        hour_start = Chronic.construct(@now.year, @now.month, @now.day, @now.hour)
         hour_end = hour_start + HOUR_SECONDS
       end
 

data/lib/chronic/repeaters/repeater_minute.rb

@@ -4,7 +4,6 @@ module Chronic
 
     def initialize(type)
       super
-      @current_minute_start = nil
     end
 
     def next(pointer = :future)
@@ -13,9 +12,9 @@ module Chronic
       if !@current_minute_start
         case pointer
         when :future
-          @current_minute_start = Time.construct(@now.year, @now.month, @now.day, @now.hour, @now.min + 1)
+          @current_minute_start = Chronic.construct(@now.year, @now.month, @now.day, @now.hour, @now.min + 1)
         when :past
-          @current_minute_start = Time.construct(@now.year, @now.month, @now.day, @now.hour, @now.min - 1)
+          @current_minute_start = Chronic.construct(@now.year, @now.month, @now.day, @now.hour, @now.min - 1)
         end
       else
         direction = pointer == :future ? 1 : -1
@@ -31,13 +30,13 @@ module Chronic
       case pointer
       when :future
         minute_begin = @now
-        minute_end = Time.construct(@now.year, @now.month, @now.day, @now.hour, @now.min)
+        minute_end = Chronic.construct(@now.year, @now.month, @now.day, @now.hour, @now.min)
       when :past
-        minute_begin = Time.construct(@now.year, @now.month, @now.day, @now.hour, @now.min)
+        minute_begin = Chronic.construct(@now.year, @now.month, @now.day, @now.hour, @now.min)
         minute_end = @now
       when :none
-        minute_begin = Time.construct(@now.year, @now.month, @now.day, @now.hour, @now.min)
-        minute_end = Time.construct(@now.year, @now.month, @now.day, @now.hour, @now.min) + MINUTE_SECONDS
+        minute_begin = Chronic.construct(@now.year, @now.month, @now.day, @now.hour, @now.min)
+        minute_end = Chronic.construct(@now.year, @now.month, @now.day, @now.hour, @now.min) + MINUTE_SECONDS
       end
 
       Span.new(minute_begin, minute_end)

data/lib/chronic/repeaters/repeater_month.rb

@@ -2,22 +2,23 @@ module Chronic
   class RepeaterMonth < Repeater #:nodoc:
     MONTH_SECONDS = 2_592_000 # 30 * 24 * 60 * 60
     YEAR_MONTHS = 12
+    MONTH_DAYS = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+    MONTH_DAYS_LEAP = [31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
 
     def initialize(type)
       super
-      @current_month_start = nil
     end
 
     def next(pointer)
       super
 
       if !@current_month_start
-        @current_month_start = offset_by(Time.construct(@now.year, @now.month), 1, pointer)
+        @current_month_start = offset_by(Chronic.construct(@now.year, @now.month), 1, pointer)
       else
-        @current_month_start = offset_by(Time.construct(@current_month_start.year, @current_month_start.month), 1, pointer)
+        @current_month_start = offset_by(Chronic.construct(@current_month_start.year, @current_month_start.month), 1, pointer)
       end
 
-      Span.new(@current_month_start, Time.construct(@current_month_start.year, @current_month_start.month + 1))
+      Span.new(@current_month_start, Chronic.construct(@current_month_start.year, @current_month_start.month + 1))
     end
 
     def this(pointer = :future)
@@ -25,14 +26,14 @@ module Chronic
 
       case pointer
       when :future
-        month_start = Time.construct(@now.year, @now.month, @now.day + 1)
-        month_end = self.offset_by(Time.construct(@now.year, @now.month), 1, :future)
+        month_start = Chronic.construct(@now.year, @now.month, @now.day + 1)
+        month_end = self.offset_by(Chronic.construct(@now.year, @now.month), 1, :future)
       when :past
-        month_start = Time.construct(@now.year, @now.month)
-        month_end = Time.construct(@now.year, @now.month, @now.day)
+        month_start = Chronic.construct(@now.year, @now.month)
+        month_end = Chronic.construct(@now.year, @now.month, @now.day)
       when :none
-        month_start = Time.construct(@now.year, @now.month)
-        month_end = self.offset_by(Time.construct(@now.year, @now.month), 1, :future)
+        month_start = Chronic.construct(@now.year, @now.month)
+        month_end = self.offset_by(Chronic.construct(@now.year, @now.month), 1, :future)
       end
 
       Span.new(month_start, month_end)
@@ -54,7 +55,11 @@ module Chronic
         new_year += 1
         new_month -= YEAR_MONTHS
       end
-      Time.construct(new_year, new_month, time.day, time.hour, time.min, time.sec)
+
+      days = month_days(new_year, new_month)
+      new_day = time.day > days ? days : time.day
+
+      Chronic.construct(new_year, new_month, new_day, time.hour, time.min, time.sec)
     end
 
     def width
@@ -64,5 +69,11 @@ module Chronic
     def to_s
       super << '-month'
     end
+
+    private
+
+    def month_days(year, month)
+      Date.leap?(year) ? MONTH_DAYS_LEAP[month - 1] : MONTH_DAYS[month - 1]
+    end
   end
 end

data/lib/chronic/repeaters/repeater_month_name.rb

@@ -18,41 +18,39 @@ module Chronic
 
     def initialize(type)
       super
-      @current_month_begin = nil
     end
 
     def next(pointer)
       super
 
       if !@current_month_begin
-        target_month = symbol_to_number(@type)
         case pointer
         when :future
-          if @now.month < target_month
-            @current_month_begin = Time.construct(@now.year, target_month)
-          elsif @now.month > target_month
-            @current_month_begin = Time.construct(@now.year + 1, target_month)
+          if @now.month < index
+            @current_month_begin = Chronic.construct(@now.year, index)
+          elsif @now.month > index
+            @current_month_begin = Chronic.construct(@now.year + 1, index)
           end
         when :none
-          if @now.month <= target_month
-            @current_month_begin = Time.construct(@now.year, target_month)
-          elsif @now.month > target_month
-            @current_month_begin = Time.construct(@now.year + 1, target_month)
+          if @now.month <= index
+            @current_month_begin = Chronic.construct(@now.year, index)
+          elsif @now.month > index
+            @current_month_begin = Chronic.construct(@now.year + 1, index)
           end
         when :past
-          if @now.month >= target_month
-            @current_month_begin = Time.construct(@now.year, target_month)
-          elsif @now.month < target_month
-            @current_month_begin = Time.construct(@now.year - 1, target_month)
+          if @now.month >= index
+            @current_month_begin = Chronic.construct(@now.year, index)
+          elsif @now.month < index
+            @current_month_begin = Chronic.construct(@now.year - 1, index)
           end
         end
         @current_month_begin || raise("Current month should be set by now")
       else
         case pointer
         when :future
-          @current_month_begin = Time.construct(@current_month_begin.year + 1, @current_month_begin.month)
+          @current_month_begin = Chronic.construct(@current_month_begin.year + 1, @current_month_begin.month)
         when :past
-          @current_month_begin = Time.construct(@current_month_begin.year - 1, @current_month_begin.month)
+          @current_month_begin = Chronic.construct(@current_month_begin.year - 1, @current_month_begin.month)
         end
       end
 
@@ -67,7 +65,7 @@ module Chronic
         next_month_month = cur_month_month + 1
       end
 
-      Span.new(@current_month_begin, Time.construct(next_month_year, next_month_month))
+      Span.new(@current_month_begin, Chronic.construct(next_month_year, next_month_month))
     end
 
     def this(pointer = :future)
@@ -86,17 +84,11 @@ module Chronic
     end
 
     def index
-      symbol_to_number(@type)
+      @index ||= MONTHS[@type]
     end
 
     def to_s
       super << '-monthname-' << @type.to_s
     end
-
-    private
-
-    def symbol_to_number(sym)
-      MONTHS[sym] || raise("Invalid symbol specified")
-    end
   end
 end