dotiw 0.6.0 → 0.7.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dotiw (0.6.0)
+    dotiw (0.7.0)
       actionpack (~> 3.0.0)
 
 GEM
@@ -51,6 +51,3 @@ DEPENDENCIES
   bundler (~> 1.0.0)
   dotiw!
   rspec (~> 2.0)
-
-METADATA
-  version: 1.0.6

data/README.markdown

@@ -18,60 +18,47 @@ Better than "about 1 year", am I right? Of course I am.
     >> distance_of_time_in_words(Time.now, Time.now + 1.second, false)
     => "1 second"
 
-This takes the same options plus an additional one on the end for passing options to the output (which uses `to_sentence`). 
-
-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"
+The third argument for this method is whether or not to include seconds. By default this is `false` (because in Rails' `distance_of_time_in_words` it is), you can turn it on though by passing `true` as the third argument:
 
-## distance\_of\_time\_in\_words\_hash
+    >> distance_of_time_in_words(Time.now, Time.now + 1.year + 1.second, true)
+    => "1 year, and 1 second" 
 
-Don't like any format you're given? That's cool too! Here, have an indifferent hash version:
+Yes this could just be merged into the options hash but I'm leaving it here to ensure "backwards-compatibility".
 
-    >> distance_of_time_in_words_hash(Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds)
-    => {"days"=>3, "seconds"=>6, "minutes"=>5, "years"=>1, "hours"=>4, "months"=>2}
+The last argument is an optional options hash that can be used to manipulate behavior and (which uses `to_sentence`). 
 
-Indiferrent means that you can access all keys by their `String` or `Symbol` version.
+Oh, and did I mention it supports I18n? Oh yeah.
 
 ### Options
 
 #### :locale
 
-The keys can be in your local language too:
+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):
 
-    >> distance_of_time_in_words_hash(Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, :locale => "es")
-    => {"horas"=>4, "días"=>3, "minutos"=>5, "segundos"=>6, "años"=>1, "meses"=>2}
+    >> distance_of_time_in_words(Time.now, Time.now + 1.minute, false, :locale => "es")
+    => "1 minuto"
     
-You are not guaranteed the order of the hash in Ruby 1.8.
+This will also be passed to `to_sentence`
 
-## distance\_of\_time\_in\_words
+#### :vague
 
-### Options
+Specify this if you want it to use the old `distance_of_time_in_words`. The value can be anything except `nil` or `false`.
 
-The third argument for this method is whether or not to include seconds. By default this is `false` (because in Rails' `distance_of_time_in_words` it is), you can turn it on though by passing `true` as the third argument:
+#### :singularize
 
-    >> distance_of_time_in_words(Time.now, Time.now + 1.year + 1.second, true)
-    => "1 year, and 1 second" 
-    
-Yes this could just be merged into the options hash but I'm leaving it here to ensure "backwards-compatibility".
+Specify if all values of the hash should be presented in their singular form. By default they will be pluralized whenever outside the `-1..1` range. If you wish to have them signularized, just add the option `:singularize => :always`.
 
-#### :vague
+This option is useful for Russian and Icelandic folks (https://github.com/radar/dotiw/issues#issue/2).
 
-Specify this if you want it to use the old `distance_of_time_in_words`. The value can be anything except `nil` or `false`.
+    >> distance_of_time_in_words(Time.now, Time.now + 2.hour + 2.minute, true, :singularize => :always)
+    => "2 hour and 2 minute"
 
-#### :locale
+#### :accumulate_on
 
-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):
+Specifies the maximum output unit which will accumulate all the surplus. Say you set it to seconds and your time difference is of 2 minutes then the output would be 120 seconds. Here's a code example:
 
-    >> distance_of_time_in_words(Time.now, Time.now + 1.minute, false, :locale => "es")
-    => "1 minuto"
-    
-This will also be passed to `to_sentence`
+    >> distance_of_time_in_words(Time.now, Time.now + 2.hour + 70.second, true, :accumulate_on => :minutes)
+    => "121 minutes minute and 10 seconds"
 
 #### :only
 
@@ -127,6 +114,22 @@ Using something other than ', and':
 
     >> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute + 1.second, true, { :last_word_connector => ', finally ' })
     => "1 hour, 1 minute, finally 1 second"
+
+## 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:
+
+    >> distance_of_time_in_words_hash(Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds)
+    => {"days"=>3, "seconds"=>6, "minutes"=>5, "years"=>1, "hours"=>4, "months"=>2}
+
+Indifferent means that you can access all keys by their `String` or `Symbol` version.
     
 ## distance\_of\_time\_in\_percent
 
@@ -139,4 +142,4 @@ If you want to calculate a distance of time in percent, use `distance_of_time_in
 
 * [chendo][http://github.com/chendo] - for talking through it with me and drawing on the whiteboard
 * [Derander][http://github.com/derander] - correct Spanish translations
-* [DBA][http://github.com/dba] - Commits leading up to the 0.6 release. 
+* [DBA][http://github.com/dba] - Commits leading up to the 0.7 release. 

data/lib/dotiw/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module DOTIW
-  VERSION = "0.6.0"
-end
+  VERSION = "0.7.0"
+end

data/lib/dotiw.rb

@@ -21,45 +21,6 @@ module ActionView
         display_time_in_words DOTIW::TimeHash.new(seconds).to_hash, options
       end
 
-      def display_time_in_words(hash, include_seconds = false, options = {})
-        options.symbolize_keys!
-        I18n.locale = options[:locale] if options[:locale]
-
-        time_measurements = { :years    => I18n.t(:years,   :default => "years"),
-                              :months   => I18n.t(:months,  :default => "months"),
-                              :weeks    => I18n.t(:weeks,   :default => "weeks"),
-                              :days     => I18n.t(:days,    :default => "days"),
-                              :hours    => I18n.t(:hours,   :default => "hours"),
-                              :minutes  => I18n.t(:minutes, :default => "minutes"),
-                              :seconds  => I18n.t(:seconds, :default => "seconds") }
-
-        hash.delete(time_measurements[:seconds]) if !include_seconds && hash[time_measurements[:minutes]]
-
-        # Remove all the values that are nil or excluded. Keep the required ones.
-        time_measurements.delete_if do |measure, key|
-          hash[key].nil? || hash[key].zero? || (!options[:except].nil? && options[:except].include?(key)) ||
-            (options[:only] && !options[:only].include?(key))
-        end
-
-        options.delete(:except)
-        options.delete(:only)
-
-        output = []
-
-        time_measurements.each do |measure, key|
-          name = hash[key] > 1 ? key : key.singularize
-          output += ["#{hash[key]} #{name}"]
-        end
-
-        # maybe only grab the first few values
-        if options[:precision]
-          output = output[0...options[:precision]]
-          options.delete(:precision)
-        end
-
-        output.to_sentence(options)
-      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)
@@ -72,6 +33,48 @@ module ActionView
         result = ((current_time - from_time) / distance) * 100
         number_with_precision(result, options).to_s + "%"
       end
+
+      private
+        def display_time_in_words(hash, include_seconds = false, options = {})
+          options.symbolize_keys!
+          I18n.locale = options[:locale] if options[:locale]
+
+          time_measurements = { :years    => I18n.t(:years,   :default => "years"),
+                                :months   => I18n.t(:months,  :default => "months"),
+                                :weeks    => I18n.t(:weeks,   :default => "weeks"),
+                                :days     => I18n.t(:days,    :default => "days"),
+                                :hours    => I18n.t(:hours,   :default => "hours"),
+                                :minutes  => I18n.t(:minutes, :default => "minutes"),
+                                :seconds  => I18n.t(:seconds, :default => "seconds") }
+
+          hash.delete(time_measurements[:seconds]) if !include_seconds && hash[time_measurements[:minutes]]
+
+          # Remove all the values that are nil or excluded. Keep the required ones.
+          time_measurements.delete_if do |measure, key|
+            hash[key].nil? || hash[key].zero? || (!options[:except].nil? && options[:except].include?(key)) ||
+              (options[:only] && !options[:only].include?(key))
+          end
+
+          options.delete(:except)
+          options.delete(:only)
+
+          output = []
+
+          time_measurements.each do |measure, key|
+            name = options[:singularize] == :always || hash[key].between?(-1, 1) ? key.singularize : key
+            output += ["#{hash[key]} #{name}"]
+          end
+
+          options.delete(:singularize)
+
+          # maybe only grab the first few values
+          if options[:precision]
+            output = output[0...options[:precision]]
+            options.delete(:precision)
+          end
+
+          output.to_sentence(options)
+        end
     end # DateHelper
   end # Helpers
 end # ActionView

data/spec/lib/dotiw_spec.rb

@@ -199,6 +199,10 @@ describe "A better distance_of_time_in_words" do
        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 + 2.year + 3.months + 4.days + 5.hours + 6.minutes + 7.seconds,
+       { :singularize => :always },
+       "2 year, 3 month, 4 day, 5 hour, 6 minute, and 7 second"]
     ].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,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dotiw
 version: !ruby/object:Gem::Version 
+  hash: 3
   prerelease: false
   segments: 
   - 0
-  - 6
+  - 7
   - 0
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Ryan Bigg
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 3
         - 0
@@ -40,6 +42,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 1
         - 0
@@ -55,6 +58,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 2
         - 0
@@ -101,6 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -109,6 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 23
       segments: 
       - 1
       - 3