activesupport-duration-human_string 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a7049bf99ad5f6ffbf07e5ae95ae38efea3b73b9b57dfaf9f655ac66ddb2338
+  data.tar.gz: ed4fa6793ec9549bd7379120b325e2a5b27c338dfc0d5728168c3d84abc407e6
+SHA512:
+  metadata.gz: b960130471d06f5cf4425b3e53158e23094703cbd4c5efbed04d4cac133628d2662ac3a8ad742f2fd1971e4edddbd54551d465c8d57b01986ce983ce3412623d
+  data.tar.gz: 8b1b76dbb70d9d31f7637b7f09c03857b15643b8eb8a3f35de1615e7df420dd18622674744ecea6fc77df865c56b7fe39d7f88b9c5bf2f602dc667cbe1d54c62

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.5
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in activesupport-duration-human_string.gemspec
+gemspec

data/License

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Tyler Rick
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/Readme.md

@@ -0,0 +1,46 @@
+# `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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+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.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'
+```
+
+Also aliased as `human_string`, `to_human_s`.
+
+## 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 tags, 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/TylerRick/activesupport-duration-human_string.
+
+##  Not really related
+
+- https://github.com/josedonizetti/ruby-duration
+- https://github.com/janko/as-duration

data/activesupport-duration-human_string.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_support/duration/human_string/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activesupport-duration-human_string"
+  spec.version       = ActiveSupport::Duration::HumanString.version
+  spec.authors       = ["Tyler Rick"]
+  spec.email         = ["tyler@tylerrick.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{Convert Duration objects to human-friendly strings like '2h 30m 17s'}
+  spec.description   = %q{Convert ActiveSupport::Duration objects to human-friendly strings like '2h 30m 17s'. }
+                       %q{Like distance_of_time_in_words helper but exact rather than approximate. }
+                       %q{Like #inspect but more concise. Like #iso8601 but more human readable rather than machine readable.}
+  spec.homepage      = "https://github.com/TylerRick/activesupport-duration-human_string"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.metadata["source_code_uri"]}/blob/master/Changelog.md"
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.3.0"
+  spec.add_dependency "activesupport", [">= 4.2", "< 5.3"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_support/duration/human_string"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_support/duration/human_string.rb

@@ -0,0 +1,90 @@
+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'`.
+    #
+    # 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.
+    #
+    # 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)
+    # 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'
+    #
+    # ## Options
+    #
+    # `:precision`: Precision of seconds (defaults to nil, which is no digits after decimal).
+    #
+    # `:separator`: The separator between the digits and units (defaults to '', giving for example '3h' with nothing between them).
+    #
+    # `:delimiter`: The delimiter between different parts like minutes and seconds (defaults to ' ').
+    #
+    # `use_2_digit_numbers`: Set to true if you want to pad 1-digit nubers to 2 digits ('3h 05m 07s'
+    # instead of '3h 5m 7s'). Never pads the first part of the duration, only later parts.
+    #
+    def human_str(precision: nil, separator: '', delimiter: ' ', use_2_digit_numbers: false)
+      HumanStringSerializer.new(
+        self,
+        precision: precision,
+        separator: separator,
+        delimiter: delimiter,
+        use_2_digit_numbers: use_2_digit_numbers,
+      ).serialize
+    end
+    alias_method :human_string, :human_str
+    alias_method :to_human_s, :human_str
+  end
+end
+
+module ActiveSupport
+  class Duration
+    # Based on: active_support/duration/iso8601_serializer.rb
+    # Inherits: #normalize
+    class HumanStringSerializer < ISO8601Serializer
+      def initialize(duration, precision: nil, separator: '', delimiter: ' ', use_2_digit_numbers: false)
+        @duration            = duration
+        @precision           = precision
+        @separator           = separator
+        @delimiter           = delimiter
+        @use_2_digit_numbers = use_2_digit_numbers
+      end
+
+      # Builds and returns output_parts string.
+      def serialize
+        parts, sign = normalize
+
+        output_parts = []
+        output_parts << [parts[:years],   'y'] if parts.key?(:years)
+        output_parts << [parts[:months],  'm'] if parts.key?(:months)
+        output_parts << [parts[:weeks],   'w'] if parts.key?(:weeks)
+        output_parts << [parts[:days],    'd'] if parts.key?(:days)
+        output_parts << [parts[:hours],   'h'] if parts.key?(:hours)
+        output_parts << [parts[:minutes], 'm'] if parts.key?(:minutes)
+        if parts.key?(:seconds)
+          output_parts << [sprintf(@precision ? "%0.0#{@precision}f" : '%g', parts[:seconds]), 's']
+        end
+
+        output_parts.map!.with_index { |(n, units), i|
+          if @use_2_digit_numbers && i >= 1
+            n = sprintf('%02d', n)
+          end
+          "#{n}#{@separator}#{units}"
+        }
+
+        output = output_parts.join(@delimiter)
+        "#{sign}#{output}"
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: activesupport-duration-human_string
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Rick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: 'Convert ActiveSupport::Duration objects to human-friendly strings like
+  ''2h 30m 17s''. '
+email:
+- tyler@tylerrick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Changelog.md
+- Gemfile
+- License
+- Rakefile
+- Readme.md
+- activesupport-duration-human_string.gemspec
+- bin/console
+- bin/setup
+- lib/active_support/duration/human_string.rb
+- lib/active_support/duration/human_string/version.rb
+homepage: https://github.com/TylerRick/activesupport-duration-human_string
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/TylerRick/activesupport-duration-human_string
+  source_code_uri: https://github.com/TylerRick/activesupport-duration-human_string
+  changelog_uri: https://github.com/TylerRick/activesupport-duration-human_string/blob/master/Changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Convert Duration objects to human-friendly strings like '2h 30m 17s'
+test_files: []