chronic_duration 0.8.1 → 0.9.0

data/README.rdoc

@@ -38,10 +38,19 @@ Examples of parse-able strings:
 * '6 mos 1 day'
 * '47 yrs 6 mos and 4d'
 * 'two hours and twenty minutes'
+* '3 weeks and 2 days'
+
+ChronicDuration.raise_exceptions can be set to true to raise exceptions when the string can't be parsed.
+
+    >> ChronicDuration.raise_exceptions = true
+    => true
+    >> ChronicDuration.parse('4 elephants and 3 Astroids')
+    ChronicDuration::DurationParseError: An invalid word "elephants" was used in the string to be parsed.
+
     
 == Contributors
 
-jduff, olauzon
+brianjlandau, jduff, olauzon
     
 == TODO
 
@@ -49,4 +58,4 @@ jduff, olauzon
 * Context specific matching (E.g., for '4m30s', assume 'm' is minutes not months)
 * Smartly parse vacation-like durations (E.g., '4 days and 3 nights')
 * :chrono output option should probably change to something like 4 days 4:00:12 instead of 4:04:00:12
-* Other locale support
+* Other locale support

data/Rakefile

@@ -43,7 +43,7 @@ Rake::RDocTask.new do |rdoc|
   end
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "my-gem #{version}"
+  rdoc.title = "chronic_duration #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -1 +1 @@
-0.8.1
+0.9.0

data/chronic_duration.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chronic_duration}
-  s.version = "0.8.1"
+  s.version = "0.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["hpoydar"]
-  s.date = %q{2010-01-01}
+  s.date = %q{2010-01-28}
   s.description = %q{A simple Ruby natural language parser for elapsed time. (For example, 4 hours and 30 minutes, 6 minutes 4 seconds, 3 days, etc.) Returns all results in seconds. Will return an integer unless you get tricky and need a float. (4 minutes and 13.47 seconds, for example.) The reverse can also be performed via the output method.}
   s.email = %q{hpoydar@gmail.com}
   s.extra_rdoc_files = [

data/lib/chronic_duration.rb

@@ -2,6 +2,19 @@ require 'numerizer'
 module ChronicDuration
   extend self
   
+  class DurationParseError < StandardError
+  end
+  
+  @@raise_exceptions = false
+  
+  def self.raise_exceptions
+    !!@@raise_exceptions
+  end
+  
+  def self.raise_exceptions=(value)
+    @@raise_exceptions = !!value
+  end
+  
   # Given a string representation of elapsed time,
   # return an integer (or float, if fractions of a
   # second are input)
@@ -166,7 +179,12 @@ private
         res << word.strip
         next
       end
-      res << mappings[word.strip] if mappings.has_key?(word.strip)
+      stripped_word = word.strip.gsub(/^,/, '').gsub(/,$/, '')
+      if mappings.has_key?(stripped_word)
+        res << mappings[stripped_word]
+      elsif !join_words.include?(stripped_word) and ChronicDuration.raise_exceptions
+        raise DurationParseError, "An invalid word #{word.inspect} was used in the string to be parsed."
+      end
     end
     res.join(' ')
   end
@@ -192,6 +210,9 @@ private
       'day'     => 'days',
       'dy'      => 'days',
       'd'       => 'days',
+      'weeks'   => 'weeks',
+      'week'    => 'weeks',
+      'w'       => 'weeks',
       'months'  => 'months',
       'mos'     => 'months',
       'years'   => 'years',
@@ -200,6 +221,10 @@ private
     }
   end
   
+  def join_words
+    ['and', 'with', 'plus']
+  end
+  
   def white_list
     self.mappings.map {|k, v| k}
   end

data/spec/chronic_duration_spec.rb

@@ -16,13 +16,22 @@ describe ChronicDuration, '.parse' do
     '47 yrs 6 mos and 4.5d' => 47 * 31557600 + 6 * 30 * 24 * 3600 + 4.5 * 24 * 3600,
     'two hours and twenty minutes' => 2 * 3600 + 20 * 60,
     'four hours and forty minutes' => 4 * 3600 + 40 * 60,
-    'four hours and fourty minutes' => 4 * 3600 + 40 * 60
+    'four hours, and fourty minutes' => 4 * 3600 + 40 * 60,
+    '3 weeks and, 2 days' => 3600 * 24 * 7 * 3 + 3600 * 24 * 2,
+    '3 weeks, plus 2 days' => 3600 * 24 * 7 * 3 + 3600 * 24 * 2,
+    '3 weeks with 2 days' => 3600 * 24 * 7 * 3 + 3600 * 24 * 2
   }
   
   it "should return nil if the string can't be parsed" do
     ChronicDuration.parse('gobblygoo').should be_nil
   end
   
+  it "should raise an exception if the string can't be parsed and @@raise_exceptions is set to true" do
+    ChronicDuration.raise_exceptions = true
+    lambda { ChronicDuration.parse('23 gobblygoos') }.should raise_exception(ChronicDuration::DurationParseError)
+    ChronicDuration.raise_exceptions = false
+  end
+  
   it "should return a float if seconds are in decimals" do
     ChronicDuration.parse('12 mins 3.141 seconds').is_a?(Float).should be_true
   end
@@ -31,6 +40,8 @@ describe ChronicDuration, '.parse' do
     ChronicDuration.parse('12 mins 3 seconds').is_a?(Integer).should be_true
   end
   
+  
+  
   @exemplars.each do |k, v|
     it "should properly parse a duration like #{k}" do
       ChronicDuration.parse(k).should == v

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: chronic_duration
 version: !ruby/object:Gem::Version 
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors: 
 - hpoydar
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-01 00:00:00 -05:00
+date: 2010-01-28 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency