chronic 0.6.3 → 0.10.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0bcdd2460eb86f8898212a9eca5e325c9aa5e61
+  data.tar.gz: d8abd19da58e28473139b8f137991cb0ee150c49
+SHA512:
+  metadata.gz: 04bfd4f32ce8f8ef6585042425ea64cc95d07998287fb16fa45b8d0a06d5dd48f8b85e6fecbf00e69101e560f21527ef6539a8994a9457357d25c2c832c7b87f
+  data.tar.gz: 87db3c22292ed9d5a22ecc84e6b14dafb2ed1c7a4c2f829873593b86b37707999adfaf43a5e0d801daffaaec9c7b599beade2d366d108c60bf2e8989998ed4b4

data/.gitignore

@@ -1,5 +1,6 @@
-pkg
 *.rbc
-rdoc
 .yardoc
-doc
+/pkg/
+/coverage/
+/doc/
+/tags/

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - jruby-19mode
+  - jruby-18mode
+  - rbx-19mode

data/HISTORY.md

@@ -1,3 +1,79 @@
+# 0.10.2 / 2013-09-09
+
+* Fix 1.8.7 support (due to be dropped in 0.11.0)
+* Bugfix for times with negative zones
+
+# 0.10.1 / 2013-08-27
+
+* Support `ActiveSupport::TimeZone` (#209, #208)
+
+# 0.10.0 / 2013-08-25
+
+* Chronic will parse subseconds correctly
+  for all supported date/time formats (#195, #198 and #200)
+* Support for date format: dd.mm.yyyy (#197)
+* Option `:hours24` to parse as 24 hour clock (#201 and #202)
+* `:guess` option allows to specify which part of Span to return.
+  (accepted values `false`,`true`,`:begin`, `:middle`, `:end`)
+* Replace `rcov` with `SimpleCov` for coverage generation
+* Add more tests
+* Various changes in codebase (#202 and #206)
+
+# 0.9.1 / 2013-02-25
+
+* Ensure Chronic strips periods from day portions (#173)
+* Properly numerize "twelfth", "twentieth" etc. (#172, James McKinney)
+* Ensure Chronic is compatible with Ruby 2.0.0 (#165, Ravil Bayramgalin)
+
+# 0.9.0 / 2012-12-21
+
+* Implement Chronic::Parser class and create an instance of this class
+  instead of leaving all data in the class level of Chronic
+* Various bug fixes
+* Add support for excel date formats (#149, @jmondo)
+* Added support for time expressions such as '10 till' or 'half
+  past two' (#146, @chicagogrooves)
+* Add support for RepeaterDayName, RepeaterMonthName,
+  Ordinal/ScalarDay and Time (#153, @kareemk)
+
+# 0.8.0 / 2012-09-16
+
+* Support parsing "<ordinal> of this month" (#109)
+* Support parsing ISO 8601 format (#115)
+* Support parsing "on <day>" without a timestamp (#117)
+* Fix time parsing regexp (#125)
+* Support time when parsing dd-mm-yyy <time> (#126)
+* Allow anchor handler to accept any separators (at, on) (#128)
+* Support parsing EXIF date format (#112)
+* Start using minitest for testing
+* Ensure periods are interpreted as colons (#81).
+* Support month/day and day/month parsing (#59).
+* Support day(scalar)-month(name)-year(scalar) (#99).
+* Handle text starting with 'a' or 'an' (#101, @steveburkett).
+* Ensure post medium timestamps are correctly formatted (#89)
+
+# 0.6.7 / 2012-01-31
+
+* Handle day, month names with scalar day and year (Joe Fiorini)
+* Ensure 31st parses correctly with day names (Joe Fiorini)
+
+# 0.6.6 / 2011-11-23
+
+* `Chronic.parse('thur')` no longer returns `nil` (@harold)
+
+# 0.6.5 / 2011-11-04
+
+* Fix bug when parsing ordinal repeaters (#73)
+* Added handler support for day_name month_name (@imme5150)
+* Fix bug when parsing strings prefixed with PM
+
+# 0.6.4 / 2011-08-08
+
+* Fixed bug where 'noon' was parsed as 00:00 rather than 12:00
+  with :ambiguous_time_range => :none (Vladimir Chernis)
+* Add support for handling '2009 May 22nd'
+* Add the ability to handle scalar-day/repeater-month-name as well as ordinals
+
 # 0.6.3 / 2011-08-01
 
 * Ensure 'thu' is parsed as Thursday for 1.8.7 generic timestamp

data/README.md

@@ -1,56 +1,54 @@
 Chronic
 =======
 
-## DESCRIPTION
-
 Chronic is a natural language date/time parser written in pure Ruby. See below
 for the wide variety of formats Chronic will parse.
 
+## Installation
 
-## INSTALLATION
-
-### RubyGems
-
-    $ [sudo] gem install chronic
+```
+$ gem install chronic
+```
 
-### GitHub
+## Usage
 
-    $ git clone git://github.com/mojombo/chronic.git
-    $ cd chronic && gem build chronic.gemspec
-    $ gem install chronic-<version>.gem
+```ruby
+require 'chronic'
 
+Time.now   #=> Sun Aug 27 23:18:25 PDT 2006
 
-## USAGE
+Chronic.parse('tomorrow')
+  #=> Mon Aug 28 12:00:00 PDT 2006
 
-You can parse strings containing a natural language date using the
-`Chronic.parse` method.
+Chronic.parse('monday', :context => :past)
+  #=> Mon Aug 21 12:00:00 PDT 2006
 
-    require 'chronic'
+Chronic.parse('this tuesday 5:00')
+  #=> Tue Aug 29 17:00:00 PDT 2006
 
-    Time.now   #=> Sun Aug 27 23:18:25 PDT 2006
+Chronic.parse('this tuesday 5:00', :ambiguous_time_range => :none)
+  #=> Tue Aug 29 05:00:00 PDT 2006
 
-    Chronic.parse('tomorrow')
-      #=> Mon Aug 28 12:00:00 PDT 2006
+Chronic.parse('may 27th', :now => Time.local(2000, 1, 1))
+  #=> Sat May 27 12:00:00 PDT 2000
 
-    Chronic.parse('monday', :context => :past)
-      #=> Mon Aug 21 12:00:00 PDT 2006
+Chronic.parse('may 27th', :guess => false)
+  #=> Sun May 27 00:00:00 PDT 2007..Mon May 28 00:00:00 PDT 2007
 
-    Chronic.parse('this tuesday 5:00')
-      #=> Tue Aug 29 17:00:00 PDT 2006
+Chronic.parse('6/4/2012', :endian_precedence => :little)
+  #=> Fri Apr 06 00:00:00 PDT 2012
 
-    Chronic.parse('this tuesday 5:00', :ambiguous_time_range => :none)
-      #=> Tue Aug 29 05:00:00 PDT 2006
+Chronic.parse('INVALID DATE')
+  #=> nil
+```
 
-    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
+If the parser can find a date or time, either a Time or Chronic::Span
+will be returned (depending on the value of `:guess`). If no
+date or time can be found, `nil` will be returned.
 
 See `Chronic.parse` for detailed usage instructions.
 
-
-## EXAMPLES
+## Examples
 
 Chronic can parse a huge variety of date and time formats. Following is a
 small sample of strings that will be properly parsed. Parsing is case
@@ -64,12 +62,17 @@ Simple
 * friday 13:00
 * mon 2:35
 * 4pm
+* 10 to 8
+* 10 past 2
+* half past 2
 * 6 in the morning
 * friday 1pm
 * sat 7 in the evening
 * yesterday
 * today
 * tomorrow
+* last week
+* next week
 * this tuesday
 * next month
 * last winter
@@ -86,6 +89,7 @@ Simple
 Complex
 
 * 3 years ago
+* a year ago
 * 5 months before now
 * 7 hours ago
 * 7 days from now
@@ -131,10 +135,11 @@ Specific Times (many of the above with an added time)
 * January 5 at 7pm
 * 22nd of june at 8am
 * 1979-05-27 05:00:00
+* 03/01/2012 07:25:09.234567
 * etc
 
 
-## TIME ZONES
+## Time Zones
 
 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
@@ -142,13 +147,14 @@ 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
-    >> Chronic.parse("June 15 2006 at 5:45 AM")
-    => Thu, 15 Jun 2006 05:45:00 UTC +00:00
-
+```
+>> Time.zone = "UTC"
+>> Chronic.time_class = Time.zone
+>> Chronic.parse("June 15 2006 at 5:45 AM")
+=> Thu, 15 Jun 2006 05:45:00 UTC +00:00
+```
 
-## LIMITATIONS
+## Limitations
 
 Chronic uses Ruby's built in Time class for all time storage and computation.
 Because of this, only times that the Time class can handle will be properly
@@ -156,20 +162,19 @@ parsed. Parsing for times outside of this range will simply return nil.
 Support for a wider range of times is planned for a future release.
 
 
-## CONTRIBUTE
+## Contribute
 
 If you'd like to hack on Chronic, start by forking the repo on GitHub:
 
 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:
+The best way to get your changes merged back into core is as follows:
 
 1. Clone down your fork
 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. Ensure your tests pass in multiple timezones. ie `TZ=utc rake` `TZ=BST rake`
 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

data/Rakefile

@@ -5,19 +5,37 @@ def version
   contents[/VERSION = "([^"]+)"/, 1]
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+def do_test
+  $:.unshift './test'
+  Dir.glob('test/test_*.rb').each { |t| require File.basename(t) }
 end
 
-desc "Generate RCov test coverage and open in your browser"
+def open_command
+  case RUBY_PLATFORM
+  when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+    'start'
+  when /darwin|mac os/
+    'open'
+  else
+    'xdg-open'
+  end
+end
+
+task :test do
+  do_test
+end
+
+desc "Generate SimpleCov test coverage and open in your browser"
 task :coverage do
-  require 'rcov'
-  sh "rm -fr coverage"
-  sh "rcov test/test_*.rb"
-  sh "open coverage/index.html"
+  require 'simplecov'
+  FileUtils.rm_rf("./coverage")
+  SimpleCov.command_name 'Unit Tests'
+  SimpleCov.at_exit do
+    SimpleCov.result.format!
+    sh "#{open_command} #{SimpleCov.coverage_path}/index.html"
+  end
+  SimpleCov.start
+  do_test
 end
 
 desc "Open an irb session preloaded with this library"
@@ -40,9 +58,9 @@ end
 
 desc "Build a gem from the gemspec"
 task :build do
-  sh "mkdir -p pkg"
+  FileUtils.mkdir_p "pkg"
   sh "gem build chronic.gemspec"
-  sh "mv chronic-#{version}.gem pkg"
+  FileUtils.mv("./chronic-#{version}.gem", "pkg")
 end
 
 task :default => :test

data/chronic.gemspec

@@ -8,10 +8,16 @@ Gem::Specification.new do |s|
   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', 'Lee Jarvis']
-  s.email    = ['tom@mojombo.com', 'lee@jarvis.co']
+  s.email    = ['tom@mojombo.com', 'ljjarvis@gmail.com']
   s.homepage = 'http://github.com/mojombo/chronic'
+  s.license = 'MIT'
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = %w[README.md HISTORY.md LICENSE]
-  s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- test`.split("\n")
-end
+  s.files = `git ls-files`.split($/)
+  s.test_files = `git ls-files -- test`.split($/)
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'minitest', '~> 5.0'
+  s.add_development_dependency 'activesupport'
+end

data/lib/chronic/date.rb

@@ -0,0 +1,82 @@
+module Chronic
+  class Date
+    YEAR_MONTHS = 12
+    MONTH_DAYS        = [nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+    MONTH_DAYS_LEAP   = [nil, 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+    YEAR_SECONDS      = 31_536_000 # 365 * 24 * 60 * 60
+    SEASON_SECONDS    =  7_862_400 #  91 * 24 * 60 * 60
+    MONTH_SECONDS     =  2_592_000 #  30 * 24 * 60 * 60
+    FORTNIGHT_SECONDS =  1_209_600 #  14 * 24 * 60 * 60
+    WEEK_SECONDS      =    604_800 #   7 * 24 * 60 * 60
+    WEEKEND_SECONDS   =    172_800 #   2 * 24 * 60 * 60
+    DAY_SECONDS       =     86_400 #       24 * 60 * 60
+    MONTHS = {
+      :january => 1,
+      :february => 2,
+      :march => 3,
+      :april => 4,
+      :may => 5,
+      :june => 6,
+      :july => 7,
+      :august => 8,
+      :september => 9,
+      :october => 10,
+      :november => 11,
+      :december => 12
+    }
+    DAYS = {
+      :sunday => 0,
+      :monday => 1,
+      :tuesday => 2,
+      :wednesday => 3,
+      :thursday => 4,
+      :friday => 5,
+      :saturday => 6
+    }
+
+    # Checks if given number could be day
+    def self.could_be_day?(day)
+      day >= 1 && day <= 31
+    end
+
+    # Checks if given number could be month
+    def self.could_be_month?(month)
+      month >= 1 && month <= 12
+    end
+
+    # Checks if given number could be year
+    def self.could_be_year?(year)
+      year >= 1 && year <= 9999
+    end
+
+    # 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:
+    #
+    #   make_year(96, 50) #=> 1996
+    #   make_year(79, 20) #=> 2079
+    #   make_year(00, 50) #=> 2000
+    #
+    # 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
+      century = (start_year / 100) * 100
+      full_year = century + year
+      full_year += 100 if full_year < start_year
+      full_year
+    end
+
+    def self.month_overflow?(year, month, day)
+      if ::Date.leap?(year)
+        day > Date::MONTH_DAYS_LEAP[month]
+      else
+        day > Date::MONTH_DAYS[month]
+      end
+    end
+
+  end
+end

data/lib/chronic/grabber.rb

@@ -1,20 +1,22 @@
 module Chronic
   class Grabber < Tag
 
-    # Scan an Array of {Token}s and apply any necessary Grabber tags to
-    # each token
+    # Scan an Array of Tokens and apply any necessary Grabber 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 Token objects to scan.
+    # options - The Hash of options specified in Chronic::parse.
+    #
+    # Returns an Array of Token objects.
     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 [Grabber, nil]
+    # token - The Token object to scan.
+    #
+    # Returns a new Grabber object.
     def self.scan_for_all(token)
       scan_for token, self,
       {

data/lib/chronic/handler.rb

@@ -1,77 +1,84 @@
 module Chronic
   class Handler
 
-    # @return [Array] A list of patterns
     attr_reader :pattern
 
-    # @return [Symbol] The method which handles this list of patterns.
-    #   This method should exist inside the {Handlers} module
     attr_reader :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
+    # pattern        - An Array of patterns to match tokens against.
+    # handler_method - A Symbol representing the method to be invoked
+    #   when a pattern matches.
     def initialize(pattern, handler_method)
       @pattern = pattern
       @handler_method = handler_method
     end
 
-    # @param [Array] tokens
-    # @param [Hash]  definitions
-    # @return [Boolean]
-    # @see Chronic.tokens_to_span
+    # tokens - An Array of tokens to process.
+    # definitions - A Hash of definitions to check against.
+    #
+    # Returns true if a match is found.
     def match(tokens, definitions)
       token_index = 0
+      @pattern.each do |elements|
+        was_optional = false
+        elements = [elements] unless elements.is_a?(Array)
+
+        elements.each_index do |i|
+          name = elements[i].to_s
+          optional = name[-1, 1] == '?'
+          name = name.chop if optional
+
+          case elements[i]
+          when Symbol
+            if tags_match?(name, tokens, token_index)
+              token_index += 1
+              break
+            else
+              if optional
+                was_optional = true
+                next
+              elsif i + 1 < elements.count
+                next
+              else
+                return false unless was_optional
+              end
+            end
 
-      @pattern.each do |element|
-        name = element.to_s
-        optional = name[-1, 1] == '?'
-        name = name.chop if optional
+          when String
+            return true if optional && token_index == tokens.size
 
-        case element
-        when Symbol
-          if tags_match?(name, tokens, token_index)
-            token_index += 1
-            next
-          else
-            if optional
-              next
+            if definitions.key?(name.to_sym)
+              sub_handlers = definitions[name.to_sym]
             else
-              return false
+              raise "Invalid subset #{name} specified"
             end
-          end
-        when String
-          return true if optional && token_index == tokens.size
 
-          if definitions.key?(name.to_sym)
-            sub_handlers = definitions[name.to_sym]
+            sub_handlers.each do |sub_handler|
+              return true if sub_handler.match(tokens[token_index..tokens.size], definitions)
+            end
           else
-            raise ChronicPain, "Invalid subset #{name} specified"
-          end
-
-          sub_handlers.each do |sub_handler|
-            return true if sub_handler.match(tokens[token_index..tokens.size], definitions)
+            raise "Invalid match type: #{elements[i].class}"
           end
-        else
-          raise ChronicPain, "Invalid match type: #{element.class}"
         end
+
       end
 
       return false if token_index != tokens.size
       return true
     end
 
-    def invoke(type, tokens, options)
+    def invoke(type, tokens, parser, options)
       if Chronic.debug
         puts "-#{type}"
         puts "Handler: #{@handler_method}"
       end
 
-      Handlers.send(@handler_method, tokens, options)
+      parser.send(@handler_method, tokens, options)
     end
 
-    # @param [Handler]  The handler to compare
-    # @return [Boolean] True if these handlers match
+    # other - The other Handler object to compare.
+    #
+    # Returns true if these Handlers match.
     def ==(other)
       @pattern == other.pattern
     end
@@ -87,4 +94,4 @@ module Chronic
     end
 
   end
-end
+end