chronic 0.3.0 → 0.4.0

data/HISTORY.md

@@ -1,3 +1,30 @@
+# 0.4.0 / 2011-06-04
+
+* Ensure context is being passed through grabbers. Now "Sunday at 2:18pm"
+  with `:context => :past` will return the correct date
+* Support parsing ordinal strings (eg first, twenty third => 1st, 23rd)
+* Seasons now ignore DST and return 00 as an hour
+* Support parsing 2 digit years and added `ambiguous_year_future_bias` option
+* Support parsing 'thurs' for Thursday
+* Fix pre_normalize() to remove periods before numerizing
+* Fix RepeaterDays to not add an extra hour in future tense. This meant
+  when parsing 'yesterday' after 11PM, Chronic would return today
+* Discard any prefixed 0 for time strings when using post noon portion
+* Gemspec updates for RubyGems deprecations
+* Ensure 0:10 is treated like 00:10
+* Ensure we load classes after setting Chronic class instance variables
+  so we can debug initialization and do assignments at compile time
+* Added a Tag.scan_for method for DRYing up some scanning code
+* Move some classes into their own files for maintainability
+* Numerizer.andition should be a private class method, make it so
+* Namespaced Numerizer, Season and MiniDate (Sascha Teske)
+* Support for Ruby 1.9 (Dave Lee, Aaron Hurley)
+* Fix `:context => :past` where parsed date is in current month (Marc Hedlund)
+* Fix undefined variable in RepeaterHour (Ryan Garver)
+* Added support for parsing 'Fourty' as another mis-spelling (Lee Reilly)
+* Added ordinal format support: ie 'February 14th, 2004' (Jeff Felchner)
+* Fix dates when working with daylight saving times Mike Mangino
+
 # 0.3.0 / 2010-10-22
 
 * Fix numerizer number combination bug (27 Oct 2006 7:30pm works now)

data/Manifest.txt

@@ -1,11 +1,16 @@
-History.txt
+HISTORY.md
+LICENSE
 Manifest.txt
-README.txt
+README.md
 Rakefile
+benchmark/benchmark.rb
+chronic.gemspec
 lib/chronic.rb
 lib/chronic/chronic.rb
 lib/chronic/grabber.rb
 lib/chronic/handlers.rb
+lib/chronic/mini_date.rb
+lib/chronic/numerizer.rb
 lib/chronic/ordinal.rb
 lib/chronic/pointer.rb
 lib/chronic/repeater.rb
@@ -22,26 +27,32 @@ lib/chronic/repeaters/repeater_season_name.rb
 lib/chronic/repeaters/repeater_second.rb
 lib/chronic/repeaters/repeater_time.rb
 lib/chronic/repeaters/repeater_week.rb
+lib/chronic/repeaters/repeater_weekday.rb
 lib/chronic/repeaters/repeater_weekend.rb
 lib/chronic/repeaters/repeater_year.rb
 lib/chronic/scalar.rb
 lib/chronic/separator.rb
+lib/chronic/span.rb
+lib/chronic/tag.rb
 lib/chronic/time_zone.rb
-lib/numerizer/numerizer.rb
-test/suite.rb
+lib/chronic/token.rb
+test/helper.rb
 test/test_Chronic.rb
+test/test_DaylightSavings.rb
 test/test_Handler.rb
 test/test_Numerizer.rb
 test/test_RepeaterDayName.rb
 test/test_RepeaterFortnight.rb
 test/test_RepeaterHour.rb
+test/test_RepeaterMinute.rb
 test/test_RepeaterMonth.rb
 test/test_RepeaterMonthName.rb
 test/test_RepeaterTime.rb
 test/test_RepeaterWeek.rb
+test/test_RepeaterWeekday.rb
 test/test_RepeaterWeekend.rb
 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

@@ -9,23 +9,26 @@ for the wide variety of formats Chronic will parse.
 
 ## INSTALLATION
 
-The best way to install Gollum is with RubyGems:
+### RubyGems
 
     $ [sudo] gem install chronic
 
+### GitHub
+
+    $ git clone git://github.com/mojombo/chronic.git
+    $ cd chronic && gem build chronic.gemspec
+    $ gem install chronic-<version>.gem
+
 
 ## USAGE
 
 You can parse strings containing a natural language date using the
-Chronic.parse method.
+`Chronic.parse` method.
 
-    require 'rubygems'
     require 'chronic'
 
     Time.now   #=> Sun Aug 27 23:18:25 PDT 2006
 
-    #---
-
     Chronic.parse('tomorrow')
       #=> Mon Aug 28 12:00:00 PDT 2006
 
