chronic 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7033fa51e89c8552e935aab7ee0bb5673338d063
-  data.tar.gz: 21a09efad9e8da2dcd3ed32a5c8605707f36abc7
+  metadata.gz: ce57c7b6e3bd50e021abd796f6cdbb4cad313dbc
+  data.tar.gz: 2ea7a98ce486caf4bbcf394903ee150a920ad888
 SHA512:
-  metadata.gz: f3d63e888e712dad2b0d4c70d11688607e56a3d1b4ac11632e14b3f23a57f21a2fd32403f50cf13002a9859607a89e6521b5c39f4ec003edd5631791cf7cf409
-  data.tar.gz: 9e2d80dcf087643ce865ede613dbd2d006942b1986e46c02f75b012711ee79bb74f0b576ba812d8b54ab599411213548effc036cc888c97b82c70fdf21627365
+  metadata.gz: 0737803ebaad62093afbdb8cabece3ec65f0921c174e1a0dc4869fa7c48c539e82bd01834d8ecf3b763e7692016cfc6bbe7893d5650a2ca8cfcd9df98e554012
+  data.tar.gz: c508780a3ea66dbce11b4351ed546483e30adb6cfa27c5f86dc466132f07447d0e5f13165990d7053d6015277f05464dfc5018f365b40e82e775f3bc7e5e6ba0

data/.gitignore

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

data/HISTORY.md

@@ -1,3 +1,15 @@
+# 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)

data/README.md

@@ -37,8 +37,15 @@ Chronic.parse('may 27th', :guess => false)
 
 Chronic.parse('6/4/2012', :endian_precedence => :little)
   #=> Fri Apr 06 00:00:00 PDT 2012
