dotiw 4.0.1 → 5.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 452b08e7e56c1727f5a05056ea6b6f5d61465eae7661b026b226b9e43c6e2919
-  data.tar.gz: '0687798a0b46e6d69b56936aa78b850f9d778cb3089109b93587507243205b02'
+  metadata.gz: 36c95ebe9c3f26cad8de3f4671810af863f765b14f0c5066d761b84881515935
+  data.tar.gz: 76b3a723afd1e060a71e148c1b2f839460e325848de32b94d1d0fe701266f266
 SHA512:
-  metadata.gz: 57e70d36c9a7fbd88af495f454318cf91775cf58eb5fe0854f3ad2ca97ef3c8727f30dd1ba695977dbc62d820d7d8cbc92f715bb4480914014717eab1487d1bf
-  data.tar.gz: 555464020ec01e55ee22d171465ff577b1cdb9790be50baf00f694c83847ede0d79874787f76cebe6eeca822c03d02fb9dbdc6410e0c63e2151955c780f99aca
+  metadata.gz: 25bbeae402bf0addf41bfdd5b0a7b7e23c51c528c1905714abad73696fa62cc8fb79eb6721fac8e69e1c8ca86c1d72c0fb04e7d8728b196d1dde5158df1cc035
+  data.tar.gz: 8d63f397602b8f07df9c4d0a1f60f10c48a19b8e01ee3346305bb364e3a18b74670032cdb37f6b1c6da8f26eb2e056ebb5b7f0940798c5bc133b612765500233

data/.github/workflows/ruby.yml

@@ -0,0 +1,45 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - 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
+            gemfile: gemfiles/rails_5.0.gemfile
+          - ruby-version: 2.6
+            gemfile: gemfiles/rails_5.1.gemfile
+          - ruby-version: 2.6
+            gemfile: gemfiles/rails_5.2.gemfile
+          - ruby-version: 2.6
+            gemfile: gemfiles/rails_6.0.gemfile
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Build and test
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+          BUNDLER: ${{ matrix.bundler-version }}
+        run: |
+          gem uninstall bundler
+          gem install bundler -v ${BUNDLER:-2.1.4}
+          bundle install --jobs 4 --retry 3
+          bundle exec rake

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Appraisals

@@ -0,0 +1,19 @@
+appraise 'rails_4' do
+  gem 'rails', '~> 4.0'
+end
+
+appraise 'rails_5.0' do
+  gem 'rails', '~> 5.0.0'
+end
+
+appraise 'rails_5.1' do
+  gem 'rails', '~> 5.1.0'
+end
+
+appraise 'rails_5.2' do
+  gem 'rails', '~> 5.2.0'
+end
+
+appraise 'rails_6.0' do
+  gem 'rails', '~> 6.0.0'
+end

data/CHANGELOG.md

@@ -1,10 +1,46 @@
+## 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).
+* [#106](https://github.com/radar/distance_of_time_in_words/pull/106): Add Vietnamese language support - [@runlevel5 ](https://github.com/runlevel5).
+
+## 5.0.0 (2020/05/07)
+
+* [#105](https://github.com/radar/distance_of_time_in_words/pull/105): Support for Ruby w/o Rails - [@dblock](https://github.com/dblock).
+* [#108](https://github.com/radar/distance_of_time_in_words/pull/108): Fix negative weeks - [@ivanovaleksey](https://github.com/ivanovaleksey).
+
+## 4.0.1 (2018/06/01)
+
 ## 3.1.1 (2016/03/08)
-* Add CHANGELOG.md
 
 ## 3.1.0 (2016/03/07)
 
-* [#68](https://github.com/radar/dotiw/pull/68): Add support for weeks - [@lauranjansen](https://github.com/lauranjansen)
-* [#69](https://github.com/radar/dotiw/pull/69): Add Indonesian language support - [@avidmaulanas](https://github.com/avidmaulanas)
-* [#70](https://github.com/radar/dotiw/pull/70): Add French language support - [@geo1004](https://github.com/geo1004)
-* [#72](https://github.com/radar/dotiw/pull/72): Add Danish language support - [@kaspernj](https://github.com/kaspernj)
-* [#71](https://github.com/radar/dotiw/pull/71): Update bundler and ruby versions for Travis CI - [@lauranjansen](https://github.com/lauranjansen)
+* [#68](https://github.com/radar/dotiw/pull/68): Add support for weeks - [@lauranjansen](https://github.com/lauranjansen).
+* [#69](https://github.com/radar/dotiw/pull/69): Add Indonesian language support - [@avidmaulanas](https://github.com/avidmaulanas).
+* [#70](https://github.com/radar/dotiw/pull/70): Add French language support - [@geo1004](https://github.com/geo1004).
+* [#72](https://github.com/radar/dotiw/pull/72): Add Danish language support - [@kaspernj](https://github.com/kaspernj).
+* [#71](https://github.com/radar/dotiw/pull/71): Update bundler and ruby versions for Travis CI - [@lauranjansen](https://github.com/lauranjansen).
+
+## 3.0.1 (2015/04/09)
+
+## 3.0 (2015/04/09)
+
+## 0.2.4 (2009/10/18)
+
+* Initial public release - [@radar](https://github.com/radar).

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 gemspec

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Ryan Bigg
+Copyright (c) 2009-2020 Ryan Bigg
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -1,65 +1,99 @@
-# dotiw [![](https://travis-ci.org/radar/dotiw.svg)](https://travis-ci.org/radar/dotiw)
+# dotiw ![Ruby](https://github.com/radar/distance_of_time_in_words/workflows/Ruby/badge.svg)
 
-dotiw is a gem for Rails that overrides the default `distance_of_time_in_words` and provides a more accurate output. Do you crave accuracy down to the second? So do I. That's why I made this gem. Take this for a totally kickass example:
+The `dotiw` library that adds `distance_of_time_in_words` to any Ruby project, or overrides the default implementation in Rails with more accurate output.
 
-    >> distance_of_time_in_words(Time.now, Time.now + 1.year + 2.months + 3.weeks + 4.days + 5.hours + 6.minutes + 7.seconds, true)
-    => "1 year, 2 months, 3 weeks, 4 days, 5 hours, 6 minutes, and 7 seconds"
+Do you crave accuracy down to the second? So do I. That's why I made this gem.
 
-Also if one of the measurement is zero it will not output it:
+## Install
 
-    >> distance_of_time_in_words(Time.now, Time.now + 1.year + 2.months + 5.hours + 6.minutes + 7.seconds, true)
-    => "1 year, 2 months, 4 days, 6 minutes, and 7 seconds"
+Add to your `Gemfile`.
 
-Better than "about 1 year", am I right? Of course I am.
+```ruby
+gem 'dotiw'
+```
 
-"But Ryan!", you say, "What happens if the time is only in seconds but because of the default the seconds aren't shown? Won't it be blank?"
-"No!" I triumphantly reply:
+Run `bundle install`.
 
-    >> distance_of_time_in_words(Time.now, Time.now + 1.second, false)
-    => "1 second"
+### Pure Ruby
 
-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
+require 'dotiw'
 
-    >> distance_of_time_in_words(Time.now, Time.now + 1.year + 1.second, true)
-    => "1 year, and 1 second"
+include DOTIW::Methods
+```
 
-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/
+### Rails
 
-The last argument is an optional options hash that can be used to manipulate behavior and (which uses `to_sentence`).
+```ruby
+require 'dotiw'
 
-Don't like having to pass in `Time.now` all the time? Then use `time_ago_in_words` which also will *rock your
-world*:
+include ActionView::Helpers::DateHelper
+include ActionView::Helpers::TextHelper
+include ActionView::Helpers::NumberHelper
+```
 
-    >> time_ago_in_words(Time.now + 3.days + 1.second)
-    => "3 days, and 1 second"
+## distance\_of\_time\_in\_words
 
-Oh, and did I mention it supports I18n? Oh yeah. Rock on!
+Take this for a totally kick-ass example:
 
-## Install
+```ruby
+>> distance_of_time_in_words(Time.now, Time.now + 1.year + 2.months + 3.weeks + 4.days + 5.hours + 6.minutes + 7.seconds, true)
+=> "1 year, 2 months, 3 weeks, 4 days, 5 hours, 6 minutes, and 7 seconds"
+```
 
-Install it as a gem:
+Also if one of the measurement is zero it will not output it:
 
 ```ruby
-gem 'dotiw'
+>> distance_of_time_in_words(Time.now, Time.now + 1.year + 2.months + 5.hours + 6.minutes + 7.seconds, true)
+=> "1 year, 2 months, 4 days, 6 minutes, and 7 seconds"
 ```
 
-Or from GitHub:
+Better than "about 1 year", am I right? Of course I am.
+
+"But Ryan!", you say, "What happens if the time is only in seconds but because of the default the seconds aren't shown? Won't it be blank?"
+"No!" I triumphantly reply:
 
 ```ruby
-gem 'dotiw', github: 'radar/dotiw'
+>> distance_of_time_in_words(Time.now, Time.now + 1.second, false)
+=> "1 second"
 ```
 
+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
+>> distance_of_time_in_words(Time.now, Time.now + 1.year + 1.second, true)
+=> "1 year, and 1 second"
+```
+
+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/
+
+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
+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!
+
 ### Options
 
 #### :locale
 
 You can pass in a locale and it'll output it in whatever language you want (provided you have translations, otherwise it'll default to your app's default locale (the `config.i18n.default_locale` you have set in `/config/application.rb`):
 
-    >> distance_of_time_in_words(Time.now, Time.now + 1.minute, false, :locale => :es)
-    => "1 minuto"
+```ruby
+>> distance_of_time_in_words(Time.now, Time.now + 1.minute, false, locale: :es)
+=> "1 minuto"
+```
 
-This will also be passed to `to_sentence`
+This will also be passed to `to_sentence`.
 
 #### :vague
 
@@ -67,46 +101,60 @@ Specify this if you want it to use the old `distance_of_time_in_words`. The valu
 
 #### :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. Here's a code example:
+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.
 
-    >> distance_of_time_in_words(Time.now, Time.now + 2.hours + 70.seconds, true, :accumulate_on => :minutes)
-    => "121 minutes and 10 seconds"
+```ruby
+>> distance_of_time_in_words(Time.now, Time.now + 2.hours + 70.seconds, true, accumulate_on: :minutes)
+=> "121 minutes and 10 seconds"
+```
 
 #### :only
 
 Only want a specific measurement of time? No problem!
 
-    >> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute, false, :only => :minutes)
-    => "1 minute"
+```ruby
+>> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute, false, only: :minutes)
+=> "1 minute"
+```
 
 You only want some? No problem too!
 
-    >> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.day + 1.minute, false, :only => [:minutes, :hours])
-    => "1 hour and 1 minute"
+```ruby
+>> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.day + 1.minute, false, only: [:minutes, :hours])
+=> "1 hour and 1 minute"
+```
 
 #### :except
 
 Don't want a measurement of time? No problem!
 
-    >> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute, false, :except => :minutes)
-    => "1 hour"
+```ruby
+>> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute, false, except: :minutes)
+=> "1 hour"
+```
 
 Culling a whole group of measurements of time:
 
-    >> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.day + 1.minute, false, :except => [:minutes, :hours])
-    => "1 day"
+```ruby
+>> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.day + 1.minute, false, except: [:minutes, :hours])
+=> "1 day"
+```
 
 #### :highest\_measure\_only
 
 For times when Rails `distance_of_time_in_words` is not precise enough and `DOTIW` is too precise. For instance, if you only want to know the highest time part (measure) that elapsed between two dates.
 
-    >> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute + 1.second, true, :highest_measure_only => true)
-    => "1 hour"
+```ruby
+>> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute + 1.second, true, highest_measure_only: true)
+=> "1 hour"
+```
 
 Notice how minutes and seconds were removed from the output. Another example:
 
-    >> distance_of_time_in_words(Time.now, Time.now + 1.minute + 1.second, true, :highest_measure_only => true)
-    => "1 minute"
+```ruby
+>> distance_of_time_in_words(Time.now, Time.now + 1.minute + 1.second, true, highest_measure_only: true)
+=> "1 minute"
+```
 
 Minutes are the highest measure, so seconds were discarded from the output.
 
@@ -114,58 +162,97 @@ Minutes are the highest measure, so seconds were discarded from the output.
 
 When you want variable precision from `DOTIW`:
 
-    >> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute + 1.second, true, :highest_measures => 2)
-    => "1 hour and 1 minute"
+```ruby
+>> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute + 1.second, true, highest_measures: 2)
+=> "1 hour and 1 minute"
+```
 
 #### :words_connector
 
-**This is an option for `to_sentence`, defaults to ', '**
+This is an option for `to_sentence`, defaults to ', '.
 
 Using something other than a comma:
 
-    >> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute + 1.second, true, :words_connector => ' - ')
-    => "1 hour - 1 minute, and 1 second"
+```ruby
+>> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute + 1.second, true, words_connector: ' - ')
+=> "1 hour - 1 minute, and 1 second"
+```
 
 #### :two\_words\_connector
 
-**This is an option for `to_sentence`, defaults to ' and '**
+This is an option for `to_sentence`, defaults to ' and '.
 
 Using something other than 'and':
 
-    >> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute, true, :two_words_connector => ' plus ')
-    => "1 hour plus 1 minute"
+```ruby
+>> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute, true, two_words_connector: ' plus ')
+=> "1 hour plus 1 minute"
+```
 
 #### :last\_word\_connector
 
-**This is an option for `to_sentence`, defaults to ', and '**
+This is an option for `to_sentence`, defaults to ', and '.
 
 Using something other than ', and':
 
-    >> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute + 1.second, true, :last_word_connector => ', finally ')
-    => "1 hour, 1 minute, finally 1 second"
+```ruby
+>> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute + 1.second, true, last_word_connector: ', finally ')
+=> "1 hour, 1 minute, finally 1 second"
+```
 
 ## distance\_of\_time
 
 If you have simply a number of seconds you can get the "stringified" version of this by using `distance_of_time`:
 
-    >> distance_of_time(300)
-    => "5 minutes"
+```ruby
+>> distance_of_time(300)
+=> "5 minutes"
+```
 
 ## distance\_of\_time\_in\_words\_hash
 
 Don't like any format you're given? That's cool too! Here, have an indifferent hash version:
 
-    >> distance_of_time_in_words_hash(Time.now, Time.now + 1.year + 2.months + 3.weeks + 4.days + 5.hours + 6.minutes + 7.seconds)
-    => {:days => 4, :weeks => 3, :seconds => 7, :minutes => 6, :years => 1, :hours => 5, :months => 2}
+```ruby
+>> distance_of_time_in_words_hash(Time.now, Time.now + 1.year + 2.months + 3.weeks + 4.days + 5.hours + 6.minutes + 7.seconds)
+=> { days: 4, weeks: 3, seconds: 7, minutes: 6, years: 1, hours: 5, months: 2 }
+```
 
 Indifferent means that you can access all keys by their `String` or `Symbol` version.
 
 ## distance\_of\_time\_in\_percent
 
-If you want to calculate a distance of time in percent, use `distance_of_time_in_percent`. The first argument is the beginning time, the second argument the "current" time and the third argument is the end time. This method takes the same options as [`number_with_precision`](http://api.rubyonrails.org/classes/ActionView/Helpers/NumberHelper.html#method-i-number_with_precision).
+This method is only available with Rails ActionView.
 
-    distance_of_time_in_percent("04-12-2009".to_time, "29-01-2010".to_time, "04-12-2010".to_time, options)
+If you want to calculate a distance of time in percent, use `distance_of_time_in_percent`. The first argument is the beginning time, the second argument the "current" time and the third argument is the end time.
 
+```ruby
+>> distance_of_time_in_percent("04-12-2009".to_time, "29-01-2010".to_time, "04-12-2010".to_time)
+=> '15%'
+```
+
+This method takes the same options as [`number_with_precision`](http://api.rubyonrails.org/classes/ActionView/Helpers/NumberHelper.html#method-i-number_with_precision).
+
+```ruby
+>> distance_of_time_in_percent("04-12-2009".to_time, "29-01-2010".to_time, "04-12-2010".to_time, precision: 1)
+=> '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
 
@@ -173,3 +260,4 @@ If you want to calculate a distance of time in percent, use `distance_of_time_in
 * [Derander](http://github.com/derander) - correct Spanish translations
 * [DBA](http://github.com/dba) - commits leading up to the 0.7 release
 * [Sija](http://github.com/Sija) - rails 4 support, v2.0 release
+* [dblock](http://github.com/dblock) - Ruby w/o Rails support