dotiw 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d52199ee419e6e9effc50ae35409aa01605c4e2b05306ddf2ba4a7d5d9a627d
-  data.tar.gz: c069bf8d7cc9078b9091284084907f777155b2a698b9fe9067ad4ee621dd4982
+  metadata.gz: e1c8a832bcdb740a88002dec2f5c843daeca75b2674b2e31c26abc17a144c6a2
+  data.tar.gz: 163a34f6e15e34026375176118399cc65ed73b2f723dab436bc9aedaf36dc0b7
 SHA512:
-  metadata.gz: 9578117b3360f17e92d49ffe07b4071f805d9c8737033c5431f9ed6e6a9e75aec787d3ef22c9e156af2f1186083cb38c9b4039b9cb12b05cf4ea0dbfd7ce0d83
-  data.tar.gz: c463d39fdf6b1e811a850b23ab363f4a1e4bf3cd76515621d90ee347489762e4cb0c436cdca038487954af6124c60ef9b84902ccc5a9a7ffa034aabee0826b16
+  metadata.gz: 6e1a5291d51d629e4fc27d3f915f84586089be0869a676107154ef5f865c46fac768c4a2e7d86ac5fdfc2aadc879b668923f130f2f75ad0c355cbb86a5b18cc4
+  data.tar.gz: f575e5e232a5adfefd8f81aa15f132dc352d020233bd1f66f6cddca473031d5cce0abf76bfd0842e0b55c3c60d4a44e2e7cf56a28b6e6fc89245e9fd17705bd7

data/.github/workflows/ruby.yml

@@ -15,23 +15,23 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - ruby-version: 2.5.x
-          - ruby-version: 2.6.x
-          - ruby-version: 2.4.x
+          - ruby-version: 2.5
+          - ruby-version: 2.6
+          - ruby-version: 2.4
             bundler-version: 1.17.3
             gemfile: gemfiles/rails_4.gemfile
-          - ruby-version: 2.6.x
+          - ruby-version: 2.6
             gemfile: gemfiles/rails_5.0.gemfile
-          - ruby-version: 2.6.x
+          - ruby-version: 2.6
             gemfile: gemfiles/rails_5.1.gemfile
-          - ruby-version: 2.6.x
+          - ruby-version: 2.6
             gemfile: gemfiles/rails_5.2.gemfile
