timerizer 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4180c0ffb871e50a47486d122ae17fc42f37cab8
-  data.tar.gz: dad648d7c6fb1f996b61d5aa1c55a7c2637abc52
+SHA256:
+  metadata.gz: e03bc2d5660e629ad3545c610bf09efa55fbe07cec5c364970eabb8001add9fd
+  data.tar.gz: 050b2b058e5c63eda87f973e5adde7c84e34c9c230833c47f84eb7189ef0d774
 SHA512:
-  metadata.gz: 369ea12d3065905306b0649f81b6517fe49d50cd2ddd601cb7d7132571ea07b21846760bc24e75b3dee56aab841c7b42a6107f54283472e014905910ba1bbca5
-  data.tar.gz: 02487b58f59677d6cf481f3a3a78a6fe10f04bb598a67a445e8e1e81cb73395267526913041a53c95477882f3bd7fe95868da9a2c190bf13791775b31b4a1510
+  metadata.gz: bcc860c64450e0e1f099dca114205f727410a216846c25a61ce75b5052783e95a7b748df72227b9b1b108d44ca0eb11f4dbb81ac7ddcf715629f3a4d9e3135a1
+  data.tar.gz: a9836b0cb9c429a8ed66fad757cea99f022934af83e7b5757f8bd84fdf805fe102624d6e14b41d6e9711cbb10dbb53fbd315798b86633de18edfb1e560d2b6ed

data/lib/timerizer/duration.rb

@@ -135,6 +135,17 @@ module Timerizer
           months: ['month', 'months'],
           years: ['year', 'years']
         }
+      },
+      min_long: {
+        units: {
+          seconds: ['second', 'seconds'],
+          minutes: ['minute', 'minutes'],
+          hours: ['hour', 'hours'],
+          days: ['day', 'days'],
+          months: ['month', 'months'],
+          years: ['year', 'years']
+        },
+        count: 2
       }
     }
 
@@ -642,6 +653,74 @@ module Timerizer
       end.join(format[:delimiter] || ', ')
     end
 
+    # Convert a Duration to a human-readable string using a rounded value.
+    #
+    # By 'rounded', we mean that the resulting value is rounded up if the input
+    # includes a value of more than half of one of the least-significant unit to
+    # be returned. For example, `(17.hours 43.minutes 31.seconds)`, when rounded
+    # to two units (hours and minutes), would return "17 hours, 44 minutes". By
+    # contrast, `#to_s`, with a `:count` option of 2, would return a value of
+    # "17 hours, 43 minutes": truncating, rather than rounding.
+    #
+    # Note that this method overloads the meaning of the `:count` option value
+    # as documented below. If the passed-in option value is numeric, it will be
+    # honored, and rounding will take place to that number of units. If the
+    # value is either `:all` or the default `nil`, then _rounding_ will be done
+    # to two units, and the rounded value will be passed on to `#to_s` with the
+    # options specified (which will result in a maximum of two time units being
+    # output).
+    #
+    # @param [Symbol, Hash] format The format type to format the duration with.
+    #   `format` can either be a key from the {FORMATS} hash or a hash with
+    #   the same shape as `options`. The default is `:min_long`, which strongly
+    #   resembles `:long` with the omission of `:weeks` units and a default
+    #   `:count` of 2.
+    # @param [Hash, nil] options Additional options to use to override default
+    #   format options.
+    #
+    # @option options [Hash<Symbol, String>] :units The full list of unit names
+    #   to use. Keys are unit names (see {UNIT_ALIASES} for a full list) and
+    #   values are strings to use when converting that unit to a string. Values
+    #   can also be an array, where the first item of the array will be used
+    #   for singular unit names and the second item will be used for plural
+    #   unit names. Note that this option will completely override the input
+    #   formats' list of names, so all units that should be used must be
+    #   specified!
+    # @option options [String] :separator The separator to use between a unit
+    #   quantity and the unit's name. For example, the string `"1 second"` uses
+    #   a separator of `" "`.
+    # @option options [String] :delimiter The delimiter to use between separate
+    #   units. For example, the string `"1 minute, 1 second"` uses a separator
+    #   of `", "`
+    # @option options [Integer, nil, :all] :count The number of significant
+    #   units to use in the string, or `nil` / `:all` to use all units.
+    #   For example, if the given duration is `1.day 1.week 1.month`, and
+    #   `options[:count]` is 2, then the resulting string will only include
+    #   the month and the week components of the string.
+    #
+    # @return [String] The rounded duration formatted as a string.
+    def to_rounded_s(format = :min_long, options = nil)
+      format =
+      case format
+      when Symbol
+        FORMATS.fetch(format)
+      when Hash
+        FORMATS.fetch(:long).merge(format)
+      else
+        raise ArgumentError, "Expected #{format.inspect} to be a Symbol or Hash"
+      end
+
+      format = format.merge(Hash(options))
+      places = format[:count]
+      begin
+        places = Integer(places) # raise if nil or `:all` supplied as value
+      rescue TypeError
+        places = 2
+      end
+      q = RoundedTime.call(self, places)
+      q.to_s(format, options)
+    end
+
     private
 
     # This method is like {#to_unit}, except it does not perform normalization
@@ -764,3 +843,5 @@ module Timerizer
     self.define_to_unit(:millennium)
   end
 end
+
+require_relative './duration/rounded_time'

data/lib/timerizer/version.rb

@@ -1,3 +1,3 @@
 module Timerizer
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timerizer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Kyle Lacy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-03 00:00:00.000000000 Z
+date: 2018-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Rails time helpers... without the Rails