dotiw 5.3.0 → 5.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1c8a832bcdb740a88002dec2f5c843daeca75b2674b2e31c26abc17a144c6a2
-  data.tar.gz: 163a34f6e15e34026375176118399cc65ed73b2f723dab436bc9aedaf36dc0b7
+  metadata.gz: 156f786ed11b28af2e890b6612fb07fb09bd462dc818a5bb8bb9075a518044d7
+  data.tar.gz: ca01c5a48869011c7c1fe9f08cf8c6ad953920b4ea5bc4dd26e21850131b6363
 SHA512:
-  metadata.gz: 6e1a5291d51d629e4fc27d3f915f84586089be0869a676107154ef5f865c46fac768c4a2e7d86ac5fdfc2aadc879b668923f130f2f75ad0c355cbb86a5b18cc4
-  data.tar.gz: f575e5e232a5adfefd8f81aa15f132dc352d020233bd1f66f6cddca473031d5cce0abf76bfd0842e0b55c3c60d4a44e2e7cf56a28b6e6fc89245e9fd17705bd7
+  metadata.gz: 807d4628412b8d810c072ea5cf4e10ed2cb7e280bdeaeb1b65906f1e203bd1155c5a7457d21d4c8c8c112a5a7d0a9b9b9a3c9ff5f1100d6ff0a255f64380a1f3
+  data.tar.gz: 78c14c9c5ea09eb378a380fe686672e925665fdebd9f75096a5cdecc1f9d8497d9cf7839a8cad4dd9d84e4938441e1380c076ecb3ccbf0a24359aa70993da9a2

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 5.3.3 (2022/04/25)
+
+* [#128](https://github.com/radar/distance_of_time_in_words/pull/128): Adds support for numeric values for both the `from_time` and `to_time` arguments in the `#distance_of_time_in_words` helper - [@bjedrocha](https://github.com/bjedrocha).
+
+## 5.3.2 (2021/11/08)
+
+* [#126](https://github.com/radar/distance_of_time_in_words/pull/126): Fixes `#distance_of_time_in_words_to_now` with `vague: true` when supplied without `include_seconds` argument - [@mozcomp](https://github.com/mozcomp).
+
+## 5.3.1 (2021/03/26)
+
+* [#124](https://github.com/radar/distance_of_time_in_words/pull/124): Fixes compact formatting for distance_of_time_in_words - [@rposborne](https://github.com/rposborne).
+
 ## 5.3.0 (2021/03/18)
 
 * [#115](https://github.com/radar/distance_of_time_in_words/pull/115): Use constants for time durations (2x faster, 3.5x less memory) - [@krzysiek1507](https://github.com/krzysiek1507).

data/README.markdown

@@ -58,6 +58,22 @@ Better than "about 1 year", am I right? Of course I am.
 => "1 second"
 ```
 
+It also supports numeric arguments like the original Rails version:
+
+```ruby
+>> distance_of_time_in_words(0, 150)
+=> "2 minutes and 30 seconds"
+```
+
+as an alternative to:
+
+```ruby
+>> distance_of_time_in_words(Time.now, Time.now + 2.5.minutes)
+=> "2 minutes and 30 seconds"
+```
+
+This is useful if you're just interested in "stringifying" the length of time. Alternatively, you can use the `#distance_of_time` helper as described [below](#distance\_of\_time).
+
 The third argument for this method is whether or not to include seconds. By default this is `false` (because in Rails' `distance_of_time_in_words` it is), you can turn it on though by passing `true` as the third argument:
 
 ```ruby
@@ -67,6 +83,8 @@ The third argument for this method is whether or not to include seconds. By defa
 
 Yes this could just be merged into the options hash but I'm leaving it here to ensure "backwards-compatibility", because that's just an insanely radical thing to do. \m/
 
+Alternatively this can be included in the options hash as `include_seconds: true` removing this argument altogether.
+
 The last argument is an optional options hash that can be used to manipulate behavior and (which uses `to_sentence`).
 
 Don't like having to pass in `Time.now` all the time? Then use `time_ago_in_words` or `distance_of_time_in_words_to_now` which also will *rock your
@@ -99,6 +117,10 @@ This will also be passed to `to_sentence`.
 
 Specify this if you want it to use the old `distance_of_time_in_words`. The value can be anything except `nil` or `false`.
 
+#### :include_seconds
+
+As described above this option is the equivalent to the third argument whether to include seconds.
+
 #### :accumulate_on
 
 Specifies the maximum output unit which will accumulate all the surplus. Say you set it to seconds and your time difference is of 2 minutes then the output would be 120 seconds.

data/lib/dotiw/action_view/helpers/date_helper.rb

@@ -9,15 +9,17 @@ module ActionView
       include DOTIW::Methods
 
       def distance_of_time_in_words(from_time, to_time = 0, include_seconds_or_options = {}, options = {})
-        return _distance_of_time_in_words(from_time, to_time, options) if options[:vague]
+        options = merge_options(include_seconds_or_options, options)
+        return _distance_of_time_in_words(from_time, to_time, options.except(:vague)) if options[:vague]
 
-        DOTIW::Methods.distance_of_time_in_words(from_time, to_time, include_seconds_or_options, options.except(:vague))
+        DOTIW::Methods.distance_of_time_in_words(from_time, to_time, options.except(:vague))
       end
 
       def distance_of_time_in_words_to_now(to_time = 0, include_seconds_or_options = {}, options = {})
-        return _distance_of_time_in_words(Time.now, to_time, options) if options[:vague]
+        options = merge_options(include_seconds_or_options, options)
+        return _distance_of_time_in_words(Time.now, to_time, options.except(:vague)) if options[:vague]
 
-        DOTIW::Methods.distance_of_time_in_words(Time.now, to_time, include_seconds_or_options, options.except(:vague))
+        DOTIW::Methods.distance_of_time_in_words(Time.now, to_time, options.except(:vague))
       end
 
       def distance_of_time_in_percent(from_time, current_time, to_time, options = {})
@@ -27,6 +29,16 @@ module ActionView
         result = ((current_time - from_time) / distance) * 100
         number_with_precision(result, options).to_s + '%'
       end
+
+      private
+      def merge_options(include_seconds_or_options, options)
+        if include_seconds_or_options.is_a?(Hash)
+          options.merge(include_seconds_or_options)
+        else
+          options.merge(include_seconds: !!include_seconds_or_options)
+        end
+      end
+      
     end
   end
 end

data/lib/dotiw/methods.rb

@@ -20,7 +20,9 @@ module DOTIW
     end
 
     def distance_of_time_in_words(from_time, to_time = 0, include_seconds_or_options = {}, options = {})
-      raise ArgumentError, "nil can't be converted to a Time value" if from_time.nil? || to_time.nil?
+      from_time = normalize_distance_of_time_argument_to_time(from_time)
+      to_time = normalize_distance_of_time_argument_to_time(to_time)
+      from_time, to_time = to_time, from_time if from_time > to_time
 
       if include_seconds_or_options.is_a?(Hash)
         options = include_seconds_or_options
@@ -28,7 +30,8 @@ module DOTIW
         options = options.dup
         options[:include_seconds] ||= !!include_seconds_or_options
       end
-      return distance_of_time(from_time, options) if to_time == 0
+
+      return distance_of_time(to_time.to_i, options) if from_time.to_i == 0
 
       options = options_with_scope(options)
       hash = distance_of_time_in_words_hash(from_time, to_time, options)
@@ -41,6 +44,16 @@ module DOTIW
 
     private
 
+    def normalize_distance_of_time_argument_to_time(value)
+      if value.is_a?(Numeric)
+        Time.at(value)
+      elsif value.respond_to?(:to_time)
+        value.to_time
+      else
+        raise ArgumentError, "#{value.inspect} can't be converted to a Time value"
+      end
+    end
+
     def options_with_scope(options)
       if options.key?(:compact)
         options.merge(scope: DOTIW::DEFAULT_I18N_SCOPE_COMPACT)
@@ -102,7 +115,7 @@ module DOTIW
                                                        default: :'support.array.last_word_connector',
                                                        locale: options[:locale]
 
-      output.to_sentence(options.except(:accumulate_on))
+      output.to_sentence(options.except(:accumulate_on, :compact))
     end
   end
 end

data/lib/dotiw/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DOTIW
-  VERSION = '5.3.0'
+  VERSION = '5.3.3'
 end

data/spec/lib/dotiw_spec.rb

@@ -101,11 +101,6 @@ 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(
@@ -135,32 +130,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|
+       '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
 
@@ -240,6 +236,38 @@ describe 'A better distance_of_time_in_words' do
         end
       end
     end
+
+    describe 'with mixed inputs' do
+      # Further backwards compatability with the original rails
+      # distance_of_time_in_words helper.
+      [
+        [0, 2.5.minutes.to_i, '2 minutes and 30 seconds'],
+        [10.minutes.to_i, 0, '10 minutes'],
+        [0, 24.weeks.to_i, '5 months, 2 weeks, and 1 day'],
+        [0, 0, 'less than 1 second'],
+      ].each do |start, finish, output|
+        it "should be #{output}" do
+          expect(distance_of_time_in_words(start, finish)).to eq(output)
+        end
+      end
+
+      context "of which one or both can't be converted to a Time value" do
+        let(:invalid_inputs) do
+          [
+            [nil, 5.minutes],
+            [nil, double(:does_not_respond_to_time)],
+            [nil],
+            [nil, nil],
+          ]
+        end
+
+        it "should raise an ArgumentError" do
+          invalid_inputs.each do |start, finish|
+            expect { distance_of_time_in_words(start, finish) }.to raise_error(ArgumentError)
+          end
+        end
+      end
+    end
   end
 
   describe 'with output options' do
@@ -319,7 +347,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,
@@ -342,7 +397,7 @@ 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
@@ -368,32 +423,93 @@ describe 'A better distance_of_time_in_words' do
             end
 
             context 'without options' do
-              it 'shows detailed duration' 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 vague option true' do
+            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, false, vague: true
+                  Time.now - 3.days - 14.minutes - 20.seconds, true, vague: true
                 )
                 expect(actual).to eq(expected)
               end
             end
 
-            context 'with vague option false' do
-              it 'shows detailed duration' do
+            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, false, vague: false
+                  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dotiw
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.3.3
 platform: ruby
 authors:
 - Ryan Bigg
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2022-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport