dotiw 5.3.1 → 5.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36c95ebe9c3f26cad8de3f4671810af863f765b14f0c5066d761b84881515935
-  data.tar.gz: 76b3a723afd1e060a71e148c1b2f839460e325848de32b94d1d0fe701266f266
+  metadata.gz: 5bbd17f6b2f3af46a5255fa9eb900aa7bb734ead661088a2936739aa2f2bef63
+  data.tar.gz: 2870eadd1e540d51e6ff73210024fbcb87de8c01cca2549d7fb80e30b4390d93
 SHA512:
-  metadata.gz: 25bbeae402bf0addf41bfdd5b0a7b7e23c51c528c1905714abad73696fa62cc8fb79eb6721fac8e69e1c8ca86c1d72c0fb04e7d8728b196d1dde5158df1cc035
-  data.tar.gz: 8d63f397602b8f07df9c4d0a1f60f10c48a19b8e01ee3346305bb364e3a18b74670032cdb37f6b1c6da8f26eb2e056ebb5b7f0940798c5bc133b612765500233
+  metadata.gz: a89bfcad7275d64474969ac9200f43d6b5b3fb922c6cfa9e4bc05550361f43dc3d1eb37c27771116dc51cfba6adfa844232fbc062592dfa2874ff0e355797c3b
+  data.tar.gz: 8379db832851f15302fa364103671c3d805c0f367d8c8c0be4d746e81a473ab4b7d49c29a248fd353410a14e22ed04db79a1bfb05b83f4fd52403781460712fa

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 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).

data/README.markdown

@@ -67,6 +67,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 +101,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/version.rb

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

data/spec/lib/dotiw_spec.rb

@@ -320,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,
@@ -343,7 +370,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
@@ -369,32 +396,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, false, vague: true
+                  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 vague option false' do
-              it 'shows detailed duration' do
+            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, false, vague: false
+                  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.1
+  version: 5.3.2
 platform: ruby
 authors:
 - Ryan Bigg
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport