natural_time 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeff Coleman
+
+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.rdoc

@@ -0,0 +1,22 @@
+= natural_time
+
+NaturalTime outputs a duration in natural language.
+
+65 seconds becomes "1 minute, 5 seconds".
+
+120 seconds becomes "2 minutes".
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jeff Coleman. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "natural_time"
+    gem.summary = %Q{Smart enumeration of durations in natural language}
+    gem.description = %Q{Smart enumeration of durations in natural language--"4 hours, 3 minutes and 2 seconds"}
+    gem.email = "progressions@gmail.com"
+    gem.homepage = "http://github.com/progressions/natural_time"
+    gem.authors = ["Jeff Coleman"]
+    gem.add_development_dependency "rspec", ">= 1.2.6"
+    gem.add_development_dependency "activesupport", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['-c']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "naturaltime #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/natural_time.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'active_support'
+
+class NaturalTime
+  attr_accessor :duration
+
+  UNITS_OF_TIME = [["year", "years"], ["month", "months"], ["week", "weeks"], ["day", "days"], ["hour", "hours"], ["minute", "minutes"]]
+  
+  def initialize(duration_in_seconds)
+    duration_in_seconds = duration_in_seconds.to_i
+    @duration = duration_in_seconds
+    elapsed_time = elapsed_time(duration_in_seconds)
+  end
+  
+  def to_sentence
+    to_array.to_sentence
+  end
+  
+  def natural_time
+    to_array.join(", ")
+  end
+  
+  def to_s
+    natural_time
+  end
+  
+  def to_array
+    elapsed_time(duration)
+  end
+  
+  def elapsed_time(duration_in_seconds)
+    elapsed_time = []
+
+    seconds_left = duration_in_seconds
+    
+    UNITS_OF_TIME.each do |period|
+      amount = (seconds_left / 1.send(period.first)).to_i
+      str = amount == 1 ? period[0] : period[1]
+      elapsed_time << "#{amount} #{str}" if amount > 0
+      seconds_left = seconds_left % 1.send(period.first)
+    end
+    
+    seconds = seconds_left % 1.minute
+    str = seconds == 1 ? "second" : "seconds"
+    elapsed_time << "#{seconds.to_i} #{str}" unless (seconds == 0 && elapsed_time.compact.length > 0)    
+    
+    elapsed_time.compact
+  end
+end

data/natural_time.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{natural_time}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeff Coleman"]
+  s.date = %q{2010-01-13}
+  s.description = %q{Smart enumeration of durations in natural language--"4 hours, 3 minutes and 2 seconds"}
+  s.email = %q{progressions@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/natural_time.rb",
+     "natural_time.gemspec",
+     "spec/natural_time_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "test.rb"
+  ]
+  s.homepage = %q{http://github.com/progressions/natural_time}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Smart enumeration of durations in natural language}
+  s.test_files = [
+    "spec/natural_time_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.6"])
+      s.add_development_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.6"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.6"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end
+

data/spec/natural_time_spec.rb

