chronic 0.6.2 → 0.7.0

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,23 +53,25 @@ 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,
       {
         /^m[ou]n(day)?$/ => :monday,
         /^t(ue|eu|oo|u|)s?(day)?$/ => :tuesday,
         /^we(d|dnes|nds|nns)(day)?$/ => :wednesday,
-        /^th(urs|ers)(day)?$/ => :thursday,
+        /^th(u|ur|urs|ers)(day)?$/ => :thursday,
         /^fr[iy](day)?$/ => :friday,
         /^sat(t?[ue]rday)?$/ => :saturday,
         /^su[nm](day)?$/ => :sunday
       }
     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

@@ -3,10 +3,10 @@ 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)
@@ -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/repeaters/repeater_time.rb

@@ -31,25 +31,25 @@ module Chronic
 
       @type =
       case t.size
-        when 1..2
-          hours = t.to_i
-          hours == 12 ? Tick.new(0 * 60 * 60, true) : Tick.new(hours * 60 * 60, true)
-        when 3
-          hours = t[0..0].to_i
-          ambiguous = hours > 0
-          Tick.new((hours * 60 * 60) + (t[1..2].to_i * 60), ambiguous)
-        when 4
-          ambiguous = time =~ /:/ && t[0..0].to_i != 0 && t[0..1].to_i <= 12
-          hours = t[0..1].to_i
-          hours == 12 ? Tick.new(0 * 60 * 60 + t[2..3].to_i * 60, ambiguous) : Tick.new(hours * 60 * 60 + t[2..3].to_i * 60, ambiguous)
-        when 5
-          Tick.new(t[0..0].to_i * 60 * 60 + t[1..2].to_i * 60 + t[3..4].to_i, true)
-        when 6
-          ambiguous = time =~ /:/ && t[0..0].to_i != 0 && t[0..1].to_i <= 12
-          hours = t[0..1].to_i
-          hours == 12 ? Tick.new(0 * 60 * 60 + t[2..3].to_i * 60 + t[4..5].to_i, ambiguous) : Tick.new(hours * 60 * 60 + t[2..3].to_i * 60 + t[4..5].to_i, ambiguous)
-        else
-          raise("Time cannot exceed six digits")
+      when 1..2
+        hours = t.to_i
+        Tick.new((hours == 12 ? 0 : hours) * 60 * 60, true)
+      when 3
+        hours = t[0..0].to_i
+        ambiguous = hours > 0
+        Tick.new((hours * 60 * 60) + (t[1..2].to_i * 60), ambiguous)
+      when 4
+        ambiguous = time =~ /:/ && t[0..0].to_i != 0 && t[0..1].to_i <= 12
+        hours = t[0..1].to_i
+        hours == 12 ? Tick.new(0 * 60 * 60 + t[2..3].to_i * 60, ambiguous) : Tick.new(hours * 60 * 60 + t[2..3].to_i * 60, ambiguous)
+      when 5
+        Tick.new(t[0..0].to_i * 60 * 60 + t[1..2].to_i * 60 + t[3..4].to_i, true)
+      when 6
+        ambiguous = time =~ /:/ && t[0..0].to_i != 0 && t[0..1].to_i <= 12
+        hours = t[0..1].to_i
+        hours == 12 ? Tick.new(0 * 60 * 60 + t[2..3].to_i * 60 + t[4..5].to_i, ambiguous) : Tick.new(hours * 60 * 60 + t[2..3].to_i * 60 + t[4..5].to_i, ambiguous)
+      else
+        raise("Time cannot exceed six digits")
       end
     end
 

data/lib/chronic/repeaters/repeater_year.rb

@@ -29,7 +29,7 @@ module Chronic
 
       case pointer
       when :future
-        this_year_start = Chronic.construct(@now.year, @now.month, @now.day) + RepeaterDay::DAY_SECONDS
+        this_year_start = Chronic.construct(@now.year, @now.month, @now.day + 1)
         this_year_end = Chronic.construct(@now.year + 1, 1, 1)
       when :past
         this_year_start = Chronic.construct(@now.year, 1, 1)

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

data/lib/chronic/separator.rb

@@ -1,12 +1,13 @@
 module Chronic
   class Separator < Tag
 
-    # Scan an Array of {Token}s and apply any necessary Separator tags to
-    # each token
+    # Scan an Array of Token objects and apply any necessary Separator
+    # 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_commas(token) then token.tag(t); next end
@@ -17,14 +18,16 @@ module Chronic
       end
     end
 
-    # @param [Token] token
-    # @return [SeparatorComma, nil]
+    # token - The Token object we want to scan.
+    #
+    # Returns a new SeparatorComma object.
     def self.scan_for_commas(token)
       scan_for token, SeparatorComma, { /^,$/ => :comma }
     end
 
-    # @param [Token] token
-    # @return [SeparatorSlashOrDash, nil]
+    # token - The Token object we want to scan.
+    #
+    # Returns a new SeparatorSlashOrDash object.
     def self.scan_for_slash_or_dash(token)
       scan_for token, SeparatorSlashOrDash,
       {
@@ -33,20 +36,23 @@ module Chronic
       }
     end
 
-    # @param [Token] token
-    # @return [SeparatorAt, nil]
+    # token - The Token object we want to scan.
+    #
+    # Returns a new SeparatorAt object.
     def self.scan_for_at(token)
       scan_for token, SeparatorAt, { /^(at|@)$/ => :at }
     end
 
-    # @param [Token] token
-    # @return [SeparatorIn, nil]
+    # token - The Token object we want to scan.
+    #
+    # Returns a new SeparatorIn object.
     def self.scan_for_in(token)
       scan_for token, SeparatorIn, { /^in$/ => :in }
     end
 
-    # @param [Token] token
-    # @return [SeparatorOn, nil]
+    # token - The Token object we want to scan.
+    #
+    # Returns a new SeparatorOn object.
     def self.scan_for_on(token)
       scan_for token, SeparatorOn, { /^on$/ => :on }
     end

data/lib/chronic/tag.rb

@@ -1,29 +1,23 @@
 module Chronic
   # Tokens are tagged with subclassed instances of this class when
-  # they match specific criteria
+  # they match specific criteria.
   class Tag
 
-    # @return [Symbol]
     attr_accessor :type
 
-    # @param [Symbol] type
+    # type - The Symbol type of this tag.
     def initialize(type)
       @type = type
     end
 
-    # @param [Time] s Set the start timestamp for this Tag
-    def start=(s)
-      @now = s
+    # time - Set the start Time for this Tag.
+    def start=(time)
+      @now = time
     end
 
     class << self
       private
 
-      # @param [Token] token
-      # @param [Class] klass The class instance to create
-      # @param [Regexp, Hash] items
-      # @return [Object, nil] either a new instance of `klass` or `nil` if
-      #   no match is found
       def scan_for(token, klass, items={})
         case items
         when Regexp

data/lib/chronic/time_zone.rb

@@ -1,20 +1,22 @@
 module Chronic
   class TimeZone < Tag
 
-    # Scan an Array of {Token}s and apply any necessary TimeZone tags to
-    # each token
+    # Scan an Array of Token objects and apply any necessary TimeZone
+    # 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); next end
       end
     end
 
-    # @param [Token] token
-    # @return [TimeZone, 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/token.rb

@@ -1,10 +1,7 @@
 module Chronic
   class Token
 
-    # @return [String] The word this Token represents
     attr_accessor :word
-
-    # @return [Array] A list of tag associated with this Token
     attr_accessor :tags
 
     def initialize(word)
@@ -12,27 +9,32 @@ module Chronic
       @tags = []
     end
 
-    # Tag this token with the specified tag
+    # Tag this token with the specified tag.
+    #
+    # new_tag - The new Tag object.
     #
-    # @param [Tag] new_tag An instance of {Tag} or one of its subclasses
+    # Returns nothing.
     def tag(new_tag)
       @tags << new_tag
     end
 
-    # Remove all tags of the given class
+    # Remove all tags of the given class.
     #
-    # @param [Class] The tag class to remove
+    # tag_class - The tag Class to remove.
+    #
+    # Returns nothing.
     def untag(tag_class)
       @tags.delete_if { |m| m.kind_of? tag_class }
     end
 
-    # @return [Boolean] true if this token has any tags
+    # Returns true if this token has any tags.
     def tagged?
       @tags.size > 0
     end
 
-    # @param [Class] tag_class The tag class to search for
-    # @return [Tag] The first Tag that matches the given class
+    # tag_class - The tag Class to search for.
+    #
+    # Returns The first Tag that matches the given class.
     def get_tag(tag_class)
       @tags.find { |m| m.kind_of? tag_class }
     end