dotiw 0.3.0 → 0.3.1

data/.gitignore

@@ -1,2 +1,3 @@
 tmp
+pkg
 spec/fixtures/database.yml

data/README.markdown

@@ -16,6 +16,13 @@ This takes the same options plus an additional one on the end for passing option
 
 Oh, and did I mention it supports I18n? Oh yeah.
 
+## distance\_of\_time
+
+If you have simply a number of seconds you can get the "stringified" version of this by using `distance_of_time`:
+
+    >> distance_of_time(300)
+    => "5 minutes"
+
 ## distance\_of\_time\_in\_words\_hash
 
 Don't like any format you're given? That's cool too! Here, have an indifferent hash version:
@@ -47,6 +54,10 @@ The third argument for this method is whether or not to include seconds. By defa
     
 Yes this could just be merged into the options hash but I'm leaving it here to ensure "backwards-compatibility".
 
+#### :vague
+
+Specify this if you want it to use the old `distance_of_time_in_words`. The value can be anything except `nil` or `false`.
+
 #### :locale
 
 You can pass in a locale and it'll output it in whatever language you want (provided you have translations, otherwise it'll default to English):

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/dotiw.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# 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{dotiw}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Bigg"]
-  s.date = %q{2009-10-18}
+  s.date = %q{2009-12-12}
   s.description = %q{Better distance_of_time_in_words for Rails}
   s.email = %q{radarlistener@gmail.com}
   s.extra_rdoc_files = [
@@ -24,7 +24,6 @@ Gem::Specification.new do |s|
      "dotiw.gemspec",
      "lib/dotiw.rb",
      "lib/i18n.rb",
-     "pkg/dotiw-0.2.4.gem",
      "rails/init.rb",
      "spec/dotiw_spec.rb",
      "spec/spec_helper.rb",
@@ -54,3 +53,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rspec>, [">= 0"])
   end
 end
+

data/lib/dotiw.rb

@@ -1,12 +1,19 @@
+# encoding: utf-8
 module ActionView
   module Helpers
     module DateHelper
       def distance_of_time_in_words_hash(from_time, to_time, options={})
-        output = HashWithIndifferentAccess.new
         from_time = from_time.to_time if from_time.respond_to?(:to_time)
         to_time = to_time.to_time if to_time.respond_to?(:to_time)
         
         distance = (from_time - to_time).abs
+        distance_of_time_hash(distance, from_time, to_time, options)
+      end
+      
+      def distance_of_time_hash(distance, from_time = nil, to_time = nil, options={})
+        output = HashWithIndifferentAccess.new
+        from_time ||= Time.now
+        to_time ||= from_time + distance.seconds
         I18n.with_options :locale => options[:locale] do |locale|
           while distance > 0
             if distance < 1.minute
@@ -34,7 +41,7 @@ module ActionView
                 # Convert the last month to days and add to total
                 months -= 1
                 last_month = largest.advance(:months => -1)
-                days += Time.days_in_month(last_month.month, last_month.year)              
+                days += Time.days_in_month(last_month.month, last_month.year)
               end
             
               if months < 0
@@ -54,8 +61,13 @@ module ActionView
         output
       end
       
-      def distance_of_time_in_words(from_time, to_time, include_seconds = false, options = {})
-        hash = distance_of_time_in_words_hash(from_time, to_time, options)
+      alias_method :old_distance_of_time_in_words, :distance_of_time_in_words
+      
+      def distance_of_time(seconds, options = {})
+        display_time_in_words(distance_of_time_hash(seconds), options)
+      end
+      
+      def display_time_in_words(hash, include_seconds = false, options = {})
         hash.delete(:seconds) if !include_seconds
         I18n.with_options :locale => options[:locale] do |locale|
           # Remove all the values that are nil.
@@ -87,8 +99,15 @@ module ActionView
             options.delete(:precision)
           end
         
+        
           output.to_sentence(options)
-        end    
+        end
+      end
+      
+      def distance_of_time_in_words(from_time, to_time, include_seconds = false, options = {})
+        return old_distance_of_time_in_words(from_time, to_time, include_seconds, options) if options.delete(:vague)
+        hash = distance_of_time_in_words_hash(from_time, to_time, options)
+        display_time_in_words(hash, include_seconds, options)
       end
     end
   end

data/spec/dotiw_spec.rb

@@ -12,6 +12,20 @@ describe "A better distance_of_time_in_words" do
     Time.zone.stub!(:now).and_return(time)
   end
   
+  describe "distance of time" do
+    [
+      [5.minutes.to_i, "5 minutes"],
+      [10.minutes.to_i, "10 minutes"],
+      [1.hour.to_i, "1 hour"],
+      [4.weeks.to_i, "4 weeks"],
+      [24.weeks.to_i, "5 months and 15 days"],
+    ].each do |number, result|
+      it "#{number} == #{result}" do
+        distance_of_time(number).should eql(result)
+      end
+    end
+  end
+  
   describe "hash version" do
     describe "giving correct numbers of" do
       
@@ -87,16 +101,26 @@ describe "A better distance_of_time_in_words" do
   describe "with output options" do
    [
       # Any numeric sequence is merely coincidental.
-      [Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, { :except => "minutes" }, "1 year, 2 months, 3 days, 4 hours, and 6 seconds"],
       [Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, { :words_connector => " - " }, "1 year - 2 months - 3 days - 4 hours - 5 minutes, and 6 seconds"],
+      
       [Time.now, Time.now + 5.minutes + 6.seconds, { :two_words_connector => " - " }, "5 minutes - 6 seconds"],
+      
       [Time.now, Time.now + 4.hours +  5.minutes + 6.seconds, { :last_word_connector => " - " }, "4 hours, 5 minutes - 6 seconds"],
+      
+      [Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, { :except => "minutes" }, "1 year, 2 months, 3 days, 4 hours, and 6 seconds"],
       [Time.now, Time.now + 1.hour + 1.minute, { :except => "minutes"}, "1 hour"],
       [Time.now, Time.now + 1.hour + 1.day + 1.minute, { :except => ["minutes", "hours"]}, "1 day"],
+      
       [Time.now, Time.now + 1.hour + 1.day + 1.minute, { :only => ["minutes", "hours"]}, "1 hour and 1 minute"],
+      
       [Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, { :precision => 2 }, "1 year and 2 months"],
       [Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, { :precision => 3 }, "1 year, 2 months, and 3 days"],
-      [Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, { :precision => 10 }, "1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6 seconds"]
+      [Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, { :precision => 10 }, "1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6 seconds"],
+      
+      [Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, { :vague => true }, "about 1 year"],
+      [Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, { :vague => "Yes please" }, "about 1 year"],
+      [Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, { :vague => false }, "1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6 seconds"],
+      [Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, { :vague => nil }, "1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6 seconds"],
     ].each do |start, finish, options, output|
       it "should be #{output}" do
         distance_of_time_in_words(start, finish, true, options).should eql(output)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dotiw
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Ryan Bigg
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-18 00:00:00 +10:00
+date: 2009-12-12 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,7 +39,6 @@ files:
 - dotiw.gemspec
 - lib/dotiw.rb
 - lib/i18n.rb
-- pkg/dotiw-0.2.4.gem
 - rails/init.rb
 - spec/dotiw_spec.rb
 - spec/spec_helper.rb