dotiw 5.3.3 → 5.6.0

data/spec/lib/dotiw_spec.rb

@@ -13,10 +13,16 @@ describe 'A better distance_of_time_in_words' do
     include DOTIW::Methods
   end
 
-  START_TIME = '01-08-2009'.to_time
+  START_TIME = '01-08-2009'.to_time(:utc)
 
   before do
     I18n.locale = :en
+    # This config is deprecated as of Rails 8.1 (it becomes the permanent,
+    # non-configurable behavior) and is removed entirely in Rails 8.2.
+    if Gem::Version.new(ActiveSupport::VERSION::STRING) < Gem::Version.new('8.1')
+      ActiveSupport.to_time_preserves_timezone = :zone
+    end
+
     allow(Time).to receive(:now).and_return(START_TIME)
     allow(Time.zone).to receive(:now).and_return(START_TIME)
   end
@@ -113,12 +119,18 @@ describe 'A better distance_of_time_in_words' do
             context category do
               fixtures.each_pair do |k, v|
                 it v do
+                  options = {
+                    locale: lang
+                  }
+
+                  options[:compact] = true if category.split.include?('compact')
+
                   expect(
                     distance_of_time_in_words(
                       START_TIME,
                       START_TIME + eval(k),
                       true,
-                      locale: lang
+                      options
                     )
                   ).to eq(v)
                 end
@@ -165,7 +177,7 @@ describe 'A better distance_of_time_in_words' do
       [Time.zone.now, Time.zone.now + 15.days - 1.minute, '14 days, 23 hours, and 59 minutes'],
       [Time.zone.now, Time.zone.now + 29.days - 1.minute, '28 days, 23 hours, and 59 minutes'],
       [Time.zone.now, Time.zone.now + 30.days - 1.minute, '29 days, 23 hours, and 59 minutes'],
-      [Time.zone.now, Time.zone.now + 31.days - 1.minute, '30 days, 23 hours, and 59 minutes'],
+      [Time.zone.now, Time.zone.now + 31.day - 1.minute, '30 days, 23 hours, and 59 minutes'],
       [Time.zone.now, Time.zone.now + 32.days - 1.minute, '31 days, 23 hours, and 59 minutes'],
       [Time.zone.now, Time.zone.now + 33.days - 1.minute, '32 days, 23 hours, and 59 minutes']
     ].each do |start, finish, output|
@@ -185,6 +197,63 @@ describe 'A better distance_of_time_in_words' do
       end
     end
 
+    context 'in timezones with an inverted DST scheme (#63)' do
+      # Real, non-mocked reproduction from #63: running the suite under
+      # certain timezones (e.g. Europe/Dublin, where IST is "standard" time
+      # and GMT is technically the DST offset) previously failed because
+      # Time#dst? disagreed between a Time built via Time.at(datetime) and
+      # one built via datetime.to_time for the exact same instant, even
+      # though their utc_offset was identical. This caused a spurious +/-1
+      # hour "DST correction" to be applied.
+      around do |example|
+        original_tz = ENV.fetch('TZ', nil)
+        ENV['TZ'] = tz
+        example.run
+        ENV['TZ'] = original_tz
+      end
+
+      %w[
+        Europe/Dublin
+        Africa/Casablanca
+        Asia/Tehran
+        Europe/Moscow
+        Asia/Gaza
+      ].each do |timezone|
+        context "TZ=#{timezone}" do
+          let(:tz) { timezone }
+
+          it 'is 1 minute' do
+            start = Time.at(DateTime.now)
+            finish = DateTime.now + 1.minute
+
+            expect(distance_of_time_in_words(start, finish)).to eq('1 minute')
+          end
+        end
+      end
+    end
+
+    context 'across a historical UTC offset change (#153)' do
+      # Real, non-mocked reproduction from #153: Pacific/Norfolk permanently
+      # changed its UTC offset from +11:30 to +11:00 on 2015-10-04 (a
+      # tzdata rule change, not a recurring DST transition - both endpoints
+      # report dst? == false). The calendar distance (years/months/weeks/
+      # days) was correct, but the leftover hours/minutes leaked the 30
+      # minute offset difference as a spurious "23 hours and 30 minutes".
+      around do |example|
+        original_tz = ENV.fetch('TZ', nil)
+        ENV['TZ'] = 'Pacific/Norfolk'
+        example.run
+        ENV['TZ'] = original_tz
+      end
+
+      it 'is 1 year and 2 months, not 1 year, 2 months, 23 hours, and 30 minutes' do
+        start = '2015-1-15'.to_time
+        finish = '2016-3-15'.to_time
+
+        expect(distance_of_time_in_words(start, finish, true)).to eq('1 year and 2 months')
+      end
+    end
+
     describe 'accumulate_on:' do
       [
         [START_TIME,
@@ -211,7 +280,8 @@ describe 'A better distance_of_time_in_words' do
          START_TIME + 2.day + 10_000.hour + 10.second,
          :months,
          '13 months, 3 weeks, 1 day, 16 hours, and 10 seconds'],
-        ['2015-1-15'.to_time, '2016-3-15'.to_time, :months, '14 months']
+        ['2015-1-15'.to_time, '2016-3-15'.to_time, :months, '14 months'],
+        ['2015-1-15'.to_time, '2016-3-15'.to_time, :years, '1 year and 2 months']
       ].each do |start, finish, accumulator, output|
         it "should be #{output}" do
           expect(distance_of_time_in_words(start, finish, true, accumulate_on: accumulator)).to eq(output)
@@ -219,6 +289,55 @@ describe 'A better distance_of_time_in_words' do
       end
     end
 
+    describe 'max_unit:' do
+      [
+        [START_TIME,
+         START_TIME + 10.minute,
+         :seconds,
+         { seconds: 600 },
+         '600 seconds'],
+        [START_TIME,
+         START_TIME + 10.hour + 10.minute + 1.second,
+         :minutes,
+         { minutes: 610 },
+         '610 minutes'],
+        [START_TIME,
+         START_TIME + 2.day + 10_000.hour + 10.second,
+         :hours,
+         { hours: 10_048 },
+         '10048 hours'],
+        [START_TIME,
+         START_TIME + 2.day + 10_000.hour + 10.second,
+         :days,
+         { days: 418 },
+         '418 days'],
+        [START_TIME,
+         START_TIME + 2.day + 10_000.hour + 10.second,
+         :weeks,
+         { weeks: 59 },
+         '59 weeks'],
+        ['2015-1-15'.to_time, '2016-3-15'.to_time, :months, { months: 14 }, '14 months'],
+        ['2015-1-15'.to_time, '2016-3-15'.to_time, :years, { years: 1 }, '1 year']
+      ].each do |start, finish, unit, hash, output|
+        it "should be #{output}" do
+          expect(distance_of_time_in_words_hash(start, finish, max_unit: unit)).to eq(hash)
+          expect(distance_of_time_in_words(start, finish, true, max_unit: unit)).to eq(output)
+        end
+      end
+
+      it 'floors and discards any remainder smaller than the unit' do
+        expect(
+          distance_of_time_in_words_hash(START_TIME, START_TIME + 1.year - 1.day, max_unit: :years)
+        ).to eq(years: 0)
+      end
+
+      it 'raises for an unrecognized unit' do
+        expect do
+          distance_of_time_in_words_hash(START_TIME, START_TIME + 1.day, max_unit: :fortnights)
+        end.to raise_error(ArgumentError, /unrecognized max_unit/)
+      end
+    end
+
     describe 'without finish time' do
       # A missing finish argument should default to zero, essentially returning
       # the equivalent of distance_of_time in order to be backwards-compatible
@@ -288,22 +407,28 @@ describe 'A better distance_of_time_in_words' do
       [START_TIME,
        START_TIME + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds,
        { except: 'minutes' },
-       '1 year, 2 months, 3 days, 4 hours, and 6 seconds'],
+       # 5 excluded minutes are folded into seconds (5 * 60 + 6 = 306) instead of being discarded.
+       '1 year, 2 months, 3 days, 4 hours, and 306 seconds'],
       [START_TIME,
        START_TIME + 1.hour + 1.minute,
-       { except: 'minutes' }, '1 hour'],
+       { except: 'minutes' },
+       # The excluded minute is folded into seconds (1 * 60 = 60) instead of being discarded.
+       '1 hour and 60 seconds'],
       [START_TIME,
        START_TIME + 1.hour + 1.day + 1.minute,
        { except: %w[minutes hours] },
-       '1 day'],
+       # The excluded hour and minute cascade down into seconds (1 * 24 * 60 * 60 + 1 * 60 = 3660).
+       '1 day and 3660 seconds'],
       [START_TIME,
        START_TIME + 1.hour + 1.day + 1.minute,
        { only: %w[minutes hours] },
-       '1 hour and 1 minute'],
+       # The excluded day is folded into hours (1 * 24 + 1 = 25) instead of being discarded.
+       '25 hours and 1 minute'],
       [START_TIME,
        START_TIME + 1.year + 2.months + 3.weeks + 4.days + 5.hours + 6.minutes + 7.seconds,
        { except: 'minutes' },
-       '1 year, 2 months, 3 weeks, 4 days, 5 hours, and 7 seconds'],
+       # 6 excluded minutes are folded into seconds (6 * 60 + 7 = 367) instead of being discarded.
+       '1 year, 2 months, 3 weeks, 4 days, 5 hours, and 367 seconds'],
       [START_TIME,
        START_TIME + 1.hour + 2.minutes + 3.seconds,
        { highest_measure_only: true },
@@ -329,7 +454,7 @@ describe 'A better distance_of_time_in_words' do
        { highest_measures: 3 },
        '1 year and 2 weeks'],
       [START_TIME,
-       START_TIME + 1.days,
+       START_TIME + 1.day,
        { only: %i[years months] },
        'less than 1 month'],
       [START_TIME,
@@ -337,15 +462,83 @@ describe 'A better distance_of_time_in_words' do
        { except: %i[hours minutes seconds] },
        'less than 1 day'],
       [START_TIME,
-       START_TIME + 1.days,
+       START_TIME + 1.day,
        { highest_measures: 1, only: %i[years months] },
-       'less than 1 month']
+       'less than 1 month'],
+      [START_TIME,
+       START_TIME + 1.day + 1.hour,
+       { highest_measures: {} },
+       '1 day'],
+      [START_TIME,
+       START_TIME + 1.day + 1.hour,
+       { highest_measures: { remainder: :floor} },
+       '1 day'],
+      [START_TIME,
+       START_TIME + 1.year + 1.minute,
+       { highest_measures: { remainder: :ceiling } },
+       '2 years'],
+      [START_TIME,
+       START_TIME + 1.day + 2.hours + 30.minutes,
+       { highest_measures: { max: 2, remainder: :round } },
+       '1 day and 3 hours'],
+      [START_TIME,
+       START_TIME + 1.day + 23.hours + 59.minutes + 59.seconds,
+       { highest_measures: { max: 3, remainder: :round } },
+       '2 days'],
+      [START_TIME,
+       START_TIME + 1.day,
+       { highest_measures: { remainder: :ceiling }, only: :months },
+       'less than 1 month'],
+      [START_TIME,
+       # Simplistic rounding: one would expect this to round up to a second week.
+       START_TIME + 1.week + 3.days + 23.hours,
+       { highest_measures: { remainder: :round } },
+       '1 week'],
+      [START_TIME,
+       # Simplistic rounding: in some months, 15 days is less than half, but we always round it up.
+       START_TIME + 1.month + 14.days,
+       { highest_measures: { remainder: :round } },
+       '2 months'],
     ].each do |start, finish, options, output|
       it "should be #{output}" do
         expect(distance_of_time_in_words(start, finish, true, options)).to eq(output)
       end
     end
 
