to_duration 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dca915b8cbc3a04cccec1bd1bac0a0984ed449b9
-  data.tar.gz: 3ee511fdca5a3c3a5488c0559216613497504f67
+SHA256:
+  metadata.gz: 7c88aeaa5f019f1bf7a63698277624b3fb0406e2752344a19f5e9886ee2168f6
+  data.tar.gz: 6821895e880e484887c691806e383b3a1b1956bffd16d71a4a9ff1445e9ebec0
 SHA512:
-  metadata.gz: 31843ff1fc0a5c024d16a20a28a50c3d1bb01db0bab2fcd00b9cb3640db2eea2d26ad4456f5c49b76f0ab6c467788d22899f90ca5dd61a401d7d9d7384aa1d48
-  data.tar.gz: d0687a8979a7c45bbbe21af8915976facde57d24f9d41c731fc3a09242b4efcd2098fb95bb47b608877b4f58aae43d2130e55420287bc4ac875f7bb28d4a8a8a
+  metadata.gz: be3f3acb88afa570c9cf86e03f04c39e8afcc9d3b74ca499d7e904f4eb8ad9e58340718879c722691279a628ad35ff22cfdc87988ef6c495ebbff32d3e843e96
+  data.tar.gz: d31929e163e45b969a6097c5f0f89cebdd1dfc899564ca01306fa074fac454353568414ee78a8368e6410c41529ef3133b935421e1696a43ad33ad81004e63f1

data/.travis.yml

@@ -1,5 +1,8 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.2
-before_install: gem install bundler -v 1.13.6
+  - 2.2.10
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+before_install: gem install bundler -v '~> 1.16'

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/to_duration.svg)](https://badge.fury.io/rb/to_duration) [![Build Status](https://travis-ci.org/digaev/to_duration.svg)](https://travis-ci.org/digaev/to_duration) [![Coverage Status](https://coveralls.io/repos/github/digaev/to_duration/badge.svg?branch=master)](https://coveralls.io/github/digaev/to_duration?branch=master)
 
-A Ruby gem for converting seconds into human-readable format. This gem adds instance method `#to_duration` to `Numeric`.
+A Ruby gem for converting seconds into human-readable format.
 
 ## Installation
 
@@ -22,6 +22,8 @@ Or install it yourself as:
 
 ## Usage
 
+Just call `#to_duration` method on any `Numeric` instance.
+
 ```ruby
 irb(main):001:0> 12345.to_duration
 => "3 hours, 25 minutes and 45 seconds"
@@ -29,50 +31,61 @@ irb(main):001:0> 12345.to_duration
 irb(main):002:0> 1234567890.to_duration
 => "39 years, 1 month, 14 days, 5 hours, 31 minutes and 30 seconds"
 
-irb(main):003:0> 1234567890.to_duration(week: true)
+irb(main):003:0> 1234567890.to_duration(weeks: true)
 => "39 years, 1 month, 2 weeks, 5 hours, 31 minutes and 30 seconds"
+
+irb(main):004:0> 0.5.to_duration
+=> "Less than one second"
 ```
 
-## Options
+### #to_duration(options = {})
 
-* `year` - default `true`
-* `month` - default `true`
-* `week` - default `false`
-* `day` - default `true`
-* `hour` - default `true`
-* `minute` - default `true`
-* `second` - default `true`
+| Option | Type | Default |
+|---|:-:|:-:|
+| `:years` | Boolean | `true` |
+| `:months` | Boolean | `true` |
+| `:weeks` | Boolean | `false` |
+| `:days` | Boolean | `true` |
+| `:hours` | Boolean | `true` |
+| `:minutes` | Boolean | `true` |
+| `:seconds` | Boolean | `true` |
+
+**Notice:** Before version `1.2.0` these keys were singular.
 
 ## Localization
 
-In your Rails application edit `config/locales/#{locale}.yml`:
+The gem uses [I18n](https://github.com/svenfuchs/i18n) for localization.
 
 ```yml
-to_duration:
-  and: and
-  year:
-    one: year
-    other: years
-  month:
-    one: month
-    other: months
-  week:
-    one: week
-    other: weeks
-  day:
-    one: day
-    other: days
-  hour:
-    one: hour
-    other: hours
-  minute:
-    one: minute
-    other: minutes
-  second:
-    one: second
-    other: seconds
+en: # Replace this key with your locale
+  to_duration:
+    and: and
+    less_than_one_second: Less than one second
+    year:
+      one: year
+      other: years
+    month:
+      one: month
+      other: months
+    week:
+      one: week
+      other: weeks
+    day:
+      one: day
+      other: days
+    hour:
+      one: hour
+      other: hours
+    minute:
+      one: minute
+      other: minutes
+    second:
+      one: second
+      other: seconds
 ```
 
+If you're on Rails you may create `config/locales/to_duration_#{locale}.yml` file.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/digaev/to_duration.

data/lib/numeric.rb

@@ -1,5 +1,5 @@
 class Numeric
   def to_duration(options = {})
-    ToDuration::Converter.call(to_i, options)
+    ToDuration::Duration.new(self).to_s(options)
   end
 end

data/lib/to_duration.rb

@@ -1,6 +1,3 @@
 require 'to_duration/version'
-require 'to_duration/converter'
+require 'to_duration/duration'
 require_relative 'numeric'
-
-module ToDuration
-end

data/lib/to_duration/duration.rb

@@ -0,0 +1,91 @@
+module ToDuration
+  class Duration
+    UNITS = {
+      years: 315_576_00,
+      months: 259_200_0,
+      weeks: 604_800,
+      days: 864_00,
+      hours: 3600,
+      minutes: 60,
+      seconds: 1
+    }.freeze
+
+    attr_reader :seconds
+
+    def initialize(seconds)
+      @seconds = Integer(seconds)
+    end
+
+    def years
+      seconds / UNITS[:years]
+    end
+
+    def months
+      seconds / UNITS[:months]
+    end
+
+    def weeks
+      seconds / UNITS[:weeks]
+    end
+
+    def days
+      seconds / UNITS[:days]
+    end
+
+    def hours
+      seconds / UNITS[:hours]
+    end
+
+    def minutes
+      seconds / UNITS[:minutes]
+    end
+
+    def add(unit, count)
+      @seconds += UNITS[unit] * count
+    end
+
+    def sub(unit, count)
+      @seconds -= UNITS[unit] * count
+    end
+
+    def to_s(options = {})
+      return t('less_than_one_second') if seconds < 1
+
+      options = {}.tap do |defaults|
+        UNITS.keys.each { |k| defaults[k] = k != :weeks }
+      end.merge!(options)
+
+      units_to_s(to_units(options))
+    end
+
+    private
+
+    def t(key, options = {})
+      I18n.t("to_duration.#{key}", options)
+    end
+
+    def to_units(options)
+      duration = Duration.new(seconds)
+
+      {}.tap do |units|
+        UNITS.keys.each do |k|
+          next if options[k] != true
+
+          count = duration.public_send(k)
+          next if count.zero?
+
+          units[k] = count
+          duration.sub(k, count)
+        end
+      end
+    end
+
+    def units_to_s(units)
+      units = units.map { |k, v| "#{v} #{t(k.to_s.chop, count: v)}" }
+
+      s = units.join(', ')
+      s.gsub!(/,([^,]*)$/, " #{t('and')}\\1") if units.length > 1
+      s
+    end
+  end
+end

data/lib/to_duration/version.rb

@@ -1,3 +1,3 @@
 module ToDuration
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/to_duration.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: to_duration
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Nikolay Digaev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-07 00:00:00.000000000 Z
+date: 2018-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '10.0'
 description: A Ruby gem for converting seconds into human-readable format.
 email:
 - ffs.cmp@gmail.com
@@ -85,7 +85,7 @@ files:
 - bin/setup
 - lib/numeric.rb
 - lib/to_duration.rb
-- lib/to_duration/converter.rb
+- lib/to_duration/duration.rb
 - lib/to_duration/version.rb
 - to_duration.gemspec
 homepage: https://github.com/digaev/to_duration
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for converting seconds into human-readable format.

data/lib/to_duration/converter.rb

@@ -1,61 +0,0 @@
-module ToDuration
-  class Converter
-    def self.call(value, options = {})
-      new(value, options).call
-    end
-
-    def initialize(value, options = {})
-      @value = value
-      @options = DEFAULTS.dup.merge!(options).freeze
-    end
-
-    def call
-      units = to_units
-      last = if units.length > 1
-               " #{I18n.t('to_duration.and')} #{units.pop}"
-             else
-               ''
-             end
-      "#{units.join(', ')}#{last}"
-    end
-
-    private
-
-    UNITS = {
-      year: 315_576_00,
-      month: 259_200_0,
-      week: 604_800,
-      day: 864_00,
-      hour: 3600,
-      minute: 60,
-      second: 1
-    }.freeze
-
-    DEFAULTS = {
-      year: true,
-      month: true,
-      week: false,
-      day: true,
-      hour: true,
-      minute: true,
-      second: true
-    }.freeze
-
-    def to_units
-      seconds = @value
-
-      UNITS.map do |k, v|
-        next if @options[k] != true
-
-        count = seconds >= v ? seconds / v : 0
-        seconds -= count * v
-
-        t_unit(k, count) if count > 0
-      end.compact
-    end
-
-    def t_unit(unit, count)
-      "#{count} #{I18n.t("to_duration.#{unit}", count: count)}"
-    end
-  end
-end