chronic 0.4.3 → 0.4.4

data/.gitignore

@@ -2,3 +2,4 @@ pkg
 *.rbc
 rdoc
 .yardoc
+doc

data/.yardopts

@@ -1,3 +1,3 @@
 -m markdown
---main README.md
+--readme README.md
 --title "Chronic - Natural language date/time parsing"

data/HISTORY.md

@@ -1,3 +1,15 @@
+# 0.4.4
+
+* Fix RepeaterYear for fetching past year offsets when the current day is
+  later than the last day of the same month in a past year (leap years) ie
+  on 29th/feb (leap year) `last year` should (and now does) return 28th/feb
+  instead of 1st/march
+
+# 0.4.3 / 2011-06-08
+
+* Fix issue with parsing 1:xxPM -- Ensure 1 is treated as ambiguous, not
+  just >1
+
 # 0.4.2 / 2011-06-07
 
 * Fix MonthRepeater for fetching past month offsets when current day is

data/Manifest.txt

@@ -3,7 +3,6 @@ LICENSE
 Manifest.txt
 README.md
 Rakefile
-benchmark/benchmark.rb
 chronic.gemspec
 lib/chronic.rb
 lib/chronic/chronic.rb
@@ -56,4 +55,4 @@ test/test_RepeaterYear.rb
 test/test_Span.rb
 test/test_Time.rb
 test/test_Token.rb
-test/test_parsing.rb
+test/test_parsing.rb

data/README.md

@@ -133,8 +133,9 @@ Specific Times (many of the above with an added time)
 
 Chronic allows you to set which Time class to use when constructing times. By
 default, the built in Ruby time class creates times in your system's local
-time zone. You can set this to something like ActiveSupport's TimeZone class
-to get full time zone support.
+time zone. You can set this to something like ActiveSupport's
+[TimeZone](http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html)
+class to get full time zone support.
 
     >> Time.zone = "UTC"
     >> Chronic.time_class = Time.zone

data/lib/chronic.rb

@@ -28,7 +28,7 @@ require 'date'
 #
 # @author Tom Preston-Werner, Lee Jarvis
 module Chronic
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 
   class << self
 

data/lib/chronic/chronic.rb

@@ -17,6 +17,8 @@ module Chronic
     # will be returned (depending on the value of `:guess`). If no
     # date or time can be found, `nil` will be returned
     #
+    # @param [String] text The text to parse
+    #
     # @option opts [Symbol] :context (:future)
     #   * If your string represents a birthday, you can set `:context` to
     #     `:past` and if an ambiguous string is given, it will assume it is
@@ -57,7 +59,6 @@ module Chronic
     #
     # @return [Time, Chronic::Span, nil]
     def parse(text, opts={})
-      @text = text
       options = DEFAULT_OPTIONS.merge opts
 
       # ensure the specified options are valid

data/lib/chronic/handlers.rb

@@ -102,7 +102,7 @@ module Chronic
     def handle_sd_rmn_sy(tokens, options) #:nodoc:
       new_tokens = [tokens[1], tokens[0], tokens[2]]
       time_tokens = tokens.last(tokens.size - 3)
-      self.handle_rmn_sd_sy(new_tokens + time_tokens, options)
+      handle_rmn_sd_sy(new_tokens + time_tokens, options)
     end
 
     # Handle scalar-month/scalar-day/scalar-year (endian middle)
@@ -125,14 +125,14 @@ module Chronic
     def handle_sd_sm_sy(tokens, options) #:nodoc:
       new_tokens = [tokens[1], tokens[0], tokens[2]]
       time_tokens = tokens.last(tokens.size - 3)
-      self.handle_sm_sd_sy(new_tokens + time_tokens, options)
+      handle_sm_sd_sy(new_tokens + time_tokens, options)
     end
 
     # Handle scalar-year/scalar-month/scalar-day
     def handle_sy_sm_sd(tokens, options) #:nodoc:
       new_tokens = [tokens[1], tokens[2], tokens[0]]
       time_tokens = tokens.last(tokens.size - 3)
-      self.handle_sm_sd_sy(new_tokens + time_tokens, options)
+      handle_sm_sd_sy(new_tokens + time_tokens, options)
     end
 
     # Handle scalar-month/scalar-year
@@ -160,13 +160,13 @@ module Chronic
     # Handle repeaters
     def handle_r(tokens, options) #:nodoc:
       dd_tokens = dealias_and_disambiguate_times(tokens, options)
-      self.get_anchor(dd_tokens, options)
+      get_anchor(dd_tokens, options)
     end
 
     # Handle repeater/grabber/repeater
     def handle_r_g_r(tokens, options) #:nodoc:
       new_tokens = [tokens[1], tokens[0], tokens[2]]
-      self.handle_r(new_tokens, options)
+      handle_r(new_tokens, options)
     end
 
     # arrows
@@ -185,19 +185,19 @@ module Chronic
       repeater = tokens[1].get_tag(Repeater)
       span = Span.new(Chronic.now, Chronic.now + 1)
 
-      self.handle_srp(tokens, span, options)
+      handle_srp(tokens, span, options)
     end
 
     # Handle pointer/scalar/repeater
     def handle_p_s_r(tokens, options) #:nodoc:
       new_tokens = [tokens[1], tokens[2], tokens[0]]
-      self.handle_s_r_p(new_tokens, options)
+      handle_s_r_p(new_tokens, options)
     end
 
     # Handle scalar/repeater/pointer/anchor
     def handle_s_r_p_a(tokens, options) #:nodoc:
       anchor_span = get_anchor(tokens[3..tokens.size - 1], options)
-      self.handle_srp(tokens, anchor_span, options)
+      handle_srp(tokens, anchor_span, options)
     end
 
     # narrows
@@ -247,7 +247,7 @@ module Chronic
       grabber = Grabber.new(:this)
       pointer = :future
 
-      repeaters = self.get_repeaters(tokens)
+      repeaters = get_repeaters(tokens)
       repeaters.size.times { tokens.pop }
 
       if tokens.first && tokens.first.get_tag(Grabber)
@@ -358,18 +358,33 @@ module Chronic
 
   end
 
-  class Handler #:nodoc:
-    attr_accessor :pattern, :handler_method
+  class Handler
+    # @return [Array] A list of patterns
+    attr_accessor :pattern
 
+    # @return [Symbol] The method which handles this list of patterns.
+    #   This method should exist inside the {Handlers} module
+    attr_accessor :handler_method
+
+    # @param [Array]  pattern A list of patterns to match tokens against
+    # @param [Symbol] handler_method The method to be invoked when patterns
+    #   are matched. This method should exist inside the {Handlers} module
     def initialize(pattern, handler_method)
       @pattern = pattern
       @handler_method = handler_method
     end
 
+    # @param [#to_s]  The snake_case name representing a Chronic constant
+    # @return [Class] The class represented by `name`
+    # @raise [NameError] Raises if this constant could not be found
     def constantize(name)
       Chronic.const_get name.to_s.gsub(/(^|_)(.)/) { $2.upcase }
     end
 
+    # @param [Array] tokens
+    # @param [Hash]  definitions
+    # @return [Boolean]
+    # @see Chronic.tokens_to_span
     def match(tokens, definitions)
       token_index = 0
       @pattern.each do |element|
@@ -397,8 +412,10 @@ module Chronic
       return true
     end
 
+    # @param [Handler]  The handler to compare
+    # @return [Boolean] True if these handlers match
     def ==(other)
-      self.pattern == other.pattern
+      @pattern == other.pattern
     end
   end
 

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)

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)

data/lib/chronic/repeaters/repeater_day_portion.rb

@@ -11,7 +11,6 @@ module Chronic
 
     def initialize(type)
       super
-      @current_span = nil
 
       if type.kind_of? Integer
         @range = (@type * 60 * 60)..((@type + 12) * 60 * 60)

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)

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)

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)

data/lib/chronic/repeaters/repeater_month.rb

@@ -7,7 +7,6 @@ module Chronic
 
     def initialize(type)
       super
-      @current_month_start = nil
     end
 
     def next(pointer)

data/lib/chronic/repeaters/repeater_month_name.rb

@@ -18,7 +18,6 @@ module Chronic
 
     def initialize(type)
       super
-      @current_month_begin = nil
     end
 
     def next(pointer)

data/lib/chronic/repeaters/repeater_season.rb

@@ -1,20 +1,38 @@
 module Chronic
   class Season
-    attr_reader :start, :end
+    # @return [MiniDate]
+    attr_reader :start
 
-    def initialize(myStart, myEnd)
-      @start = myStart
-      @end = myEnd
+    # @return [MiniDate]
+    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 => 0, :summer => 1, :autumn => 2, :winter => 3}
-      next_season_num = (lookup[season]+1*pointer) % 4
+      next_season_num = (lookup[season] + 1 * pointer) % 4
       lookup.invert[next_season_num]
     end
 
-    def self.season_after(season); find_next_season(season, +1); end
-    def self.season_before(season); find_next_season(season, -1); 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
   end
 
   class RepeaterSeason < Repeater #:nodoc:
@@ -28,7 +46,6 @@ module Chronic
 
     def initialize(type)
       super
-      @next_season_start = nil
     end
 
     def next(pointer)

data/lib/chronic/repeaters/repeater_second.rb

@@ -4,7 +4,6 @@ module Chronic
 
     def initialize(type)
       super
-      @second_start = nil
     end
 
     def next(pointer = :future)

data/lib/chronic/repeaters/repeater_time.rb

@@ -27,7 +27,6 @@ module Chronic
     end
 
     def initialize(time)
-      @current_time = nil
       t = time.gsub(/\:/, '')
 
       @type =

data/lib/chronic/repeaters/repeater_week.rb

