activesupport-duration-human_string 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a7049bf99ad5f6ffbf07e5ae95ae38efea3b73b9b57dfaf9f655ac66ddb2338
-  data.tar.gz: ed4fa6793ec9549bd7379120b325e2a5b27c338dfc0d5728168c3d84abc407e6
+  metadata.gz: 4f26808d70339292160cc34e94c6c4bf3d4b76a344269e51a714da471706d45f
+  data.tar.gz: b00aa1e03d68ece37ba93ab7ae765d3dca9c11bd5da32b8d2055083a4a14981e
 SHA512:
-  metadata.gz: b960130471d06f5cf4425b3e53158e23094703cbd4c5efbed04d4cac133628d2662ac3a8ad742f2fd1971e4edddbd54551d465c8d57b01986ce983ce3412623d
-  data.tar.gz: 8b1b76dbb70d9d31f7637b7f09c03857b15643b8eb8a3f35de1615e7df420dd18622674744ecea6fc77df865c56b7fe39d7f88b9c5bf2f602dc667cbe1d54c62
+  metadata.gz: c032fe5ce288994bb132f3896de00d3e6a45169bc57eaf9b5fb441c6049d593b105bf4d47ee3847405c3e40f378b4cf7c5df13321549d870055f28406f9a75d9
+  data.tar.gz: 9707cfa9cbeff415f31f67f8fd2955cb660874c6c160df0e3a67b60e6a85ff43cca23d951de356af11a4be12480ca04c7619c1c5c3d96e14c0416d145cab201c

data/Readme.md

@@ -1,10 +1,21 @@
-# `ActiveSupport::Duration#human_string`
-
-Convert [ActiveSupport::Duration](https://api.rubyonrails.org/classes/ActiveSupport/Duration.html) objects to human-friendly strings like `'2h 30m 17s'`.
-
-- Like [`distance_of_time_in_words`](https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html) helper but _exact_ rather than approximate.
-- Like [`#inspect`](https://github.com/rails/rails/blob/b9ca94caea2ca6a6cc09abaffaad67b447134079/activesupport/lib/active_support/duration.rb#L372) but more concise and configurable.
-- Like [`#iso8601`](https://api.rubyonrails.org/classes/ActiveSupport/Duration.html#method-i-iso8601) but more human readable rather than machine readable.
+# ActiveSupport::Duration#human_string  [![Gem Version](https://badge.fury.io/rb/activesupport-duration-human_string.svg)](https://badge.fury.io/rb/activesupport-duration-human_string)
+
+Convert [ActiveSupport::Duration](https://api.rubyonrails.org/classes/ActiveSupport/Duration.html)
+objects to human-friendly strings like `'2h 30m 17s'` or `'3y 6m 4d 12h 30m 5s'`.
+
+- Like [`distance_of_time_in_words`](https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-distance_of_time_in_words)
+  helper but _exact_ rather than approximate
+  - `distance_of_time_in_words` is somewhat configurable but only gives an approximation (`'over 3
+    years'`), with no option to print the exact number of each units.
+- Like [`#inspect`](https://github.com/rails/rails/blob/b9ca94caea2ca6a6cc09abaffaad67b447134079/activesupport/lib/active_support/duration.rb#L372)
+  but more concise and configurable.
+  - `#inspect` is long (`'3 years, 6 months, 4 days, 12 hours, 30 minutes, and 5 seconds'`) and not
+    at all configurable.
+- Like [`#iso8601`](https://api.rubyonrails.org/classes/ActiveSupport/Duration.html#method-i-iso8601)
+  but more human readable rather than machine readable.
+  - `#iso8601` is concise and machine-readable, but not very human-readable (`'P3Y6M4DT12H30M5S'`)!
+- Unlike [`#to_s`](https://api.rubyonrails.org/classes/ActiveSupport/Duration.html#method-i-to_s),
+  which is very concise (`'110839937'`) but not at all human-readable for large durations
 
 ## Installation
 
@@ -17,15 +28,18 @@ gem 'activesupport-duration-human_string'
 ## Usage
 
 ```ruby
-    duration = ActiveSupport::Duration.build(65)
-    duration.human_str                            # =>  '1m 5s'
-    duration.human_str(use_2_digit_numbers: true) # =>  '1m 05s'
-
-    duration = ActiveSupport::Duration.build(3500)
+    duration = 3500.seconds
     duration.human_str                 # =>  '58m 20s'
     duration.human_str(delimiter: '')  # =>  '58m20s'
     duration.human_str(separator: ' ') # =>  '58 m 20 s'
     duration.human_str(delimiter: ', ', separator: ' ') # =>  '58 m, 20 s'
+
+    duration = ActiveSupport::Duration.parse "P3Y6M4DT12H30M5S"
+    # => 3 years, 6 months, 4 days, 12 hours, 30 minutes, and 5 seconds
+
+    duration.human_str                  # => "3y 6m 4d 12h 30m 5s"
+    (duration - 4.days).human_str       # => "3y 6m 12h 30m 5s"
+    duration.human_str(delimiter: ', ') # => "3y, 6m, 4d, 12h, 30m, 5s"
 ```
 
 Also aliased as `human_string`, `to_human_s`.

data/lib/active_support/duration/human_string.rb

@@ -3,25 +3,32 @@ require 'active_support/duration/iso8601_serializer'
 
 module ActiveSupport
   class Duration
-    # Convert [ActiveSupport::Duration](https://api.rubyonrails.org/classes/ActiveSupport/Duration.html) objects to human-friendly strings like `'2h 30m 17s'`.
+    # Convert [ActiveSupport::Duration](https://api.rubyonrails.org/classes/ActiveSupport/Duration.html)
+    # objects to human-friendly strings like `'2h 30m 17s'` or `'3y 6m 4d 12h 30m 5s'`.
     #
-    # Like [`distance_of_time_in_words`](https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html) helper but _exact_ rather than approximate.
-    # Like `#inspect` but more concise. Like [`#iso8601`](https://api.rubyonrails.org/classes/ActiveSupport/Duration.html#method-i-iso8601) but more human readable rather than machine readable.
+    # - Like [`distance_of_time_in_words`](https://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html) helper but _exact_ rather than approximate.
+    # - Like [`#inspect`](https://github.com/rails/rails/blob/b9ca94caea2ca6a6cc09abaffaad67b447134079/activesupport/lib/active_support/duration.rb#L372) but more concise and configurable.
+    # - Like [`#iso8601`](https://api.rubyonrails.org/classes/ActiveSupport/Duration.html#method-i-iso8601) but more human readable rather than machine readable.
     #
     # Note that the unit 'm' is used for both months and minutes.
     #
     # ## Examples
     #
-    # duration = ActiveSupport::Duration.build(65)
-    # duration.human_str                            # =>  '1m 5s'
-    # duration.human_str(use_2_digit_numbers: true) # =>  '1m 05s'
-    #
-    # duration = ActiveSupport::Duration.build(3500)
+    # ```ruby
+    # duration = 3500.seconds
     # duration.human_str                 # =>  '58m 20s'
     # duration.human_str(delimiter: '')  # =>  '58m20s'
     # duration.human_str(separator: ' ') # =>  '58 m 20 s'
     # duration.human_str(delimiter: ', ', separator: ' ') # =>  '58 m, 20 s'
     #
+    # duration = ActiveSupport::Duration.parse "P3Y6M4DT12H30M5S"
+    # # => 3 years, 6 months, 4 days, 12 hours, 30 minutes, and 5 seconds
+    #
+    # duration.human_str                  # => "3y 6m 4d 12h 30m 5s"
+    # (duration - 4.days).human_str       # => "3y 6m 12h 30m 5s"
+    # duration.human_str(delimiter: ', ') # => "3y, 6m, 4d, 12h, 30m, 5s"
+    # ```
+    #
     # ## Options
     #
     # `:precision`: Precision of seconds (defaults to nil, which is no digits after decimal).

data/lib/active_support/duration/human_string/version.rb

@@ -2,7 +2,7 @@ module ActiveSupport
   class Duration
     module HumanString
     def self.version
-      "0.1.0"
+      "0.1.1"
     end
     end
   end

data/lib/activesupport-duration-human_string.rb

@@ -0,0 +1 @@
+require 'active_support/duration/human_string'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activesupport-duration-human_string
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tyler Rick
@@ -93,6 +93,7 @@ files:
 - bin/setup
 - lib/active_support/duration/human_string.rb
 - lib/active_support/duration/human_string/version.rb
+- lib/activesupport-duration-human_string.rb
 homepage: https://github.com/TylerRick/activesupport-duration-human_string
 licenses:
 - MIT