chronic_duration 0.9.6 → 0.10.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -1,10 +1,2 @@
 source "http://rubygems.org"
-
-gem "numerizer", "~> 0.1.1"
-
-group :development do
-  gem "rspec", "~> 2.3.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
-end
+gemspec

data/{README.rdoc → README.md}

@@ -1,15 +1,10 @@
-= Chronic Duration
+# Chronic Duration
 
-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.) 
+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 accomplished with the output method.  So pass in seconds and you can get strings like 4 mins 31.51 secs (default  format), 4h 3m 30s, or 4:01:29.
+The reverse can also be accomplished with the output method. So pass in seconds and you can get strings like 4 mins 31.51 secs (default  format), 4h 3m 30s, or 4:01:29.
 
-== Installation
-
-    $ sudo gem sources -a http://gemcutter.org
-    $ sudo gem install chronic_duration
-
-== Usage
+## Usage
 
     >> require 'chronic_duration'
     => true
@@ -23,13 +18,19 @@ The reverse can also be accomplished with the output method.  So pass in seconds
     => 4 minutes 30 seconds
     >> ChronicDuration.output(270, :format => :chrono)
     => 4:30
-    
+    >> ChronicDuration.output(1299600, :weeks => true)
+    => 2 wks 1 day 1 hr
+    >> ChronicDuration.output(1299600, :weeks => true, :units => 2)
+    => 2 wks 1 day
+    >> ChronicDuration.output(1296000)
+    => 15 days
+
 Nil is returned if the string can't be parsed
 
 Examples of parse-able strings:
 
 * '12.4 secs'
-* '1:20' 
+* '1:20'
 * '1:20.51'
 * '4:01:01'
 * '3 mins 4 sec'
@@ -47,12 +48,12 @@ ChronicDuration.raise_exceptions can be set to true to raise exceptions when the
     >> ChronicDuration.parse('4 elephants and 3 Astroids')
     ChronicDuration::DurationParseError: An invalid word "elephants" was used in the string to be parsed.
 
-    
-== Contributors
+
+## Contributors
 
 brianjlandau, jduff, olauzon, roboman, ianlevesque
-    
-== TODO
+
+## TODO
 
 * Benchmark, optimize
 * Context specific matching (E.g., for '4m30s', assume 'm' is minutes not months)

data/Rakefile

@@ -1,45 +1,6 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  gem.name = "chronic_duration"
-  gem.summary = %Q{A Ruby natural language parser for elapsed time}
-  gem.license = "MIT"
-  gem.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.}
-  gem.email = "hpoydar@gmail.com"
-  gem.homepage = "http://github.com/hpoydar/chronic_duration"
-  gem.authors = ["hpoydar"]
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
+require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
 
+RSpec::Core::RakeTask.new('spec')
 task :default => :spec
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "chronic_duration #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/chronic_duration.gemspec

@@ -1,62 +1,26 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chronic_duration/version'
 
-Gem::Specification.new do |s|
-  s.name = %q{chronic_duration}
-  s.version = "0.9.6"
+Gem::Specification.new do |gem|
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["hpoydar"]
-  s.date = %q{2011-06-04}
-  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 = [
-    "README.rdoc"
-  ]
-  s.files = [
-    "Gemfile",
-    "Gemfile.lock",
-    "MIT-LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "chronic_duration.gemspec",
-    "lib/chronic_duration.rb",
-    "spec/chronic_duration_spec.rb"
-  ]
-  s.homepage = %q{http://github.com/hpoydar/chronic_duration}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.2}
-  s.summary = %q{A Ruby natural language parser for elapsed time}
-  s.test_files = [
-    "spec/chronic_duration_spec.rb"
-  ]
+  gem.name          = "chronic_duration"
+  gem.version       = ChronicDuration::VERSION
+  gem.authors       = ["hpoydar"]
+  gem.email         = ["henry@poydar.com"]
+  gem.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.}
+  gem.summary       = %q{A simple Ruby natural language parser for elapsed time}
+  gem.homepage      = "https://github.com/hpoydar/chronic_duration"
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<numerizer>, ["~> 0.1.1"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-    else
-      s.add_dependency(%q<numerizer>, ["~> 0.1.1"])
-      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<numerizer>, ["~> 0.1.1"])
-    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-  end
-end
+  gem.add_runtime_dependency "numerizer", "~> 0.1.1"
+
+  gem.add_development_dependency "rake", "~> 10.0.3"
+  gem.add_development_dependency "rspec", "~> 2.12.0"
 
+end

data/lib/chronic_duration.rb

@@ -1,40 +1,42 @@
 require 'numerizer' unless defined?(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)
   def parse(string, opts = {})
     result = calculate_from_words(cleanup(string), opts)
     result == 0 ? nil : result
-  end  
-  
+  end
+
   # Given an integer and an optional format,
   # returns a formatted string representing elapsed time
   def output(seconds, opts = {})
-    
+
     opts[:format] ||= :default
-    
-    years = months = days = hours = minutes = 0
-    
+
+    years = months = weeks = days = hours = minutes = 0
+
     decimal_places = seconds.to_s.split('.').last.length if seconds.is_a?(Float)
 
     if seconds >= 60
-      minutes = (seconds / 60).to_i 
+      minutes = (seconds / 60).to_i
       seconds = seconds % 60
       if minutes >= 60
         hours = (minutes / 60).to_i
@@ -42,40 +44,52 @@ module ChronicDuration
         if hours >= 24
           days = (hours / 24).to_i
           hours = (hours % 24).to_i
-          if days >= 30
-            months = (days / 30).to_i
-            days = (days % 30).to_i
-            if months >= 12
-              years = (months / 12).to_i
-              months = (months % 12).to_i
+          if opts[:weeks]
+            if days >= 7
+              weeks = (days / 7).to_i
+              days = (days % 7).to_i
+              if weeks >= 4
+                months = (weeks / 4).to_i
+                weeks = (weeks % 4).to_i
+              end
+            end
+          else
+            if days >= 30
+              months = (days / 30).to_i
+              days = (days % 30).to_i
             end
           end
+          if months >= 12
+            years = (months / 12).to_i
+            months = (months % 12).to_i
+            days = days - (5 * years)
+          end
         end
       end
     end
-    
+
     joiner = ' '
     process = nil
-    
+
     case opts[:format]
     when :micro
-      dividers = { 
-        :years => 'y', :months => 'm', :days => 'd', :hours => 'h', :minutes => 'm', :seconds => 's' }
+      dividers = {
+        :years => 'y', :months => 'mo', :weeks => 'w', :days => 'd', :hours => 'h', :minutes => 'm', :seconds => 's' }
       joiner = ''
     when :short
-      dividers = { 
-        :years => 'y', :months => 'm', :days => 'd', :hours => 'h', :minutes => 'm', :seconds => 's' }
-    when :default 
       dividers = {
-        :years => ' yr', :months => ' mo', :days => ' day', :hours => ' hr', :minutes => ' min', :seconds => ' sec',
+        :years => 'y', :months => 'mo', :weeks => 'w', :days => 'd', :hours => 'h', :minutes => 'm', :seconds => 's' }
+    when :default
+      dividers = {
+        :years => ' yr', :months => ' mo', :weeks => ' wk', :days => ' day', :hours => ' hr', :minutes => ' min', :seconds => ' sec',
         :pluralize => true }
-    when :long 
+    when :long
       dividers = {
-        :years => ' year', :months => ' month', :days => ' day', :hours => ' hour', :minutes => ' minute', :seconds => ' second', 
+        :years => ' year', :months => ' month', :weeks => ' week', :days => ' day', :hours => ' hour', :minutes => ' minute', :seconds => ' second',
         :pluralize => true }
     when :chrono
       dividers = {
-        :years => ':', :months => ':', :days => ':', :hours => ':', :minutes => ':', :seconds => ':', :keep_zero => true }
+        :years => ':', :months => ':', :weeks => ':', :days => ':', :hours => ':', :minutes => ':', :seconds => ':', :keep_zero => true }
       process = lambda do |str|
         # Pad zeros
         # Get rid of lead off times if they are zero
@@ -85,34 +99,36 @@ module ChronicDuration
       end
       joiner = ''
     end
-    
-    result = []
-    [:years, :months, :days, :hours, :minutes, :seconds].each do |t|
+
+    result = [:years, :months, :weeks, :days, :hours, :minutes, :seconds].map do |t|
+      next if t == :weeks && !opts[:weeks]
       num = eval(t.to_s)
