time_units 0.1.0 → 0.2.0

data/ChangeLog

@@ -0,0 +1,7 @@
+
+
+# 0.2.0
+
+- added months and years
+- human_duration now take an argument allowing to limit the number of fields returned
+  (ex: (2.months + 1.hour + 10.seconds).human_duration(2) => "2 months 1 hour" )

data/lib/time_units/duration.rb

@@ -5,21 +5,25 @@ module TimeDuration
   end
   
   self.units = [
-    [1.week,    :weeks,   "week", "weeks"],
-    [1.day,     :days,    "day", 'days'],
-    [1.hour,    :hours,   "hour", "hours"],
-    [1.minute,  :minutes, "min", "mins"],
-    [1,         :seconds, "s", "s"]
+    [1.year,    :years,   "year",   "years"],
+    [1.month,   :months,  "month",  "months"],
+    [1.week,    :weeks,   "week",   "weeks"],
+    [1.day,     :days,    "day",    "days"],
+    [1.hour,    :hours,   "hour",   "hours"],
+    [1.minute,  :minutes, "min",    "mins"],
+    [1,         :seconds, "s",      "s"]
   ]
   
-  def human_duration
-    diff = {
-      :weeks    => 0,
-      :days     => 0,
-      :hours    => 0,
-      :minutes  => 0,
-      :seconds  => 0
-    }
+  ##
+  # Format a duration for display.
+  # 
+  # @param [Integer,nil] limit if set this will limit the
+  #   number of fields shown (ex: 2 = 2 months 3 weeks)
+  # 
+  # @return [String] the formatted duration
+  # 
+  def human_duration(limit = nil)
+    diff = Hash.new(0)
     
     ret = []
     
@@ -45,7 +49,13 @@ module TimeDuration
     
     TimeDuration.units.each.with_index do |unit|
       unit_name = unit[1]
-      ret << pluralize.(diff[unit_name], unit)     if diff[unit_name] > 0
+      if diff[unit_name] > 0
+        ret << pluralize.(diff[unit_name], unit)
+        
+        if ret.size == limit
+          break
+        end
+      end
     end
     
     ret.join(' ')

data/lib/time_units/version.rb

@@ -1,3 +1,3 @@
 module TimeUnits
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/specs/unit/duration_spec.rb

@@ -18,5 +18,9 @@ describe 'TimeDuration' do
     (2*day1 + 21*hour1 + 3).human_duration.should == "2 days 21 hours 3 s"
     
     (2.weeks + 36.hours).human_duration.should == "2 weeks 1 day 12 hours"
+    (2.weeks + 36.hours).human_duration(2).should == "2 weeks 1 day"
+    
+    (2.months).human_duration.should == "2 months"
+    (2.years + 1.month).human_duration.should == "2 years 1 month"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: time_units
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-29 00:00:00.000000000 Z
+date: 2012-07-13 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- ChangeLog
 - Gemfile
 - Guardfile
 - LICENSE
@@ -46,7 +47,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2833575916128421829
+      hash: 4060331108915470852
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -55,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2833575916128421829
+      hash: 4060331108915470852
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24