duration_in_words 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 61890a8cefb328cd0317b59e381a4482cec0426059036bb2b24f40a73dccb11e
+  data.tar.gz: ecf684b6fca14b39e7a68126f19f85e9341f1a33ffa0ec886878223b145ae864
+SHA512:
+  metadata.gz: da2221acad3383d7be4adf48dcbe7bf6d5fda42d120c1ce649c40cf298fc21fcc4b6275d0599706689d831151c9ef53b5aba6c0484ca2553a206422ef1dd3898
+  data.tar.gz: c609b68e4ba85d0c68327b346a7a2d781ac6b3beae6d4031412e85d414074cf7e0f8435718a4dcf64e089e35da7ed20bc5626143638092ead316e41417b23e12

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,136 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+
+# Commonly used screens these days easily fit more than 80 characters.
+Layout/LineLength:
+  Max: 120
+
+# Too short methods lead to extraction of single-use methods, which can make
+# the code easier to read (by naming things), but can also clutter the class
+Metrics/MethodLength:
+  Max: 20
+
+# The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
+Metrics/ClassLength:
+  Max: 1500
+
+# No space makes the method definition shorter and differentiates
+# from a regular assignment.
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
+
+# Single quotes being faster is hardly measurable and only affects parse time.
+# 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:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+# We do not need to support Ruby 1.9, so this is good to use.
+Style/SymbolArray:
+  Enabled: true
+
+# Most readable form.
+Style/OptionHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+# Mixing the styles looks just silly.
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+# has_key? and has_value? are far more readable than key? and value?
+Style/PreferredHashMethods:
+  Enabled: false
+
+# String#% is by far the least verbose and only object oriented variant.
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    # inject seems more common in the community.
+    reduce: 'inject'
+
+# Either allow this style or don't. Marking it as safe with parenthesis
+# is silly. Let's try to live without them for now.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+# A specialized exception class will take one or more arguments and construct the message from it.
+# So both variants make sense.
+Style/RaiseArgs:
+  Enabled: false
+
+# Indenting the chained dots beneath each other is not supported by this cop,
+# see https://github.com/bbatsov/rubocop/issues/1633
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+# Fail is an alias of raise. Avoid aliases, it's more cognitive load for no gain.
+# The argument that fail should be used to abort the program is wrong too,
+# there's Kernel#abort for that.
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Suppressing exceptions can be perfectly fine, and be it to avoid to
+# explicitly type nil into the rescue since that's what you want to return,
+# or suppressing LoadError for optional dependencies
+Lint/SuppressedException:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+
+# { ... } for multi-line blocks is okay, follow Weirichs rule instead:
+# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc
+Style/BlockDelimiters:
+  Enabled: false
+
+# do / end blocks should be used for side effects,
+# methods that run a block for side effects and have
+# a useful return value are rare, assign the return
+# value to a local variable for those cases.
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# Enforcing the names of variables? To single letter ones? Just no.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# Shadowing outer local variables with block parameters is often useful
+# to not reinvent a new name for the same thing, it highlights the relation
+# between the outer variable and the parameter. The cases where it's actually
+# confusing are rare, and usually bad for other reasons already, for example
+# because the method is too long.
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+# Check with yard instead.
+Style/Documentation:
+  Enabled: false
+
+# This is just silly. Calling the argument `other` in all cases makes no sense.
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+# There are valid cases, for example debugging Cucumber steps,
+# also they'll fail CI anyway
+Lint/Debugger:
+  Enabled: false
+
+# Style preference
+Style/MethodDefParentheses:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-04
+
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in duration_in_words.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Syed Aslam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# DurationInWords
+
+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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add duration_in_words
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install duration_in_words
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/duration_in_words.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module ActionView
+  module Helpers
+    module DurationHelper
+      include DurationInWords::Methods
+
+      # Reports the Duration object as seconds.
+      #
+      # === 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.
+      #
+      # === Examples
+      # d = 1.day + 2.hours + 30.minutes
+      # duration_in_words(d)                  => 1d, 2h, and 30m
+      # d = 2.hours
+      # duration_in_words(d)                  => 2h
+      #
+      # Using <tt>:format</tt> option:
+      # d = 1.day + 2.hours + 30.minutes
+      # duration_in_words(d, format: :full)   => 1 day, 2 hours, and 30 minutes
+      #
+      # Using <tt>:locale</tt> option:
+      #   # Given this locale dictionary:
+      #   #
+      #   # de:
+      #   #   duration:
+      #   #     in_words:
+      #   #       format:
+      #   #         compact:
+      #   #           support:
+      #   #             words_connector: ', '
+      #   #             two_words_connector: ' und '
+      #   #             last_word_connector: ', und '
+      #   #           years:
+      #   #             one: J
+      #   #             other: ...
+      #   #           months:
+      #   #             ...
+      #   #         full:
+      #   #           ...
+      #
+      # d = 1.day + 2.hours + 30.minutes
+      # duration_in_words(d, locale: :de)     => 1 Tag, 2 Std., und 30 Sekunden
+      #
+      def duration_in_words(duration, options = {})
+        DurationInWords::Methods.duration_in_words(duration, options)
+      end
+    end
+  end
+end

data/lib/duration_in_words/locales/de.yml

@@ -0,0 +1,50 @@
+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 '

data/lib/duration_in_words/locales/en.yml

@@ -0,0 +1,50 @@
+en:
+  duration:
+    in_words:
+      format:
+        compact:
+          years:
+            one: '%{count}yr.'
+            other: '%{count}yrs.'
+          months:
+            one: '%{count}mo.'
+            other: '%{count}mos.'
+          days:
+            one: '%{count}d'
+            other: '%{count}d'
+          hours:
+            one: '%{count}h'
+            other: '%{count}h'
+          minutes:
+            one: '%{count}m'
+            other: '%{count}m'
+          seconds:
+            one: '%{count}s'
+            other: '%{count}s'
+          support:
+            words_connector: ' '
+            two_words_connector: ' and '
+            last_word_connector: ' and '
+        full:
+          years:
+            one: '%{count} year'
+            other: '%{count} years'
+          months:
+            one: '%{count} month'
+            other: '%{count} months'
+          days:
+            one: '%{count} day'
+            other: '%{count} days'
+          hours:
+            one: '%{count} hour'
+            other: '%{count} hours'
+          minutes:
+            one: '%{count} minute'
+            other: '%{count} minutes'
+          seconds:
+            one: '%{count} second'
+            other: '%{count} seconds'
+          support:
+            words_connector: ', '
+            two_words_connector: ' and '
+            last_word_connector: ', and '

data/lib/duration_in_words/methods.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module DurationInWords
+  module Methods
+    extend self
+
+    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
+
+      sentencify(parts, scope, locale)
+    end
+
+    private
+
+    def parse_options(options)
+      format = options.fetch(:format, :compact)
+      locale = options.fetch(:locale, :en)
+
+      scope = format.to_s == "full" ? I18N_SCOPE_FULL : DEFAULT_I18N_SCOPE
+
+      [locale, scope]
+    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
+        }
+        .to_sentence(sentence_options(scope, locale))
+    end
+
+    def sentence_options(scope, locale)
+      I18n.t(:support, scope: scope, locale: locale, default: { locale: locale })
+    end
+
+    def raise_type_error(type)
+      raise TypeError, "no implicit conversion of #{type.class} into ActiveSupport::Duration"
+    end
+  end
+end

data/lib/duration_in_words/version.rb

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

data/lib/duration_in_words.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "i18n"
+require "active_support"
+require "active_support/core_ext"
+
+require_relative "duration_in_words/version"
+
+module DurationInWords
+  extend ActiveSupport::Autoload
+
+  eager_autoload do
+    autoload :Methods, "duration_in_words/methods"
+  end
+
+  I18N_SCOPE_FULL = :'duration.in_words.format.full'
+  DEFAULT_I18N_SCOPE = :'duration.in_words.format.compact'
+
+  module_function
+
+  def setup_i18n!
+    locale_files = Dir[File.join File.dirname(__FILE__), "duration_in_words/locales", "*.yml"]
+
+    I18n.load_path.unshift(*locale_files)
+    I18n.reload!
+  end
+end
+
+DurationInWords.setup_i18n!
+
+begin
+  require "action_view"
+  require_relative "duration_in_words/action_view/helpers/duration_helper"
+rescue LoadError
+end

data/sig/duration_in_words.rbs

@@ -0,0 +1,4 @@
+module DurationInWords
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: duration_in_words
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Syed Aslam
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.18.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.18.1
+description: |-
+  Convert ActiveSupport::Duration objects to concise human readable formats like '2h 30m 45s'
+      with locale support.
+email:
+- aslam.maqsood@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/duration_in_words.rb
+- lib/duration_in_words/action_view/helpers/duration_helper.rb
+- lib/duration_in_words/locales/de.yml
+- lib/duration_in_words/locales/en.yml
+- lib/duration_in_words/methods.rb
+- lib/duration_in_words/version.rb
+- sig/duration_in_words.rbs
+homepage: https://github.com/aslam/duration_in_words
+licenses:
+- MIT
+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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Report ActiveSupport::Duration in concise human readable formats.
+test_files: []