@@ -44,7 +47,7 @@ Chronic.parse method.
     Chronic.parse('may 27th', :guess => false)
       #=> Sun May 27 00:00:00 PDT 2007..Mon May 28 00:00:00 PDT 2007
 
-See Chronic.parse for detailed usage instructions.
+See `Chronic.parse` for detailed usage instructions.
 
 
 ## EXAMPLES
@@ -99,12 +102,14 @@ Complex
 Specific Dates
 
 * January 5
+* February twenty first
 * dec 25
 * may 27th
 * October 2006
 * oct 06
 * jan 3 2010
 * february 14, 2004
+* february 14th, 2004
 * 3 jan 2000
 * 17 april 85
 * 5/27/1979
@@ -149,7 +154,7 @@ Support for a wider range of times is planned for a future release.
 
 If you'd like to hack on Chronic, start by forking the repo on GitHub:
 
-http://github.com/github/chronic
+https://github.com/mojombo/chronic
 
 To get all of the dependencies, install the gem first. The best way to get
 your changes merged back into core is as follows:
@@ -158,8 +163,9 @@ your changes merged back into core is as follows:
 1. Create a thoughtfully named topic branch to contain your change
 1. Hack away
 1. Add tests and make sure everything still passes by running `rake`
+1. Ensure your tests pass in multiple timezones
 1. If you are adding new functionality, document it in the README
 1. Do not change the version number, we will do that on our end
 1. If necessary, rebase your commits into logical chunks, without errors
 1. Push the branch up to GitHub
-1. Send a pull request for your branch
+1. Send a pull request for your branch

data/Rakefile

@@ -1,5 +1,3 @@
-require 'rubygems'
-require 'rake'
 require 'date'
 
 #############################################################################
@@ -17,10 +15,6 @@ def version
   line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
 end
 
-def date
-  Date.today.to_s
-end
-
 def rubyforge_project
   name
 end
@@ -70,7 +64,7 @@ end
 
 desc "Open an irb session preloaded with this library"
 task :console do
-  sh "irb -rubygems -r ./lib/#{name}.rb"
+  sh "irb -Ilib -rchronic"
 end
 
 #############################################################################
@@ -113,7 +107,7 @@ task :gemspec => :validate do
   # replace name version and date
   replace_header(head, :name)
   replace_header(head, :version)
-  replace_header(head, :date)
+
   #comment this out if your rubyforge_project has a different name
   replace_header(head, :rubyforge_project)
 

data/chronic.gemspec

@@ -1,22 +1,15 @@
 Gem::Specification.new do |s|
-  s.specification_version = 2 if s.respond_to? :specification_version=
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.rubygems_version = '1.3.5'
-
   s.name              = 'chronic'
-  s.version           = '0.3.0'
-  s.date              = '2010-10-22'
+  s.version           = '0.4.0'
   s.rubyforge_project = 'chronic'
 
   s.summary     = "Natural language date/time parsing."
   s.description = "Chronic is a natural language date/time parser written in pure Ruby."
 
-  s.authors  = ["Tom Preston-Werner"]
-  s.email    = 'tom@mojombo.com'
+  s.authors  = ["Tom Preston-Werner", "Lee Jarvis"]
+  s.email    = ['tom@mojombo.com', 'lee@jarvis.co']
   s.homepage = 'http://github.com/mojombo/chronic'
 
-  s.require_paths = %w[lib]
-
   s.rdoc_options = ["--charset=UTF-8"]
   s.extra_rdoc_files = %w[README.md HISTORY.md LICENSE]
 
@@ -33,7 +26,8 @@ Gem::Specification.new do |s|
     lib/chronic/chronic.rb
     lib/chronic/grabber.rb
     lib/chronic/handlers.rb
-    lib/chronic/numerizer/numerizer.rb
+    lib/chronic/mini_date.rb
+    lib/chronic/numerizer.rb
     lib/chronic/ordinal.rb
     lib/chronic/pointer.rb
     lib/chronic/repeater.rb
@@ -55,7 +49,10 @@ Gem::Specification.new do |s|
     lib/chronic/repeaters/repeater_year.rb
     lib/chronic/scalar.rb
     lib/chronic/separator.rb
+    lib/chronic/span.rb
+    lib/chronic/tag.rb
     lib/chronic/time_zone.rb
+    lib/chronic/token.rb
     test/helper.rb
     test/test_Chronic.rb
     test/test_DaylightSavings.rb

data/lib/chronic.rb

@@ -7,12 +7,27 @@
 #
 #=============================================================================
 