@@ -4,7 +4,6 @@ module Chronic
 
     def initialize(type)
       super
-      @current_week_start = nil
     end
 
     def next(pointer)

data/lib/chronic/repeaters/repeater_weekday.rb

@@ -13,7 +13,6 @@ module Chronic
 
     def initialize(type)
       super
-      @current_weekday_start = nil
     end
 
     def next(pointer)

data/lib/chronic/repeaters/repeater_weekend.rb

@@ -4,7 +4,6 @@ module Chronic
 
     def initialize(type)
       super
-      @current_week_start = nil
     end
 
     def next(pointer)

data/lib/chronic/repeaters/repeater_year.rb

@@ -4,7 +4,6 @@ module Chronic
 
     def initialize(type)
       super
-      @current_year_start = nil
     end
 
     def next(pointer)
@@ -45,13 +44,8 @@ module Chronic
 
     def offset(span, amount, pointer)
       direction = pointer == :future ? 1 : -1
-
-      sb = span.begin
-      new_begin = Time.construct(sb.year + (amount * direction), sb.month, sb.day, sb.hour, sb.min, sb.sec)
-
-      se = span.end
-      new_end = Time.construct(se.year + (amount * direction), se.month, se.day, se.hour, se.min, se.sec)
-
+      new_begin = build_offset_time(span.begin, amount, direction)
+      new_end   = build_offset_time(span.end, amount, direction)
       Span.new(new_begin, new_end)
     end
 
@@ -62,5 +56,22 @@ module Chronic
     def to_s
       super << '-year'
     end
+
+    private
+
+    def build_offset_time(time, amount, direction)
+      year = time.year + (amount * direction)
+      days = month_days(year, time.month)
+      day = time.day > days ? days : time.day
+      Time.construct(year, time.month, day, time.hour, time.min, time.sec)
+    end
+
+    def month_days(year, month)
+      if Date.leap?(year)
+        RepeaterMonth::MONTH_DAYS_LEAP[month - 1]
+      else
+        RepeaterMonth::MONTH_DAYS[month - 1]
+      end
+    end
   end
 end

data/lib/chronic/token.rb

@@ -14,7 +14,7 @@ module Chronic
 
     # Tag this token with the specified tag
     #
-    # @param [Tag] new_tag A instance of {Tag} or one of its subclasses
+    # @param [Tag] new_tag An instance of {Tag} or one of its subclasses
     def tag(new_tag)
       @tags << new_tag
     end

data/test/test_RepeaterYear.rb

@@ -57,6 +57,13 @@ class TestRepeaterYear < Test::Unit::TestCase
 
     assert_equal Time.local(1996, 8, 16, 14), offset_span.begin
     assert_equal Time.local(1996, 8, 16, 14, 0, 1), offset_span.end
+
+    now = Time.local(2008, 2, 29)
+    span = Chronic::Span.new(now, now + 1)
+    offset_span = Chronic::RepeaterYear.new(:year).offset(span, 1, :past)
+
+    assert_equal Time.local(2007, 2, 28), offset_span.begin
+    assert_equal Time.local(2007, 2, 28, 0, 0, 1), offset_span.end
   end
 
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: chronic
 version: !ruby/object:Gem::Version 
-  hash: 9
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 3
-  version: 0.4.3
+  prerelease: 
+  version: 0.4.4
 platform: ruby
 authors: 
 - Tom Preston-Werner
@@ -16,8 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-08 00:00:00 +01:00
-default_executable: 
+date: 2011-06-12 00:00:00 Z
 dependencies: []
 
 description: Chronic is a natural language date/time parser written in pure Ruby.
@@ -33,6 +27,7 @@ extra_rdoc_files:
 - HISTORY.md
 - LICENSE
 files: 
+- .gemtest
 - .gitignore
 - .yardopts
 - HISTORY.md
@@ -40,7 +35,6 @@ files:
 - Manifest.txt
 - README.md
 - Rakefile
-- benchmark/benchmark.rb
 - chronic.gemspec
 - lib/chronic.rb
 - lib/chronic/chronic.rb
@@ -94,7 +88,6 @@ files:
 - test/test_Time.rb
 - test/test_Token.rb
 - test/test_parsing.rb
-has_rdoc: true
 homepage: http://github.com/mojombo/chronic
 licenses: []
 
@@ -108,23 +101,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: chronic
-rubygems_version: 1.3.7
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Natural language date/time parsing.

data/benchmark/benchmark.rb

@@ -1,13 +0,0 @@
-require 'chronic'
-require 'benchmark'
-
-print "jan 3 2010:                          "
-puts Benchmark.measure { Chronic.parse("jan 3 2010") }
-
-print "7 hours before tomorrow at midnight: "
-puts Benchmark.measure { Chronic.parse("7 hours before tomorrow at midnight") }
-
-# n = 100
-# Benchmark.bm(14) do |x|
-#   x.report("jan 3 2010:")   { for i in 1..n; Chronic.parse("jan 3 2010"); end }
-# end