activesupport-duration-human_string 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a7049bf99ad5f6ffbf07e5ae95ae38efea3b73b9b57dfaf9f655ac66ddb2338
-  data.tar.gz: ed4fa6793ec9549bd7379120b325e2a5b27c338dfc0d5728168c3d84abc407e6
+  metadata.gz: 7a42d606d1f8510d965e98436ecb7232868bf0f00053da7cb7f6f430c0dd2321
+  data.tar.gz: c1c817cf2dcec49125adad4fc6c05f45331a255ec112b52e90926296aea1f45a
 SHA512:
-  metadata.gz: b960130471d06f5cf4425b3e53158e23094703cbd4c5efbed04d4cac133628d2662ac3a8ad742f2fd1971e4edddbd54551d465c8d57b01986ce983ce3412623d
-  data.tar.gz: 8b1b76dbb70d9d31f7637b7f09c03857b15643b8eb8a3f35de1615e7df420dd18622674744ecea6fc77df865c56b7fe39d7f88b9c5bf2f602dc667cbe1d54c62
+  metadata.gz: 8705aed9bc654ba6667ad5b9c9ebe99931f479846c24fd2a5112ca848cee2f438b95746b8ef96296e7f5d6f50d677369d2f9d6d13f578e2f17cc2ef8b1d26d94
+  data.tar.gz: 29d6639d5c7131b4db0b8f7a8b48a3155c245169b53838d163c6bd308231e15e723a9630d46de119462a8315ae40f4c791403390b46f715d96419cfc6eb88a27

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/
 
 # rspec failure tracking
 .rspec_status

data/Changelog.md

@@ -0,0 +1,14 @@
+## 1.0.0 (2024-02-16)
+
+Fixes:
+
+- Relax activesupport dependency version
+
+Breaking changes:
+
+- Extract `#change`, `#truncate`, `#round`, etc. out of this gem into the [activesupport-duration-change](https://github.com/TylerRick/activesupport-duration-change) gem
+
+## 0.1.1 (2019-04-02)
+
+Initial release
+

data/Gemfile

@@ -2,3 +2,5 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in activesupport-duration-human_string.gemspec
 gemspec
+
+gem 'byebug'

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,19 +28,26 @@ 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`.
 
+## See also
+
+- [activesupport-duration-change](https://github.com/TylerRick/activesupport-duration-change), which adds methods such as `#change`, `#truncate`, `#round` to `Duration`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -40,7 +58,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/TylerRick/activesupport-duration-human_string.
 
-##  Not really related
+## Not really related
 
 - https://github.com/josedonizetti/ruby-duration
 - https://github.com/janko/as-duration

data/activesupport-duration-human_string.gemspec

@@ -30,9 +30,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = ">= 2.3.0"
-  spec.add_dependency "activesupport", [">= 4.2", "< 5.3"]
+  spec.add_dependency "activesupport", [">= 5.2"]
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

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

@@ -1,9 +1,9 @@
 module ActiveSupport
   class Duration
     module HumanString
-    def self.version
-      "0.1.0"
-    end
+      def self.version
+        "1.0.0"
+      end
     end
   end
 end

data/lib/active_support/duration/human_string.rb

@@ -1,27 +1,35 @@
+require 'active_support'
 require 'active_support/duration'
 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).
@@ -35,7 +43,7 @@ module ActiveSupport
     #
     def human_str(precision: nil, separator: '', delimiter: ' ', use_2_digit_numbers: false)
       HumanStringSerializer.new(
-        self,
+        self.class.build(value),
         precision: precision,
         separator: separator,
         delimiter: delimiter,

data/lib/activesupport-duration-human_string.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activesupport-duration-human_string
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tyler Rick
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-02 00:00:00.000000000 Z
+date: 2024-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,62 +16,56 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: 'Convert ActiveSupport::Duration objects to human-friendly strings like
   ''2h 30m 17s''. '
 email:
@@ -93,6 +87,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
@@ -115,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.5.1
 signing_key: 
 specification_version: 4
 summary: Convert Duration objects to human-friendly strings like '2h 30m 17s'