dotiw 5.1.0 → 5.3.2

data/spec/lib/dotiw_spec.rb

@@ -23,18 +23,19 @@ describe 'A better distance_of_time_in_words' do
 
   describe '#distance_of_time' do
     [
-      [0.5.minutes, '30 seconds'],
-      [4.5.minutes, '4 minutes and 30 seconds'],
-      [5.minutes, '5 minutes'],
-      [10.minutes, '10 minutes'],
-      [1.hour, '1 hour'],
-      [1.hour + 30.seconds, '1 hour and 30 seconds'],
-      [4.weeks, '4 weeks'],
-      [4.weeks + 2.days, '4 weeks and 2 days'],
-      [24.weeks, '5 months, 2 weeks, and 1 day']
-    ].each do |number, result|
+      [0.5.minutes, '30 seconds', '30s'],
+      [4.5.minutes, '4 minutes and 30 seconds', '4m30s'],
+      [5.minutes.to_i, '5 minutes', '5m'],
+      [10.minutes.to_i, '10 minutes', '10m'],
+      [1.hour.to_i, '1 hour', '1h'],
+      [1.hour + 30.seconds, '1 hour and 30 seconds', '1h30s'],
+      [4.weeks.to_i, '4 weeks', '4w'],
+      [4.weeks + 2.days, '4 weeks and 2 days', '4w2d'],
+      [24.weeks.to_i, '5 months, 2 weeks, and 1 day', '5mo2w1d']
+    ].each do |number, result, compact_result|
       it "#{number} == #{result}" do
         expect(distance_of_time(number)).to eq(result)
+        expect(distance_of_time(number, compact: true)).to eq(compact_result)
       end
     end
 
@@ -100,6 +101,11 @@ describe 'A better distance_of_time_in_words' do
         expect(DOTIW.languages.map(&:to_s).sort).to eq languages.sort
       end
 
+      it 'raises ArgumentError when nil is passed for time' do
+        expect { distance_of_time_in_words(nil) }.to raise_error(ArgumentError)
+        expect { distance_of_time_in_words(nil, nil) }.to raise_error(ArgumentError)
+      end
+
       DOTIW.languages.each do |lang|
         context lang do
           YAML.safe_load(
@@ -129,31 +135,33 @@ describe 'A better distance_of_time_in_words' do
     end
 
     [
-      [START_TIME, START_TIME + 5.days + 3.minutes, '5 days and 3 minutes'],
-      [START_TIME, START_TIME + 1.minute, '1 minute'],
-      [START_TIME, START_TIME + 3.years, '3 years'],
-      [START_TIME, START_TIME + 10.years, '10 years'],
-      [START_TIME, START_TIME + 8.months, '8 months'],
-      [START_TIME, START_TIME + 3.hour, '3 hours'],
-      [START_TIME, START_TIME + 13.months, '1 year and 1 month'],
+      [START_TIME, START_TIME + 5.days + 3.minutes, '5 days and 3 minutes', '5d3m'],
+      [START_TIME, START_TIME + 1.minute, '1 minute', '1m'],
+      [START_TIME, START_TIME + 3.years, '3 years', '3y'],
+      [START_TIME, START_TIME + 10.years, '10 years', '10y'],
+      [START_TIME, START_TIME + 8.months, '8 months', '8mo'],
+      [START_TIME, START_TIME + 3.hour, '3 hours', '3h'],
+      [START_TIME, START_TIME + 13.months, '1 year and 1 month', '1y1mo'],
       # Any numeric sequence is merely coincidental.
-      [START_TIME, START_TIME + 1.year + 2.months + 3.weeks + 4.days + 5.hours + 6.minutes + 7.seconds, '1 year, 2 months, 3 weeks, 4 days, 5 hours, 6 minutes, and 7 seconds'],
-      ['2009-3-16'.to_time, '2008-4-14'.to_time, '11 months and 2 days'],
-      ['2009-3-16'.to_time + 1.minute, '2008-4-14'.to_time, '11 months, 2 days, and 1 minute'],
-      ['2009-4-14'.to_time, '2008-3-16'.to_time, '1 year, 4 weeks, and 1 day'],
-      ['2009-2-01'.to_time, '2009-3-01'.to_time, '1 month'],
-      ['2008-2-01'.to_time, '2008-3-01'.to_time, '1 month'],
-      [Date.parse('31.03.2015').to_time, Time.parse('01.03.2016'), '10 months, 4 weeks, and 2 days'],
-      [Date.new(2014, 1, 31), Date.new(2014, 3, 1), '4 weeks and 1 day'],
-      ['2008-2-01'.to_time, '2008-3-01'.to_time, '1 month'],
-      ['2014-1-31'.to_time, '2014-3-01'.to_time, '4 weeks and 1 day'],
-      ['2014-1-31'.to_time, '2014-3-02'.to_time, '4 weeks and 2 days'],
-      ['2016-1-31'.to_time, '2016-3-01'.to_time, '4 weeks and 2 days'],
-      ['2016-1-31'.to_time, '2016-3-02'.to_time, '1 month']
-    ].each do |start, finish, output|
+      [START_TIME, START_TIME + 1.year + 2.months + 3.weeks + 4.days + 5.hours + 6.minutes + 7.seconds,
+       '1 year, 2 months, 3 weeks, 4 days, 5 hours, 6 minutes, and 7 seconds', '1y2mo3w4d5h6m7s'],
+      ['2009-3-16'.to_time, '2008-4-14'.to_time, '11 months and 2 days', '11mo2d'],
+      ['2009-3-16'.to_time + 1.minute, '2008-4-14'.to_time, '11 months, 2 days, and 1 minute', '11mo2d1m'],
+      ['2009-4-14'.to_time, '2008-3-16'.to_time, '1 year, 4 weeks, and 1 day', '1y4w1d'],
+      ['2009-2-01'.to_time, '2009-3-01'.to_time, '1 month', '1mo'],
+      ['2008-2-01'.to_time, '2008-3-01'.to_time, '1 month', '1mo'],
+      [Date.parse('31.03.2015').to_time, Time.parse('01.03.2016'), '10 months, 4 weeks, and 2 days', '10mo4w2d'],
+      [Date.new(2014, 1, 31), Date.new(2014, 3, 1), '4 weeks and 1 day', '4w1d'],
+      ['2008-2-01'.to_time, '2008-3-01'.to_time, '1 month', '1mo'],
+      ['2014-1-31'.to_time, '2014-3-01'.to_time, '4 weeks and 1 day', '4w1d'],
+      ['2014-1-31'.to_time, '2014-3-02'.to_time, '4 weeks and 2 days', '4w2d'],
+      ['2016-1-31'.to_time, '2016-3-01'.to_time, '4 weeks and 2 days', '4w2d'],
+      ['2016-1-31'.to_time, '2016-3-02'.to_time, '1 month', '1mo']
+    ].each do |start, finish, output, compact_result|
       it "should be #{output}" do
         expect(distance_of_time_in_words(start, finish, true)).to eq(output)
         expect(distance_of_time_in_words(finish, start, true)).to eq(output)
+        expect(distance_of_time_in_words(start, finish, true, compact: true)).to eq(compact_result)
       end
     end
 
@@ -214,7 +222,7 @@ describe 'A better distance_of_time_in_words' do
           expect(distance_of_time_in_words(start, finish, true, accumulate_on: accumulator)).to eq(output)
         end
       end
-    end # :accumulate_on
+    end
 
     describe 'without finish time' do
       # A missing finish argument should default to zero, essentially returning
@@ -312,7 +320,34 @@ describe 'A better distance_of_time_in_words' do
     end
 
     if defined?(ActionView)
