time_difference 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f41189c3216e381c0b064cde1fd7de7bad4a7bf
-  data.tar.gz: 79c6dff109309e90f0b0303b927b47ba5521e286
+  metadata.gz: 521798b61869e9f427fbca86a655a6c58fb2d1dd
+  data.tar.gz: 057f1bca6e4d5635b8acf32cd9712f94c597f037
 SHA512:
-  metadata.gz: 423c17b810279a3b072d423542ea31ea985a97644aa91096ffc1932bf05b6841599a6d8c81ee44901bed63fdd85a469debd573370f0cde6359574052804ad92c
-  data.tar.gz: d8b9992a80bf9b35fbda3d8d04ecccbd104aefa23f71c7457926ec9dad47f7967a45059904c3cfd5ffab5fd8d331d2deaa17820944f7fb1581773e52c5417162
+  metadata.gz: af876c743e4defbd0595924b6f579e59d1d43bd0b421d27de0749f782bd9e78e5e2ad8fee73f88ccd9921755417093d18eec62c8814d1d2e573b8e2c945def79
+  data.tar.gz: a366fd8bf3be6e4e46c0c50e49ad93800b52c0703079b4ed273839458311747bcb0304f215e6c2307648c744618c0b979a3de2212a1e9b960855c6b4aaf45b61

data/.travis.yml

@@ -7,5 +7,8 @@ rvm:
 # uncomment this line if your project needs to run something other than `rake`:
 script: bundle exec rspec spec
 gemfile:
-- Gemfile.activesupport32
-- Gemfile
+  - Gemfile.activesupport32
+  - Gemfile
+
+before_install:
+  - gem install bundler

data/README.md

@@ -8,63 +8,100 @@ TimeDifference is the missing Ruby method to calculate difference between two gi
 
 Add this line to your application's Gemfile:
 
-    gem 'time_difference'
+```ruby
+gem 'time_difference'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle install
+```
 
 ## Usage
 
-### Get the time difference in year
+### Works for Time, DateTime, and Date
 
-	# Works for Time, DateTime, and Date
-	start_time = Time.new(2013,1)
-	end_time = Time.new(2014,1)
-	TimeDifference.between(start_time, end_time).in_years
-	=> 1.0
+```ruby
+# Time
+start_time = Time.new(2013,1)
+end_time = Time.new(2014,1)
 
-	start_time = DateTime.new(2013,1)
-	end_time = DateTime.new(2014,1)
-	TimeDifference.between(start_time, end_time).in_years
-	=> 1.0
+TimeDifference.between(start_time, end_time).in_years
+=> 1.0
 
-	start_time = Date.new(2013,1)
-	end_time = Date.new(2014,1)
-	TimeDifference.between(start_time, end_time).in_years
-	=> 1.0
+# DateTime
+start_time = DateTime.new(2013,1)
+end_time = DateTime.new(2014,1)
 
-### Get the time difference in months
+TimeDifference.between(start_time, end_time).in_years
+=> 1.0
 
-	start_time = Time.new(2013,1)
-	end_time = Time.new(2014,1)
-	TimeDifference.between(start_time, end_time).in_months
-	=> 12.0
+# Date
+start_time = Date.new(2013,1)
+end_time = Date.new(2014,1)
+
+TimeDifference.between(start_time, end_time).in_years
+=> 1.0
+```
+
+### Get the time difference in various units
+
+```ruby
+start_time = Time.new(2013,1)
+end_time = Time.new(2014,1)
+
+TimeDifference.between(start_time, end_time).in_years
+=> 1.0
+
+TimeDifference.between(start_time, end_time).in_months
+=> 12.0
+
+TimeDifference.between(start_time, end_time).in_weeks
+=> 52.14 
+
+TimeDifference.between(start_time, end_time).in_days
+=> 365.0 
+
+TimeDifference.between(start_time, end_time).in_hours
+=> 8760.0
+
+TimeDifference.between(start_time, end_time).in_minutes
+=> 525600.0
+
+TimeDifference.between(start_time, end_time).in_seconds
+=> 31536000.0 
+```
 
 ### Get the time difference in each component
 
-	start_time = Time.new(2013,1)
-	end_time = Time.new(2014,1)
-	TimeDifference.between(start_time, end_time).in_each_component
-	=> {:years=>1.0, :months=>12.0, :weeks=>52.14, :days=>365.0, :hours=>8760.0, :minutes=>525600.0, :seconds=>31536000.0}
+```ruby
+start_time = Time.new(2013,1)
+end_time = Time.new(2014,1)
+
+TimeDifference.between(start_time, end_time).in_each_component
+=> {:years=>1.0, :months=>12.0, :weeks=>52.14, :days=>365.0, :hours=>8760.0, :minutes=>525600.0, :seconds=>31536000.0}
+```
+
+### If you would like an overall estimated time component, use `in_general` _(not that accurate)_
+
+```ruby
+start_time = Time.new(2013,1)
+end_time = Time.new(2014,1)
 
-### If you would like an overall estimated time component, use in_general (not that accurate)
+TimeDifference.between(start_time, end_time).in_general
+=> {:years=>0, :months=>12, :weeks=>0, :days=>5, :hours=>0, :minutes=>0, :seconds=>0}
+```
 
-	start_time = Time.new(2013,1)
-	end_time = Time.new(2014,1)
-	TimeDifference.between(start_time, end_time).in_general
-	=> {:years=>0, :months=>12, :weeks=>0, :days=>5, :hours=>0, :minutes=>0, :seconds=>0}
+### You can also get `in_general` as a human readable string, using `humanize`
 
-### Supported time difference includes
+```ruby
+start_time = Time.new(2013,1)
+end_time = Time.new(2014,1)
 
-	in_years
-	in_months
-	in_weeks
-	in_days
-	in_hours
-	in_minutes
-	in_seconds
-	
+TimeDifference.between(start_time, end_time).humanize
+=> "12 Months and 5 Days"
+```
 
 ## Contributing
 

data/lib/time_difference.rb

@@ -56,6 +56,27 @@ class TimeDifference
     end]
   end
 
+  def humanize
+    diff_parts = []
+    in_general.each do |part,quantity|
+      next if quantity <= 0
+      part = part.to_s.humanize
+
+      if quantity <= 1
+        part = part.singularize
+      end
+
+      diff_parts << "#{quantity} #{part}"
+    end
+
+    last_part = diff_parts.pop
+    if diff_parts.empty?
+      return last_part
+    else
+      return [diff_parts.join(', '), last_part].join(' and ')
+    end
+  end
+
   private
   
   def initialize(start_time, end_time)

data/spec/spec_helper.rb

@@ -4,4 +4,7 @@ require 'time_difference'
 RSpec.configure do |config|
   config.color_enabled = true
   config.formatter     = 'documentation'
+
+  # Configure Timezone for proper tests
+  ENV['TZ'] = 'UTC'
 end

data/spec/time_difference_spec.rb

@@ -13,11 +13,13 @@ describe TimeDifference do
   end
 
   describe ".between" do
-    it "returns a new TimeDifference instance" do
-      start_time = Time.new(2011, 1)
-      end_time = Time.new(2011, 12)
+    with_each_class do |clazz|
+      it "returns a new TimeDifference instance in each component" do
+        start_time = clazz.new(2011, 1)
+        end_time = clazz.new(2011, 12)
 
-      expect(TimeDifference.between(start_time, end_time)).to be_a(TimeDifference)
+        expect(TimeDifference.between(start_time, end_time)).to be_a(TimeDifference)
+      end
     end
   end
 
@@ -27,7 +29,7 @@ describe TimeDifference do
         start_time = clazz.new(2011, 1)
         end_time = clazz.new(2011, 12)
 
-        expect(TimeDifference.between(start_time, end_time).in_each_component).to eql({:years => 0.91, :months => 10.98, :weeks => 47.71, :days => 334.0, :hours => 8016.0, :minutes => 480960.0, :seconds => 28857600.0})
+        expect(TimeDifference.between(start_time, end_time).in_each_component).to eql({years: 0.91, months: 10.98, weeks: 47.71, days: 334.0, hours: 8016.0, minutes: 480960.0, seconds: 28857600.0})
       end
     end
   end
@@ -38,7 +40,18 @@ describe TimeDifference do
         start_time = clazz.new(2009, 11)
         end_time = clazz.new(2011, 1)
 
-        expect(TimeDifference.between(start_time, end_time).in_general).to eql({:years => 1, :months => 2, :weeks => 0, :days => 0, :hours => 18, :minutes => 0, :seconds => 0})
+        expect(TimeDifference.between(start_time, end_time).in_general).to eql({years: 1, months: 2, weeks: 0, days: 0, hours: 18, minutes: 0, seconds: 0})
+      end
+    end
+  end
+
+  describe "#humanize" do
+    with_each_class do |clazz|
+      it "returns a string representing the time difference from in_general" do
+        start_time = clazz.new(2009, 11)
+        end_time = clazz.new(2011, 1)
+
+        expect(TimeDifference.between(start_time, end_time).humanize).to eql("1 Year, 2 Months and 18 Hours")
       end
     end
   end

data/time_difference.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "time_difference"
   gem.require_paths = ["lib"]
-  gem.version       = "0.4.2"
+  gem.version       = "0.5.0"
   gem.license = 'MIT'
 
   gem.add_runtime_dependency('activesupport')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_difference
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - TM Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-24 00:00:00.000000000 Z
+date: 2016-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: TimeDifference is the missing Ruby method to calculate difference between