chronic 0.6.7 → 0.7.0

data/lib/chronic/handlers.rb

@@ -224,6 +224,27 @@ module Chronic
       handle_sm_sd_sy(new_tokens + time_tokens, options)
     end
 
+    # Handle scalar-day/scalar-month AND scalar-month/scalar-day
+    def handle_sm_sd(tokens, options)
+      month = tokens[0].get_tag(ScalarMonth).type
+      day = tokens[1].get_tag(ScalarDay).type
+      year = Chronic.now.year
+
+      if Array(options[:endian_precedence]).first == :little
+        day, month = month, day
+      end
+
+      return if month_overflow?(year, month, day)
+
+      begin
+        start_time = Chronic.time_class.local(year, month, day)
+        end_time = Chronic.time_class.local(year, month, day + 1)
+        Span.new(start_time, end_time)
+      rescue ArgumentError
+        nil
+      end
+    end
+
     # Handle scalar-month/scalar-year
     def handle_sm_sy(tokens, options)
       month = tokens[0].get_tag(ScalarMonth).type
@@ -296,6 +317,15 @@ module Chronic
       end
     end
 
+    def handle_sm_rmn_sy(tokens, options)
+      day = tokens[0].get_tag(ScalarDay).type
+      month = tokens[1].get_tag(RepeaterMonthName).index
+      year = tokens[2].get_tag(ScalarYear).type
+      time = Chronic.time_class.local(year, month, day)
+      end_time = Chronic.time_class.local(year, month, day + 1)
+      Span.new(time, end_time)
+    end
+
     # anchors
 
     # Handle repeaters
@@ -318,7 +348,7 @@ module Chronic
       repeater = tokens[1].get_tag(Repeater)
       pointer = tokens[2].get_tag(Pointer).type
 
-      repeater.offset(span, distance, pointer)
+      repeater.offset(span, distance, pointer) if repeater.respond_to?(:offset)
     end
 
     # Handle scalar/repeater/pointer
@@ -434,6 +464,8 @@ module Chronic
       else
         day > RepeaterMonth::MONTH_DAYS[month - 1]
       end
+    rescue ArgumentError
+      false
     end
 
     # Recursively finds repeaters within other repeaters.

data/lib/chronic/ordinal.rb

@@ -1,12 +1,13 @@
 module Chronic
   class Ordinal < Tag
 
-    # Scan an Array of {Token}s and apply any necessary Ordinal tags to
-    # each token
+    # Scan an Array of Token objects 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
+    # tokens - An Array of tokens to scan.
+    # options - The Hash of options specified in Chronic::parse.
+    #
+    # Returns an Array of tokens.
     def self.scan(tokens, options)
       tokens.each do |token|
         if t = scan_for_ordinals(token) then token.tag(t) end
@@ -14,14 +15,16 @@ module Chronic
       end
     end
 
-    # @param [Token] token
-    # @return [Ordinal, nil]
+    # token - The Token object we want to scan.
+    #
+    # Returns a new Ordinal object.
     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]
+    # token - The Token object we want to scan.
+    #
+    # Returns a new Ordinal object.
     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,20 +1,22 @@
 module Chronic
   class Pointer < Tag
 
-    # Scan an Array of {Token}s and apply any necessary Pointer tags to
-    # each token
+    # Scan an Array of Token objects 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
+    # tokens - An Array of tokens to scan.
+    # options - The Hash of options specified in Chronic::parse.
+    #
+    # Returns an Array of tokens.
     def self.scan(tokens, options)
       tokens.each do |token|
         if t = scan_for_all(token) then token.tag(t) end
       end
     end
 