-      num = ("%.#{decimal_places}f" % num) if num.is_a?(Float) && t == :seconds 
-      result << humanize_time_unit( num, dividers[t], dividers[:pluralize], dividers[:keep_zero] )
-    end
+      num = ("%.#{decimal_places}f" % num) if num.is_a?(Float) && t == :seconds
+      humanize_time_unit( num, dividers[t], dividers[:pluralize], dividers[:keep_zero] )
+    end.compact!
+
+    result = result[0...opts[:units]] if opts[:units]
+
+    result = result.join(joiner)
 
-    result = result.join(joiner).squeeze(' ').strip
-    
     if process
       result = process.call(result)
     end
-    
+
     result.length == 0 ? nil : result
 
   end
-  
+
 private
-  
+
   def humanize_time_unit(number, unit, pluralize, keep_zero)
-    return '' if number == 0 && !keep_zero
+    return nil if number == 0 && !keep_zero
     res = "#{number}#{unit}"
     # A poor man's pluralizer
     res << 's' if !(number == 1) && pluralize
     res
   end
-  
+
   def calculate_from_words(string, opts)
     val = 0
     words = string.split(' ')
@@ -123,18 +139,18 @@ private
     end
     val
   end
-  
+
   def cleanup(string)
     res = string.downcase
     res = filter_by_type(Numerizer.numerize(res))
     res = res.gsub(float_matcher) {|n| " #{n} "}.squeeze(' ').strip
     res = filter_through_white_list(res)
   end
-  
+
   def convert_to_number(string)
     string.to_f % 1 > 0 ? string.to_f : string.to_i
   end
-  
+
   def duration_units_list
     %w(seconds minutes hours days weeks months years)
   end
@@ -150,18 +166,19 @@ private
     when 'seconds'; 1
     end
   end
-  
+
   def error_message
     'Sorry, that duration could not be parsed'
   end
-  
+
   # Parse 3:41:59 and return 3 hours 41 minutes 59 seconds
   def filter_by_type(string)
+    chrono_units_list = duration_units_list.reject {|v| v == "weeks"}
     if string.gsub(' ', '') =~ /#{float_matcher}(:#{float_matcher})+/
       res = []
       string.gsub(' ', '').split(':').reverse.each_with_index do |v,k|
-        return unless duration_units_list[k]
-        res << "#{v} #{duration_units_list[k]}"
+        return unless chrono_units_list[k]
+        res << "#{v} #{chrono_units_list[k]}"
       end
       res = res.reverse.join(' ')
     else
@@ -169,11 +186,11 @@ private
     end
     res
   end
-  
+
   def float_matcher
     /[0-9]*\.?[0-9]+/
   end
-  
+
   # Get rid of unknown words and map found
   # words to defined time units
   def filter_through_white_list(string)
@@ -190,11 +207,13 @@ private
         raise DurationParseError, "An invalid word #{word.inspect} was used in the string to be parsed."
       end
     end
+    # add '1' at front if string starts with something recognizable but not with a number, like 'day' or 'minute 30sec' 
+    res.unshift(1) if res.length > 0 && mappings[res[0]]  
     res.join(' ')
   end
-  
+
   def mappings
