time_diff 0.1.1 → 0.2.0

data/README

@@ -16,3 +16,19 @@ You can use the difference like:
 
 diff[:year], diff[:month], diff[:week]
 
+
+Formatted Time difference
+-------------------------
+
+%y - year
+%M - month
+%w - week
+%d - day
+%h - hour
+%m - minute
+%s - second
+
+By default the format is '%y, %M, %w, %d and %h:%m:%s' this will return '1 year, 2 months, 3 weeks, 4 days and 12:05:52'.
+You will get the result from the output hash, time_diff_components[:diff] 
+
+You can pass your own format as third parameter to this function.

data/README.rdoc

@@ -8,13 +8,28 @@ gem install time_diff
 
 require 'time_diff'
 
-diff = Time.diff(start_date_time, end_date_time)
+time_diff_components = Time.diff(start_date_time, end_date_time)
 
 This will return the hash of time difference in terms of years, month, week, day, hour, minute and second.
 
 You can use the difference like:
 
-diff[:year], diff[:month], diff[:week]
+time_diff_components[:year], time_diff_components[:month], time_diff_components[:week]
+
+==Formatted Time difference
+
+%y - year
+%M - month
+%w - week
+%d - day
+%h - hour
+%m - minute
+%s - second
+
+By default the format is '%y, %M, %w, %d and %h:%m:%s' this will return '1 year, 2 months, 3 weeks, 4 days and 12:05:52'.
+You will get the result from the output hash, time_diff_components[:diff] 
+
+You can pass your own format as third parameter to this function.
 
 == Contributing to time_diff
  

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/time_diff.rb

@@ -2,17 +2,52 @@ require 'rubygems'
 require 'active_support/all'
 
 class Time
-  def self.diff(start_date, end_date)
-    from_time = start_date.to_time if start_date.respond_to?(:to_time)
-    to_time = end_date.to_time if end_date.respond_to?(:to_time)
-    distance_in_seconds = ((to_time - from_time).abs).round
+  def self.diff(start_date, end_date, format_string='%y, %M, %w, %d and %h:%m:%s')
+    start_time = start_date.to_time if start_date.respond_to?(:to_time)
+    end_time = end_date.to_time if end_date.respond_to?(:to_time)
+    distance_in_seconds = ((end_time - start_time).abs).round
     components = []
 
     %w(year month week day hour minute second).each do |interval|
-        delta = (distance_in_seconds / 1.send(interval)).floor
-        distance_in_seconds -= delta.send(interval)
-        components << delta
+        component = (distance_in_seconds / 1.send(interval)).floor
+        distance_in_seconds -= component.send(interval)
+        components << component
     end
-    return {:year => components[0], :month => components[1], :week => components[2], :day => components[3], :hour => components[4], :minute => components[5], :second => components[6]}
+    time_diff_components = {:year => components[0], :month => components[1], :week => components[2], :day => components[3], :hour => components[4], :minute => components[5], :second => components[6]}
+    format_string = remove_format_string_for_zero_components(time_diff_components, format_string)
+    time_diff_components[:diff] = format_date_time(time_diff_components, format_string) unless format_string.nil?
+    return time_diff_components
+  end
+
+  def Time.format_date_time(time_diff_components, format_string)
+    format_string.gsub!('%y', "#{time_diff_components[:year]} #{pluralize('year', time_diff_components[:year])}")
+    format_string.gsub!('%M', "#{time_diff_components[:month]} #{pluralize('month', time_diff_components[:month])}")
+    format_string.gsub!('%w', "#{time_diff_components[:week]} #{pluralize('week', time_diff_components[:week])}")
+    format_string.gsub!('%d', "#{time_diff_components[:day]} #{pluralize('day', time_diff_components[:day])}")
+    format_string.gsub!('%h', format_digit(time_diff_components[:hour]).to_s)
+    format_string.gsub!('%m', format_digit(time_diff_components[:minute]).to_s)
+    format_string.gsub!('%s', format_digit(time_diff_components[:second]).to_s)
+    format_string
+  end
+
+  def Time.pluralize(word, count)
+    return count > 1 ? word.pluralize : word
+  end
+
+  def Time.remove_format_string_for_zero_components(time_diff_components, format_string)
+    format_string.gsub!('%y, ','') if time_diff_components[:year] == 0
+    format_string.gsub!('%M, ','') if time_diff_components[:month] == 0
+    format_string.gsub!('%w, ','') if time_diff_components[:week] == 0
+    if format_string.slice(0..1) == '%d'
+      format_string.gsub!('%d ','') if time_diff_components[:day] == 0
+    else
+      format_string.gsub!(', %d','') if time_diff_components[:day] == 0
+    end
+    format_string.slice!(0..3) if format_string.slice(0..3) == 'and ' 
+    format_string
+  end
+
+  def Time.format_digit(number)
+    return '%02d' % number
   end
 end

data/test/test_time_diff.rb

@@ -3,15 +3,25 @@ require 'time'
 
 class TestTimeDiff < Test::Unit::TestCase
   should "return the time differnce in displayable format" do
-    assert_test_scenarios(Time.parse('2011-03-06'), Time.parse('2011-03-07'), {:year => 0, :month => 0, :week => 0, :day => 1, :hour => 0, :minute => 0, :second => 0})
-    assert_test_scenarios(Time.parse('2011-03-06'), Time.parse('2011-04-08'), {:year => 0, :month => 1, :week => 0, :day => 3, :hour => 0, :minute => 0, :second => 0})
-    assert_test_scenarios(Time.parse('2011-03-06 12:30:00'), Time.parse('2011-03-07 12:30:30'), {:year => 0, :month => 0, :week => 0, :day => 1, :hour => 0, :minute => 0, :second => 30})
-    assert_test_scenarios(Time.parse('2011-03-06'), Time.parse('2013-03-07'), {:year => 2, :month => 0, :week => 0, :day => 1, :hour => 12, :minute => 0, :second => 0})
-    assert_test_scenarios(Time.parse('2011-03-06'), Time.parse('2011-03-14'), {:year => 0, :month => 0, :week => 1, :day => 1, :hour => 0, :minute => 0, :second => 0})
+    assert_test_scenarios(Time.parse('2011-03-06'), Time.parse('2011-03-07'), {:year => 0, :month => 0, :week => 0, :day => 1, :hour => 0, :minute => 0, :second => 0, :diff => '1 day and 00:00:00'})
+    assert_test_scenarios(Time.parse('2011-03-06'), Time.parse('2011-04-08'), {:year => 0, :month => 1, :week => 0, :day => 3, :hour => 0, :minute => 0, :second => 0, :diff => '1 month, 3 days and 00:00:00'})
+    assert_test_scenarios(Time.parse('2011-03-06 12:30:00'), Time.parse('2011-03-07 12:30:30'), {:year => 0, :month => 0, :week => 0, :day => 1, :hour => 0, :minute => 0, :second => 30, :diff => '1 day and 00:00:30'})
+    assert_test_scenarios(Time.parse('2011-03-06'), Time.parse('2013-03-07'), {:year => 2, :month => 0, :week => 0, :day => 1, :hour => 12, :minute => 0, :second => 0, :diff => '2 years, 1 day and 12:00:00'})
+    assert_test_scenarios(Time.parse('2011-03-06'), Time.parse('2011-03-14'), {:year => 0, :month => 0, :week => 1, :day => 1, :hour => 0, :minute => 0, :second => 0, :diff => '1 week, 1 day and 00:00:00'})
+    assert_test_scenarios(Time.parse('2011-03-06 12:30:00'), Time.parse('2011-03-06 12:30:30'), {:year => 0, :month => 0, :week => 0, :day => 0, :hour => 0, :minute => 0, :second => 30, :diff => '00:00:30'})
+  end
+
+  should "return the time difference in a formatted text" do
+    assert_test_scenarios_for_formatted_diff(Time.parse('2010-03-06 12:30:00'), Time.parse('2011-03-07 12:30:30'), '%y, %d and %h:%m:%s', '1 year and 18:00:30')
   end
 
   def assert_test_scenarios(start_date, end_date, expected_result)
     date_diff = Time.diff(start_date, end_date)
     assert_equal(date_diff, expected_result)
   end
+
+  def assert_test_scenarios_for_formatted_diff(start_date, end_date, format_string, expected_result)
+    date_diff = Time.diff(start_date, end_date, format_string)
+    assert_equal(date_diff[:diff], expected_result)
+  end
 end

data/time_diff.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{time_diff}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["abhilash"]
-  s.date = %q{2011-03-07}
+  s.date = %q{2011-04-04}
   s.description = %q{It returns a hash file with the difference in terms of year, month, week, day, hour, minute and second}
   s.email = %q{abhidsm@gmail.com}
   s.extra_rdoc_files = [

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: time_diff
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - abhilash
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-07 00:00:00 +05:30
+date: 2011-04-04 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency