hpoydar-chronic_duration 0.2.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) Henry Poydar
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,40 @@
+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.)
+
+Installation
+------------
+
+    $ sudo gem sources -a http://gems.github.com
+    $ sudo gem install hpoydar-chronic_duration
+
+Usage
+-----
+
+    >> require 'chronic_duration'
+    => true
+    >> ChronicDuration.parse('4 minutes and 30 seconds')
+    => 270
+    
+Nil is returned if the string can't be parsed
+
+Examples of parse-able strings:
+
+* '12.4 secs'
+* '1:20' 
+* '1:20.51'
+* '4:01:01'
+* '3 mins 4 sec'
+* '2 hrs 20 min'
+* '2h20min'
+* '6 mos 1 day'
+* '47 yrs 6 mos and 4d'
+
+    
+TODO
+----
+
+* Benchmark and optimize
+* Context specific matching (E.g., for '4m30s', assume 'm' is minutes)
+* Smartly parse vacation-like durations (E.g., '4 days and 3 nights')

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+ 
+task :default => :spec
+ 
+desc 'Run specs'
+Spec::Rake::SpecTask.new('spec') do |task|
+  task.spec_files = FileList['spec/**/*_spec.rb']
+end
+ 
+Rake::RDocTask.new do |task|
+  task.rdoc_dir = 'doc'
+  task.title = 'chronic_duration'
+  task.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
+  task.rdoc_files.include 'README'
+  task.rdoc_files.include 'lib/**/*.rb'
+end

data/lib/chronic_duration.rb

@@ -0,0 +1,118 @@
+module ChronicDuration
+  extend self
+  
+  def parse(string)
+    result = calculate_from_words(cleanup(string))
+    result == 0 ? nil : result
+  end  
+  
+private
+  
+  def calculate_from_words(string)
+    val = 0
+    words = string.split(' ')
+    words.each_with_index do |v, k|
+      if v =~ float_matcher
+        val += (convert_to_number(v) * duration_units_seconds_multiplier(words[k + 1] || 'seconds'))
+      end
+    end
+    val
+  end
+  
+  def cleanup(string)
+    res = filter_by_type(string)
+    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
+  def duration_units_seconds_multiplier(unit)
+    return 0 unless duration_units_list.include?(unit)
+    case unit
+    when 'years';   31557600 # accounts for leap years
+    when 'months';  3600 * 24 * 30
+    when 'weeks';   3600 * 24 * 7
+    when 'days';    3600 * 24
+    when 'hours';   3600
+    when 'minutes'; 60
+    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)
+    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]}"
+      end
+      res = res.reverse.join(' ')
+    else
+      res = string
+    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)
+    res = []
+    string.split(' ').each do |word|
+      if word =~ float_matcher
+        res << word.strip
+        next
+      end
+      res << mappings[word.strip] if mappings.has_key?(word.strip)
+    end
+    res.join(' ')
+  end
+  
+  def mappings
+    { 
+      'seconds' => 'seconds',
+      'second'  => 'seconds',
+      'secs'    => 'seconds',
+      'sec'     => 'seconds',
+      's'       => 'seconds',
+      'minutes' => 'minutes',
+      'minute'  => 'minutes',
+      'mins'    => 'minutes',
+      'min'     => 'minutes',
+      'm'       => 'minutes',
+      'hours'   => 'hours',
+      'hour'    => 'hours',
+      'hrs'     => 'hours',
+      'hr'      => 'hours',
+      'h'       => 'hours',
+      'days'    => 'days',
+      'day'     => 'days',
+      'dy'      => 'days',
+      'd'       => 'days',
+      'months'  => 'months',
+      'mos'     => 'months',
+      'years'   => 'years',
+      'yrs'     => 'years',
+      'y'       => 'years'
+    }
+  end
+  
+  def white_list
+    self.mappings.map {|k, v| k}
+  end
+  
+end

data/spec/chronic_duration_spec.rb

@@ -0,0 +1,86 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe ChronicDuration, 'gem' do
+  
+  it "should build" do
+    spec = eval(File.read("#{File.dirname(__FILE__)}/../chronic_duration.gemspec"))
+    FileUtils.rm_f(File.dirname(__FILE__) + "/../chronic_duration-#{spec.version}.gem")
+    system "cd #{File.dirname(__FILE__)}/.. && gem build chronic_duration.gemspec -q --no-verbose"
+    File.exists?(File.dirname(__FILE__) + "/../chronic_duration-#{spec.version}.gem").should be_true
+    FileUtils.rm_f(File.dirname(__FILE__) + "/../chronic_duration-#{spec.version}.gem")
+  end
+  
+end
+
+describe ChronicDuration, '.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,
+    '2 hrs 20 min'          => 2 * 3600 + 20 * 60,
+    '2h20min'               => 2 * 3600 + 20 * 60,
+    '6 mos 1 day'           => 6 * 30 * 24 * 3600 + 24 * 3600,
+    '2.5 hrs'               => 2.5 * 3600,
+    '47 yrs 6 mos and 4.5d' => 47 * 31557600 + 6 * 30 * 24 * 3600 + 4.5 * 24 * 3600
+  }
+  
+  it "should return nil if the string can't be parsed" do
+    ChronicDuration.parse('gobblygoo').should be_nil
+  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
+  
+  @exemplars.each do |k, v|
+    it "should properly parse a duration like #{k}" do
+      ChronicDuration.parse(k).should == v
+    end
+  end
+  
+end
+
+# Some of the private methods deserve some spec'ing to aid
+# 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 

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'spec'
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'chronic_duration'

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: hpoydar-chronic_duration
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Henry Poydar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-11 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+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.)
+email: henry@poydar.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/chronic_duration.rb
+- LICENSE
+- Rakefile
+- README
+has_rdoc: true
+homepage: http://github.com/hpoydar/chronic_duration
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A Ruby natural language parser for elapsed time
+test_files: 
+- spec/chronic_duration_spec.rb
+- spec/spec_helper.rb
+- Rakefile