@@ -0,0 +1,224 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Naturaltime" do
+  describe "seconds" do
+    it "should return zero seconds" do
+      NaturalTime.new(0).natural_time.should == "0 seconds"
+    end
+    
+    it "should return singular" do
+      NaturalTime.new(1).natural_time.should == "1 second"
+    end
+    
+    it "should return seconds" do
+      (2..59).each do |i|
+        NaturalTime.new(i).natural_time.should == "#{i} seconds"
+      end
+    end
+    
+    it "should not return 60 seconds" do
+      NaturalTime.new(60.seconds).natural_time.should_not match(/60 seconds/)
+    end
+    
+    it "should return remainder in seconds" do
+      NaturalTime.new(65.seconds).natural_time.should match(/ 5 seconds/)
+    end
+  end
+  
+  describe "minutes" do
+    it "should return singular" do
+      NaturalTime.new(60.seconds).natural_time.should == "1 minute"
+    end
+    
+    it "should return whole minutes" do
+      (2..59).each do |i|
+        NaturalTime.new(i.minutes).natural_time.should == "#{i} minutes"
+      end
+    end
+    
+    it "should not return 60 minutes" do
+      NaturalTime.new(60.minutes).natural_time.should_not match(/60 minutes/)
+    end
+    
+    it "should return remainder in seconds" do
+      NaturalTime.new(65.seconds).natural_time.should == "1 minute, 5 seconds"
+    end
+  end
+  
+  describe "hours" do
+    it "should return singular" do
+      NaturalTime.new(1.hour).natural_time.should == "1 hour"
+    end
+    
+    it "should return whole hours" do
+      (2..23).each do |i|
+        NaturalTime.new(i.hours).natural_time.should == "#{i} hours"
+      end
+    end
+    
+    it "should not return 24 hours" do
+      NaturalTime.new(24.hours).natural_time.should_not match(/24 hours/)
+    end
+    
+    it "should return remainder in minutes" do
+      NaturalTime.new(1.hour + 5.minutes).natural_time.should == "1 hour, 5 minutes"
+    end
+    
+    it "should return remainder in minutes and seconds" do
+      NaturalTime.new(1.hour + 5.minutes + 5.seconds).natural_time.should == "1 hour, 5 minutes, 5 seconds"
+    end
+  end
+  
+  describe "days" do
+    it "should return singular" do
+      NaturalTime.new(1.day).natural_time.should == "1 day"
+    end
+    
+    it "should return whole days" do
+      (2..6).each do |i|
+        NaturalTime.new(i.days).natural_time.should == "#{i} days"
+      end
+    end
+    
+    it "should not return 7 days" do
+      NaturalTime.new(7.days).natural_time.should_not match(/7 days/)
+    end
+    
+    it "should return remainder in hours" do
+      NaturalTime.new(1.day + 1.hour).natural_time.should == "1 day, 1 hour"
+    end
+    
+    it "should return remainder in hours and minutes" do
+      NaturalTime.new(1.day + 1.hour + 5.minutes).natural_time.should == "1 day, 1 hour, 5 minutes"
+    end
+    
+    it "should return remainder in hours and minutes and seconds" do
+      NaturalTime.new(1.day + 1.hour + 5.minutes + 5.seconds).natural_time.should == "1 day, 1 hour, 5 minutes, 5 seconds"
+    end
+  end
+  
+  describe "weeks" do
+    it "should return singular" do
+      NaturalTime.new(1.week).natural_time.should == "1 week"
+    end
+    
+    it "should return whole weeks" do
+      (2..4).each do |i|
+        NaturalTime.new(i.weeks).natural_time.should == "#{i} weeks"
+      end
+    end
+    
+    it "should not return 5 weeks" do
+      NaturalTime.new(5.weeks).natural_time.should_not match(/5 weeks/)
+    end
+    
+    it "should return remainder in days" do
+      NaturalTime.new(1.week + 1.day).natural_time.should == "1 week, 1 day"
+    end
+    
+    it "should return remainder in days and hours" do
+      NaturalTime.new(1.week + 1.day + 1.hour).natural_time.should == "1 week, 1 day, 1 hour"
+    end
+    
+    it "should return remainder in days and hours and minutes" do
+      NaturalTime.new(1.week + 1.day + 1.hour + 5.minutes).natural_time.should == "1 week, 1 day, 1 hour, 5 minutes"
+    end
+    
+    it "should return remainder in days and hours and minutes and seconds" do
+      NaturalTime.new(1.week + 1.day + 1.hour + 5.minutes + 5.seconds).natural_time.should == "1 week, 1 day, 1 hour, 5 minutes, 5 seconds"
+    end
+  end
+  
+  describe "months" do
+    it "should return singular" do
+      NaturalTime.new(1.month).natural_time.should == "1 month"
+    end
+    
+    it "should return whole months" do
+      (2..4).each do |i|
+        NaturalTime.new(i.months).natural_time.should == "#{i} months"
+      end
+    end
+    
+    it "should not return 12 months" do
+      NaturalTime.new(13.months).natural_time.should_not match(/13 months/)
+    end
+    
+    it "should return remainder in weeks" do
+      NaturalTime.new(1.month + 1.week).natural_time.should == "1 month, 1 week"
+    end
+    
+    it "should return remainder in days" do
+      NaturalTime.new(1.month + 1.week + 1.day).natural_time.should == "1 month, 1 week, 1 day"
+    end
+    
+    it "should return remainder in days and hours" do
+      NaturalTime.new(1.month + 1.week + 1.day + 1.hour).natural_time.should == "1 month, 1 week, 1 day, 1 hour"
+    end
+    
+    it "should return remainder in days and hours and minutes" do
+      NaturalTime.new(1.month + 1.week + 1.day + 1.hour + 5.minutes).natural_time.should == "1 month, 1 week, 1 day, 1 hour, 5 minutes"
+    end
+    
+    it "should return remainder in days and hours and minutes and seconds" do
+      NaturalTime.new(1.month + 1.week + 1.day + 1.hour + 5.minutes + 5.seconds).natural_time.should == "1 month, 1 week, 1 day, 1 hour, 5 minutes, 5 seconds"
+    end
+  end
+  
+  describe "years" do
+    it "should return singular" do
+      NaturalTime.new(1.year).natural_time.should == "1 year"
+    end
+    
+    it "should return whole years" do
+      (2..4).each do |i|
+        NaturalTime.new(i.years).natural_time.should == "#{i} years"
+      end
+    end
+    
+    it "should return remainder in months" do
+      NaturalTime.new(1.year + 1.month).natural_time.should == "1 year, 1 month"
+    end
+    
+    it "should return remainder in months and weeks" do
+      NaturalTime.new(1.year + 1.month + 1.week).natural_time.should == "1 year, 1 month, 1 week"
+    end
+    
+    it "should return remainder in months and days" do
+      NaturalTime.new(1.year + 1.month + 1.week + 1.day).natural_time.should == "1 year, 1 month, 1 week, 1 day"
+    end
+    
+    it "should return remainder in months and days and hours" do
+      NaturalTime.new(1.year + 1.month + 1.week + 1.day + 1.hour).natural_time.should == "1 year, 1 month, 1 week, 1 day, 1 hour"
+    end
+    
+    it "should return remainder in months and days and hours and minutes" do
+      NaturalTime.new(1.year + 1.month + 1.week + 1.day + 1.hour + 5.minutes).natural_time.should == "1 year, 1 month, 1 week, 1 day, 1 hour, 5 minutes"
+    end
+    
+    it "should return remainder in months and days and hours and minutes and seconds" do
+      NaturalTime.new(1.year + 1.month + 1.week + 1.day + 1.hour + 5.minutes + 5.seconds).natural_time.should == "1 year, 1 month, 1 week, 1 day, 1 hour, 5 minutes, 5 seconds"
+    end
+  end
+  
+  describe "to_s" do
+    it "should equal natural_time" do
+      (1..100).each do |i|
+        @natural_time = NaturalTime.new(i)
+        @natural_time.to_s.should == @natural_time.natural_time
+      end
+    end
+  end
+  
+  describe "to_sentence" do
+    it "should put 'and' before the last entry in the list" do
+      NaturalTime.new(1.minute + 1.second).to_sentence.should == "1 minute and 1 second"
+    end
+  end
+  
+  describe "to_array" do
+    it "should return an array" do
+      NaturalTime.new(1.minutes + 1.second).to_array.should == ["1 minute", "1 second"]
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'natural_time'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/test.rb

@@ -0,0 +1,6 @@
+require 'lib/natural_time'
+
+puts "Enter number of seconds: "
+s = $stdin.gets
+
+puts NaturalTime.new(s.to_i)

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: natural_time
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Jeff Coleman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-13 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Smart enumeration of durations in natural language--"4 hours, 3 minutes and 2 seconds"
+email: progressions@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/natural_time.rb
+- natural_time.gemspec
+- spec/natural_time_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- test.rb
+has_rdoc: true
+homepage: http://github.com/progressions/natural_time
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Smart enumeration of durations in natural language
+test_files: 
+- spec/natural_time_spec.rb
+- spec/spec_helper.rb