chronic 0.6.2 → 0.7.0

data/lib/chronic.rb

@@ -1,9 +1,10 @@
 require 'time'
 require 'date'
 
-# Parse natural language dates and times into Time or {Chronic::Span} objects
+# Parse natural language dates and times into Time or Chronic::Span objects.
+#
+# Examples:
 #
-# @example
 #   require 'chronic'
 #
 #   Time.now   #=> Sun Aug 27 23:18:25 PDT 2006
@@ -25,17 +26,16 @@ require 'date'
 #
 #   Chronic.parse('may 27th', :guess => false)
 #     #=> Sun May 27 00:00:00 PDT 2007..Mon May 28 00:00:00 PDT 2007
-#
-# @author Tom Preston-Werner, Lee Jarvis
 module Chronic
-  VERSION = "0.6.2"
+  VERSION = "0.7.0"
 
   class << self
 
-    # @return [Boolean] true when debug mode is enabled
+    # Returns true when debug mode is enabled.
     attr_accessor :debug
 
-    # @example
+    # Examples:
+    #
     #   require 'chronic'
     #   require 'active_support/time'
     #
@@ -44,63 +44,68 @@ module Chronic
     #   Chronic.parse('June 15 2006 at 5:54 AM')
     #     # => Thu, 15 Jun 2006 05:45:00 UTC +00:00
     #
-    # @return [Time] The time class Chronic uses internally
+    # Returns The Time class Chronic uses internally.
     attr_accessor :time_class
 
-    # The current Time Chronic is using to base from
+    # The current Time Chronic is using to base from.
+    #
+    # Examples:
     #
-    # @example
     #   Time.now #=> 2011-06-06 14:13:43 +0100
     #   Chronic.parse('yesterday') #=> 2011-06-05 12:00:00 +0100
     #
     #   now = Time.local(2025, 12, 24)
     #   Chronic.parse('tomorrow', :now => now) #=> 2025-12-25 12:00:00 +0000
     #
-    # @return [Time, nil]
+    # Returns a Time object.
     attr_accessor :now
   end
 
   self.debug = false
   self.time_class = Time
+
+  autoload :Handler, 'chronic/handler'
+  autoload :Handlers, 'chronic/handlers'
+  autoload :MiniDate, 'chronic/mini_date'
+  autoload :Tag, 'chronic/tag'
+  autoload :Span, 'chronic/span'
+  autoload :Token, 'chronic/token'
+  autoload :Grabber, 'chronic/grabber'
+  autoload :Pointer, 'chronic/pointer'
+  autoload :Scalar, 'chronic/scalar'
+  autoload :Ordinal, 'chronic/ordinal'
+  autoload :OrdinalDay, 'chronic/ordinal'
+  autoload :Separator, 'chronic/separator'
+  autoload :TimeZone, 'chronic/time_zone'
+  autoload :Numerizer, 'chronic/numerizer'
+  autoload :Season, 'chronic/season'
+
+  autoload :Repeater, 'chronic/repeater'
+  autoload :RepeaterYear, 'chronic/repeaters/repeater_year'
+  autoload :RepeaterSeason, 'chronic/repeaters/repeater_season'
+  autoload :RepeaterSeasonName, 'chronic/repeaters/repeater_season_name'
+  autoload :RepeaterMonth, 'chronic/repeaters/repeater_month'
+  autoload :RepeaterMonthName, 'chronic/repeaters/repeater_month_name'
+  autoload :RepeaterFortnight, 'chronic/repeaters/repeater_fortnight'
+  autoload :RepeaterWeek, 'chronic/repeaters/repeater_week'
+  autoload :RepeaterWeekend, 'chronic/repeaters/repeater_weekend'
+  autoload :RepeaterWeekday, 'chronic/repeaters/repeater_weekday'
+  autoload :RepeaterDay, 'chronic/repeaters/repeater_day'
+  autoload :RepeaterDayName, 'chronic/repeaters/repeater_day_name'
+  autoload :RepeaterDayPortion, 'chronic/repeaters/repeater_day_portion'
+  autoload :RepeaterHour, 'chronic/repeaters/repeater_hour'
+  autoload :RepeaterMinute, 'chronic/repeaters/repeater_minute'
+  autoload :RepeaterSecond, 'chronic/repeaters/repeater_second'
+  autoload :RepeaterTime, 'chronic/repeaters/repeater_time'
+
 end
 
 require 'chronic/chronic'
-require 'chronic/handler'
-require 'chronic/handlers'
-require 'chronic/mini_date'
-require 'chronic/tag'
-require 'chronic/span'
-require 'chronic/token'
-require 'chronic/grabber'
-require 'chronic/pointer'
-require 'chronic/scalar'
-require 'chronic/ordinal'
-require 'chronic/separator'
-require 'chronic/time_zone'
-require 'chronic/numerizer'
-require 'chronic/season'
-
-require 'chronic/repeater'
-require 'chronic/repeaters/repeater_year'
-require 'chronic/repeaters/repeater_season'
-require 'chronic/repeaters/repeater_season_name'
-require 'chronic/repeaters/repeater_month'
-require 'chronic/repeaters/repeater_month_name'
-require 'chronic/repeaters/repeater_fortnight'
-require 'chronic/repeaters/repeater_week'
-require 'chronic/repeaters/repeater_weekend'
-require 'chronic/repeaters/repeater_weekday'
-require 'chronic/repeaters/repeater_day'
-require 'chronic/repeaters/repeater_day_name'
-require 'chronic/repeaters/repeater_day_portion'
-require 'chronic/repeaters/repeater_hour'
-require 'chronic/repeaters/repeater_minute'
-require 'chronic/repeaters/repeater_second'
-require 'chronic/repeaters/repeater_time'
 
 class Time
+
   def self.construct(year, month = 1, day = 1, hour = 0, minute = 0, second = 0)
-    warn "Chronic.construct will be deprecated in version 0.7.0. Please use Chronic.construct instead"
+    warn "Time.construct will be deprecated in version 0.7.0. Please use Chronic.construct instead"
     Chronic.construct(year, month, day, hour, minute, second)
   end
 
@@ -108,4 +113,5 @@ class Time
     warn "Time.to_minidate will be deprecated in version 0.7.0. Please use Chronic::MiniDate.from_time(time) instead"
     Chronic::MiniDate.from_time(self)
   end
+
 end

data/test/helper.rb

@@ -1,6 +1,12 @@
 unless defined? Chronic
-  $:.unshift File.expand_path('../../lib')
+  $:.unshift File.expand_path('../../lib', __FILE__)
   require 'chronic'
 end
 
-require 'test/unit'
+require 'minitest/autorun'
+
+class TestCase < MiniTest::Unit::TestCase
+  def self.test(name, &block)
+    define_method("test_#{name.gsub(/\W/, '_')}", &block) if block
+  end
+end

data/test/{test_Chronic.rb → test_chronic.rb}

@@ -1,12 +1,16 @@
 require 'helper'
 
-class TestChronic < Test::Unit::TestCase
+class TestChronic < TestCase
 
   def setup
     # Wed Aug 16 14:00:00 UTC 2006
     @now = Time.local(2006, 8, 16, 14, 0, 0, 0)
   end
 
+  def test_pre_normalize
+    assert_equal Chronic.pre_normalize('12:55 pm'), Chronic.pre_normalize('12.55 pm')
+  end
+
   def test_pre_normalize_numerized_string
     string = 'two and a half years'
     assert_equal Chronic::Numerizer.numerize(string), Chronic.pre_normalize(string)
@@ -131,11 +135,7 @@ class TestChronic < Test::Unit::TestCase
     assert_equal Time.local(2004, 3, 4), Chronic.construct(2004, 2, 33)
     assert_equal Time.local(2000, 3, 4), Chronic.construct(2000, 2, 33)
 
-    assert_nothing_raised do
-      Chronic.construct(2006, 1, 56)
-    end
-
-    assert_raise(RuntimeError) do
+    assert_raises(RuntimeError) do
       Chronic.construct(2006, 1, 57)
     end
   end

data/test/{test_DaylightSavings.rb → test_daylight_savings.rb}

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestDaylightSavings < Test::Unit::TestCase
+class TestDaylightSavings < TestCase
 
   def setup
     @begin_daylight_savings = Time.local(2008, 3, 9, 5, 0, 0, 0)

data/test/{test_Handler.rb → test_handler.rb}

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestHandler < Test::Unit::TestCase
+class TestHandler < TestCase
 
   def setup
     # Wed Aug 16 14:00:00 UTC 2006

data/test/{test_MiniDate.rb → test_mini_date.rb}

@@ -1,32 +1,32 @@
 require 'helper'
 
-class TestMiniDate < Test::Unit::TestCase
+class TestMiniDate < TestCase
   def test_valid_month