-    { 
+    {
       'seconds' => 'seconds',
       'second'  => 'seconds',
       'secs'    => 'seconds',
@@ -218,21 +237,23 @@ private
       'week'    => 'weeks',
       'w'       => 'weeks',
       'months'  => 'months',
+      'mo'      => 'months',
       'mos'     => 'months',
       'month'   => 'months',
       'years'   => 'years',
       'year'    => 'years',
       'yrs'     => 'years',
+      'yr'      => 'years',
       'y'       => 'years'
     }
   end
-  
+
   def join_words
     ['and', 'with', 'plus']
   end
-  
+
   def white_list
-    self.mappings.map {|k, v| k}
+    self.mappings.keys
   end
-  
+
 end

data/lib/chronic_duration/version.rb

@@ -0,0 +1,3 @@
+module ChronicDuration
+  VERSION = '0.10.0'
+end

data/spec/chronic_duration_spec.rb

@@ -1,8 +1,8 @@
 require 'chronic_duration'
 
 describe ChronicDuration, '.parse' do
-  
-  @exemplars = { 
+
+  @exemplars = {
     '1:20'                  => 60 + 20,
     '1:20.51'               => 60 + 20.51,
     '4:01:01'               => 4 * 3600 + 60 + 1,
@@ -22,47 +22,49 @@ describe ChronicDuration, '.parse' do
     '3 weeks, plus 2 days' => 3600 * 24 * 7 * 3 + 3600 * 24 * 2,
     '3 weeks with 2 days' => 3600 * 24 * 7 * 3 + 3600 * 24 * 2,
     '1 month'               => 3600 * 24 * 30,
-    '2 months'              => 3600 * 24 * 30 * 2
+    '2 months'              => 3600 * 24 * 30 * 2,
+    'day'                   => 3600 * 24,
+    'minute 30s'            => 90
   }
-  
+
   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
-  
+
   it "should return an integer unless the seconds are in decimals" do
     ChronicDuration.parse('12 mins 3 seconds').is_a?(Integer).should be_true
   end
-  
+
   it "should be able to parse minutes by default" do
     ChronicDuration.parse('5', :default_unit => "minutes").should == 300
   end
-  
+
   @exemplars.each do |k, v|
     it "should properly parse a duration like #{k}" do
       ChronicDuration.parse(k).should == v
     end
   end
-  
+
 end
 
 describe ChronicDuration, '.output' do
-  
+
   it "should return nil if the input can't be parsed" do
     ChronicDuration.parse('gobblygoo').should be_nil
   end
-  
-  @exemplars = { 
-    #(0) => 
+
+  @exemplars = {
+    #(0) =>
       #{
         #:micro    => '0s',
         #:short    => '0s',
@@ -70,64 +72,80 @@ describe ChronicDuration, '.output' do
         #:long     => '0 seconds',
         #:chrono   => '0'
       #},
-    (60 + 20) => 
-      { 
+    (60 + 20) =>
+      {
         :micro    => '1m20s',
         :short    => '1m 20s',
         :default  => '1 min 20 secs',
         :long     => '1 minute 20 seconds',
         :chrono   => '1:20'
       },
-    (60 + 20.51) => 
-      { 
+    (60 + 20.51) =>
+      {
         :micro    => '1m20.51s',
         :short    => '1m 20.51s',
         :default  => '1 min 20.51 secs',
         :long     => '1 minute 20.51 seconds',
         :chrono   => '1:20.51'
       },
-    (60 + 20.51928) => 
-      { 
+    (60 + 20.51928) =>
+      {
         :micro    => '1m20.51928s',
         :short    => '1m 20.51928s',
         :default  => '1 min 20.51928 secs',
         :long     => '1 minute 20.51928 seconds',
         :chrono   => '1:20.51928'
       },
-    (4 * 3600 + 60 + 1) => 
-      { 
+    (4 * 3600 + 60 + 1) =>
+      {
         :micro    => '4h1m1s',
         :short    => '4h 1m 1s',
         :default  => '4 hrs 1 min 1 sec',
         :long     => '4 hours 1 minute 1 second',
         :chrono   => '4:01:01'
       },
-    (2 * 3600 + 20 * 60) => 
-      { 
+    (2 * 3600 + 20 * 60) =>
+      {
         :micro    => '2h20m',
         :short    => '2h 20m',
         :default  => '2 hrs 20 mins',
         :long     => '2 hours 20 minutes',
         :chrono   => '2:20'
       },
-    (2 * 3600 + 20 * 60) => 
-      { 
+    (2 * 3600 + 20 * 60) =>
+      {
         :micro    => '2h20m',
         :short    => '2h 20m',
         :default  => '2 hrs 20 mins',
         :long     => '2 hours 20 minutes',
         :chrono   => '2:20:00'
       },
-    (6 * 30 * 24 * 3600 + 24 * 3600) => 
-      { 
-        :micro    => '6m1d',
-        :short    => '6m 1d',
+    (6 * 30 * 24 * 3600 + 24 * 3600) =>
+      {
+        :micro    => '6mo1d',
+        :short    => '6mo 1d',
         :default  => '6 mos 1 day',
         :long     => '6 months 1 day',
         :chrono   => '6:01:00:00:00' # Yuck. FIXME
-      }
+      },
+    (365 * 24 * 3600 + 24 * 3600 ) =>
+      {
+        :micro    => '1y1d',
+        :short    => '1y 1d',
+        :default  => '1 yr 1 day',
+        :long     => '1 year 1 day',
+        :chrono   => '1:00:01:00:00:00'
+      },
+    (3  * 365 * 24 * 3600 + 24 * 3600 ) =>
+      {
+        :micro    => '3y1d',
+        :short    => '3y 1d',
+        :default  => '3 yrs 1 day',
+        :long     => '3 years 1 day',
+        :chrono   => '3:00:01:00:00:00'
+      },
   }
-  
+
   @exemplars.each do |k, v|
     v.each do |key, val|
       it "should properly output a duration of #{k} seconds as #{val} using the #{key.to_s} format option" do
@@ -135,12 +153,27 @@ describe ChronicDuration, '.output' do
       end
     end
   end
-  
+
+  it "should show weeks when needed" do
+    ChronicDuration.output(15*24*60*60, :weeks => true).should =~ /.*wk.*/
+  end
+
+  it "should show the specified number of units if provided" do
+    ChronicDuration.output(4 * 3600 + 60 + 1, units: 2).should == '4 hrs 1 min'
+    ChronicDuration.output(6 * 30 * 24 * 3600 + 24 * 3600 + 3600 + 60 + 1, units: 3, format: :long).should == '6 months 1 day 1 hour'
+  end
+
   it "should use the default format when the format is not specified" do
     ChronicDuration.output(2 * 3600 + 20 * 60).should == '2 hrs 20 mins'
   end
-  
-  
+
+  @exemplars.each do |seconds,format_spec|
+    format_spec.each do |format,_|
+      it "it should properly output a duration for #{seconds} that parses back to the same thing when using the #{format.to_s} format" do
+        ChronicDuration.parse(ChronicDuration.output(seconds, :format => format)).should == seconds
+      end
+    end
+  end
 end
 
 
@@ -148,37 +181,37 @@ end
 # us in development...
 
 describe ChronicDuration, "private methods" do
-  
+
   describe ".filter_by_type" do
-    
+
     it "should take a chrono-formatted time like 3:14 and return a human time like 3 minutes 14 seconds" do
       ChronicDuration.instance_eval("filter_by_type('3:14')").should == '3 minutes 14 seconds'
     end
-    
+
     it "should take a chrono-formatted time like 12:10:14 and return a human time like 12 hours 10 minutes 14 seconds" do
       ChronicDuration.instance_eval("filter_by_type('12:10:14')").should == '12 hours 10 minutes 14 seconds'
     end
-    
+
     it "should return the input if it's not a chrono-formatted time" do
       ChronicDuration.instance_eval("filter_by_type('4 hours')").should == '4 hours'
     end
-  
+
   end
-  
+
   describe ".cleanup" do
-    
+
     it "should clean up extraneous words" do
       ChronicDuration.instance_eval("cleanup('4 days and 11 hours')").should == '4 days 11 hours'
     end
-    
+
     it "should cleanup extraneous spaces" do
       ChronicDuration.instance_eval("cleanup('  4 days and 11     hours')").should == '4 days 11 hours'
     end
-    
+
     it "should insert spaces where there aren't any" do
       ChronicDuration.instance_eval("cleanup('4m11.5s')").should == '4 minutes 11.5 seconds'
     end
-    
+
   end
-  
-end 
+
+end

data/spec/lib/chronic_duration_spec.rb

@@ -0,0 +1,212 @@
+require 'spec_helper'
+
+describe ChronicDuration do
+
+  describe ".parse" do
+
+    @exemplars = {
+      '1:20'                  => 60 + 20,
+      '1:20.51'               => 60 + 20.51,
+      '4:01:01'               => 4 * 3600 + 60 + 1,
+      '3 mins 4 sec'          => 3 * 60 + 4,
+      '3 Mins 4 Sec'          => 3 * 60 + 4,
+      'three mins four sec'          => 3 * 60 + 4,
+      '2 hrs 20 min'          => 2 * 3600 + 20 * 60,
+      '2h20min'               => 2 * 3600 + 20 * 60,
+      '6 mos 1 day'           => 6 * 30 * 24 * 3600 + 24 * 3600,
+      '1 year 6 mos 1 day'    => 1 * 31536000 + 6 * 30 * 24 * 3600 + 24 * 3600,
+      '2.5 hrs'               => 2.5 * 3600,
+      '47 yrs 6 mos and 4.5d' => 47 * 31536000 + 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,
+      '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,
+      '1 month'               => 3600 * 24 * 30,
+      '2 months'              => 3600 * 24 * 30 * 2
+    }
+
+    context "when string can't be parsed" do
+
+      it "returns nil" do
+        ChronicDuration.parse('gobblygoo').should be_nil
+      end
+
+      context "when @@raise_exceptions set to true" do
+
+        it "raises with ChronicDuration::DurationParseError" do
+          ChronicDuration.raise_exceptions = true
+          lambda { ChronicDuration.parse('23 gobblygoos') }.should raise_exception(ChronicDuration::DurationParseError)
+          ChronicDuration.raise_exceptions = false
+        end
+
+      end
+
+    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
+
+    it "should return an integer unless the seconds are in decimals" do
+      ChronicDuration.parse('12 mins 3 seconds').is_a?(Integer).should be_true
+    end
+
+    it "should be able to parse minutes by default" do
+      ChronicDuration.parse('5', :default_unit => "minutes").should == 300
+    end
+
+    @exemplars.each do |k, v|
+      it "parses a duration like #{k}" do
+        ChronicDuration.parse(k).should == v
+      end
+    end
+
+  end
+
+  describe '.output' do
+
+    @exemplars = {
+      (60 + 20) =>
+        {
+          :micro    => '1m20s',
+          :short    => '1m 20s',
+          :default  => '1 min 20 secs',
+          :long     => '1 minute 20 seconds',
+          :chrono   => '1:20'
+        },
+      (60 + 20.51) =>
+        {
+          :micro    => '1m20.51s',
+          :short    => '1m 20.51s',
+          :default  => '1 min 20.51 secs',
+          :long     => '1 minute 20.51 seconds',
+          :chrono   => '1:20.51'
+        },
+      (60 + 20.51928) =>
+        {
+          :micro    => '1m20.51928s',
+          :short    => '1m 20.51928s',
+          :default  => '1 min 20.51928 secs',
+          :long     => '1 minute 20.51928 seconds',
+          :chrono   => '1:20.51928'
+        },
+      (4 * 3600 + 60 + 1) =>
+        {
+          :micro    => '4h1m1s',
+          :short    => '4h 1m 1s',
+          :default  => '4 hrs 1 min 1 sec',
+          :long     => '4 hours 1 minute 1 second',
+          :chrono   => '4:01:01'
+        },
+      (2 * 3600 + 20 * 60) =>
+        {
+          :micro    => '2h20m',
+          :short    => '2h 20m',
+          :default  => '2 hrs 20 mins',
+          :long     => '2 hours 20 minutes',
+          :chrono   => '2:20'
+        },
+      (2 * 3600 + 20 * 60) =>
+        {
+          :micro    => '2h20m',
+          :short    => '2h 20m',
+          :default  => '2 hrs 20 mins',
+          :long     => '2 hours 20 minutes',
+          :chrono   => '2:20:00'
+        },
+      (6 * 30 * 24 * 3600 + 24 * 3600) =>
+        {
+          :micro    => '6mo1d',
+          :short    => '6mo 1d',
+          :default  => '6 mos 1 day',
+          :long     => '6 months 1 day',
+          :chrono   => '6:01:00:00:00' # Yuck. FIXME
+        },
+      (365 * 24 * 3600 + 24 * 3600 ) =>
+        {
+          :micro    => '1y1d',
+          :short    => '1y 1d',
+          :default  => '1 yr 1 day',
+          :long     => '1 year 1 day',
+          :chrono   => '1:00:01:00:00:00'
+        },
+      (3  * 365 * 24 * 3600 + 24 * 3600 ) =>
+        {
+          :micro    => '3y1d',
+          :short    => '3y 1d',
+          :default  => '3 yrs 1 day',
+          :long     => '3 years 1 day',
+          :chrono   => '3:00:01:00:00:00'
+        },
+    }
+
+    @exemplars.each do |k, v|
+      v.each do |key, val|
+        it "properly outputs a duration of #{k} seconds as #{val} using the #{key.to_s} format option" do
+          ChronicDuration.output(k, :format => key).should == val
+        end
+      end
+    end
+
+    it "returns weeks when needed" do
+      ChronicDuration.output(15*24*60*60, :weeks => true).should =~ /.*wk.*/
+    end
+
+    it "returns the specified number of units if provided" do
+      ChronicDuration.output(4 * 3600 + 60 + 1, units: 2).should == '4 hrs 1 min'
+      ChronicDuration.output(6 * 30 * 24 * 3600 + 24 * 3600 + 3600 + 60 + 1, units: 3, format: :long).should == '6 months 1 day 1 hour'
+    end
+
+    context "when the format is not specified" do
+
+      it "uses the default format" do
+        ChronicDuration.output(2 * 3600 + 20 * 60).should == '2 hrs 20 mins'
+      end
+
+    end
+
+    @exemplars.each do |seconds, format_spec|
+      format_spec.each do |format, _|
+        it "outputs a duration for #{seconds} that parses back to the same thing when using the #{format.to_s} format" do
+          ChronicDuration.parse(ChronicDuration.output(seconds, :format => format)).should == seconds
+        end
+      end
+    end
+
+  end
+
+  describe ".filter_by_type" do
+
+    it "receives a chrono-formatted time like 3:14 and return a human time like 3 minutes 14 seconds" do
+      ChronicDuration.instance_eval("filter_by_type('3:14')").should == '3 minutes 14 seconds'
+    end
+
+    it "receives chrono-formatted time like 12:10:14 and return a human time like 12 hours 10 minutes 14 seconds" do
+      ChronicDuration.instance_eval("filter_by_type('12:10:14')").should == '12 hours 10 minutes 14 seconds'
+    end
+
+    it "returns the input if it's not a chrono-formatted time" do
+      ChronicDuration.instance_eval("filter_by_type('4 hours')").should == '4 hours'
+    end
+
+  end
+
+  describe ".cleanup" do
+
+    it "cleans up extraneous words" do
+      ChronicDuration.instance_eval("cleanup('4 days and 11 hours')").should == '4 days 11 hours'
+    end
+
+    it "cleans up extraneous spaces" do
+      ChronicDuration.instance_eval("cleanup('  4 days and 11     hours')").should == '4 days 11 hours'
+    end
+
+    it "inserts spaces where there aren't any" do
+      ChronicDuration.instance_eval("cleanup('4m11.5s')").should == '4 minutes 11.5 seconds'
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'chronic_duration'
+
+RSpec.configure do |config|
+end
+
+

metadata

@@ -1,121 +1,111 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: chronic_duration
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.10.0
   prerelease: 
-  version: 0.9.6
 platform: ruby
-authors: 
+authors:
 - hpoydar
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-04 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: numerizer
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 2.3.0
-  type: :development
-  prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: bundler
-  requirement: &id003 !ruby/object:Gem::Requirement 
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.0.0
+      - !ruby/object:Gem::Version
+        version: 10.0.3
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: jeweler
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.5.2
-  type: :development
-  prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rcov
-  requirement: &id005 !ruby/object:Gem::Requirement 
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *id005
-description: 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.
-email: hpoydar@gmail.com
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: 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.
+email:
+- henry@poydar.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-files: 
+extra_rdoc_files: []
+files:
+- .gitignore
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
-- VERSION
 - chronic_duration.gemspec
 - lib/chronic_duration.rb
+- lib/chronic_duration/version.rb
 - spec/chronic_duration_spec.rb
-has_rdoc: true
-homepage: http://github.com/hpoydar/chronic_duration
-licenses: 
-- MIT
+- spec/lib/chronic_duration_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hpoydar/chronic_duration
+licenses: []
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 2762452318022251891
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: A Ruby natural language parser for elapsed time
-test_files: 
+summary: A simple Ruby natural language parser for elapsed time
+test_files:
 - spec/chronic_duration_spec.rb
+- spec/lib/chronic_duration_spec.rb
+- spec/spec_helper.rb

data/Gemfile.lock

@@ -1,30 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.2)
-    git (1.2.5)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    numerizer (0.1.1)
-    rake (0.8.7)
-    rcov (0.9.9)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.2)
-  numerizer (~> 0.1.1)
-  rcov
-  rspec (~> 2.3.0)

data/VERSION

@@ -1 +0,0 @@
-0.9.6