+    it "raises ArgumentError when an unrecognized value is passed for highest_measure.remainder" do
+      expect do
+        distance_of_time_in_words(START_TIME, START_TIME + 1.day, true, { highest_measures: { remainder: :oops }})
+      end.to raise_error(ArgumentError)
+    end
+
+    describe 'folding excluded fractions into included ones (regression for #77 and #120)' do
+      it 'folds excluded weeks into days rather than discarding them' do
+        from = '2019-01-02'.to_time
+        to = '2020-12-28'.to_time
+        expect(distance_of_time_in_words(from, to, false, only: %i[years months days]))
+          .to eq('1 year, 11 months, and 26 days')
+      end
+
+      it 'folds excluded weeks into days when using except' do
+        from = '2019-01-02'.to_time
+        to = '2020-12-28'.to_time
+        expect(distance_of_time_in_words(from, to, false, except: :weeks))
+          .to eq('1 year, 11 months, and 26 days')
+      end
+
+      it 'folds an excluded month into days' do
+        expect(distance_of_time_in_words(START_TIME, START_TIME + 1.month + 9.days, false, only: %i[months days]))
+          .to eq('1 month and 9 days')
+      end
+
+      it 'converts a negative day count into a week when the day-of-month matches but the hour rolls back' do
+        from = Time.new(2024, 5, 1, 10, 0, 0)
+        to = Time.new(2024, 6, 1, 9, 0, 0)
+        expect(distance_of_time_in_words(from, to, false, only: %i[months weeks days]))
+          .to eq('4 weeks and 2 days')
+      end
+    end
+
     if defined?(ActionView)
       describe 'ActionView without include seconds argument' do
         [
@@ -391,13 +584,31 @@ describe 'A better distance_of_time_in_words' do
           [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, 6 minutes, and 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,
+           { vague: true, locale: :en },
+           'about 1 year']
         ].each do |start, finish, options, output|
           it "should be #{output}" do
             expect(distance_of_time_in_words(start, finish, true, options)).to eq(output)
           end
         end
-  
+
+        # requires the rails-i18n gem for non-English datetime.distance_in_words translations, see #44
+        if defined?(RailsI18n)
+          it 'should be rundt 1 år for vague: true, locale: :nb' do
+            finish = START_TIME + 1.year + 2.months
+            expect(distance_of_time_in_words(START_TIME, finish, true, vague: true, locale: :nb)).to eq('rundt 1 år')
+          end
+        else
+          it 'returns a translation missing message for vague: true, locale: :nb without the rails-i18n gem' do
+            finish = START_TIME + 1.year + 2.months
+            expect(distance_of_time_in_words(START_TIME, finish, true, vague: true, locale: :nb))
+              .to eq('Translation missing: nb.datetime.distance_in_words.about_x_years')
+          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

data/spec/lib/i18n/dz.yml

@@ -0,0 +1,21 @@
+seconds:
+  1.second: སྐར་ཆ་ ༡
+  3.seconds: སྐར་ཆ་ 3
+minutes:
+  1.minute: སྐར་མ་ ༡
+  20.minutes: སྐར་མ་ 20
+hours:
+  1.hour: ཆུ་ཚོད་ ༡
+  5.hours: ཆུ་ཚོད་ 5
+days:
+  1.day: ཉིནམ་ ༡
+  6.days: ཉིནམ་ 6
+weeks:
+  1.week: བདུན༌ཕྲག་ ༡
+  2.weeks: བདུན༌ཕྲག་ 2
+months:
+  1.month: ཟླཝ་ ༡
+  9.months: ཟླཝ་ 9
+years:
+  1.year: ལོ་ ༡
+  3.years: ལོ་ 3

data/spec/lib/i18n/ru.yml

@@ -3,3 +3,21 @@ seconds:
   1.second: 1 секунда
 minutes:
   1.minute: 1 минута
+compact seconds:
+  1.second: 1с
+  11.seconds: 11с
+  21.seconds: 21с
+compact minutes:
+  1.minute: 1м
+  11.minutes: 11м
+  21.minutes: 21м
+compact hours:
+  1.hour: 1ч
+  11.hours: 11ч
+  21.hours: 21ч
+compact days:
+  1.day: 1д
+compact years:
+  1.year: 1г
+  11.years: 11г
+  21.years: 21г