-      describe 'ActionView' do
+      describe 'ActionView without include seconds argument' do
+        [
+          [START_TIME,
+          START_TIME + 1.year + 2.months + 3.weeks + 4.days + 5.hours + 6.minutes + 7.seconds,
+          { vague: true },
+          'about 1 year'],
+          [START_TIME,
+          START_TIME + 1.year + 2.months + 3.weeks + 4.days + 5.hours + 6.minutes + 7.seconds,
+          { vague: 'Yes please' },
+          'about 1 year'],
+          [START_TIME,
+          START_TIME + 1.year + 2.months + 3.weeks + 4.days + 5.hours + 6.minutes + 7.seconds,
+          { vague: false },
+          '1 year, 2 months, 3 weeks, 4 days, 5 hours, and 6 minutes'],
+          [START_TIME,
+          START_TIME + 1.year + 2.months + 3.weeks + 4.days + 5.hours + 6.minutes + 7.seconds,
+          { vague: nil },
+          '1 year, 2 months, 3 weeks, 4 days, 5 hours, and 6 minutes']
+        ].each do |start, finish, options, output|
+          it "should be #{output}" do
+            expect(distance_of_time_in_words(start, finish, options)).to eq(output)
+          end
+        end
+      end
+    end
+
+    if defined?(ActionView)
+      describe 'ActionView with include seconds argument' do
         [
           [START_TIME,
            START_TIME + 1.year + 2.months + 3.weeks + 4.days + 5.hours + 6.minutes + 7.seconds,
@@ -335,12 +370,13 @@ describe 'A better distance_of_time_in_words' do
             expect(distance_of_time_in_words(start, finish, true, options)).to eq(output)
           end
         end
-
+  
         context 'via ActionController::Base.helpers' do
           it '#distance_of_time_in_words' do
             end_time = START_TIME + 1.year + 2.months + 3.weeks + 4.days + 5.hours + 6.minutes + 7.seconds
             expected = '1 year, 2 months, 3 weeks, 4 days, 5 hours, 6 minutes, and 7 seconds'
-            actual = ActionController::Base.helpers.distance_of_time_in_words(START_TIME, end_time, true, { vague: false })
+            actual = ActionController::Base.helpers.distance_of_time_in_words(START_TIME, end_time, true,
+                                                                              { vague: false })
             expect(actual).to eq(expected)
           end
 
@@ -349,6 +385,105 @@ describe 'A better distance_of_time_in_words' do
             actual = ActionController::Base.helpers.time_ago_in_words(Time.now - 3.days - 14.minutes)
             expect(actual).to eq(expected)
           end
+
+          describe '#distance_of_time_in_words_to_now' do
+            context 'with nil' do
+              it 'raises ArgumentError when nil is passed for time' do
+                expect do
+                  ActionController::Base.helpers.distance_of_time_in_words_to_now(nil)
+                end.to raise_error(ArgumentError)
+              end
+            end
+
+            context 'without options' do
+              it 'shows detailed duration without seconds' do
+                expected = '3 days and 14 minutes'
+                actual = ActionController::Base.helpers.distance_of_time_in_words_to_now(Time.now - 3.days - 14.minutes)
+                expect(actual).to eq(expected)
+              end
+            end
+
+            context 'with seconds false and vague option true' do
+              it 'shows vague duration' do
+                expected = '3 days'
+                actual = ActionController::Base.helpers.distance_of_time_in_words_to_now(
+                  Time.now - 3.days - 14.minutes - 20.seconds, false, vague: true
+                )
+                expect(actual).to eq(expected)
+              end
+            end
+
+            context 'with seconds true and vague option true' do
+              it 'shows vague duration' do
+                expected = '3 days'
+                actual = ActionController::Base.helpers.distance_of_time_in_words_to_now(
+                  Time.now - 3.days - 14.minutes - 20.seconds, true, vague: true
+                )
+                expect(actual).to eq(expected)
+              end
+            end
+
+            context 'with seconds false and vague option false' do
+              it 'shows detailed duration without seconds' do
+                expected = '3 days and 14 minutes'
+                actual = ActionController::Base.helpers.distance_of_time_in_words_to_now(
+                  Time.now - 3.days - 14.minutes - 20.seconds, false, vague: false
+                )
+                expect(actual).to eq(expected)
+              end
+            end
+
+            context 'with seconds true and vague option false' do
+              it 'shows detailed duration with seconds' do
+                expected = '3 days, 14 minutes, and 20 seconds'
+                actual = ActionController::Base.helpers.distance_of_time_in_words_to_now(
+                  Time.now - 3.days - 14.minutes - 20.seconds, true, vague: false
+                )
+                expect(actual).to eq(expected)
+              end
+            end
+
+            context 'without seconds and vague option false' do
+              it 'shows detailed duration without seconds' do
+                expected = '3 days and 14 minutes'
+                actual = ActionController::Base.helpers.distance_of_time_in_words_to_now(
+                  Time.now - 3.days - 14.minutes - 20.seconds, vague: false
+                )
+                expect(actual).to eq(expected)
+              end
+            end
+
+            context 'without seconds and vague option true' do
+              it 'shows vague duration' do
+                expected = '3 days'
+                actual = ActionController::Base.helpers.distance_of_time_in_words_to_now(
+                  Time.now - 3.days - 14.minutes - 20.seconds, vague: true
+                )
+                expect(actual).to eq(expected)
+              end
+            end
+
+            context 'with options include_seconds true and vague option false' do
+              it 'shows detailed duration with seconds' do
+                expected = '3 days, 14 minutes, and 20 seconds'
+                actual = ActionController::Base.helpers.distance_of_time_in_words_to_now(
+                  Time.now - 3.days - 14.minutes - 20.seconds, {include_seconds: true, vague: false}
+                )
+                expect(actual).to eq(expected)
+              end
+            end
+
+            context 'with options include_seconds false and vague option true' do
+              it 'shows vague duration' do
+                expected = '3 days'
+                actual = ActionController::Base.helpers.distance_of_time_in_words_to_now(
+                  Time.now - 3.days - 14.minutes - 20.seconds, {include_seconds: false, vague: true}
+                )
+                expect(actual).to eq(expected)
+              end
+            end
+
+          end
         end
       end
     end
@@ -367,7 +502,7 @@ describe 'A better distance_of_time_in_words' do
           )
         ).to eq('1 year, 2 months, 3 weeks, 4 days, 5 hours, and 6 minutes')
       end
-    end # include_seconds
+    end
   end
 
   if defined?(ActionView)

data/spec/lib/i18n/sv.yml

@@ -0,0 +1,2 @@
+seconds:
+  1.second: 1 sekund

data/spec/lib/i18n/zh-TW.yml

@@ -0,0 +1,2 @@
+seconds:
+  1.second: 1 秒

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dotiw
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.3.2
 platform: ruby
 authors:
 - Ryan Bigg
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -146,6 +146,7 @@ files:
 - MIT-LICENSE
 - README.markdown
 - Rakefile
+- benchmarks/time_hash_bench.rb
 - dotiw.gemspec
 - gemfiles/.bundle/config
 - gemfiles/rails_4.gemfile
@@ -170,8 +171,10 @@ files:
 - lib/dotiw/locale/pl.yml
 - lib/dotiw/locale/pt-BR.yml
 - lib/dotiw/locale/ru.yml
+- lib/dotiw/locale/sv.yml
 - lib/dotiw/locale/vi.yml
 - lib/dotiw/locale/zh-CN.yml
+- lib/dotiw/locale/zh-TW.yml
 - lib/dotiw/methods.rb
 - lib/dotiw/time_hash.rb
 - lib/dotiw/version.rb
@@ -191,8 +194,10 @@ files:
 - spec/lib/i18n/pl.yml
 - spec/lib/i18n/pt-BR.yml
 - spec/lib/i18n/ru.yml
+- spec/lib/i18n/sv.yml
 - spec/lib/i18n/vi.yml
 - spec/lib/i18n/zh-CN.yml
+- spec/lib/i18n/zh-TW.yml
 - spec/spec_helper.rb
 homepage: https://github.com/radar/distance_of_time_in_words
 licenses:
@@ -213,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.3
 signing_key:
 specification_version: 4
 summary: Better distance_of_time_in_words for Rails
@@ -234,6 +239,8 @@ test_files:
 - spec/lib/i18n/pl.yml
 - spec/lib/i18n/pt-BR.yml
 - spec/lib/i18n/ru.yml
+- spec/lib/i18n/sv.yml
 - spec/lib/i18n/vi.yml
 - spec/lib/i18n/zh-CN.yml
+- spec/lib/i18n/zh-TW.yml
 - spec/spec_helper.rb