dotiw 5.3.2 → 5.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bbd17f6b2f3af46a5255fa9eb900aa7bb734ead661088a2936739aa2f2bef63
-  data.tar.gz: 2870eadd1e540d51e6ff73210024fbcb87de8c01cca2549d7fb80e30b4390d93
+  metadata.gz: 156f786ed11b28af2e890b6612fb07fb09bd462dc818a5bb8bb9075a518044d7
+  data.tar.gz: ca01c5a48869011c7c1fe9f08cf8c6ad953920b4ea5bc4dd26e21850131b6363
 SHA512:
-  metadata.gz: a89bfcad7275d64474969ac9200f43d6b5b3fb922c6cfa9e4bc05550361f43dc3d1eb37c27771116dc51cfba6adfa844232fbc062592dfa2874ff0e355797c3b
-  data.tar.gz: 8379db832851f15302fa364103671c3d805c0f367d8c8c0be4d746e81a473ab4b7d49c29a248fd353410a14e22ed04db79a1bfb05b83f4fd52403781460712fa
+  metadata.gz: 807d4628412b8d810c072ea5cf4e10ed2cb7e280bdeaeb1b65906f1e203bd1155c5a7457d21d4c8c8c112a5a7d0a9b9b9a3c9ff5f1100d6ff0a255f64380a1f3
+  data.tar.gz: 78c14c9c5ea09eb378a380fe686672e925665fdebd9f75096a5cdecc1f9d8497d9cf7839a8cad4dd9d84e4938441e1380c076ecb3ccbf0a24359aa70993da9a2

data/CHANGELOG.md

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

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

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)

data/lib/dotiw/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DOTIW
-  VERSION = '5.3.2'
+  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(
@@ -241,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

metadata

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