data/spec/spec_helper.rb

@@ -3,8 +3,27 @@
 ROOT_PATH = File.join(File.dirname(__FILE__), '..')
 $LOAD_PATH.unshift ROOT_PATH unless $LOAD_PATH.include? ROOT_PATH
 
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+# Ruby 3.4 dropped concurrent-ruby's implicit require of logger, which older
+# Rails versions rely on being already loaded, see https://github.com/rails/rails/issues/54271.
+require 'logger'
+require 'bundler'
+Bundler.require
+
 require 'dotiw'
 
+# Loads Rails' own datetime.distance_in_words translations for non-English
+# locales, needed by the vague: true option, which falls back to Rails'
+# native distance_of_time_in_words instead of dotiw's own translations, see #44.
+# Only present when the rails-i18n gem is in the Gemfile (see gemfiles/rails_8.1_i18n.gemfile).
+if defined?(RailsI18n)
+  I18n.load_path += Dir[File.join(Gem.loaded_specs['rails-i18n'].gem_dir, 'rails', 'locale', '*.yml')]
+end
+
 Time.zone = 'UTC'
 
 I18n.locale = :en

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dotiw
 version: !ruby/object:Gem::Version
-  version: 5.3.3
+  version: 5.6.0
 platform: ruby
 authors:
 - Ryan Bigg
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-25 00:00:00.000000000 Z
+date: 2026-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -110,19 +110,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: tzinfo
+  name: mutex_m
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.7
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.7
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   dotiw is a gem for Rails that overrides the
                 default distance_of_time_in_words and provides
@@ -141,24 +183,34 @@ files:
 - ".rspec"
 - Appraisals
 - CHANGELOG.md
+- CODEOWNERS
 - CONTRIBUTING.md
 - Gemfile
 - MIT-LICENSE
 - README.markdown
+- RELEASING.md
 - Rakefile
+- benchmarks/distance_of_time_in_words_bench.rb
 - benchmarks/time_hash_bench.rb
 - dotiw.gemspec
 - gemfiles/.bundle/config
-- gemfiles/rails_4.gemfile
 - gemfiles/rails_5.0.gemfile
 - gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
+- gemfiles/rails_7.0.gemfile
+- gemfiles/rails_7.1.gemfile
+- gemfiles/rails_7.2.gemfile
+- gemfiles/rails_8.0.gemfile
+- gemfiles/rails_8.1.gemfile
+- gemfiles/rails_8.1_i18n.gemfile
 - lib/dotiw.rb
 - lib/dotiw/action_view/helpers/date_helper.rb
+- lib/dotiw/core.rb
 - lib/dotiw/locale/ar.yml
 - lib/dotiw/locale/da.yml
 - lib/dotiw/locale/de.yml
+- lib/dotiw/locale/dz.yml
 - lib/dotiw/locale/en.yml
 - lib/dotiw/locale/es.yml
 - lib/dotiw/locale/fr.yml
@@ -178,10 +230,12 @@ files:
 - lib/dotiw/methods.rb
 - lib/dotiw/time_hash.rb
 - lib/dotiw/version.rb
+- spec/lib/dotiw_module_spec.rb
 - spec/lib/dotiw_spec.rb
 - spec/lib/i18n/ar.yml
 - spec/lib/i18n/da.yml
 - spec/lib/i18n/de.yml
+- spec/lib/i18n/dz.yml
 - spec/lib/i18n/en.yml
 - spec/lib/i18n/es.yml
 - spec/lib/i18n/fr.yml
@@ -218,15 +272,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Better distance_of_time_in_words for Rails
 test_files:
+- spec/lib/dotiw_module_spec.rb
 - spec/lib/dotiw_spec.rb
 - spec/lib/i18n/ar.yml
 - spec/lib/i18n/da.yml
 - spec/lib/i18n/de.yml
+- spec/lib/i18n/dz.yml
 - spec/lib/i18n/en.yml
 - spec/lib/i18n/es.yml
 - spec/lib/i18n/fr.yml