-    assert_raise(ArgumentError){ Chronic::MiniDate.new(0,12) }
-    assert_raise(ArgumentError){ Chronic::MiniDate.new(13,1) }
+    assert_raises(ArgumentError){ Chronic::MiniDate.new(0,12) }
+    assert_raises(ArgumentError){ Chronic::MiniDate.new(13,1) }
   end
-  
+
   def test_is_between
     m=Chronic::MiniDate.new(3,2)
     assert m.is_between?(Chronic::MiniDate.new(2,4), Chronic::MiniDate.new(4,7))
-    assert !m.is_between?(Chronic::MiniDate.new(1,5), Chronic::MiniDate.new(2,7))    
-    
+    assert !m.is_between?(Chronic::MiniDate.new(1,5), Chronic::MiniDate.new(2,7))
+
     #There was a hang if date tested is in december and outside the testing range
     m=Chronic::MiniDate.new(12,24)
     assert !m.is_between?(Chronic::MiniDate.new(10,1), Chronic::MiniDate.new(12,21))
   end
-  
+
   def test_is_between_short_range
     m=Chronic::MiniDate.new(5,10)
     assert m.is_between?(Chronic::MiniDate.new(5,3), Chronic::MiniDate.new(5,12))
     assert !m.is_between?(Chronic::MiniDate.new(5,11), Chronic::MiniDate.new(5,15))
   end
-  
+
   def test_is_between_wrapping_range
     m=Chronic::MiniDate.new(1,1)
     assert m.is_between?(Chronic::MiniDate.new(11,11), Chronic::MiniDate.new(2,2))
     m=Chronic::MiniDate.new(12,12)
     assert m.is_between?(Chronic::MiniDate.new(11,11), Chronic::MiniDate.new(1,5))
   end
-  
+
 end

data/test/{test_Numerizer.rb → test_numerizer.rb}

@@ -1,6 +1,6 @@
 require 'helper'
 