-$:.unshift File.dirname(__FILE__)     # For use/testing when no gem is installed
+module Chronic
+  VERSION = "0.4.0"
+
+  class << self
+    attr_accessor :debug
+    attr_accessor :time_class
+  end
+
+  self.debug = false
+  self.time_class = Time
+end
 
 require 'time'
+require 'date'
 
 require 'chronic/chronic'
 require 'chronic/handlers'
+require 'chronic/mini_date'
+require 'chronic/tag'
+require 'chronic/span'
+require 'chronic/token'
 
 require 'chronic/repeater'
 require 'chronic/repeaters/repeater_year'
@@ -39,19 +54,7 @@ require 'chronic/ordinal'
 require 'chronic/separator'
 require 'chronic/time_zone'
 
-require 'chronic/numerizer/numerizer'
-
-module Chronic
-  VERSION = "0.3.0"
-
-  class << self
-    attr_accessor :debug
-    attr_accessor :time_class
-  end
-
-  self.debug = false
-  self.time_class = Time
-end
+require 'chronic/numerizer'
 
 # class Time
 #   def self.construct(year, month = 1, day = 1, hour = 0, minute = 0, second = 0)
@@ -124,4 +127,8 @@ class Time
 
     Chronic.time_class.local(year, month, day, hour, minute, second)
   end
+
+  def to_minidate
+    Chronic::MiniDate.new(self.month, self.day)
+  end
 end

data/lib/chronic/chronic.rb

@@ -1,4 +1,14 @@
 module Chronic
+
+  DEFAULT_OPTIONS = {
+    :context => :future,
+    :now => nil,
+    :guess => true,
+    :ambiguous_time_range => 6,
+    :endian_precedence    => [:middle, :little],
+    :ambiguous_year_future_bias => 50
+  }
+
   class << self
 
     # Parses a string containing a natural language date or time. If the parser
@@ -38,48 +48,31 @@ module Chronic
     #     assume that means 5:00pm. If <tt>:none</tt> is given, no assumption
     #     will be made, and the first matching instance of that time will
     #     be used.
+    #
+    # [<tt>:endian_precedence</tt>]
+    #     Array (defaults to <tt>[:middle, :little]</tt>)
+    #
+    #     By default, Chronic will parse "03/04/2011" as the fourth day
+    #     of the third month. Alternatively you can tell Chronic to parse
+    #     this as the third day of the fourth month by altering the
+    #     <tt>:endian_precedence</tt> to <tt>[:little, :middle]</tt>.
     def parse(text, specified_options = {})
       @text = text
-
-      # get options and set defaults if necessary
-      default_options = {:context => :future,
-                         :now => Chronic.time_class.now,
-                         :guess => true,
-                         :ambiguous_time_range => 6,
-                         :endian_precedence => nil}
-      options = default_options.merge specified_options
-
-      # handle options that were set to nil
-      options[:context] = :future unless options[:context]
-      options[:now] = Chronic.time_class.now unless options[:context]
-      options[:ambiguous_time_range] = 6 unless options[:ambiguous_time_range]
+      options = DEFAULT_OPTIONS.merge specified_options
 
       # ensure the specified options are valid
-      specified_options.keys.each do |key|
-        default_options.keys.include?(key) || raise(InvalidArgumentException, "#{key} is not a valid option key.")
-      end
+      (specified_options.keys-DEFAULT_OPTIONS.keys).each {|key| raise(InvalidArgumentException, "#{key} is not a valid option key.")}
+
       [:past, :future, :none].include?(options[:context]) || raise(InvalidArgumentException, "Invalid value ':#{options[:context]}' for :context specified. Valid values are :past and :future.")
 
-      # store now for later =)
+      options[:now] ||= Chronic.time_class.now
       @now = options[:now]
 
       # put the text into a normal format to ease scanning
-      text = self.pre_normalize(text)
-
-      # get base tokens for each word
-      @tokens = self.base_tokenize(text)
-
-      # scan the tokens with each token scanner
-      [Repeater].each do |tokenizer|
-        @tokens = tokenizer.scan(@tokens, options)
-      end
-
-      [Grabber, Pointer, Scalar, Ordinal, Separator, TimeZone].each do |tokenizer|
-        @tokens = tokenizer.scan(@tokens)
-      end
+      text = pre_normalize(text)
 
-      # strip any non-tagged tokens
-      @tokens = @tokens.select { |token| token.tagged? }
+      # tokenize words
+      @tokens = tokenize(text, options)
 
       if Chronic.debug
         puts "+---------------------------------------------------"
@@ -87,19 +80,12 @@ module Chronic
         puts "+---------------------------------------------------"
       end
 
