humantime 0.2.1 → 0.2.2

data/README.md

@@ -21,6 +21,10 @@ Output a number of seconds in human readable form:
     >> HumanTime.output 5452302
     => "2 months"
     
+Output the number of seconds in human readable form, rounding up to a minimum unit:
+
+    >> HumanTime.output 53005, { :round_to => HumanTime::DAY }
+    
 Get the difference between two integer values of seconds:
 
     >> HumanTime.between 3600, 60
@@ -30,10 +34,55 @@ Get the difference between two integer values of seconds:
  
     >> HumanTime.between Time.now, Time.now
     => "0 seconds" 
+    
+    >> t1 = Time.utc( 2011, 12, 1 )
+    => 2011-12-01 00:00:00 UTC 
+    >> t2 = Time.utc( 2011, 12, 8 )
+    => 2011-12-08 00:00:00 UTC 
+    >> HumanTime.between t1, t2
+    => "1 week" 
+    
+    >> t1 = Time.now
+    => 2012-04-03 11:35:22 +0100 
+    >> t2 = Time.now + 3600
+    => 2012-04-03 12:35:26 +0100 
+    >> HumanTime.between t1, t2
+    => "1 hour" 
+    
+You can also additional options to #output or #between.
+
+To round up times:
 
+    >> HumanTime.output 23
+    => "23 seconds" 
+    >> HumanTime.output 23, { :round_to => HumanTime::MINUTE }
+    => "1 minute" 
+    >> HumanTime.output 234
+    => "3 minutes 54 seconds" 
+    >> HumanTime.output 234, { :round_to => HumanTime::HOUR }
+    => "1 hour" 
+    >> HumanTime.output 53005
+    => "14 hours 43 minutes" 
+    >> HumanTime.output 53005, { :round_to => HumanTime::DAY }
+    => "1 day" 
+    >> HumanTime.output 530052
+    => "6 days" 
+    >> HumanTime.output 530052, { :round_to => HumanTime::WEEK }
+    => "6 days" 
+    >> HumanTime.output 1209600
+    => "2 weeks" 
+    >> HumanTime.output 1209600, { :round_to => HumanTime::MONTH }
+    => "1 month" 
+    >> HumanTime.output 5452302
+    => "2 months" 
+    >> HumanTime.output 5452302, { :round_to => HumanTime::YEAR }
+    => "2 months"
+    
     >> t1 = Time.now
     => 2012-04-03 11:35:22 +0100 
     >> t2 = Time.now + 3600
     => 2012-04-03 12:35:26 +0100 
     >> HumanTime.between t1, t2
-    => "1 hour" 
+    => "1 hour" 
+    >> HumanTime.between t1, t2, { :round_to => HumanTime::DAY }
+    => "1 day" 

data/lib/humantime.rb

@@ -4,11 +4,12 @@ class HumanTime
   MINUTE = 60
   HOUR = 3600
   DAY = 86400
+  WEEK = 604800
   MONTH = 2629743
   YEAR = 31556926
   
   # Parse an integer and return the string representation of a time
-  def self.output int
+  def self.output int, options = {}
     str = []
     display = ['years', 'months', 'days', 'hours', 'minutes', 'seconds']
     
@@ -31,13 +32,18 @@ class HumanTime
     end
         
     # Months
-    if int < YEAR && int > ( MONTH - 1 ) && display.include?('months')
+    if ( int < YEAR && int > ( MONTH - 1 ) && display.include?('months') ) || options[:round_to] == MONTH
       months = int / MONTH
       int = int - ( months * MONTH )
       display.delete 'minutes'
       display.delete 'seconds'
       display.delete 'hours' 
       
+      if options[:round_to] == MONTH
+        months = months.round + 1
+        int = 0
+      end
+      
       if months.round == 1
         str << "#{months.round} month"
       elsif months.round == 12
@@ -49,12 +55,17 @@ class HumanTime
     end
         
     # Days
-    if int < MONTH && int > ( DAY - 1 ) && display.include?('hours')
+    if ( int < MONTH && int > ( DAY - 1 ) && display.include?('hours')) || options[:round_to] == DAY
       days = int / DAY
       int = int - ( days * DAY )
       display.delete 'minutes' 
       display.delete 'seconds'
       
+      if options[:round_to] == DAY
+        days = days.round + 1
+        int = 0
+      end
+      
       if days.round == 1
         str << "#{days.round} day"
       else
@@ -74,32 +85,42 @@ class HumanTime
     end    
         
     # Hours
-    if int < DAY && int > ( HOUR - 1 ) && display.include?('hours')
+    if ( int < DAY && int > ( HOUR - 1 ) && display.include?('hours') ) || options[:round_to] == HOUR
       hours = int / HOUR
       int = int - ( hours * HOUR )
       display.delete 'seconds'
       
-      if hours.round == 1
-        str << "#{hours.round} hour"
+      if options[:round_to] == HOUR
+        hours = hours.round + 1
+        int = 0
+      end
+      
+      if hours == 1
+        str << "#{hours} hour"
       else
-        str << "#{hours.round} hours"
+        str << "#{hours} hours"
       end
     end
         
     # Minutes
-    if int < HOUR && int > ( MINUTE - 1 ) && display.include?('minutes')
+    if ( int < HOUR && int > ( MINUTE - 1 ) && display.include?('minutes') ) || options[:round_to] == MINUTE
       mins = int / MINUTE
       int = int - ( mins * MINUTE )
       
-      if mins.round == 1
-        str << "#{mins.round} minute"
+      if options[:round_to] == MINUTE
+        mins = mins.round + 1
+        int = 0
+      end
+      
+      if mins == 1
+        str << "#{mins} minute"
       else
-        str << "#{mins.round} minutes"
+        str << "#{mins} minutes"
       end
     end
         
     # Seconds
-    if int < MINUTE && int > 0 && display.include?('seconds')
+    if int < MINUTE && int > 0 && display.include?('seconds')      
       if int.round == 1
         str << "#{int.round} second"
       else
@@ -111,7 +132,7 @@ class HumanTime
   end
   
   # Output the difference betwen two integer / DateTime / Time values
-  def self.between start_time, end_time
+  def self.between start_time, end_time, options = {}
     et = end_time.to_i
     st = start_time.to_i
     
@@ -122,7 +143,7 @@ class HumanTime
     else
       diff = 0
     end
-    self.output diff
+    self.output diff, options
   end
     
   # From https://github.com/hpoydar/chronic_duration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: humantime
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70092746521980 !ruby/object:Gem::Requirement
+  requirement: &70274888367980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70092746521980
+  version_requirements: *70274888367980
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70092746520160 !ruby/object:Gem::Requirement
+  requirement: &70274888366260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70092746520160
+  version_requirements: *70274888366260
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70092746518240 !ruby/object:Gem::Requirement
+  requirement: &70274888363980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70092746518240
+  version_requirements: *70274888363980
 description: Outputs human readable times
 email: james@jamesinman.co.uk
 executables: []
@@ -70,7 +70,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2380798774758535066
+      hash: 2626903473191386984
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: