dotiw 5.1.0 → 5.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c3178c4c07b2647581895e344418e9ce40e3da5d9e3cc1fda714f9817b852e8
-  data.tar.gz: cef2e7944c792c501181789e3ed9f0155e12be6954e40664f495bcb298f40709
+  metadata.gz: 5bbd17f6b2f3af46a5255fa9eb900aa7bb734ead661088a2936739aa2f2bef63
+  data.tar.gz: 2870eadd1e540d51e6ff73210024fbcb87de8c01cca2549d7fb80e30b4390d93
 SHA512:
-  metadata.gz: 2db64efc0d3189bca7be013a3faff83820392bcfc69bf111497ea3543d67eba53f3792f62e6c43b1d39b73a6d6fb32811b6ae4f511f04c19d069283cdd18f355
-  data.tar.gz: a9bae3a175fada3623c8275abec2052e377716db914dadd0b2908a33fbff67fa95191062cb37cb20d15a90478b61ddc9647140d04dc37f0be73fd44b833e7957
+  metadata.gz: a89bfcad7275d64474969ac9200f43d6b5b3fb922c6cfa9e4bc05550361f43dc3d1eb37c27771116dc51cfba6adfa844232fbc062592dfa2874ff0e355797c3b
+  data.tar.gz: 8379db832851f15302fa364103671c3d805c0f367d8c8c0be4d746e81a473ab4b7d49c29a248fd353410a14e22ed04db79a1bfb05b83f4fd52403781460712fa

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,24 @@
+## 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).
+* [#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).
+* [#112](https://github.com/radar/distance_of_time_in_words/pull/112): Add Swedish language support - [@davidwessman](https://github.com/davidwessman).
+* [#114](https://github.com/radar/distance_of_time_in_words/pull/114): Add Traditional Chinese (Taiwan) language support - [@sibevin](https://github.com/sibevin).
+
 ## 5.1.0 (2020/08/05)
 
 * [#111](https://github.com/radar/distance_of_time_in_words/pull/111): Fix: `NoMethodError` when calling `ActionController::Base.helpers.distance_of_time_in_words` - [@denisahearn](https://github.com/denisahearn).

data/README.markdown

@@ -67,14 +67,19 @@ 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` 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!
@@ -96,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.
@@ -235,6 +244,22 @@ This method takes the same options as [`number_with_precision`](http://api.rubyo
 => '15.3%'
 ```
 
+## :compact
+
+Pressed for space? Try `compact: true`.
+
+```ruby
+>> distance_of_time_in_words(Time.now, Time.now + 2.year + 1.day + 1.second, compact: true)
+=> "2y1d"
+```
+
+Pairs well with `words_connector`, `last_word_connector`, and `two_words_connector` if you can spare just a little more room:
+
+```ruby
+>> distance_of_time_in_words(Time.now, Time.now + 5.years + 1.day + 23.seconds, words_connector: " ", last_word_connector: " ", two_words_connector: " ", compact: true)
+=> "5y 1d 23s"
+```
+
 ## Contributors
 
 * [chendo](http://github.com/chendo) - for talking through it with me and drawing on the whiteboard

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/action_view/helpers/date_helper.rb

@@ -3,22 +3,42 @@
 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)
+        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, options.except(:vague))
+      end
+
+      def distance_of_time_in_words_to_now(to_time = 0, include_seconds_or_options = {}, options = {})
+        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, options.except(:vague))
       end
 
       def distance_of_time_in_percent(from_time, current_time, to_time, options = {})
         options[:precision] ||= 0
+        options = options_with_scope(options)
         distance = to_time - from_time
         result = ((current_time - from_time) / distance) * 100
         number_with_precision(result, options).to_s + '%'
       end
-    end # DateHelper
-  end # Helpers
-end # ActionView
+
+      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/locale/ar.yml

@@ -26,7 +26,7 @@ ar:
         zero: يوم
         one: يوم واحد
         two: يومين
-        few: "%{count} أيام"        
+        few: "%{count} أيام"
         many: "%{count} يومًا"
         other: "%{count} يوم"
       weeks:
@@ -38,16 +38,67 @@ ar:
         other: "%{count} أسيوع"
       months:
         zero: شهر
-        one: شهر واحد 
+        one: شهر واحد
         two: شهرين
         few: "%{count} أشهر"
         many: "%{count} شهراً"
         other: "%{count} شهر"
       years:
         zero: عام
-        one: عام واحد 
+        one: عام واحد
         two: عامين
         few: "%{count} أعوام"
         many: "%{count} عاماً"
         other: "%{count} عام"
       less_than_x: "%{distance} أقل من"
+  dotiw_compact:
+    seconds:
+      zero: ثانية
+      one: ثانية واحدة
+      two: ثانيتين
+      few: "%{count}توانٍ"
+      many: "%{count}ثانية"
+      other: "%{count}ثانية"
+    minutes:
+      zero: دقيقة
+      one: دقيقة واحدة
+      two: دقيقتين
+      few: "%{count}دقائق"
+      many: "%{count}دقيقة"
+      other: "%{count}دقيقة"
+    hours:
+      zero: ساعة
+      one: ساعة واحدة
+      two: ساعتين
+      few: "%{count}ساعات"
+      many: "%{count}ساعة"
+      other: "%{count}ساعة"
+    days:
+      zero: يوم
+      one: يوم واحد
+      two: يومين
+      few: "%{count}أيام"
+      many: "%{count}يومًا"
+      other: "%{count}يوم"
+    weeks:
+      zero: أسبوع
+      one: أسبوع واحدة
+      two: أسبوعين
+      few: "%{count}أسابيع"
+      many: "%{count}أسابيع"
+      other: "%{count}أسيوع"
+    months:
+      zero: شهر
+      one: شهر واحد
+      two: شهرين
+      few: "%{count}أشهر"
+      many: "%{count}شهراً"
+      other: "%{count}شهر"
+    years:
+      zero: عام
+      one: عام واحد
+      two: عامين
+      few: "%{count}أعوام"
+      many: "%{count}عاماً"
+      other: "%{count}عام"
+    less_than_x: "%{distance}>"

data/lib/dotiw/locale/da.yml

@@ -21,3 +21,38 @@ da:
         other: "%{count} måneder"
       years: "%{count} år"
       less_than_x: "mindre end %{distance}"
+    dotiw_compact:
+      seconds:
+        one: 1s
+        other: "%{count}s"
+      minutes:
+        one: 1m
+        other: "%{count}m"
+      hours:
+        one: 1t
+        other: "%{count}t"
+      days:
+        one: 1d
+        other: "%{count}d"
+      weeks:
+        one: 1u
+        other: "%{count}u"
+      months:
+        one: 1må
+        other: "%{count}må"
+      years:
+        one: 1år
+        other: "%{count}år"
+      less_than_x: "<%{distance}"
+      words_connector: ""
+      two_words_connector: ""
+      last_word_connector: ""
+      about_x_years:
+        one: ~1y
+        any: "~%{count}y"
+      over_x_years:
+        one: ">1y"
+        other: ">%{count}y"
+      almost_x_years:
+        one: ~1y
+        any: "~%{count}y"

data/lib/dotiw/locale/de.yml

@@ -22,4 +22,39 @@ de:
       years:
         one: 1 Jahr
         other: "%{count} Jahre"
-      less_than_x: "weniger als %{distance}"
+      less_than_x: "weniger als %{distance}"
+    dotiw_compact:
+      seconds:
+        one: 1s
+        other: "%{count}s"
+      minutes:
+        one: 1m
+        other: "%{count}m"
+      hours:
+        one: 1std
+        other: "%{count}std"
+      days:
+        one: 1t
+        other: "%{count}t"
+      weeks:
+        one: 1w
+        other: "%{count}w"
+      months:
+        one: 1mo
+        other: "%{count}mo"
+      years:
+        one: 1j
+        other: "%{count}j"
+      less_than_x: "<%{distance}"
+      words_connector: ""
+      two_words_connector: ""
+      last_word_connector: ""
+      about_x_years:
+        one: ~1y
+        any: "~%{count}y"
+      over_x_years:
+        one: ">1y"
+        other: ">%{count}y"
+      almost_x_years:
+        one: ~1y
+        any: "~%{count}y"

data/lib/dotiw/locale/en.yml

@@ -23,3 +23,38 @@ en:
         one: 1 year
         other: "%{count} years"
       less_than_x: "less than %{distance}"
+    dotiw_compact:
+      seconds:
+        one: 1s
+        other: "%{count}s"
+      minutes:
+        one: 1m
+        other: "%{count}m"
+      hours:
+        one: 1h
+        other: "%{count}h"
+      days:
+        one: 1d
+        other: "%{count}d"
+      weeks:
+        one: 1w
+        other: "%{count}w"
+      months:
+        one: 1mo
+        other: "%{count}mo"
+      years:
+        one: 1y
+        other: "%{count}y"
+      less_than_x: "<%{distance}"
+      words_connector: ""
+      two_words_connector: ""
+      last_word_connector: ""
+      about_x_years:
+        one: ~1y
+        any: "~%{count}y"
+      over_x_years:
+        one: ">1y"
+        other: ">%{count}y"
+      almost_x_years:
+        one: ~1y
+        any: "~%{count}y"

data/lib/dotiw/locale/es.yml

@@ -22,4 +22,39 @@ es:
       years:
         one: un año
         other: "%{count} años"
-      less_than_x: "menos de %{distance}"
+      less_than_x: "menos de %{distance}"
+    dotiw_compact:
+      seconds:
+        one: 1s
+        other: "%{count}s"
+      minutes:
+        one: 1m
+        other: "%{count}m"
+      hours:
+        one: 1h
+        other: "%{count}h"
+      days:
+        one: 1d
+        other: "%{count}d"
+      weeks:
+        one: 1s
+        other: "%{count}s"
+      months:
+        one: 1me
+        other: "%{count}me"
+      years:
+        one: 1a
+        other: "%{count}a"
+      less_than_x: "<%{distance}"
+      words_connector: ""
+      two_words_connector: ""
+      last_word_connector: ""
+      about_x_years:
+        one: ~1a
+        any: "~%{count}a"
+      over_x_years:
+        one: ">1a"
+        other: ">%{count}a"
+      almost_x_years:
+        one: ~1a
+        any: "~%{count}a"

data/lib/dotiw/locale/fr.yml

@@ -23,3 +23,38 @@ fr:
         one: 1 an
         other: "%{count} ans"
       less_than_x: "moins de %{distance}"
+    dotiw_compact:
+      seconds:
+        one: 1s
+        other: "%{count}s"
+      minutes:
+        one: 1m
+        other: "%{count}m"
+      hours:
+        one: 1h
+        other: "%{count}h"
+      days:
+        one: 1j
+        other: "%{count}j"
+      weeks:
+        one: 1se
+        other: "%{count}se"
+      months:
+        one: 1mo
+        other: "%{count}mo"
+      years:
+        one: 1a
+        other: "%{count}a"
+      less_than_x: "<%{distance}"
+      words_connector: ""
+      two_words_connector: ""
+      last_word_connector: ""
+      about_x_years:
+        one: ~1a
+        any: "~%{count}a"
+      over_x_years:
+        one: ">1a"
+        other: ">%{count}a"
+      almost_x_years:
+        one: ~1a
+        any: "~%{count}a"

data/lib/dotiw/locale/id.yml

@@ -23,3 +23,38 @@ id:
         one: 1 tahun
         other: "%{count} tahun"
       less_than_x: "kurang dari %{distance}"
+    dotiw_compact:
+      seconds:
+        one: 1d
+        other: "%{count}d"
+      minutes:
+        one: 1m
+        other: "%{count}m"
+      hours:
+        one: 1j
+        other: "%{count}j"
+      days:
+        one: 1h
+        other: "%{count}h"
+      weeks:
+        one: 1mi
+        other: "%{count}mi"
+      months:
+        one: 1b
+        other: "%{count}b"
+      years:
+        one: 1t
+        other: "%{count}t"
+      less_than_x: "<%{distance}"
+      words_connector: ""
+      two_words_connector: ""
+      last_word_connector: ""
+      about_x_years:
+        one: ~1t
+        any: "~%{count}t"
+      over_x_years:
+        one: ">1t"
+        other: ">%{count}t"
+      almost_x_years:
+        one: ~1t
+        any: "~%{count}t"

data/lib/dotiw/locale/it.yml

@@ -22,3 +22,38 @@ it:
       years:
         one: un anno
         other: "%{count} anni"
+    dotiw_compact:
+      seconds:
+        one: 1s
+        other: "%{count}s"
+      minutes:
+        one: 1m
+        other: "%{count}m"
+      hours:
+        one: 1o
+        other: "%{count}o"
+      days:
+        one: 1g
+        other: "%{count}g"
+      weeks:
+        one: 1se
+        other: "%{count}se"
+      months:
+        one: 1me
+        other: "%{count}me"
+      years:
+        one: 1a
+        other: "%{count}a"
+      less_than_x: "<%{distance}"
+      words_connector: ""
+      two_words_connector: ""
+      last_word_connector: ""
+      about_x_years:
+        one: ~1a
+        any: "~%{count}a"
+      over_x_years:
+        one: ">1a"
+        other: ">%{count}a"
+      almost_x_years:
+        one: ~1a
+        any: "~%{count}a"

data/lib/dotiw/locale/ja.yml

@@ -22,3 +22,38 @@ ja:
       years:
         one: "1年間"
         other: "%{count}年間"
+    dotiw_compact:
+      seconds:
+        one: "1秒"
+        other: "%{count}秒"
+      minutes:
+        one: "1分"
+        other: "%{count}分"
+      hours:
+        one: "1時間"
+        other: "%{count}時間"
+      days:
+        one: "1日間"
+        other: "%{count}日間"
+      weeks:
+        one: "1週間"
+        other: "%{count}週間"
+      months:
+        one: "1ヶ月"
+        other: "%{count}ヶ月"
+      years:
+        one: "1年間"
+        other: "%{count}年間"
+      less_than_x: "<%{distance}"
+      words_connector: ""
+      two_words_connector: ""
+      last_word_connector: ""
+      about_x_years:
+        one: ~1年間
+        any: "~%{count}年間"
+      over_x_years:
+        one: ">1年間"
+        other: ">%{count}年間"
+      almost_x_years:
+        one: ~1年間
+        any: "~%{count}年間"

data/lib/dotiw/locale/ko.yml

@@ -23,3 +23,26 @@ ko:
         one: 일년
         other: "%{count} 년"
       less_than_x: "%{distance} 미만"
+    dotiw_compact:
+      seconds:
+        one: 일초
+        other: "%{count}초"
+      minutes:
+        one: 일분
+        other: "%{count}분"
+      hours:
+        one: 한시간
+        other: "%{count}시간"
+      days:
+        one: 하루
+        other: "%{count}일"
+      weeks:
+        one: 일주
+        other: "%{count}주"
+      months:
+        one: 한달
+        other: "%{count}달"
+      years:
+        one: 일년
+        other: "%{count}년"
+      less_than_x: "< %{distance}"

data/lib/dotiw/locale/nb.yml

@@ -22,4 +22,39 @@ nb:
       years:
         one: 1 år
         other: "%{count} år"
-      less_than_x: "mindre enn %{distance}"
+      less_than_x: "mindre enn %{distance}"
+    dotiw_compact:
+      seconds:
+        one: 1s
+        other: "%{count}s"
+      minutes:
+        one: 1m
+        other: "%{count}m"
+      hours:
+        one: 1t
+        other: "%{count}t"
+      days:
+        one: 1d
+        other: "%{count}d"
+      weeks:
+        one: 1u
+        other: "%{count}u"
+      months:
+        one: 1må
+        other: "%{count}må"
+      years:
+        one: 1å
+        other: "%{count}å"
+      less_than_x: "<%{distance}"
+      words_connector: ""
+      two_words_connector: ""
+      last_word_connector: ""
+      about_x_years:
+        one: ~1å
+        any: "~%{count}å"
+      over_x_years:
+        one: ">1å"
+        other: ">%{count}å"
+      almost_x_years:
+        one: ~1å
+        any: "~%{count}å"