time_diff 0.2.0 → 0.2.1

data/README

@@ -1,34 +1,63 @@
-Installing
-----------
+= time_diff
+Gem which calculates the difference between two time
 
-gem install time_diff
+== Installation
 
-Usage
------
+    gem install time_diff
 
-require 'time_diff'
+== Usage
 
-diff = Time.diff(start_date_time, end_date_time)
+    require 'time_diff'
+
+    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
+
+    %N - minute
 
+    %S - second
 
-Formatted Time difference
--------------------------
+    %h - hour (without adding 'hour' text to the hours. eg: 3 for 3 hours)
 
-%y - year
-%M - month
-%w - week
-%d - day
-%h - hour
-%m - minute
-%s - second
+    %m - minute (without adding 'minute' text)
+
+    %s - second (without adding 'second' text)
+
+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'.
 
-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.
+
+If you give '%d %h' as the third parameter to the Time.diff() method, then the difference(time_diff_components[:diff]) will be calculated only in days and hours.
+
+== Examples
+
+    > Time.diff(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'}
+    > Time.diff(Time.parse('2010-03-06 12:30:00'), Time.parse('2011-03-07 12:30:30'), '%y, %d and %h:%m:%s')
+    => {:year => 1, :month => 0, :week => 0, :day => 0, :hour => 18, :minute => 0, :second => 30, :diff => '1 year and 18:00:30'}
+    > Time.diff(Time.parse('2011-03-06 12:30:00'), Time.parse('2011-03-07 12:30:30'), '%H %N %S')
+    => {:year => 0, :month => 0, :week => 0, :day => 1, :hour => 0, :minute => 0, :second => 30, :diff => '24 hours 0 minute 30 seconds'} 

data/README.rdoc

@@ -1,36 +1,67 @@
 = time_diff
+Gem which calculates the difference between two time
 
-==Installing
+== Installation
 
-gem install time_diff
+    gem install time_diff
 
-==Usage
+== Usage
 
-require 'time_diff'
+    require 'time_diff'
 
-time_diff_components = 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:
 
-time_diff_components[:year], time_diff_components[:month], time_diff_components[:week]
+    time_diff_components[:year], time_diff_components[:month], time_diff_components[:week]
 
-==Formatted Time difference
+== Formatted Time difference
 
-%y - year
-%M - month
-%w - week
-%d - day
-%h - hour
-%m - minute
-%s - second
+    %y - year
+
+    %M - month
+
+    %w - week
+
+    %d - day
+
+    %H - hour
+
+    %N - minute
+
+    %S - second
+
+    %h - hour (without adding 'hour' text to the hours. eg: 3 for 3 hours)
+
+    %m - minute (without adding 'minute' text)
+
+    %s - second (without adding 'second' text)
+
+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'.
 
-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.
 
+If you give '%d %h' as the third parameter to the Time.diff() method, then the difference(time_diff_components[:diff]) will be calculated only in days and hours.
+
+== Examples
+
+    > Time.diff(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'}
+    > Time.diff(Time.parse('2010-03-06 12:30:00'), Time.parse('2011-03-07 12:30:30'), '%y, %d and %h:%m:%s')
+    => {:year => 1, :month => 0, :week => 0, :day => 0, :hour => 18, :minute => 0, :second => 30, :diff => '1 year and 18:00:30'}
+    > Time.diff(Time.parse('2011-03-06 12:30:00'), Time.parse('2011-03-07 12:30:30'), '%H %N %S')
+    => {:year => 0, :month => 0, :week => 0, :day => 1, :hour => 0, :minute => 0, :second => 30, :diff => '24 hours 0 minute 30 seconds'} 
+
 == Contributing to time_diff
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
@@ -43,6 +74,6 @@ You can pass your own format as third parameter to this function.
 
 == Copyright
 
-Copyright (c) 2011 abhilash. See LICENSE.txt for
+Copyright (c) 2011 abhidsm. See LICENSE.txt for
 further details.
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/time_diff.rb

@@ -6,27 +6,61 @@ class Time
     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|
+    components = get_time_diff_components(%w(year month week day hour minute second), distance_in_seconds)
+    time_diff_components = {:year => components[0], :month => components[1], :week => components[2], :day => components[3], :hour => components[4], :minute => components[5], :second => components[6]}
+
+    formatted_intervals = get_formatted_intervals(format_string)
+    components = get_time_diff_components(formatted_intervals, distance_in_seconds)
+    formatted_components = create_formatted_component_hash(components, formatted_intervals)
+    format_string = remove_format_string_for_zero_components(formatted_components, format_string)
+    time_diff_components[:diff] = format_date_time(formatted_components, format_string) unless format_string.nil?
+    return time_diff_components
+  end
+
+  def self.get_formatted_intervals(format_string)
+    intervals = []
+    intervals << 'year' if format_string.include?('%y')
+    intervals << 'month' if format_string.include?('%M')
+    intervals << 'week' if format_string.include?('%w')
+    intervals << 'day' if format_string.include?('%d')
+    intervals << 'hour' if format_string.include?('%h') || format_string.include?('%H')
+    intervals << 'minute' if format_string.include?('%m') || format_string.include?('%N')
+    intervals << 'second' if format_string.include?('%s') || format_string.include?('%S')
+    intervals
+  end
+
+  def self.create_formatted_component_hash(components, formatted_intervals)
+    formatted_components = {}
+    index = 0
+    components.each do |component|
+      formatted_components[:"#{formatted_intervals[index]}"] = component
+      index = index + 1
+    end
+    formatted_components
+  end
+
+  def self.get_time_diff_components(intervals, distance_in_seconds)
+    components = []
+    intervals.each do |interval|
         component = (distance_in_seconds / 1.send(interval)).floor
         distance_in_seconds -= component.send(interval)
         components << component
     end
-    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
+    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.gsub!('%y', "#{time_diff_components[:year]} #{pluralize('year', time_diff_components[:year])}") if time_diff_components[:year] 
+    format_string.gsub!('%M', "#{time_diff_components[:month]} #{pluralize('month', time_diff_components[:month])}") if time_diff_components[:month]
+    format_string.gsub!('%w', "#{time_diff_components[:week]} #{pluralize('week', time_diff_components[:week])}") if time_diff_components[:week]
+    format_string.gsub!('%d', "#{time_diff_components[:day]} #{pluralize('day', time_diff_components[:day])}") if time_diff_components[:day]
+    format_string.gsub!('%H', "#{time_diff_components[:hour]} #{pluralize('hour', time_diff_components[:hour])}") if time_diff_components[:hour]
+    format_string.gsub!('%N', "#{time_diff_components[:minute]} #{pluralize('minute', time_diff_components[:minute])}") if time_diff_components[:minute]
+    format_string.gsub!('%S', "#{time_diff_components[:second]} #{pluralize('second', time_diff_components[:second])}") if time_diff_components[:second]
+    format_string.gsub!('%h', format_digit(time_diff_components[:hour]).to_s) if time_diff_components[:hour]
+    format_string.gsub!('%m', format_digit(time_diff_components[:minute]).to_s) if time_diff_components[:minute]
+    format_string.gsub!('%s', format_digit(time_diff_components[:second]).to_s) if time_diff_components[:second]
     format_string
   end
 

data/test/test_time_diff.rb

@@ -13,6 +13,8 @@ class TestTimeDiff < Test::Unit::TestCase
 
   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')
+    assert_test_scenarios_for_formatted_diff(Time.parse('2010-03-06 12:30:00'), Time.parse('2011-03-07 12:30:30'), '%d %H %N %S', '366 days 0 hour 0 minute 30 seconds')
+    assert_test_scenarios_for_formatted_diff(Time.parse('2011-03-06 12:30:00'), Time.parse('2011-03-07 12:30:30'), '%H %N %S', '24 hours 0 minute 30 seconds')
   end
 
   def assert_test_scenarios(start_date, end_date, expected_result)

data/time_diff.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{time_diff}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["abhilash"]
-  s.date = %q{2011-04-04}
+  s.date = %q{2011-04-10}
   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: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - abhilash
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-04 00:00:00 +05:30
+date: 2011-04-10 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency