natural_time 0.0.3 → 0.0.4

data/README.rdoc

@@ -4,15 +4,62 @@ NaturalTime outputs a duration in natural language.
 
 == Usage
 
-  NaturalTime.new(65).to_sentence         #=> "1 minute, 5 seconds"
+=== Sentence
+
+The <tt>to_sentence</tt> method will output the duration in time in natural language
+and formatted like a sentence.
+
+  NaturalTime.new(65).to_sentence         #=> "1 minute and 5 seconds"
 
   NaturalTime.new(120).to_sentence        #=> "2 minutes"
 
-NaturalTime instances can also be output to an array:
+  NaturalTime.new(10000).to_sentence      #=> "2 hours, 46 minutes, and 40 seconds"
+
+=== String
+
+The <tt>to_s</tt> command will separate the units with commas but with no "and":
+
+  NaturalTime.new(65).to_s                #=> "1 minute, 5 seconds"
+
+  NaturalTime.new(10000).to_s             #=> "2 hours, 46 minutes, 40 seconds"
+  
+=== Array
+
+NaturalTime instances can also be output to an array with <tt>to_a</tt>:
+
+  NaturalTime.new(65).to_a                #=> ["1 minutes", "5 seconds"]
+  
+  NaturalTime.new(120).to_a               #=> ["2 minutes"]
+
+=== Precision
 
-  NaturalTime.new(65).to_array            #=> ["1 minutes", "5 seconds"]
+NaturalTime can return the amount of time to a specific precision.  If all you want is the greatest unit:
+
+  NaturalTime.new(65, :precision => 1).to_sentence     #=> "1 minute"
+  
+  NaturalTime.new(10000, :precision => 1).to_sentence  #=> "2 hours"
   
-  NaturalTime.new(120).to_array           #=> ["2 minutes"]
+  NaturalTime.new(10000, :precision => 2).to_sentence  #=> "2 hours and 46 minutes"
+
+=== Distance
+
+If you want to use NaturalTime to show an elapsed time and you don't care if it's in the
+past or the future, use the <tt>natural_time</tt> or <tt>to_sentence</tt> methods, or the
+<tt>to_a</tt> method if you need the units in an array.
+
+If you're measuring distances that may be in the past or the future, the <tt>distance</tt>
+method will return a sentence indicating how long ago or in the future is your duration.
+
+  NaturalTime.new(65).distance                      #=> "1 minute and 5 seconds from now"
+  
+  NaturalTime.new(-65).distance                     #=> "1 minute and 5 seconds ago"
+  
+It works with <tt>:precision</tt> too:
+  
+  NaturalTime.new(10000, :precision => 1).distance  #=> "2 hours from now"
+  
+  NaturalTime.new(-10000, :precision => 2).distance #=> "2 hours and 46 minutes ago"
+
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -10,7 +10,7 @@ begin
     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 "rspec", ">= 1.2.6"
     gem.add_runtime_dependency "activesupport", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/natural_time.gemspec

@@ -1,58 +1,53 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{natural_time}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeff Coleman"]
-  s.date = %q{2010-01-22}
+  s.date = %q{2011-04-04}
   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"
+    "README.rdoc"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "History.txt",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "lib/natural_time.rb",
-     "natural_time.gemspec",
-     "spec/natural_time_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
+    "History.txt",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/natural_time.rb",
+    "natural_time.gemspec",
+    "spec/natural_time_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.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.rubygems_version = %q{1.3.7}
   s.summary = %q{Smart enumeration of durations in natural language}
   s.test_files = [
     "spec/natural_time_spec.rb",
-     "spec/spec_helper.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"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_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

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: natural_time
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Jeff Coleman
@@ -9,29 +15,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-22 00:00:00 -06:00
+date: 2011-04-04 00:00:00 -05: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: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: Smart enumeration of durations in natural language--"4 hours, 3 minutes and 2 seconds"
 email: progressions@gmail.com
 executables: []
@@ -43,7 +43,6 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
-- .gitignore
 - History.txt
 - LICENSE
 - README.rdoc
@@ -59,26 +58,32 @@ homepage: http://github.com/progressions/natural_time
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Smart enumeration of durations in natural language

data/.gitignore

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