chronic 0.4.1 → 0.6.5

data/lib/chronic.rb

@@ -1,33 +1,84 @@
-#=============================================================================
+require 'time'
+require 'date'
+
+# Parse natural language dates and times into Time or {Chronic::Span} objects
 #
-#  Name:       Chronic
-#  Author:     Tom Preston-Werner
-#  Purpose:    Parse natural language dates and times into Time or
-#              Chronic::Span objects
+# @example
+#   require 'chronic'
 #
-#=============================================================================
-
+#   Time.now   #=> Sun Aug 27 23:18:25 PDT 2006
+#
+#   Chronic.parse('tomorrow')
+#     #=> Mon Aug 28 12:00:00 PDT 2006
+#
+#   Chronic.parse('monday', :context => :past)
+#     #=> Mon Aug 21 12:00:00 PDT 2006
+#
+#   Chronic.parse('this tuesday 5:00')
+#     #=> Tue Aug 29 17:00:00 PDT 2006
+#
+#   Chronic.parse('this tuesday 5:00', :ambiguous_time_range => :none)
+#     #=> Tue Aug 29 05:00:00 PDT 2006
+#
+#   Chronic.parse('may 27th', :now => Time.local(2000, 1, 1))
+#     #=> Sat May 27 12:00:00 PDT 2000
+#
+#   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.4.1"
+  VERSION = "0.6.5"
 
   class << self
+
+    # @return [Boolean] true when debug mode is enabled
     attr_accessor :debug
+
+    # @example
+    #   require 'chronic'
+    #   require 'active_support/time'
+    #
+    #   Time.zone = 'UTC'
+    #   Chronic.time_class = Time.zone
+    #   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
     attr_accessor :time_class
+
+    # The current Time Chronic is using to base from
+    #
+    # @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]
+    attr_accessor :now
   end
 
   self.debug = false
   self.time_class = Time
 end
 
-require 'time'
-require 'date'
-
 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'
@@ -47,88 +98,14 @@ require 'chronic/repeaters/repeater_minute'
 require 'chronic/repeaters/repeater_second'
 require 'chronic/repeaters/repeater_time'
 
-require 'chronic/grabber'
-require 'chronic/pointer'
-require 'chronic/scalar'
-require 'chronic/ordinal'
-require 'chronic/separator'
-require 'chronic/time_zone'
-
-require 'chronic/numerizer'
-
-# class Time
-#   def self.construct(year, month = 1, day = 1, hour = 0, minute = 0, second = 0)
-#     # extra_seconds = second > 60 ? second - 60 : 0
-#     # extra_minutes = minute > 59 ? minute - 59 : 0
-#     # extra_hours = hour > 23 ? hour - 23 : 0
-#     # extra_days = day >
-#
-#     if month > 12
-#       if month % 12 == 0
-#         year += (month - 12) / 12
-#         month = 12
-#       else
-#         year += month / 12
-#         month = month % 12
-#       end
-#     end
-#
-#     base = Time.local(year, month)
-#     puts base
-#     offset = ((day - 1) * 24 * 60 * 60) + (hour * 60 * 60) + (minute * 60) + second
-#     puts offset.to_s
-#     date = base + offset
-#     puts date
-#     date
-#   end
-# end
-
 class Time
   def self.construct(year, month = 1, day = 1, hour = 0, minute = 0, second = 0)
-    if second >= 60
-      minute += second / 60
-      second = second % 60
-    end
-
-    if minute >= 60
-      hour += minute / 60
-      minute = minute % 60
-    end
-
-    if hour >= 24
-      day += hour / 24
-      hour = hour % 24
-    end
-
-    # determine if there is a day overflow. this is complicated by our crappy calendar
-    # system (non-constant number of days per month)
-    day <= 56 || raise("day must be no more than 56 (makes month resolution easier)")
-    if day > 28
-      # no month ever has fewer than 28 days, so only do this if necessary
-      leap_year = (year % 4 == 0) && !(year % 100 == 0)
-      leap_year_month_days = [31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
-      common_year_month_days = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
-      days_this_month = leap_year ? leap_year_month_days[month - 1] : common_year_month_days[month - 1]
-      if day > days_this_month
-        month += day / days_this_month
-        day = day % days_this_month
-      end
-    end
-
-    if month > 12
-      if month % 12 == 0
-        year += (month - 12) / 12
-        month = 12
-      else
-        year += month / 12
-        month = month % 12
-      end
-    end
-
-    Chronic.time_class.local(year, month, day, hour, minute, second)
+    warn "Chronic.construct will be deprecated in version 0.7.0. Please use Chronic.construct instead"
+    Chronic.construct(year, month, day, hour, minute, second)
   end
 
   def to_minidate
-    Chronic::MiniDate.new(self.month, self.day)
+    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,5 +1,5 @@
 unless defined? Chronic
-  $:.unshift File.expand_path('../../lib')
+  $:.unshift File.expand_path('../../lib', __FILE__)
   require 'chronic'
 end
 

data/test/test_Chronic.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class TestChronic < Test::Unit::TestCase
 
@@ -21,7 +21,7 @@ class TestChronic < Test::Unit::TestCase
 
     assert_equal :morning, tokens[1].tags[0].type
 
-    tokens = Chronic.dealias_and_disambiguate_times(tokens, {})
+    tokens = Chronic::Handlers.dealias_and_disambiguate_times(tokens, {})
 
     assert_equal :am, tokens[1].tags[0].type
     assert_equal 2, tokens.size
@@ -34,7 +34,7 @@ class TestChronic < Test::Unit::TestCase
 
     assert_equal :morning, tokens[1].tags[0].type
 
-    tokens = Chronic.dealias_and_disambiguate_times(tokens, {})
+    tokens = Chronic::Handlers.dealias_and_disambiguate_times(tokens, {})
 
     assert_equal :morning, tokens[1].tags[0].type
     assert_equal 2, tokens.size
@@ -51,4 +51,98 @@ class TestChronic < Test::Unit::TestCase
     assert_equal Time.local(2006, 11, 16), Chronic.guess(span)
   end
 
+  def test_now
+    Chronic.parse('now', :now => Time.local(2006, 01))
+    assert_equal Time.local(2006, 01), Chronic.now
+
+    Chronic.parse('now', :now => Time.local(2007, 01))
+    assert_equal Time.local(2007, 01), Chronic.now
+  end
+
+  def test_endian_definitions
+    # middle, little
+    endians = [
+      Chronic::Handler.new([:scalar_month, :separator_slash_or_dash, :scalar_day, :separator_slash_or_dash, :scalar_year, :separator_at?, 'time?'], :handle_sm_sd_sy),
+      Chronic::Handler.new([:scalar_day, :separator_slash_or_dash, :scalar_month, :separator_slash_or_dash, :scalar_year, :separator_at?, 'time?'], :handle_sd_sm_sy)
+    ]
+
+    assert_equal endians, Chronic.definitions[:endian]
+
+    defs = Chronic.definitions(:endian_precedence => :little)
+    assert_equal endians.reverse, defs[:endian]
+
+    defs = Chronic.definitions(:endian_precedence => [:little, :middle])
+    assert_equal endians.reverse, defs[:endian]
+
+    assert_raises(ArgumentError) do
+      Chronic.definitions(:endian_precedence => :invalid)
+    end
+  end
+
+  def test_passing_options
+    assert_raises(ArgumentError) do
+      Chronic.parse('now', :invalid => :option)
+    end
+
+    assert_raises(ArgumentError) do
+      Chronic.parse('now', :context => :invalid_context)
+    end
+  end
+
+  def test_debug
+    require 'stringio'
+    $stdout = StringIO.new
+    Chronic.debug = true
+
+    Chronic.parse 'now'
+    assert $stdout.string.include?('this(grabber-this)')
+  ensure
+    $stdout = STDOUT
+    Chronic.debug = false
+  end
+
+  # Chronic.construct
+
+  def test_normal
+    assert_equal Time.local(2006, 1, 2, 0, 0, 0), Chronic.construct(2006, 1, 2, 0, 0, 0)
+    assert_equal Time.local(2006, 1, 2, 3, 0, 0), Chronic.construct(2006, 1, 2, 3, 0, 0)
+    assert_equal Time.local(2006, 1, 2, 3, 4, 0), Chronic.construct(2006, 1, 2, 3, 4, 0)
+    assert_equal Time.local(2006, 1, 2, 3, 4, 5), Chronic.construct(2006, 1, 2, 3, 4, 5)
+  end
+
+  def test_second_overflow
+    assert_equal Time.local(2006, 1, 1, 0, 1, 30), Chronic.construct(2006, 1, 1, 0, 0, 90)
+    assert_equal Time.local(2006, 1, 1, 0, 5, 0), Chronic.construct(2006, 1, 1, 0, 0, 300)
+  end
+
+  def test_minute_overflow
+    assert_equal Time.local(2006, 1, 1, 1, 30), Chronic.construct(2006, 1, 1, 0, 90)
+    assert_equal Time.local(2006, 1, 1, 5), Chronic.construct(2006, 1, 1, 0, 300)
+  end
+
+  def test_hour_overflow
+    assert_equal Time.local(2006, 1, 2, 12), Chronic.construct(2006, 1, 1, 36)
+    assert_equal Time.local(2006, 1, 7), Chronic.construct(2006, 1, 1, 144)
+  end
+
+  def test_day_overflow
+    assert_equal Time.local(2006, 2, 1), Chronic.construct(2006, 1, 32)
+    assert_equal Time.local(2006, 3, 5), Chronic.construct(2006, 2, 33)
+    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
+      Chronic.construct(2006, 1, 57)
+    end
+  end
+
+  def test_month_overflow
+    assert_equal Time.local(2006, 1), Chronic.construct(2005, 13)
+    assert_equal Time.local(2005, 12), Chronic.construct(2000, 72)
+  end
+
 end

data/test/test_DaylightSavings.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class TestDaylightSavings < Test::Unit::TestCase
 

data/test/test_Handler.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class TestHandler < Test::Unit::TestCase
 
@@ -101,9 +101,4 @@ class TestHandler < Test::Unit::TestCase
     assert handler.match(tokens, Chronic.definitions)
   end
 
-  def test_constantize
-    handler = Chronic::Handler.new([], :handler)
-    assert_equal Chronic::RepeaterTime, handler.constantize(:repeater_time)
-  end
-
 end

data/test/test_MiniDate.rb

@@ -1,9 +1,9 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class TestMiniDate < Test::Unit::TestCase
   def test_valid_month
-    assert_raise(Chronic::InvalidArgumentException){ Chronic::MiniDate.new(0,12) }
-    assert_raise(Chronic::InvalidArgumentException){ Chronic::MiniDate.new(13,1) }
+    assert_raise(ArgumentError){ Chronic::MiniDate.new(0,12) }
+    assert_raise(ArgumentError){ Chronic::MiniDate.new(13,1) }
   end
   
   def test_is_between

data/test/test_Numerizer.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class ParseNumbersTest < Test::Unit::TestCase
 

data/test/test_RepeaterDayName.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class TestRepeaterDayName < Test::Unit::TestCase
 

data/test/test_RepeaterFortnight.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class TestRepeaterFortnight < Test::Unit::TestCase
 

data/test/test_RepeaterHour.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class TestRepeaterHour < Test::Unit::TestCase
 

data/test/test_RepeaterMinute.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class TestRepeaterMinute < Test::Unit::TestCase
 

data/test/test_RepeaterMonth.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class TestRepeaterMonth < Test::Unit::TestCase
 
@@ -23,6 +23,10 @@ class TestRepeaterMonth < Test::Unit::TestCase
 
     time = Chronic::RepeaterMonth.new(:month).offset_by(@now, 10, :past)
     assert_equal Time.local(2005, 10, 16, 14), time
+
+    time = Chronic::RepeaterMonth.new(:month).offset_by(Time.local(2010, 3, 29), 1, :past)
+    assert_equal 2, time.month
+    assert_equal 28, time.day
   end
 
   def test_offset

data/test/test_RepeaterMonthName.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class TestRepeaterMonthName < Test::Unit::TestCase
 

data/test/test_RepeaterSeason.rb

@@ -0,0 +1,40 @@
+require 'helper'
+
+class TestRepeaterSeason < Test::Unit::TestCase
+
+  def setup
+    @now = Time.local(2006, 8, 16, 14, 0, 0, 0)
+  end
+
+  def test_next_future
+    seasons = Chronic::RepeaterSeason.new(:season)
+    seasons.start = @now
+
+    next_season = seasons.next(:future)
+    assert_equal Time.local(2006, 9, 23), next_season.begin
+    assert_equal Time.local(2006, 12, 21), next_season.end
+  end
+
+  def test_next_past
+    seasons = Chronic::RepeaterSeason.new(:season)
+    seasons.start = @now
+
+    last_season = seasons.next(:past)
+    assert_equal Time.local(2006, 3, 20), last_season.begin
+    assert_equal Time.local(2006, 6, 20), last_season.end
+  end
+
+  def test_this
+    seasons = Chronic::RepeaterSeason.new(:season)
+    seasons.start = @now
+
+    this_season = seasons.this(:future)
+    assert_equal Time.local(2006, 8, 17), this_season.begin
+    assert_equal Time.local(2006, 9, 22), this_season.end
+
+    this_season = seasons.this(:past)
+    assert_equal Time.local(2006, 6, 21), this_season.begin
+    assert_equal Time.local(2006, 8, 16), this_season.end
+  end
+
+end

data/test/test_RepeaterTime.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class TestRepeaterTime < Test::Unit::TestCase
 

data/test/test_RepeaterWeek.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class TestRepeaterWeek < Test::Unit::TestCase
 

data/test/test_RepeaterWeekday.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class TestRepeaterWeekday < Test::Unit::TestCase
 

data/test/test_RepeaterWeekend.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class TestRepeaterWeekend < Test::Unit::TestCase
 

data/test/test_RepeaterYear.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class TestRepeaterYear < Test::Unit::TestCase
 
@@ -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

data/test/test_Span.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class TestSpan < Test::Unit::TestCase
 

data/test/test_Token.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), *%w[helper])
+require 'helper'
 
 class TestToken < Test::Unit::TestCase