natural_time 0.0.2 → 0.0.3

data/History.txt

@@ -0,0 +1,10 @@
+== 0.0.3 2010-01-22
+  * major enhancements
+    * specify level of precision
+    * distance method shows whether it's past or future
+  * minor enhancements
+  * bug fixes
+
+== 0.0.2 2010-01-13
+  * major enhancements
+    * outputs duration of time in natural language

data/README.rdoc

@@ -2,10 +2,17 @@
 
 NaturalTime outputs a duration in natural language.
 
-65 seconds becomes "1 minute, 5 seconds".
+== Usage
 
-120 seconds becomes "2 minutes".
+  NaturalTime.new(65).to_sentence         #=> "1 minute, 5 seconds"
 
+  NaturalTime.new(120).to_sentence        #=> "2 minutes"
+
+NaturalTime instances can also be output to an array:
+
+  NaturalTime.new(65).to_array            #=> ["1 minutes", "5 seconds"]
+  
+  NaturalTime.new(120).to_array           #=> ["2 minutes"]
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -11,7 +11,7 @@ begin
     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.add_runtime_dependency "activesupport", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -29,6 +29,7 @@ end
 Spec::Rake::SpecTask.new(:rcov) do |spec|
   spec.libs << 'lib' << 'spec'
   spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov_opts = ['--exclude', '.gem,Library,spec', '--sort', 'coverage']
   spec.rcov = true
 end
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/natural_time.rb

@@ -2,13 +2,15 @@ require 'rubygems'
 require 'active_support'
 
 class NaturalTime
-  attr_accessor :duration
+  attr_accessor :duration, :precision, :past
 
   UNITS_OF_TIME = [["year", "years"], ["month", "months"], ["week", "weeks"], ["day", "days"], ["hour", "hours"], ["minute", "minutes"]]
   
-  def initialize(duration_in_seconds)
+  def initialize(duration_in_seconds, options={})
+    @precision = options[:precision]
     duration_in_seconds = duration_in_seconds.to_i
-    @duration = duration_in_seconds
+    @past = duration_in_seconds < 1
+    @duration = duration_in_seconds.abs
     elapsed_time = elapsed_time(duration_in_seconds)
   end
   
@@ -24,10 +26,23 @@ class NaturalTime
     natural_time
   end
   
-  def to_array
+  def to_a
     elapsed_time(duration)
   end
   
+  def to_array
+    to_a
+  end
+  
+  def distance
+    if past
+      modifier = "ago"
+    else
+      modifier = "from now"
+    end
+    "#{to_sentence} #{modifier}"
+  end
+  
   def elapsed_time(duration_in_seconds)
     elapsed_time = []
 
@@ -44,6 +59,10 @@ class NaturalTime
     str = seconds == 1 ? "second" : "seconds"
     elapsed_time << "#{seconds.to_i} #{str}" unless (seconds == 0 && elapsed_time.compact.length > 0)    
     
-    elapsed_time.compact
+    if precision
+      elapsed_time.compact.first(precision)
+    else
+      elapsed_time.compact
+    end
   end
 end

data/natural_time.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{natural_time}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   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.date = %q{2010-01-22}
   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 = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "History.txt",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
@@ -27,8 +28,7 @@ Gem::Specification.new do |s|
      "natural_time.gemspec",
      "spec/natural_time_spec.rb",
      "spec/spec.opts",
-     "spec/spec_helper.rb",
-     "test.rb"
+     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/progressions/natural_time}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -46,7 +46,7 @@ Gem::Specification.new do |s|
 
     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"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.6"])
       s.add_dependency(%q<activesupport>, [">= 0"])

data/spec/natural_time_spec.rb

@@ -199,6 +199,53 @@ describe "Naturaltime" do
     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
+  
+    describe "precision" do
+      it "should limit the precision to 1" do
+        NaturalTime.new(1.week + 1.minutes + 1.second, :precision => 1).natural_time.should == "1 week"
+      end
+      
+      it "should limit the precision to 2" do
+        NaturalTime.new(1.week + 1.minutes + 1.second, :precision => 2).natural_time.should == "1 week, 1 minute"
+      end
+      
+      it "should show the distance with precision of 1 in the past" do
+        distance = -1 * (1.week + 1.minutes + 1.second)
+        NaturalTime.new(distance, :precision => 1).distance.should == "1 week ago"
+      end
+      
+      it "should show the distance with precision of 2 in the past" do
+        distance = -1 * (1.week + 1.minutes + 1.second)
+        NaturalTime.new(distance, :precision => 2).distance.should == "1 week and 1 minute ago"
+      end
+      
+      it "should show the distance with precision of 1 in the future" do
+        distance = (1.week + 1.minutes + 1.second)
+        NaturalTime.new(distance, :precision => 1).distance.should == "1 week from now"
+      end
+      
+      it "should show the distance with precision of 2 in the future" do
+        distance = (1.week + 1.minutes + 1.second)
+        NaturalTime.new(distance, :precision => 2).distance.should == "1 week and 1 minute from now"
+      end
+    end
+    
+    describe "distances" do
+      it "should give the distance in the past" do
+        NaturalTime.new(-1).distance.should == "1 second ago"
+      end
+      
+      it "should give the distance in the past" do
+        NaturalTime.new(-2).distance.should == "2 seconds ago"
+      end
+      it "should give the distance in the future" do
+        NaturalTime.new(1).distance.should == "1 second from now"
+      end
+      
+      it "should give the distance in the future" do
+        NaturalTime.new(2).distance.should == "2 seconds from now"
+      end
+    end
   end
   
   describe "to_s" do
@@ -208,17 +255,51 @@ describe "Naturaltime" do
         @natural_time.to_s.should == @natural_time.natural_time
       end
     end
+  
+    describe "precision" do
+      it "should limit the precision to 1" do
+        NaturalTime.new(1.week + 1.minutes + 1.second, :precision => 1).to_s.should == "1 week"
+      end
+      
+      it "should limit the precision to 2" do
+        NaturalTime.new(1.week + 1.minutes + 1.second, :precision => 2).to_s.should == "1 week, 1 minute"
+      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
+  
+    describe "precision" do
+      it "should limit the precision to 1" do
+        NaturalTime.new(1.week + 1.minutes + 1.second, :precision => 1).to_sentence.should == "1 week"
+      end
+      
+      it "should limit the precision to 2" do
+        NaturalTime.new(1.week + 1.minutes + 1.second, :precision => 2).to_sentence.should == "1 week and 1 minute"
+      end
+    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
+    
+    it "should return an array" do
+      NaturalTime.new(1.minutes + 1.second).to_a.should == ["1 minute", "1 second"]
+    end
+  
+    describe "precision" do
+      it "should limit the precision to 1" do
+        NaturalTime.new(1.week + 1.minutes + 1.second, :precision => 1).to_a.should == ["1 week"]
+      end
+      
+      it "should limit the precision to 2" do
+        NaturalTime.new(1.week + 1.minutes + 1.second, :precision => 2).to_a.should == ["1 week", "1 minute"]
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: natural_time
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Jeff Coleman
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-13 00:00:00 -06:00
+date: 2010-01-22 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,7 +24,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  type: :development
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -44,6 +44,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- History.txt
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -53,7 +54,6 @@ files:
 - 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: []

data/test.rb

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