-class ParseNumbersTest < Test::Unit::TestCase
+class ParseNumbersTest < TestCase
 
   def test_straight_parsing
     strings = {

data/test/test_parsing.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestParsing < Test::Unit::TestCase
+class TestParsing < TestCase
   # Wed Aug 16 14:00:00 UTC 2006
   TIME_2006_08_16_14_00_00 = Time.local(2006, 8, 16, 14, 0, 0, 0)
 
@@ -76,6 +76,22 @@ class TestParsing < Test::Unit::TestCase
     assert_equal Time.local(2006, 12, 11, 8), time
   end
 
+  def test_handle_sy_rmn_od
+    time = parse_now("2009 May 22nd")
+    assert_equal Time.local(2009, 05, 22, 12), time
+  end
+
+  def test_handle_sd_rmn
+    time = parse_now("22 February")
+    assert_equal Time.local(2007, 2, 22, 12), time
+
+    time = parse_now("31 of may at 6:30pm")
+    assert_equal Time.local(2007, 5, 31, 18, 30), time
+
+    time = parse_now("11 december 8am")
+    assert_equal Time.local(2006, 12, 11, 8), time
+  end
+
   def test_handle_rmn_od_on
     time = parse_now("5:00 pm may 27th", :context => :past)
     assert_equal Time.local(2006, 5, 27, 17), time
@@ -222,6 +238,9 @@ class TestParsing < Test::Unit::TestCase
     time = parse_now("7/12/11", :endian_precedence => :little)
     assert_equal Time.local(2011, 12, 7, 12), time
 
+    time = parse_now("9/19/2011 6:05:57 PM")
+    assert_equal Time.local(2011, 9, 19, 18, 05, 57), time
+
     # month day overflows
     time = parse_now("30/2/2000")
     assert_nil time
@@ -233,6 +252,9 @@ class TestParsing < Test::Unit::TestCase
 
     time = parse_now("27/5/1979 @ 0700")
     assert_equal Time.local(1979, 5, 27, 7), time
+
+    time = parse_now("03/18/2012 09:26 pm")
+    assert_equal Time.local(2012, 3, 18, 21, 26), time
   end
 
   def test_handle_sy_sm_sd
@@ -259,19 +281,34 @@ class TestParsing < Test::Unit::TestCase
 
     time = parse_now("1902-08-20")
     assert_equal Time.local(1902, 8, 20, 12, 0, 0), time
+
+    # exif date time original
+    time = parse_now("2012:05:25 22:06:50")
+    assert_equal Time.local(2012, 5, 25, 22, 6, 50), time
   end
 
-  def test_handle_sm_sy
+  def test_handle_sm_sd
     time = parse_now("05/06")
-    assert_equal Time.local(2006, 5, 16, 12), time
+    assert_equal Time.local(2006, 5, 6, 12), time
 
-    time = parse_now("12/06")
-    assert_equal Time.local(2006, 12, 16, 12), time
+    time = parse_now("05/06", :endian_precedence => [:little, :medium])
+    assert_equal Time.local(2006, 6, 5, 12), time
 
-    time = parse_now("13/06")
-    assert_equal nil, time
+    time = parse_now("13/01")
+    assert_nil time
   end
 
+  # def test_handle_sm_sy
+  #   time = parse_now("05/06")
+  #   assert_equal Time.local(2006, 5, 16, 12), time
+  #
+  #   time = parse_now("12/06")
+  #   assert_equal Time.local(2006, 12, 16, 12), time
+  #
+  #   time = parse_now("13/06")
+  #   assert_equal nil, time
+  # end
+
   def test_handle_r
   end
 
@@ -291,6 +328,19 @@ class TestParsing < Test::Unit::TestCase
   end
 
   def test_handle_orr
+    time = parse_now("5th tuesday in january")
+    assert_equal Time.local(2007, 01, 30, 12), time
+
+    time = parse_now("5th tuesday in february")
+    assert_equal nil, time
+
+    %W(jan feb march april may june july aug sep oct nov dec).each_with_index do |month, index|
+      time = parse_now("5th tuesday in #{month}")
+
+      if time then
+        assert_equal time.month, index+1
+      end
+    end
   end
 
   def test_handle_o_r_s_r
@@ -322,6 +372,11 @@ class TestParsing < Test::Unit::TestCase
     assert_equal Time.local(2006, 8, 9, 12), time
   end
 
+  def test_handle_sm_rmn_sy
+    time = parse_now('30-Mar-11')
+    assert_equal Time.local(2011, 3, 30, 12), time
+  end
+
   # end of testing handlers
 
   def test_parse_guess_r
@@ -417,11 +472,11 @@ class TestParsing < Test::Unit::TestCase
   def test_parse_guess_gr
     # year
 
-    time = parse_now("this year")
-    assert_equal Time.local(2006, 10, 24, 12, 30), time
+    time = parse_now("this year", :guess => false)
+    assert_equal Time.local(2006, 8, 17), time.begin
 
-    time = parse_now("this year", :context => :past)
-    assert_equal Time.local(2006, 4, 24, 12, 30), time
+    time = parse_now("this year", :context => :past, :guess => false)
+    assert_equal Time.local(2006, 1, 1), time.begin
 
     # month
 
@@ -507,6 +562,34 @@ class TestParsing < Test::Unit::TestCase
     time = parse_now("last wed")
     assert_equal Time.local(2006, 8, 9, 12), time
 
+    monday = Time.local(2006, 8, 21, 12)
+    assert_equal monday, parse_now("mon")
+    assert_equal monday, parse_now("mun")
+
+    tuesday = Time.local(2006, 8, 22, 12)
+    assert_equal tuesday, parse_now("tue")
+    assert_equal tuesday, parse_now("tus")
+
+    wednesday = Time.local(2006, 8, 23, 12)
+    assert_equal wednesday, parse_now("wed")
+    assert_equal wednesday, parse_now("wenns")
+
+    thursday = Time.local(2006, 8, 17, 12)
+    assert_equal thursday, parse_now("thu")
+    assert_equal thursday, parse_now("thur")
+
+    friday = Time.local(2006, 8, 18, 12)
+    assert_equal friday, parse_now("fri")
+    assert_equal friday, parse_now("fry")
+
+    saturday = Time.local(2006, 8, 19, 12)
+    assert_equal saturday, parse_now("sat")
+    assert_equal saturday, parse_now("satterday")
+
+    sunday = Time.local(2006, 8, 20, 12)
+    assert_equal sunday, parse_now("sun")
+    assert_equal sunday, parse_now("sum")
+
     # day portion
 
     time = parse_now("this morning")
@@ -515,13 +598,33 @@ class TestParsing < Test::Unit::TestCase
     time = parse_now("tonight")
     assert_equal Time.local(2006, 8, 16, 22), time
 
+    # hour
+
+    time = parse_now("next hr")
+    assert_equal Time.local(2006, 8, 16, 15, 30, 0), time
+
+    time = parse_now("next hrs")
+    assert_equal Time.local(2006, 8, 16, 15, 30, 0), time
+
     # minute
 
+    time = parse_now("next min")
+    assert_equal Time.local(2006, 8, 16, 14, 1, 30), time
+
+    time = parse_now("next mins")
+    assert_equal Time.local(2006, 8, 16, 14, 1, 30), time
+
     time = parse_now("next minute")
     assert_equal Time.local(2006, 8, 16, 14, 1, 30), time
 
     # second
 
+    time = parse_now("next sec")
+    assert_equal Time.local(2006, 8, 16, 14, 0, 1), time
+
+    time = parse_now("next secs")
+    assert_equal Time.local(2006, 8, 16, 14, 0, 1), time
+
     time = parse_now("this second")
     assert_equal Time.local(2006, 8, 16, 14), time
 
@@ -614,6 +717,20 @@ class TestParsing < Test::Unit::TestCase
     assert_equal Time.local(2006, 8, 8, 12), time
   end
 
+  def test_parse_guess_a_ago
+    time = parse_now("AN hour ago")
+    assert_equal Time.local(2006, 8, 16, 13), time
+
+    time = parse_now("A day ago")
+    assert_equal Time.local(2006, 8, 15, 14), time
+
+    time = parse_now("a month ago")
+    assert_equal Time.local(2006, 7, 16, 14), time
+
+    time = parse_now("a year ago")
+    assert_equal Time.local(2005, 8, 16, 14), time
+  end
+
   def test_parse_guess_s_r_p
     # past
 
@@ -776,6 +893,7 @@ class TestParsing < Test::Unit::TestCase
     assert_equal parse_now("33 days from now"), parse_now("thirty-three days from now")
     assert_equal parse_now("2867532 seconds from now"), parse_now("two million eight hundred and sixty seven thousand five hundred and thirty two seconds from now")
     assert_equal parse_now("may 10th"), parse_now("may tenth")
+    assert_equal parse_now("second monday in january"), parse_now("2nd monday in january")
   end
 
   def test_parse_only_complete_pointers
@@ -795,11 +913,11 @@ class TestParsing < Test::Unit::TestCase
   end
 
   def test_argument_validation
-    assert_raise(ArgumentError) do
+    assert_raises(ArgumentError) do
       time = Chronic.parse("may 27", :foo => :bar)
     end
 
-    assert_raise(ArgumentError) do
+    assert_raises(ArgumentError) do
       time = Chronic.parse("may 27", :context => :bar)
     end
   end
@@ -855,7 +973,48 @@ class TestParsing < Test::Unit::TestCase
     t1 = Chronic.parse("now")
     sleep 0.1
     t2 = Chronic.parse("now")
-    assert_not_equal t1, t2
+    refute_equal t1, t2
+  end
+
+  def test_noon
+    t1 = Chronic.parse('2011-01-01 at noon', :ambiguous_time_range => :none)
+    assert_equal Time.local(2011, 1, 1, 12, 0), t1
+  end
+
+  def test_handle_rdn_rmn_sd
+    time = parse_now("Thu Aug 10")
+    assert_equal Time.local(2006, 8, 10, 12), time
+
+    time = parse_now("Thursday July 31")
+    assert_equal Time.local(2006, 7, 31, 12), time
+
+    time = parse_now("Thursday December 31")
+    assert_equal Time.local(2006, 12, 31, 12), time
+  end
+
+  def test_handle_rdn_rmn_sd_sy
+    time = parse_now("Thu Aug 10 2006")
+    assert_equal Time.local(2006, 8, 10, 12), time
+
+    time = parse_now("Thursday July 31 2006")
+    assert_equal Time.local(2006, 7, 31, 12), time
+
+    time = parse_now("Thursday December 31 2006")
+    assert_equal Time.local(2006, 12, 31, 12), time
+
+    time = parse_now("Thursday December 30 2006")
+    assert_equal Time.local(2006, 12, 30, 12), time
+  end
+
+  def test_handle_rdn_rmn_od
+    time = parse_now("Thu Aug 10th")
+    assert_equal Time.local(2006, 8, 10, 12), time
+
+    time = parse_now("Thursday July 31st")
+    assert_equal Time.local(2006, 7, 31, 12), time
+
+    time = parse_now("Thursday December 31st")
+    assert_equal Time.local(2006, 12, 31, 12), time
   end
 
   private

data/test/{test_RepeaterDayName.rb → test_repeater_day_name.rb}

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestRepeaterDayName < Test::Unit::TestCase
+class TestRepeaterDayName < TestCase
 
   def setup
     @now = Time.local(2006, 8, 16, 14, 0, 0, 0)