-      # do the heavy lifting
-      begin
-        span = self.tokens_to_span(@tokens, options)
-      rescue
-        raise
-        return nil
-      end
+      span = tokens_to_span(@tokens, options)
 
-      # guess a time within a span if required
       if options[:guess]
-        return self.guess(span)
+        guess span
       else
-        return span
+        span
       end
     end
 
@@ -109,10 +95,12 @@ module Chronic
     # ordinals (third => 3rd)
     def pre_normalize(text) #:nodoc:
       normalized_text = text.to_s.downcase
-      normalized_text = numericize_numbers(normalized_text)
       normalized_text.gsub!(/['"\.,]/, '')
+      normalized_text.gsub!(/\bsecond (of|day|month|hour|minute|second)\b/, '2nd \1')
+      normalized_text = numericize_numbers(normalized_text)
       normalized_text.gsub!(/ \-(\d{4})\b/, ' tzminus\1')
       normalized_text.gsub!(/([\/\-\,\@])/) { ' ' + $1 + ' ' }
+      normalized_text.gsub!(/\b0(\d+:\d+\s*pm?\b)/, '\1')
       normalized_text.gsub!(/\btoday\b/, 'this day')
       normalized_text.gsub!(/\btomm?orr?ow\b/, 'next day')
       normalized_text.gsub!(/\byesterday\b/, 'last day')
@@ -129,7 +117,7 @@ module Chronic
       normalized_text.gsub!(/\b\d+:?\d*[ap]\b/,'\0m')
       normalized_text.gsub!(/(\d)([ap]m|oclock)\b/, '\1 \2')
       normalized_text.gsub!(/\b(hence|after|from)\b/, 'future')
-      normalized_text = numericize_ordinals(normalized_text)
+      normalized_text
     end
 
     # Convert number words to numbers (three => 3)
@@ -137,15 +125,12 @@ module Chronic
       Numerizer.numerize(text)
     end
 
-    # Convert ordinal words to numeric ordinals (third => 3rd)
-    def numericize_ordinals(text) #:nodoc:
-      text
-    end
-
-    # Split the text on spaces and convert each word into
-    # a Token
-    def base_tokenize(text) #:nodoc:
-      text.split(' ').map { |word| Token.new(word) }
+    def tokenize(text, options) #:nodoc:
+      tokens = text.split(' ').map { |word| Token.new(word) }
+      [Repeater, Grabber, Pointer, Scalar, Ordinal, Separator, TimeZone].each do |tok|
+        tokens = tok.scan(tokens, options)
+      end
+      tokens.delete_if { |token| !token.tagged? }
     end
 
     # Guess a specific time within the given span
@@ -159,83 +144,6 @@ module Chronic
     end
   end
 
-  class Token #:nodoc:
-    attr_accessor :word, :tags
-
-    def initialize(word)
-      @word = word
-      @tags = []
-    end
-
-    # Tag this token with the specified tag
-    def tag(new_tag)
-      @tags << new_tag
-    end
-
-    # Remove all tags of the given class
-    def untag(tag_class)
-      @tags = @tags.select { |m| !m.kind_of? tag_class }
-    end
-
-    # Return true if this token has any tags
-    def tagged?
-      @tags.size > 0
-    end
-
-    # Return the Tag that matches the given class
-    def get_tag(tag_class)
-      matches = @tags.select { |m| m.kind_of? tag_class }
-      #matches.size < 2 || raise("Multiple identical tags found")
-      return matches.first
-    end
-
-    # Print this Token in a pretty way
-    def to_s
-      @word << '(' << @tags.join(', ') << ') '
-    end
-  end
-
-  # A Span represents a range of time. Since this class extends
-  # Range, you can use #begin and #end to get the beginning and
-  # ending times of the span (they will be of class Time)
-  class Span < Range
-    # Returns the width of this span in seconds
-    def width
-      (self.end - self.begin).to_i
-    end
-
-    # Add a number of seconds to this span, returning the
-    # resulting Span
-    def +(seconds)
-      Span.new(self.begin + seconds, self.end + seconds)
-    end
-
-    # Subtract a number of seconds to this span, returning the
-    # resulting Span
-    def -(seconds)
-      self + -seconds
-    end
-
-    # Prints this span in a nice fashion
-    def to_s
-      '(' << self.begin.to_s << '..' << self.end.to_s << ')'
-    end
-  end
-
-  # Tokens are tagged with subclassed instances of this class when
-  # they match specific criteria
-  class Tag #:nodoc:
-    attr_accessor :type
-
-    def initialize(type)
-      @type = type
-    end
-
-    def start=(s)
-      @now = s
-    end
-  end
-
   # Internal exception
   class ChronicPain < Exception #:nodoc: