duration_in_words 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61890a8cefb328cd0317b59e381a4482cec0426059036bb2b24f40a73dccb11e
-  data.tar.gz: ecf684b6fca14b39e7a68126f19f85e9341f1a33ffa0ec886878223b145ae864
+  metadata.gz: 53a9a76ccc79bc85bd8f85480e62c12783260c31c8a9dd658d2534f1485eb663
+  data.tar.gz: ed294f375f5d68a38c5665ee3766b171c4a26cde8c209ea9ea05be04333bd5bf
 SHA512:
-  metadata.gz: da2221acad3383d7be4adf48dcbe7bf6d5fda42d120c1ce649c40cf298fc21fcc4b6275d0599706689d831151c9ef53b5aba6c0484ca2553a206422ef1dd3898
-  data.tar.gz: c609b68e4ba85d0c68327b346a7a2d781ac6b3beae6d4031412e85d414074cf7e0f8435718a4dcf64e089e35da7ed20bc5626143638092ead316e41417b23e12
+  metadata.gz: 900214bb1801e30866b551fe395bd8695a3d101c4abf919cbf3e1f9e237ccca5af3756cb037fbe5e954377c0b00694a1a5b9f9a52410f8874d76fbca130b962c
+  data.tar.gz: b82c111999a4ae3078f57bb028926b34bdd37075b02c9f7002d37b9736eb8bd9857932a1d52a73be06c5a931b5038935476678cd827739dffef3aa79e4435af1

data/.rubocop.yml

@@ -1,7 +1,17 @@
-require: rubocop-rspec
+require:
+  - rubocop-rspec
+
+plugins:
+  - rubocop-rake
 
 AllCops:
   TargetRubyVersion: 2.6
+  NewCops: enable
+
+# This gem keeps development dependencies in the gemspec, which matches the
+# standard Bundler gem template used to generate it.
+Gemspec/DevelopmentDependencies:
+  Enabled: false
 
 # Commonly used screens these days easily fit more than 80 characters.
 Layout/LineLength:
@@ -25,7 +35,7 @@ Layout/SpaceAroundEqualsInParameterDefault:
 # Enforcing double quotes reduces the times where you need to change them
 # when introducing an interpolation. Use single quotes only if their semantics
 # are needed.
-Layout/StringLiterals:
+Style/StringLiterals:
   EnforcedStyle: double_quotes
 
 Style/StringLiteralsInInterpolation:
@@ -36,10 +46,10 @@ Style/StringLiteralsInInterpolation:
 Style/SymbolArray:
   Enabled: true
 
-# Most readable form.
+# The old style configuration for this cop has been removed in recent RuboCop
+# versions, so keep it disabled instead of carrying invalid options.
 Style/OptionHash:
-  EnforcedHashRocketStyle: table
-  EnforcedColonStyle: table
+  Enabled: false
 
 # Mixing the styles looks just silly.
 Style/HashSyntax:
@@ -73,7 +83,7 @@ Style/RaiseArgs:
 
 # Indenting the chained dots beneath each other is not supported by this cop,
 # see https://github.com/bbatsov/rubocop/issues/1633
-Style/MultilineOperationIndentation:
+Layout/MultilineOperationIndentation:
   Enabled: false
 
 # Fail is an alias of raise. Avoid aliases, it's more cognitive load for no gain.
@@ -134,3 +144,8 @@ Style/MethodDefParentheses:
 
 RSpec/MultipleExpectations:
   Max: 2
+
+# This gem does not use Capybara, and the bundled cop currently crashes when
+# inspecting these plain RSpec examples under the pinned plugin set.
+Capybara/RSpec/PredicateMatcher:
+  Enabled: false

data/CHANGELOG.md

@@ -1,4 +1,46 @@
-## [Unreleased]
+## [0.4.0] - 2026-07-14
+
+### Fixed
+
+- Stop calling `I18n.reload!` when setting up locale files. It was discarding
+  any translations the host app had already stored in memory (e.g. via
+  `I18n.backend.store_translations`), not just ones loaded from files.
+- Removed trailing whitespace from the `de` locale file.
+
+### Changed
+
+- `duration_in_words` now raises `ArgumentError` for an unrecognized `:format`
+  value instead of silently falling back to `:compact`.
+- CI now runs the test suite against a matrix of supported Ruby versions
+  (2.6, 3.1, 3.4) instead of a single pinned version, and runs RuboCop and
+  `bundler-audit` as separate jobs.
+- Expanded the RBS signatures beyond `VERSION` to cover
+  `DurationInWords::Methods` and the `ActionView` helper.
+
+## [0.3.1] - 2026-03-28
+
+### Fixed
+
+- Respect the current `I18n.locale` by default when formatting durations.
+- Delegate pluralization to I18n so locales with plural forms beyond `one` and `other` are handled correctly.
+
+### Changed
+
+- Modernized the RuboCop configuration for the current toolchain and added RubyGems MFA metadata.
+
+## [0.3.0] - 2025-08-20
+
+### Added
+
+- Support for `weeks` as a duration unit by adding the necessary translations to the `en` and `de` locale files.
+
+## [0.2.0] - 2023-02-04
+
+### Added
+
+- Support for `:full` format for more descriptive output (e.g., "1 day, 2 hours, and 30 minutes").
+- Internationalization (i18n) support using the `:locale` option.
+- Handling of fractional duration values (e.g., `2.5.minutes`).
 
 ## [0.1.0] - 2023-02-04
 

data/README.md

@@ -1,22 +1,142 @@
-# DurationInWords
+# DurationInWords ![Ruby](https://github.com/aslam/duration_in_words/actions/workflows/main.yml/badge.svg)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/duration_in_words`. To experiment with that code, run `bin/console` for an interactive prompt.
+`duration_in_words` provides a view helper to convert [ActiveSupport::Duration](https://api.rubyonrails.org/classes/ActiveSupport/Duration.html) objects into concise string like `1h 20m and 30s`, with locale support.
 
-TODO: Delete this and the text above, and describe your gem
+## Why?
 
-## Installation
+Currently, there is no direct way to format `ActiveSupport::Duration` objects in `Rails`. You'd have to resort to using the `#inspect`, which provides limited configuration options. Also, the locale support in the `#inspect` was removed around `Rails 5.1`.
+
+You could do something like the following to format an `ActiveSupport::Duration` object by hand in a view helper:
+
+```ruby
+def duration_as_sentence(duration)
+  parts = duration.parts
+  units = [:days, :hours, :minutes]
+  map   = {
+    :days     => { :one => :d },
+    :hours    => { :one => :h, :other => :hrs },
+    :minutes  => { :one => :m, :other => :mins }
+  }
 
-Install the gem and add to the application's Gemfile by executing:
+  parts.
+    sort_by { |unit, _| units.index(unit) }.
+    map     { |unit, val| "#{val} #{val == 1 ? map[unit][:one].to_s : map[unit][:other].to_s}" }.
+    to_sentence
+end
+```
+
+This gem does something similar along with providing a flexible way of defining formats in locale files and giving you an option to switch between `:compact`, and `:full` formats.
+
+## Installation
 
-    $ bundle add duration_in_words
+Add to your `Gemfile`:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```ruby
+gem "duration_in_words"
+```
 
-    $ gem install duration_in_words
+Install the gem by running `bundle install`.
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+include ActionView::Helpers::DurationHelper
+
+>> duration = 2.hours
+>> duration_in_words(duration)
+=> "2h"
+>> duration = 1.day + 2.hours + 30.minutes
+>> duration_in_words(duration)
+=> "1d 2h and 30m"
+>> duration = 2.5.minutes
+>> duration_in_words(duration)
+=> "2.5m"
+>> duration = 3.weeks
+>> duration_in_words(duration)
+=> "3wks."
+>> duration_in_words(duration)
+=> "2.5m"
+```
+
+### Using <tt>:format</tt> option:
+
+There are two formats available, `:compact`, and `:full`. `:compact` being the default.
+
+```ruby
+>> duration = 1.day + 2.hours + 30.minutes
+>> duration_in_words(duration, format: :full)
+=> "1 day, 2 hours, and 30 minutes"
+```
+
+### Using <tt>:locale</tt> option:
+
+If you do not pass `:locale`, the helper uses the current `I18n.locale`.
+
+Given this locale dictionary:
+
+```yaml
+de:
+  duration:
+    in_words:
+      format:
+        compact:
+          years:
+            one: '%{count}J'
+            other: '%{count}J'
+          months:
+            one: '%{count}M'
+            other: '%{count}M'
+          days:
+            one: '%{count}T'
+            other: '%{count}T'
+          hours:
+            one: '%{count}Std.'
+            other: '%{count}Std.'
+          minutes:
+            one: '%{count}Min'
+            other: '%{count}Min'
+          seconds:
+            one: '%{count}s'
+            other: '%{count}s'
+          support:
+            words_connector: ' '
+            two_words_connector: ' und '
+            last_word_connector: ' und '
+        full:
+          years:
+            one: '%{count} Jahr'
+            other: '%{count} Jahre'
+          months:
+            one: '%{count} Monat'
+            other: '%{count} Monate'
+          days:
+            one: '%{count} Tag'
+            other: '%{count} Tage'
+          hours:
+            one: '%{count} Stunde'
+            other: '%{count} Stunden'
+          minutes:
+            one: '%{count} Minute'
+            other: '%{count} Minuten'
+          seconds:
+            one: '%{count} Sekunde'
+            other: '%{count} Sekunden'
+          support:
+            words_connector: ', '
+            two_words_connector: ' und '
+            last_word_connector: ', und '
+```
+
+```ruby
+>> duration = 1.day + 2.hours + 30.minutes
+>> duration_in_words(duration, locale: :de)
+=> "1T 2Std. und 30Min"
+>> duration = 3.weeks
+>> duration_in_words(duration, locale: :de)
+=> "3W"
+>> duration_in_words(duration, format: :full, locale: :de)
+>> "1 Tag 2 Stunden und 30 Minuten"
+```
 
 ## Development
 
@@ -26,7 +146,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/duration_in_words.
+Bug reports and pull requests are welcome on GitHub at https://github.com/aslam/duration_in_words.
 
 ## License
 

data/Rakefile

@@ -9,4 +9,8 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
+require "bundler/audit/task"
+
+Bundler::Audit::Task.new
+
 task default: %i[spec rubocop]

data/duration_in_words.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/duration_in_words/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "duration_in_words"
+  spec.version = DurationInWords::VERSION
+  spec.authors = ["Syed Aslam"]
+  spec.email = ["aslam.maqsood@gmail.com"]
+
+  spec.summary = "Report ActiveSupport::Duration in concise human readable formats."
+  spec.description = "Convert ActiveSupport::Duration objects to concise human readable formats like '2h 30m 45s'
+    with locale support."
+  spec.homepage = "https://github.com/aslam/duration_in_words"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/aslam/duration_in_words/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 6.0"
+  spec.add_dependency "i18n", "~> 1.12"
+
+  spec.add_development_dependency "bundler-audit"
+  spec.add_development_dependency "racc"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.21"
+  spec.add_development_dependency "rubocop-rake"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.18.1"
+end

data/lib/duration_in_words/action_view/helpers/duration_helper.rb

@@ -9,8 +9,8 @@ module ActionView
       #
       # === Options
       # * <tt>:format</tt> - The format to be used in reporting the duration, :full or :compact (default: :compact)
-      # * <tt>:locale</tt> - If +I18n+ is available, you can set a locale and use the connector options defined on
-      #   the 'support.array' namespace in the corresponding dictionary file.
+      # * <tt>:locale</tt> - Defaults to the current +I18n.locale+. You can also pass a locale explicitly and use the
+      #   connector options defined on the 'support.array' namespace in the corresponding dictionary file.
       #
       # === Examples
       # d = 1.day + 2.hours + 30.minutes

data/lib/duration_in_words/locales/de.yml

@@ -9,6 +9,9 @@ de:
           months:
             one: '%{count}M'
             other: '%{count}M'
+          weeks:
+            one: '%{count}W'
+            other: '%{count}W'
           days:
             one: '%{count}T'
             other: '%{count}T'
@@ -32,6 +35,9 @@ de:
           months:
             one: '%{count} Monat'
             other: '%{count} Monate'
+          weeks:
+            one: '%{count} Woche'
+            other: '%{count} Wochen'
           days:
             one: '%{count} Tag'
             other: '%{count} Tage'

data/lib/duration_in_words/locales/en.yml

@@ -9,6 +9,9 @@ en:
           months:
             one: '%{count}mo.'
             other: '%{count}mos.'
+          weeks:
+            one: '%{count}wk.'
+            other: '%{count}wks.'
           days:
             one: '%{count}d'
             other: '%{count}d'
@@ -32,6 +35,9 @@ en:
           months:
             one: '%{count} month'
             other: '%{count} months'
+          weeks:
+            one: '%{count} week'
+            other: '%{count} weeks'
           days:
             one: '%{count} day'
             other: '%{count} days'

data/lib/duration_in_words/methods.rb

@@ -4,16 +4,15 @@ module DurationInWords
   module Methods
     extend self
 
+    VALID_FORMATS = %i[compact full].freeze
+
     def duration_in_words(duration, options = {})
       raise_type_error(duration) unless duration.is_a?(ActiveSupport::Duration)
 
       locale, scope = parse_options(options)
       parts = duration.parts
 
-      if parts.empty?
-        key = "seconds.#{duration.value == 1 ? 'one' : 'other'}"
-        return I18n.t(key, count: duration.value, scope: scope, locale: locale)
-      end
+      return I18n.t(:seconds, count: duration.value, scope: scope, locale: locale) if parts.empty?
 
       sentencify(parts, scope, locale)
     end
@@ -21,23 +20,27 @@ module DurationInWords
     private
 
     def parse_options(options)
-      format = options.fetch(:format, :compact)
-      locale = options.fetch(:locale, :en)
+      format = normalize_format(options.fetch(:format, :compact))
+      locale = options.fetch(:locale, I18n.locale)
 
-      scope = format.to_s == "full" ? I18N_SCOPE_FULL : DEFAULT_I18N_SCOPE
+      scope = format == :full ? I18N_SCOPE_FULL : DEFAULT_I18N_SCOPE
 
       [locale, scope]
     end
 
+    def normalize_format(format)
+      symbol = format.respond_to?(:to_sym) ? format.to_sym : format
+
+      return symbol if VALID_FORMATS.include?(symbol)
+
+      raise ArgumentError,
+            "invalid :format, #{format.inspect} given. Valid formats: #{VALID_FORMATS.map(&:inspect).join(', ')}"
+    end
+
     def sentencify(parts, scope, locale)
       parts
         .sort_by { |unit, _| ActiveSupport::Duration::PARTS.index(unit) }
-        .map     { |unit, val|
-          case val
-          when 1 then I18n.t("#{unit}.one", count: val, scope: scope, locale: locale)
-          else I18n.t("#{unit}.other", count: val, scope: scope, locale: locale)
-          end
-        }
+        .map     { |unit, val| I18n.t(unit, count: val, scope: scope, locale: locale) }
         .to_sentence(sentence_options(scope, locale))
     end
 

data/lib/duration_in_words/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DurationInWords
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/lib/duration_in_words.rb

@@ -13,8 +13,8 @@ module DurationInWords
     autoload :Methods, "duration_in_words/methods"
   end
 
-  I18N_SCOPE_FULL = :'duration.in_words.format.full'
-  DEFAULT_I18N_SCOPE = :'duration.in_words.format.compact'
+  I18N_SCOPE_FULL = :"duration.in_words.format.full"
+  DEFAULT_I18N_SCOPE = :"duration.in_words.format.compact"
 
   module_function
 
@@ -22,7 +22,6 @@ module DurationInWords
     locale_files = Dir[File.join File.dirname(__FILE__), "duration_in_words/locales", "*.yml"]
 
     I18n.load_path.unshift(*locale_files)
-    I18n.reload!
   end
 end
 

data/sig/duration_in_words.rbs

@@ -1,4 +1,36 @@
 module DurationInWords
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  I18N_SCOPE_FULL: Symbol
+  DEFAULT_I18N_SCOPE: Symbol
+
+  def self.setup_i18n!: () -> void
+
+  module Methods
+    VALID_FORMATS: Array[Symbol]
+
+    def duration_in_words: (untyped duration, ?Hash[Symbol, untyped] options) -> String
+
+    private
+
+    def parse_options: (Hash[Symbol, untyped] options) -> [untyped, Symbol]
+
+    def normalize_format: (untyped format) -> Symbol
+
+    def sentencify: (Hash[Symbol, untyped] parts, Symbol scope, untyped locale) -> String
+
+    def sentence_options: (Symbol scope, untyped locale) -> untyped
+
+    def raise_type_error: (untyped type) -> bot
+  end
+end
+
+module ActionView
+  module Helpers
+    module DurationHelper
+      include DurationInWords::Methods
+
+      def duration_in_words: (untyped duration, ?Hash[Symbol, untyped] options) -> String
+    end
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: duration_in_words
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Syed Aslam
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,28 +15,56 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  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: racc
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +107,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  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: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +151,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- duration_in_words.gemspec
 - lib/duration_in_words.rb
 - lib/duration_in_words/action_view/helpers/duration_helper.rb
 - lib/duration_in_words/locales/de.yml
@@ -124,7 +166,7 @@ metadata:
   homepage_uri: https://github.com/aslam/duration_in_words
   source_code_uri: https://github.com/aslam/duration_in_words
   changelog_uri: https://github.com/aslam/duration_in_words/blob/main/CHANGELOG.md
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -139,8 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Report ActiveSupport::Duration in concise human readable formats.
 test_files: []