+
+Chronic.parse('INVALID DATE')
+  #=> nil
 ```
 
+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
@@ -128,6 +135,7 @@ 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
 
 

data/Rakefile

@@ -5,17 +5,37 @@ def version
   contents[/VERSION = "([^"]+)"/, 1]
 end
 
-task :test do
+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"
@@ -38,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,13 +8,15 @@ 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")
+  s.files = `git ls-files`.split($/)
+  s.test_files = `git ls-files -- test`.split($/)
 
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'minitest'
-end
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'minitest', '~> 5.0'
+end

data/lib/chronic.rb

@@ -2,6 +2,8 @@ require 'time'
 require 'date'
 
 require 'chronic/parser'
+require 'chronic/date'
+require 'chronic/time'
 
 require 'chronic/handler'
 require 'chronic/handlers'
@@ -14,6 +16,7 @@ require 'chronic/pointer'
 require 'chronic/scalar'
 require 'chronic/ordinal'
 require 'chronic/separator'
+require 'chronic/sign'
 require 'chronic/time_zone'
 require 'chronic/numerizer'
 require 'chronic/season'
@@ -50,7 +53,7 @@ require 'chronic/repeaters/repeater_time'
 #   Chronic.parse('monday', :context => :past)
 #     #=> Mon Aug 21 12:00:00 PDT 2006
 module Chronic
-  VERSION = "0.9.1"
+  VERSION = "0.10.0"
 
   class << self
 
@@ -72,7 +75,7 @@ module Chronic
   end
 
   self.debug = false
-  self.time_class = Time
+  self.time_class = ::Time
 
 
   # Parses a string containing a natural language date or time.
@@ -98,7 +101,7 @@ module Chronic
   # second - Integer second.
   #
   # Returns a new Time object constructed from these params.
-  def self.construct(year, month = 1, day = 1, hour = 0, minute = 0, second = 0)
+  def self.construct(year, month = 1, day = 1, hour = 0, minute = 0, second = 0, offset = nil)
     if second >= 60
       minute += second / 60
       second = second % 60
@@ -117,11 +120,8 @@ module Chronic
     # 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_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 = Date.leap?(year) ? leap_year_month_days[month - 1] : common_year_month_days[month - 1]
+    if day > 28 # no month ever has fewer than 28 days, so only do this if necessary
+      days_this_month = ::Date.leap?(year) ? Date::MONTH_DAYS_LEAP[month] : Date::MONTH_DAYS[month]
       if day > days_this_month
         month += day / days_this_month
         day = day % days_this_month
@@ -137,8 +137,8 @@ module Chronic
         month = month % 12
       end
     end
-
-    Chronic.time_class.local(year, month, day, hour, minute, second)
+    offset = Time::normalize_offset(offset) if Chronic.time_class.is_a?(DateTime)
+    Chronic.time_class.new(year, month, day, hour, minute, second, offset)
   end
 
 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/handler.rb

@@ -19,39 +19,48 @@ module Chronic
     # 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 "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 "Invalid match type: #{element.class}"
         end
+
       end
 
       return false if token_index != tokens.size

data/lib/chronic/handlers.rb

@@ -134,6 +134,8 @@ module Chronic
     def handle_generic(tokens, options)
       t = Chronic.time_class.parse(options[:text])
       Span.new(t, t + 1)
+    rescue ArgumentError => e
+      raise e unless e.message =~ /out of range/
     end
 
     # Handle repeater-month-name/scalar-day/scalar-year
@@ -304,6 +306,23 @@ module Chronic
       end
     end
 
+    # Handle RepeaterDayName RepeaterMonthName OrdinalDay ScalarYear
+    def handle_rdn_rmn_od_sy(tokens, options)
+      month = tokens[1].get_tag(RepeaterMonthName)
+      day = tokens[2].get_tag(OrdinalDay).type
+      year = tokens[3].get_tag(ScalarYear).type
+
+      return if month_overflow?(year, month.index, day)
+
+      begin
+        start_time = Chronic.time_class.local(year, month.index, day)
+        end_time = time_with_rollover(year, month.index, day + 1)
+        Span.new(start_time, end_time)
+      rescue ArgumentError
+        nil
+      end
+    end
+
     # Handle RepeaterDayName OrdinalDay
     def handle_rdn_od(tokens, options)
       day = tokens[1].get_tag(OrdinalDay).type
@@ -476,9 +495,9 @@ module Chronic
     def day_or_time(day_start, time_tokens, options)
       outer_span = Span.new(day_start, day_start + (24 * 60 * 60))
 
-      if !time_tokens.empty?
+      unless time_tokens.empty?
         self.now = outer_span.begin
-        get_anchor(dealias_and_disambiguate_times(time_tokens, options), options)
+        get_anchor(dealias_and_disambiguate_times(time_tokens, options), options.merge(:context => :future))
       else
         outer_span
       end
@@ -525,7 +544,7 @@ module Chronic
     end
 
     def month_overflow?(year, month, day)
-      if Date.leap?(year)
+      if ::Date.leap?(year)
         day > RepeaterMonth::MONTH_DAYS_LEAP[month - 1]
       else
         day > RepeaterMonth::MONTH_DAYS[month - 1]

data/lib/chronic/ordinal.rb

@@ -9,26 +9,16 @@ module Chronic
     #
     # Returns an Array of tokens.
     def self.scan(tokens, options)
-      tokens.each do |token|
-        if t = scan_for_ordinals(token) then token.tag(t) end
-        if t = scan_for_days(token) then token.tag(t) end
-      end
-    end
-
-    # token - The Token object we want to scan.
-    #
-    # Returns a new Ordinal object.
-    def self.scan_for_ordinals(token)
-      Ordinal.new($1.to_i) if token.word =~ /^(\d*)(st|nd|rd|th)$/
-    end
-
-    # token - The Token object we want to scan.
-    #
-    # Returns a new Ordinal object.
-    def self.scan_for_days(token)
-      if token.word =~ /^(\d*)(st|nd|rd|th)$/
-        unless $1.to_i > 31 || $1.to_i < 1
-          OrdinalDay.new(token.word.to_i)
+      tokens.each_index do |i|
+        if tokens[i].word =~ /^(\d+)(st|nd|rd|th|\.)$/
+            ordinal = $1.to_i
+            tokens[i].tag(Ordinal.new(ordinal))
+            tokens[i].tag(OrdinalDay.new(ordinal)) if Chronic::Date::could_be_day?(ordinal)
+            tokens[i].tag(OrdinalMonth.new(ordinal)) if Chronic::Date::could_be_month?(ordinal)
+            if Chronic::Date::could_be_year?(ordinal)
+                year = Chronic::Date::make_year(ordinal, options[:ambiguous_year_future_bias])
+                tokens[i].tag(OrdinalYear.new(year.to_i))
+            end
         end
       end
     end
@@ -44,4 +34,16 @@ module Chronic
     end
   end
 
+  class OrdinalMonth < Ordinal #:nodoc:
+    def to_s
+      super << '-month-' << @type.to_s
+    end
+  end
+
+  class OrdinalYear < Ordinal #:nodoc:
+    def to_s
+      super << '-year-' << @type.to_s
+    end
+  end
+
 end