-    # @param [Token] token
-    # @return [Pointer, nil]
+    # token - The Token object we want to scan.
+    #
+    # Returns a new Pointer object.
     def self.scan_for_all(token)
       scan_for token, self,
       {

data/lib/chronic/repeater.rb

@@ -1,12 +1,13 @@
 module Chronic
   class Repeater < Tag
 
-    # Scan an Array of {Token}s and apply any necessary Repeater tags to
-    # each token
+    # Scan an Array of Token objects 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
+    # tokens - An Array of tokens to scan.
+    # options - The Hash of options specified in Chronic::parse.
+    #
+    # Returns an Array of tokens.
     def self.scan(tokens, options)
       tokens.each do |token|
         if t = scan_for_season_names(token) then token.tag(t); next end
@@ -18,8 +19,9 @@ module Chronic
       end
     end
 
-    # @param [Token] token
-    # @return [RepeaterSeasonName, nil]
+    # token - The Token object we want to scan.
+    #
+    # Returns a new Repeater object.
     def self.scan_for_season_names(token)
       scan_for token, RepeaterSeasonName,
       {
@@ -30,8 +32,9 @@ module Chronic
       }
     end
 
-    # @param [Token] token
-    # @return [RepeaterMonthName, nil]
+    # token - The Token object we want to scan.
+    #
+    # Returns a new Repeater object.
     def self.scan_for_month_names(token)
       scan_for token, RepeaterMonthName,
       {
@@ -50,8 +53,9 @@ module Chronic
       }
     end
 
-    # @param [Token] token
-    # @return [RepeaterDayName, nil]
+    # token - The Token object we want to scan.
+    #
+    # Returns a new Repeater object.
     def self.scan_for_day_names(token)
       scan_for token, RepeaterDayName,
       {
@@ -65,8 +69,9 @@ module Chronic
       }
     end
 
-    # @param [Token] token
-    # @return [RepeaterDayPortion, nil]
+    # token - The Token object we want to scan.
+    #
+    # Returns a new Repeater object.
     def self.scan_for_day_portions(token)
       scan_for token, RepeaterDayPortion,
       {
@@ -79,14 +84,16 @@ module Chronic
       }
     end
 
-    # @param [Token] token
-    # @return [RepeaterTime, nil]
+    # token - The Token object we want to scan.
+    #
+    # Returns a new Repeater object.
     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
+    # token - The Token object we want to scan.
+    #
+    # Returns a new Repeater object.
     def self.scan_for_units(token)
       {
         /^years?$/ => :year,
@@ -97,8 +104,11 @@ module Chronic
         /^weekends?$/ => :weekend,
         /^(week|business)days?$/ => :weekday,
         /^days?$/ => :day,
+	/^hrs?$/ => :hour,
         /^hours?$/ => :hour,
+	/^mins?$/ => :minute,
         /^minutes?$/ => :minute,
+	/^secs?$/ => :second,
         /^seconds?$/ => :second
       }.each do |item, symbol|
         if item =~ token.word
@@ -132,4 +142,4 @@ module Chronic
       'repeater'
     end
   end
-end
+end

data/lib/chronic/repeaters/repeater_day_portion.rb

@@ -25,8 +25,6 @@ module Chronic
     def next(pointer)
       super
 
-      full_day = 60 * 60 * 24
-
       if !@current_span
         now_seconds = @now - Chronic.construct(@now.year, @now.month, @now.day)
         if now_seconds < @range.begin
@@ -34,32 +32,38 @@ module Chronic
           when :future
             range_start = Chronic.construct(@now.year, @now.month, @now.day) + @range.begin
           when :past
-            range_start = Chronic.construct(@now.year, @now.month, @now.day) - full_day + @range.begin
+            range_start = Chronic.construct(@now.year, @now.month, @now.day - 1) + @range.begin
           end
         elsif now_seconds > @range.end
           case pointer
           when :future
-            range_start = Chronic.construct(@now.year, @now.month, @now.day) + full_day + @range.begin
+            range_start = Chronic.construct(@now.year, @now.month, @now.day + 1) + @range.begin
           when :past
             range_start = Chronic.construct(@now.year, @now.month, @now.day) + @range.begin
           end
         else
           case pointer
           when :future
-            range_start = Chronic.construct(@now.year, @now.month, @now.day) + full_day + @range.begin
+            range_start = Chronic.construct(@now.year, @now.month, @now.day + 1) + @range.begin
           when :past
-            range_start = Chronic.construct(@now.year, @now.month, @now.day) - full_day + @range.begin
+            range_start = Chronic.construct(@now.year, @now.month, @now.day - 1) + @range.begin
           end
         end
-
-        @current_span = Span.new(range_start, range_start + (@range.end - @range.begin))
+        offset = (@range.end - @range.begin)
+        range_end = construct_date_from_reference_and_offset(range_start, offset)
+        @current_span = Span.new(range_start, range_end)
       else
+        days_to_shift_window =
         case pointer
         when :future
-          @current_span += full_day
+          1
         when :past
-          @current_span -= full_day
+          -1
         end
+
+        new_begin = Chronic.construct(@current_span.begin.year, @current_span.begin.month, @current_span.begin.day + days_to_shift_window, @current_span.begin.hour, @current_span.begin.min, @current_span.begin.sec)
+        new_end = Chronic.construct(@current_span.end.year, @current_span.end.month, @current_span.end.day + days_to_shift_window, @current_span.end.hour, @current_span.end.min, @current_span.end.sec)
+        @current_span = Span.new(new_begin, new_end)
       end
     end
 
@@ -67,7 +71,8 @@ module Chronic
       super
 
       range_start = Chronic.construct(@now.year, @now.month, @now.day) + @range.begin
-      @current_span = Span.new(range_start, range_start + (@range.end - @range.begin))
+      range_end = construct_date_from_reference_and_offset(range_start)
+      @current_span = Span.new(range_start, range_end)
     end
 
     def offset(span, amount, pointer)
@@ -90,5 +95,14 @@ module Chronic
     def to_s
       super << '-dayportion-' << @type.to_s
     end
+
+    private
+    def construct_date_from_reference_and_offset(reference, offset = nil)
+      elapsed_seconds_for_range = offset || (@range.end - @range.begin)
+      second_hand = ((elapsed_seconds_for_range - (12 * 60))) % 60
+      minute_hand = (elapsed_seconds_for_range - second_hand) / (60) % 60
+      hour_hand = (elapsed_seconds_for_range - minute_hand - second_hand) / (60 * 60) + reference.hour % 24
+      Chronic.construct(reference.year, reference.month, reference.day, hour_hand, minute_hand, second_hand)
+    end
   end
 end

data/lib/chronic/scalar.rb

@@ -2,12 +2,13 @@ module Chronic
   class Scalar < Tag
     DAY_PORTIONS = %w( am pm morning afternoon evening night )
 
-    # Scan an Array of {Token}s and apply any necessary Scalar tags to
-    # each token
+    # Scan an Array of Token objects and apply any necessary Scalar
+    # 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
+    # tokens - An Array of tokens to scan.
+    # options - The Hash of options specified in Chronic::parse.
+    #
+    # Returns an Array of tokens.
     def self.scan(tokens, options)
       tokens.each_index do |i|
         if t = scan_for_scalars(tokens[i], tokens[i + 1]) then tokens[i].tag(t) end
@@ -17,9 +18,10 @@ module Chronic
       end
     end
 
-    # @param [Token] token
-    # @param [Token] post_token
-    # @return [Scalar, nil]
+    # token - The Token object we want to scan.
+    # post_token - The next Token object.
+    #
+    # Returns a new Scalar object.
     def self.scan_for_scalars(token, post_token)
       if token.word =~ /^\d*$/
         unless post_token && DAY_PORTIONS.include?(post_token.word)
@@ -28,9 +30,10 @@ module Chronic
       end
     end
 
-    # @param [Token] token
-    # @param [Token] post_token
-    # @return [ScalarDay, nil]
+    # token - The Token object we want to scan.
+    # post_token - The next Token object.
+    #
+    # Returns a new Scalar object.
     def self.scan_for_days(token, post_token)
       if token.word =~ /^\d\d?$/
         toi = token.word.to_i
@@ -40,9 +43,10 @@ module Chronic
       end
     end
 
-    # @param [Token] token
-    # @param [Token] post_token
-    # @return [ScalarMonth, nil]
+    # token - The Token object we want to scan.
+    # post_token - The next Token object.
+    #
+    # Returns a new Scalar object.
     def self.scan_for_months(token, post_token)
       if token.word =~ /^\d\d?$/
         toi = token.word.to_i
@@ -52,10 +56,11 @@ module Chronic
       end
     end
 
-    # @param [Token] token
-    # @param [Token] post_token
-    # @param [Hash] options Options specified in {Chronic.parse}
-    # @return [ScalarYear, nil]
+    # token - The Token object we want to scan.
+    # post_token - The next Token object.
+    # options - The Hash of options specified in Chronic::parse.
+    #
+    # Returns a new Scalar object.
     def self.scan_for_years(token, post_token, options)
       if token.word =~ /^([1-9]\d)?\d\d?$/
         unless post_token && DAY_PORTIONS.include?(post_token.word)
@@ -65,16 +70,18 @@ module Chronic
       end
     end
 
-    # Build a year from a 2 digit suffix
+    # Build a year from a 2 digit suffix.
+    #
+    # year - The two digit Integer year to build from.
+    # bias - The Integer amount of future years to bias.
+    #
+    # Examples:
     #
-    # @example
     #   make_year(96, 50) #=> 1996
     #   make_year(79, 20) #=> 2079
     #   make_year(00, 50) #=> 2000
     #
-    # @param [Integer] year The two digit year to build from
-    # @param [Integer] bias The amount of future years to bias
-    # @return [Integer] The 4 digit year
+    # Returns The Integer 4 digit year.
     def self.make_year(year, bias)
       return year if year.to_s.size > 2
       start_year = Chronic.time_class.now.year - bias

data/lib/chronic/season.rb

@@ -1,35 +1,24 @@
 module Chronic
   class Season
-    # @return [MiniDate]
-    attr_reader :start
 
-    # @return [MiniDate]
+    attr_reader :start
     attr_reader :end
 
-    # @param [MiniDate] start_date
-    # @param [MiniDate] end_date
     def initialize(start_date, end_date)
       @start = start_date
       @end = end_date
     end
 
-    # @param [Symbol]  season  The season name
-    # @param [Integer] pointer The direction (-1 for past, 1 for future)
-    # @return [Symbol] The new season name
     def self.find_next_season(season, pointer)
       lookup = [:spring, :summer, :autumn, :winter]
       next_season_num = (lookup.index(season) + 1 * pointer) % 4
       lookup[next_season_num]
     end
 
-    # @param [Symbol] season The season name
-    # @return [Symbol] The new season name
     def self.season_after(season)
       find_next_season(season, +1)
     end
 
-    # @param [Symbol] season The season name
-    # @return [Symbol] The new season name
     def self.season_before(season)
       find_next_season(season, -1)
     end