-          - ruby-version: 2.6.x
+          - ruby-version: 2.6
             gemfile: gemfiles/rails_6.0.gemfile
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
       - name: Build and test

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 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).
+* [#117](https://github.com/radar/distance_of_time_in_words/pull/117): Support `#distance_of_time_in_words_to_now` with `vague: true` - [@joshuapinter](https://github.com/joshuapinter).
+* [#118](https://github.com/radar/distance_of_time_in_words/pull/118): Raise `ArgumentError` when `nil` is passed for time, to match original `distance_of_time_in_words` - [@joshuapinter](https://github.com/joshuapinter).
+* [#119](https://github.com/radar/distance_of_time_in_words/pull/119): Do not mutate input options - [@joshuapinter](https://github.com/joshuapinter).
+
 ## 5.2.0 (2020/10/03)
 
 * [#94](https://github.com/radar/distance_of_time_in_words/pull/94): Add :compact formatting option - [@booty](https://github.com/booty).

data/README.markdown

@@ -69,12 +69,15 @@ Yes this could just be merged into the options hash but I'm leaving it here to e
 
 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` which also will *rock your
+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
 world*:
 
 ```ruby
 >> time_ago_in_words(Time.now + 3.days + 1.second)
 => "3 days, and 1 second"
+
+>> distance_of_time_in_words_to_now(Time.now + 3.days + 1.second)
+=> "3 days, and 1 second"
 ```
 
 Oh, and did I mention it supports I18n? Oh yeah. Rock on!

data/benchmarks/time_hash_bench.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'benchmark/ips'
+require 'benchmark/memory'
+require 'active_support/core_ext/numeric'
+require 'active_support/core_ext/integer'
+
+require_relative '../lib/dotiw/time_hash'
+
+from = Time.now
+to = Time.now + 1.year + 2.months + 3.weeks + 4.days + 5.hours + 6.minutes + 7.seconds
+
+%i[ips memory].each do |type|
+  Benchmark.public_send(type) do |x|
+    x.report('master') { DOTIW::TimeHash.new(nil, from, to) }
+
+    x.compare!
+  end
+end

data/lib/dotiw.rb

@@ -37,7 +37,7 @@ module DOTIW
   def files(directory, ext)
     Dir[File.join File.dirname(__FILE__), directory, ext]
   end
-end # DOTIW
+end
 
 DOTIW.init_i18n!
 

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

@@ -3,14 +3,21 @@
 module ActionView
   module Helpers
     module DateHelper
-      alias_method :_distance_of_time_in_words, :distance_of_time_in_words
-      alias_method :_time_ago_in_words, :time_ago_in_words
+      alias _distance_of_time_in_words distance_of_time_in_words
+      alias _time_ago_in_words time_ago_in_words
 
       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.delete(:vague)
-        DOTIW::Methods.distance_of_time_in_words(from_time, to_time, include_seconds_or_options, options)
+        return _distance_of_time_in_words(from_time, to_time, options) if options[:vague]
+
+        DOTIW::Methods.distance_of_time_in_words(from_time, to_time, include_seconds_or_options, 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]
+
+        DOTIW::Methods.distance_of_time_in_words(Time.now, to_time, include_seconds_or_options, options.except(:vague))
       end
 
       def distance_of_time_in_percent(from_time, current_time, to_time, options = {})
@@ -20,6 +27,6 @@ module ActionView
         result = ((current_time - from_time) / distance) * 100
         number_with_precision(result, options).to_s + '%'
       end
-    end # DateHelper
-  end # Helpers
-end # ActionView
+    end
+  end
+end

data/lib/dotiw/methods.rb

@@ -12,14 +12,20 @@ module DOTIW
     end
 
     def distance_of_time(seconds, options = {})
-      options[:include_seconds] ||= true
-      _display_time_in_words DOTIW::TimeHash.new(seconds, nil, nil, options_with_scope(options)).to_hash, options
+      options = options_with_scope(options).reverse_merge(
+        include_seconds: true
+      )
+      options.delete(:compact)
+      _display_time_in_words DOTIW::TimeHash.new(seconds, nil, nil, options).to_hash, options
     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?
+
       if include_seconds_or_options.is_a?(Hash)
         options = include_seconds_or_options
       else
+        options = options.dup
         options[:include_seconds] ||= !!include_seconds_or_options
       end
       return distance_of_time(from_time, options) if to_time == 0
@@ -36,12 +42,15 @@ module DOTIW
     private
 
     def options_with_scope(options)
-      options.merge!({:scope => DOTIW::DEFAULT_I18N_SCOPE_COMPACT}) if options.delete(:compact)
-      options
+      if options.key?(:compact)
+        options.merge(scope: DOTIW::DEFAULT_I18N_SCOPE_COMPACT)
+      else
+        options
+      end
     end
 
     def _display_time_in_words(hash, options = {})
-      options.reverse_merge!(
+      options = options.reverse_merge(
         include_seconds: false
       ).symbolize_keys!
 
@@ -93,7 +102,7 @@ module DOTIW
                                                        default: :'support.array.last_word_connector',
                                                        locale: options[:locale]
 
-      output.to_sentence(options)
+      output.to_sentence(options.except(:accumulate_on))
     end
   end
-end # DOTIW
+end

data/lib/dotiw/time_hash.rb

@@ -8,7 +8,7 @@ module DOTIW
 
     def initialize(distance, from_time, to_time = nil, options = {})
       @output     = {}
-      @options    = options
+      @options    = options.dup
       @distance   = distance
       @from_time  = from_time || Time.current
       @to_time    = to_time   || (@to_time_not_given = true && @from_time + distance.seconds)
@@ -34,23 +34,29 @@ module DOTIW
 
     attr_reader :options, :output
 
+    ONE_MINUTE = 1.minute.freeze
+    ONE_HOUR = 1.hour.freeze
+    ONE_DAY = 1.day.freeze
+    ONE_WEEK = 7.days.freeze
+    FOUR_WEEKS = 28.days.freeze
+
     def build_time_hash
-      if accumulate_on = options.delete(:accumulate_on)
+      if accumulate_on = options[:accumulate_on]
         accumulate_on = accumulate_on.to_sym
         return build_time_hash if accumulate_on == :years
 
         TIME_FRACTIONS.index(accumulate_on).downto(0) { |i| send("build_#{TIME_FRACTIONS[i]}") }
       else
         while distance > 0
-          if distance < 1.minute
+          if distance < ONE_MINUTE
             build_seconds
-          elsif distance < 1.hour
+          elsif distance < ONE_HOUR
             build_minutes
-          elsif distance < 1.day
+          elsif distance < ONE_DAY
             build_hours
-          elsif distance < 7.days
+          elsif distance < ONE_WEEK
             build_days
-          elsif distance < 28.days
+          elsif distance < FOUR_WEEKS
             build_weeks
           else # greater than a week
             build_years_months_weeks_days
@@ -67,19 +73,19 @@ module DOTIW
     end
 
     def build_minutes
-      output[:minutes], @distance = distance.divmod(1.minute.to_i)
+      output[:minutes], @distance = distance.divmod(ONE_MINUTE.to_i)
     end
 
     def build_hours
-      output[:hours], @distance = distance.divmod(1.hour.to_i)
+      output[:hours], @distance = distance.divmod(ONE_HOUR.to_i)
     end
 
     def build_days
-      output[:days], @distance = distance.divmod(1.day.to_i) unless output[:days]
+      output[:days], @distance = distance.divmod(ONE_DAY.to_i) unless output[:days]
     end
 
     def build_weeks
-      output[:weeks], @distance = distance.divmod(1.week.to_i) unless output[:weeks]
+      output[:weeks], @distance = distance.divmod(ONE_WEEK.to_i) unless output[:weeks]
     end
 
     def build_months
@@ -137,9 +143,9 @@ module DOTIW
       output[:weeks]   = weeks
       output[:days]    = days
 
-      total_days, @distance = distance.abs.divmod(1.day.to_i)
+      total_days, @distance = distance.abs.divmod(ONE_DAY.to_i)
 
       [total_days, @distance]
     end
-  end # TimeHash
-end # DOTIW
+  end
+end

data/lib/dotiw/version.rb

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

data/spec/lib/dotiw_spec.rb

@@ -23,15 +23,15 @@ describe 'A better distance_of_time_in_words' do
 
   describe '#distance_of_time' do
     [
-      [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"]
+      [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)
@@ -101,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(
@@ -138,7 +143,8 @@ describe 'A better distance_of_time_in_words' do
       [START_TIME, START_TIME + 3.hour, '3 hours'],
       [START_TIME, START_TIME + 13.months, '1 year and 1 month'],
       # 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'],
+      [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'],
@@ -215,7 +221,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
@@ -341,7 +347,8 @@ describe 'A better distance_of_time_in_words' 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
 
@@ -350,6 +357,44 @@ 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' 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
+              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
+                )
+                expect(actual).to eq(expected)
+              end
+            end
+
+            context 'with vague option false' do
+              it 'shows detailed duration' 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
+                )
+                expect(actual).to eq(expected)
+              end
+            end
+          end
         end
       end
     end
@@ -368,7 +413,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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dotiw
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Ryan Bigg
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-03 00:00:00.000000000 Z
+date: 2021-03-18 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
@@ -217,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