human-date 0.0.1 → 0.0.2

data/README.md

@@ -3,6 +3,7 @@ human-date
 
 Installation:
 -------------
+
 ```
 gem install human-date
 ```
@@ -11,18 +12,19 @@ Usage:
 ------
 
 ```ruby
-date_translator = HumanDate::DateTranslator.new
-from = DateTime.now
-sleep 10
-to = DateTime.now
+require 'human-date'
+
+translator = HumanDate::DateTranslator.new
+date1 = DateTime.parse "2011-10-23T00:00:00"
+date2 = DateTime.parse "2012-12-25T02:05:10"
 
-date_translator.translate(from, to)
-=> '10 seconds'
+translator.translate(date1, date2)
+#=> 1 year, 2 months, 4 days, 2 hours, 5 minutes and 10 seconds
 
-date_translator.translate(to, from)
-=> '10 seconds ago'
+translator.translate(date2, date1)
+#=> 1 year, 2 months, 4 days, 2 hours, 5 minutes and 10 seconds ago
 
-date_translator.tolerance = 10
-date_translator.translate(from, to)
-=> 'now'
+translator.parts = [:year, :month, :day]
+translator.translate(date1, date2)
+#=> 1 year, 2 months and 4 days
 ```

data/Rakefile

@@ -4,3 +4,10 @@ require 'rake/testtask'
 Rake::TestTask.new do |t|
     t.pattern = "test/test_*.rb"
 end
+
+require 'erb'
+task :examples do
+  require_relative 'lib/human-date'
+  template = ERB.new(File.read('examples/example.erb'))
+  puts template.result(binding).gsub /\n{3,}/, "\n"
+end

data/examples/example.erb

@@ -0,0 +1,15 @@
+require 'human-date'
+
+translator = HumanDate::DateTranslator.new    <% translator = HumanDate::DateTranslator.new %>
+date1 = DateTime.parse "2011-10-23T00:00:00"  <% date1 = DateTime.parse "2011-10-23T00:00:00" %>
+date2 = DateTime.parse "2012-12-25T02:05:10"  <% date2 = DateTime.parse "2012-12-25T02:05:10" %>
+
+translator.translate(date1, date2)
+#=> <%= translator.translate(date1, date2) %>
+
+translator.translate(date2, date1)
+#=> <%= translator.translate(date2, date1) %>
+
+translator.parts = [:year, :month, :day] <% translator.parts = [:year, :month, :day] %>
+translator.translate(date1, date2)
+#=> <%= translator.translate(date1, date2) %>

data/human-date.gemspec

@@ -18,4 +18,5 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.add_development_dependency "minitest"
+  s.add_development_dependency "erubis"
 end

data/lib/human-date/date_translator.rb

@@ -2,7 +2,7 @@ require 'date'
 
 module HumanDate
   class DateTranslator
-    attr_accessor :tolerance
+    attr_accessor :tolerance, :parts
 
     TIME = {
       :year     => 365 * 24 * 60 * 60,
@@ -15,20 +15,43 @@ module HumanDate
 
     def initialize
       @tolerance = 1
+      @parts = TIME.keys
     end
 
-    def translate(from, to)
+    def translate from, to
       total_difference_in_seconds = ((to-from) * 60 * 60 * 24).to_i
-      return 'now' if total_difference_in_seconds.abs <= tolerance
-
-      TIME.keys.each do |key|
-        if total_difference_in_seconds.abs >= TIME[key]
-          result = "#{total_difference_in_seconds.abs / TIME[key]} #{key}"
-          result += 's' if total_difference_in_seconds.abs >= (TIME[key] * 2)
-          result += ' ago' if total_difference_in_seconds < 0
-          return result
+      absolute_total_difference_in_seconds = total_difference_in_seconds.abs
+      return 'now' if absolute_total_difference_in_seconds <= tolerance
+
+      words = []
+      parts.each do |key|
+        if absolute_total_difference_in_seconds >= TIME[key]
+          count = 0
+          while absolute_total_difference_in_seconds >= TIME[key]
+            absolute_total_difference_in_seconds -= TIME[key]
+            count += 1
+          end
+          word = "#{count} #{key}"
+          word += 's' if count >= 2
+          words << word
         end
       end
+
+      sentence = join_words(words)
+      sentence += ' ago' if total_difference_in_seconds < 0
+      sentence
+    end
+
+    private
+
+    def join_words(words)
+      if words.size > 2
+        last_two_words = "#{words[-2]} and #{words[-1]}"
+        words.pop
+        words.pop
+        words.push(last_two_words)
+      end
+      words.join(", ")
     end
 
   end

data/lib/human-date/version.rb

@@ -1,5 +1,5 @@
 module Human
   module Date
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/test/test_date_translator.rb

@@ -25,13 +25,13 @@ class DateTranslatorTest < MiniTest::Unit::TestCase
   end
 
   def test_translate_returns_years
-    assert_equal "1 year", translate("2012-10-23T00:00:00")
-    assert_equal "2 years", translate("2013-10-23T00:00:00")
+    assert_equal "1 year", translate("2012-10-22T00:00:00")
+    assert_equal "2 years", translate("2013-10-22T00:00:00")
   end
 
   def test_translate_returns_months
-    assert_equal "1 month", translate("2011-11-23T00:00:00")
-    assert_equal "2 months", translate("2011-12-23T00:00:00")
+    assert_equal "1 month", translate("2011-11-22T00:00:00")
+    assert_equal "2 months", translate("2011-12-22T00:00:00")
   end
 
   def test_translate_returns_days
@@ -60,4 +60,13 @@ class DateTranslatorTest < MiniTest::Unit::TestCase
     assert_equal "1 day ago", translate("2011-10-22T00:00:00")
   end
 
+  def test_translate_returns_all_possible_times
+    assert_equal "1 year, 2 months, 4 days, 2 hours, 5 minutes and 10 seconds", translate("2012-12-25T02:05:10")
+  end
+
+  def test_translage_only_returns_specified_values
+    @date_translator.parts = [:year, :month, :day]
+    assert_equal "1 year, 2 months and 4 days", translate("2012-12-25T00:00:00")
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: human-date
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70305826377680 !ruby/object:Gem::Requirement
+  requirement: &70231184237040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,7 +22,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70305826377680
+  version_requirements: *70231184237040
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: &70231184236620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70231184236620
 description: Human readable date differences
 email:
 - andrew.vos@gmail.com
@@ -34,6 +45,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- examples/example.erb
 - human-date.gemspec
 - lib/human-date.rb
 - lib/human-date/date_translator.rb