activesupport-duration-change 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7339f01b9c0cb2e98702c59b463b2e9919b5b5ebeda8b248e6683b0ae6f3eb5d
+  data.tar.gz: 3bce02d7c7ab9f1d3c18726814cddd6c963071b420a19bb6b5ab8956b9171525
+SHA512:
+  metadata.gz: fceb5ea4dc1f38eae7f56d580a9e458b1291f864d85f92aa3d56a1ffd316d184ef28c72bd6fd019d1b622705ca31155d85cccc7a16ac0dffea33a76e443b0147
+  data.tar.gz: b846cae81544e325def271ca47e8fed45a77e81521e21e62c8153e6e43d1e11eb078a4e3a9175c629b950a464fa813abe10cd2e9907f97c33b3d9353d9db6429

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+
+# 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/Changelog.md

@@ -0,0 +1,14 @@
+## 1.0.0 (2024-02-16)
+
+Fixes:
+
+- Relax activesupport dependency version
+
+Breaking changes:
+
+- Extract `#change`, `#truncate`, `#round`, etc. out of this gem into the [activesupport-duration-change](https://github.com/TylerRick/activesupport-duration-change) gem
+
+## 0.1.1 (2019-04-02)
+
+Initial release
+

data/Gemfile

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

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,77 @@
+# ActiveSupport::Duration#change  [![Gem Version](https://badge.fury.io/rb/activesupport-duration-change.svg)](https://badge.fury.io/rb/activesupport-duration-change)
+
+Change/manipulate [ActiveSupport::Duration](https://api.rubyonrails.org/classes/ActiveSupport/Duration.html) objects with these added methods:
+
+# API
+
+## `#change`, `#change_cascade`
+
+```ruby
+(9.hours + 10.minutes + 40.seconds).change(hours: 12)             #=> 12 hours, 10 minutes, and 40 seconds
+(9.hours + 10.minutes + 40.seconds).change(hours: 12, minutes: 5) #=> 12 hours, 5 minutes, and 40 seconds
+(9.hours + 10.minutes + 40.seconds).change(minutes: 5)            #=> 9 hours, 5 minutes, and 40 seconds
+
+(9.hours + 10.minutes + 40.seconds).change_cascade(hours: 12)  # => 12 hours
+(9.hours + 10.minutes + 40.seconds).change_cascade(minutes: 5) # => 9 hours and 5 minutes
+```
+
+## `#normalize`
+
+```ruby
+90.seconds.normalize                          #=> 1 minute and 30 seconds
+23.hours + 59.minutes + 60.seconds).normalize #=> 1 day
+```
+
+## `#round`
+
+```ruby
+30.seconds.round(:minutes)        #=> 1 minute
+89.seconds.round(:minutes)        #=> 1 minute
+90.seconds.round(:minutes)        #=> 2 minutes
+(1.hour + 30.seconds).round(:minutes)  #=> 1 hour and 1 minute
+
+2.5.seconds.round                 #=> 3 seconds
+2.5.seconds.round(half: :down)    #=> 2 seconds
+```
+
+## `#truncate`
+
+```ruby
+30.seconds.truncate(:minutes)      #=> 0 seconds
+
+# This could be surprising, but remember that it just looks at the values as they exist in each part.
+90.seconds.truncate(:minutes)      #=> 0 seconds
+
+# If needed, you can always normalize the duration first...
+90.seconds.normalize                    #=> 1 minute and 30 seconds
+90.seconds.normalize.truncate(:minutes) #=> 1 minute
+```
+
+## .from_parts
+
+```ruby
+# This is the inverse of #parts.
+duration = ActiveSupport::Duration.from_parts({hours: 9, minutes: 10, seconds: 40})
+```
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activesupport-duration-change'
+```
+
+# See also
+
+- [activesupport-duration-human_string](https://github.com/TylerRick/activesupport-duration-human_string), which lets you convert `Duration` objects to human-friendly strings like '2h 30m 17s'
+
+# 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-change.

data/activesupport-duration-change.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_support/duration/change/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activesupport-duration-change"
+  spec.version       = ActiveSupport::Duration::Change.version
+  spec.authors       = ["Tyler Rick"]
+  spec.email         = ["tyler@tylerrick.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{Adds methods such as `#change`, `#truncate`, `#round` to `Duration`}
+  spec.homepage      = "https://github.com/TylerRick/activesupport-duration-change"
+
+  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", [">= 5.2"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_support/duration/change"
+
+# 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/change/version.rb

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

data/lib/active_support/duration/change.rb

@@ -0,0 +1,218 @@
+require 'active_support/duration'
+
+module ActiveSupport
+  class Duration
+    class << self
+      # Creates a new Duration from a Hash of parts (inverse of Duration#parts).
+      #
+      # Surprising that upstream ActiveSupport doesn't provide this method
+      #
+      # normalize: true (the default) changes 30.5m into 30m, 30s, for example.
+      def from_parts(parts, normalize: true)
+        parts = parts.compact.reject { |k, v| v.zero? }
+        duration = new(calculate_total_seconds(parts), parts)
+        if normalize
+          duration.normalize
+        else
+          duration
+        end
+      end
+
+      alias parse_parts from_parts
+
+      def units_largest_first
+        # Reverse since PARTS_IN_SECONDS is ordered smallest to largest
+        PARTS_IN_SECONDS.keys.reverse.freeze
+      end
+
+      def next_smaller_unit(unit)
+        i = PARTS.index(unit) or raise(ArgumentError, "unknown unit #{unit}")
+        PARTS[i + 1]
+      end
+
+      def smaller_units(unit)
+        # The index of unit; we only want parts with indexes > this index
+        unit_i = units_largest_first.index(unit) or raise(ArgumentError, "unknown unit #{unit}")
+        units_largest_first.select.with_index { |key, i| i > unit_i }
+      end
+    end
+
+    # Re-builds the Duration using build(value). Useful if you may have "extra" seconds, minutes,
+    # etc. that could be carried over to the next higher unit, such as if you've built a Duration
+    # using Duration.seconds and a number of seconds > 60.
+    #
+    # ActiveSupport::Duration.seconds(61).normalize
+    # => 1 minute and 1 second
+    #
+    def normalize
+      Duration.build(value)
+    end
+
+    # Replaces parts of duration with given part values. Unlike #change_cascade and Time#change,
+    # *only* ever changes the given parts; it does *not* reset any smaller-unit parts.
+    def change(**changes)
+      self.class.from_parts(
+        parts.merge(changes),
+        normalize: false
+      )
+    end
+
+    # Changes the given part(s) of the duration and resets any smaller parts.
+    #
+    # @example
+    #   (9.hours + 10.minutes + 40.seconds).change_cascade(hours: 12)  # => 12 hours
+    #   (9.hours + 10.minutes + 40.seconds).change_cascade(minutes: 5) # => 9 hours and 5 minutes
+    #
+    # Similar to Time#change
+    # But note that the keys are plural, so :years instead of :year.
+    # Should we allow key aliases? Should we raise ArgumentError if key not recognized? Yes. (Why doesn't Time#change?)
+    # or should this be named truncate? or change_reset_smaller_parts?
+    #
+    #-----------
+    # Returns a new Duration where one or more of the elements have been changed according
+    # to the +options+ parameter. The time options (<tt>:hour</tt>, <tt>:min</tt>,
+    # <tt>:sec</tt>, <tt>:usec</tt>, <tt>:nsec</tt>) reset cascadingly, so if only
+    # the hour is passed, then minute, sec, usec and nsec is set to 0. If the hour
+    # and minute is passed, then sec, usec and nsec is set to 0. The +options+ parameter
+    # takes a hash with any of these keys: <tt>:year</tt>, <tt>:month</tt>, <tt>:day</tt>,
+    # <tt>:hour</tt>, <tt>:min</tt>, <tt>:sec</tt>, <tt>:usec</tt>, <tt>:nsec</tt>,
+    # <tt>:offset</tt>. Pass either <tt>:usec</tt> or <tt>:nsec</tt>, not both.
+    #
+    #   Time.new(2012, 8, 29, 22, 35, 0).change(day: 1)              # => Time.new(2012, 8, 1, 22, 35, 0)
+    #   Time.new(2012, 8, 29, 22, 35, 0).change(year: 1981, day: 1)  # => Time.new(1981, 8, 1, 22, 35, 0)
+    #   Time.new(2012, 8, 29, 22, 35, 0).change(year: 1981, hour: 0) # => Time.new(1981, 8, 29, 0, 0, 0)
+    def change_cascade(options)
+      options.assert_valid_keys(*PARTS_IN_SECONDS, :nsec, :usec)
+
+      reset = false
+      new_parts = {}
+      new_parts[:years]   = options.fetch(:years,               parts[:years])  ; reset ||= options.key?(:years)
+      new_parts[:months]  = options.fetch(:months,  reset ? 0 : parts[:months]) ; reset ||= options.key?(:months)
+      new_parts[:days]    = options.fetch(:days,    reset ? 0 : parts[:days])   ; reset ||= options.key?(:days)
+      new_parts[:hours]   = options.fetch(:hours,   reset ? 0 : parts[:hours])  ; reset ||= options.key?(:hours)
+      new_parts[:minutes] = options.fetch(:minutes, reset ? 0 : parts[:minutes]); reset ||= options.key?(:minutes)
+      new_parts[:seconds] = options.fetch(:seconds, reset ? 0 : parts[:seconds])
+
+      if new_nsec = options[:nsec]
+        raise ArgumentError, "Can't change both :nsec and :usec at the same time: #{options.inspect}" if options[:usec]
+        new_usec = Rational(new_nsec, 1000)
+      else
+        new_usec = nil
+#        new_usec = options.fetch(:usec, (options[:hour] || options[:min] || options[:sec]) ? 0 :
+#                                         Rational(nsec, 1000))
+      end
+      if new_usec
+        raise ArgumentError, "argument out of range" if new_usec >= 1000000
+
+        new_parts[:seconds] += Rational(new_usec, 1000000)
+      end
+
+      self.class.from_parts(
+        new_parts.compact.reject { |k, v| v.zero? },
+        normalize: false,
+      )
+    end
+
+
+    # Returns duration rounded to the nearest value having a precision of `precision`, which is a
+    # unit such as :hours, which would mean "round to the nearest hour". The smaller parts (:minutes
+    # and :seconds in this example) are turned into a fraction of the requested precision (:hours),
+    # which is then added to requested precision part. Finally, `round` is called on the requested
+    # precision part (hours in this example).
+    #
+    # If optional [ndigits] [, half: mode] arguments are supplied, they are passed along to
+    # [round](https://ruby-doc.org/core/Float.html#method-i-round).
+    #
+    # @example
+    #   30.seconds.round(:minutes)        #=> 1 minute
+    #   89.seconds.round(:minutes)        #=> 1 minute
+    #   90.seconds.round(:minutes)        #=> 2 minutes
+    #   (1.hour + 30.seconds).round(:minutes)  #=> 1 hour and 1 minute
+    #
+    #   2.5.seconds.round                 #=> 3 seconds
+    #   2.5.seconds.round(half: :down)    #=> 2 seconds
+    #
+    # @raises ArgumentError
+    # TODO raise ArgumentError if precision not recognized as a unit
+    #
+    def round(precision = smallest_unit, *args, **opts)
+      #puts "Rounding #{parts.inspect} (in particular #{parts[precision]} #{precision}) to nearest #{precision.inspect}"
+
+      new_part_value = orig_part_value = (parts[precision] || 0)
+      fraction = smaller_parts_to_fraction_of(precision)
+      # Usually fraction is in the range 0..1, unless the smaller units are overflowed (non-normalized)
+      new_part_value += fraction
+      #puts "Adding #{orig_part_value} + fraction parts #{fraction.inspect} (#{fraction.to_f}) = #{new_part_value} (#{new_part_value.to_f})"
+
+      new_part_value = new_part_value.round(*args, **opts)
+
+      change_cascade(
+        precision => new_part_value
+      )
+    end
+
+    # Convert the parts that are smaller than `unit` to be a fraction (Rational) of that
+    # `unit`.
+    #
+    # For example, if `unit` is :hours and self is 1h 29m 60s, then it would look at the parts
+    # smaller than hour, 29m 60s, which is the same as 30m, and would convert that to a fraction of
+    # hours, which would be 30m/60m = 1/2r.
+    #
+    def smaller_parts_to_fraction_of(unit)
+      #next_smaller_unit = self.class.next_smaller_unit(unit)
+      #next_smaller_unit_in_s = ActiveSupport::Duration::PARTS_IN_SECONDS[next_smaller_unit] # 1 if unit == :minutes
+      #puts %(unit_in_s=#{(unit_in_s).inspect}, next_smaller_unit_in_s=#{(next_smaller_unit_in_s).inspect})
+
+      smaller_parts = smaller_parts(unit)
+      numerator_s = ActiveSupport::Duration.send(:calculate_total_seconds, smaller_parts)
+      denominator_s = ActiveSupport::Duration::PARTS_IN_SECONDS[unit] # 60 if unit == :minutes
+
+      fraction = Rational(numerator_s, denominator_s)
+      #puts "#{smaller_parts.inspect} converted to  fraction #{numerator_s}/#{denominator_s} = #{fraction} (#{fraction.to_f})"
+      fraction
+    end
+
+    # Returns all parts than `unit` as a Hash that is a subset of self.parts.
+    #
+    # For example, if `unit` is :hours and self is 1h 29m 60s, then it would return the parts
+    # smaller than hour, 29m 60s, as the hash { minutes: 29, seconds: 60 }.
+    #
+    def smaller_parts(unit)
+      parts.slice *ActiveSupport::Duration.smaller_units(unit)
+    end
+
+    def smallest_part
+      [parts.to_a.last].to_h
+    end
+
+    def smallest_unit
+      parts.to_a.last[0]
+    end
+
+    # Truncates the Duration to the specified precision. All smaller parts are discarded.
+    #
+    # Similar to https://ruby-doc.org/core-2.7.1/Float.html#method-i-truncate
+    #
+    def truncate(precision = smallest_unit, *args, **opts)
+      #puts %(Truncating #{parts.inspect} to #{precision.inspect})
+
+      # TODO: only use truncate here if :seconds or if part is Float ?
+      # or just always pass them along, although they are probably only needed for :seconds
+      part_value = (parts[precision] || 0)
+      new_part_value = part_value.truncate(*args)
+      change_cascade(
+        precision => new_part_value
+      )
+    end
+
+    # TODO: For completeness to complement truncate:
+    # https://ruby-doc.org/3.2.2/Float.html#method-i-ceil
+    # https://ruby-doc.org/3.2.2/Rational.html#method-i-round
+#    def ceil
+#    end
+
+#    def floor
+#    end
+
+  end
+end

data/lib/activesupport-duration-change.rb

@@ -0,0 +1 @@
+require 'active_support/duration/change'

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: activesupport-duration-change
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tyler Rick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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
+    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: rspec
+  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'
+description: 
+email:
+- tyler@tylerrick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Changelog.md
+- Gemfile
+- License
+- Rakefile
+- Readme.md
+- activesupport-duration-change.gemspec
+- bin/console
+- bin/setup
+- lib/active_support/duration/change.rb
+- lib/active_support/duration/change/version.rb
+- lib/activesupport-duration-change.rb
+homepage: https://github.com/TylerRick/activesupport-duration-change
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/TylerRick/activesupport-duration-change
+  source_code_uri: https://github.com/TylerRick/activesupport-duration-change
+  changelog_uri: https://github.com/TylerRick/activesupport-duration-change/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.5.1
+signing_key: 
+specification_version: 4
+summary: Adds methods such as `#change`, `#truncate`, `#round` to `Duration`
+test_files: []