road_to_el_duration 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e61bb17754de369f7def0f960b0912e74b90486f88339bfbf37be1540de592dc
+  data.tar.gz: 8d4914de53c504eaa680be2c83aae08a6778aafd5defbe37359f3e734d4a23c1
+SHA512:
+  metadata.gz: 5aa9cce3f2e8ef38a0f70bd181965bfde0e2e998a3a49d655f5c93c4793ed91a3d8f5f2055bf72f62b00123f4193b5f222c53fbe95c761e46f7a151ff50b8b02
+  data.tar.gz: 65b61abea98d14685197eb37611ff04ee16f0363aafe4726ba8654262a37244d6dfcc14a3cd7aa9ae97df7a225f660613ab74d11b735e71f493eb4969ad0fead

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Collin Jilbert
+
+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,53 @@
+# RoadToElDuration
+Like a counter cache but for length in time attributes.
+
+If the duration or length in time of an object needs to be calculated from the
+duration or length in time of associated records this gem helps you achieve
+that easily.
+
+It handles automatic recalculations as child records are added,
+removed, and transferred to other parent records.
+
+It also comes with its own coder class that handles serializing and
+deserializing the duration columns to and from instances of the
+ActiveSupport::Duration class and the Ruby Integer class. This is an opt-in
+feature so you don't have to use it if you don't want.
+
+## Usage
+```ruby
+class Episode < ApplicationRecord
+  include RoadToElDuration::Calculations
+
+  belongs_to :series
+
+  serialize :duration, coder: RoadToElDuration::DurationCoder
+  updates_duration_of :series
+end
+
+
+class Series < ApplicationRecord
+  include RoadToElDuration::Calculations
+
+  has_many :episodes
+
+  serialize :duration, coder: RoadToElDuration::DurationCoder
+  calculates_duration_from :episodes
+end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "road_to_el_duration"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+## Contributing
+Contribution directions go here.
+
+## 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,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/road_to_el_duration/calculations.rb

@@ -0,0 +1,95 @@
+module RoadToElDuration
+  module Calculations
+    extend ActiveSupport::Concern
+
+    included do
+      # This callback will update the duration of the current and any previous
+      # parent records. It will only update the parent records if the
+      # parent_to_update attribute is set.
+      #
+      after_save_commit :update_any_parent_durations
+
+      # These are class attribute accessors that will be set by the class
+      # methods below.
+      #
+      cattr_accessor :child_association_name,
+                     :child_duration_column,
+                     :parent_association_name,
+                     :parent_duration_column
+    end
+
+    class_methods do
+      # This class method is used to set the association that the duration will be
+      # calculated from. It also sets the column that will be used from the
+      # child records to calculate the duration of the parent. The default
+      # column is :duration but you can set it to any column that will be used
+      # to calculate the duration.
+      #
+      def calculates_duration_from(child_association_name, column: :duration)
+        self.child_association_name= child_association_name
+        self.child_duration_column = column
+      end
+
+      # This class method is used to set the parent association that will be updated.
+      #
+      def updates_duration_of(parent_association, column: :duration)
+        self.parent_association_name = parent_association
+        self.parent_duration_column = column
+      end
+    end
+
+    # This method is used to update the duration of the record. It will sum the
+    # :duration_column of the associated records and update the :duration_column of
+    # the record. It is left as public API so that you can call it manually if
+    # needed.
+    #
+    def update_duration!
+      child_class = ActiveSupport::Inflector.singularize(child_association_name).camelize.constantize
+      duration_value[child_class.parent_duration_column] = calculate_duration
+      update!(**duration_value)
+    end
+
+    # This method is used to update the duration of the parent records. It will
+    # only update the parent records if the parent_to_update attribute is set.
+    # It will update the duration of the current parent record and any previous
+    # parent record if the record was transferred or removed from the collection.
+    #
+    def update_any_parent_durations
+      update_previous_parent_duration if transferred_or_removed_from_collection?
+      update_current_parent_duration if has_parent_record?
+    end
+
+    private
+
+    attr_writer :duration_value
+
+    def duration_value
+      @duration_value ||= {}
+    end
+
+    def calculate_duration
+      send(child_association_name).sum(child_duration_column)
+    end
+
+    def has_parent_record?
+      !!send(parent_association_name) if parent_association_name
+    end
+
+    def transferred_or_removed_from_collection?
+      send(:"#{parent_association_name}_id_previously_changed?") if parent_association_name
+    end
+
+    def previous_parent_id
+      send(:"#{parent_association_name}_id_previously_was")
+    end
+
+    def update_previous_parent_duration
+      return if previous_parent_id.nil?
+      parent_association_name.to_s.classify.constantize.find(previous_parent_id).update_duration!
+    end
+
+    def update_current_parent_duration
+      send(parent_association_name).update_duration!
+    end
+  end
+end

data/lib/road_to_el_duration/duration_coder.rb

@@ -0,0 +1,27 @@
+module RoadToElDuration
+  class DurationCoder
+    def self.dump(value)
+      value.to_i
+    end
+
+    def self.load(value)
+      initial_duration = ActiveSupport::Duration.build(value || 0)
+      ActiveSupport::Duration.new(initial_duration.to_i, convert_parts(initial_duration.parts))
+    end
+
+    def self.convert_parts(duration_parts)
+      new_duration_parts = {
+        hours: duration_parts.delete(:hours) || 0,
+        minutes: duration_parts.delete(:minutes) || 0
+      }
+      duration_parts.delete(:seconds)
+
+      # Take remaining parts (parts larger than hours) and convert to hours
+      duration_parts.each do |name, value|
+        new_duration_parts[:hours] += value.send(name).in_hours.to_i
+      end
+
+      new_duration_parts
+    end
+  end
+end

data/lib/road_to_el_duration/railtie.rb

@@ -0,0 +1,4 @@
+module RoadToElDuration
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/road_to_el_duration/version.rb

@@ -0,0 +1,3 @@
+module RoadToElDuration
+  VERSION = "0.1.0"
+end

data/lib/road_to_el_duration.rb

@@ -0,0 +1,7 @@
+require "road_to_el_duration/version"
+require "road_to_el_duration/railtie"
+require "road_to_el_duration/calculations"
+require "road_to_el_duration/duration_coder"
+
+module RoadToElDuration
+end

data/lib/tasks/road_to_el_duration_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :road_to_el_duration do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: road_to_el_duration
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Collin Jilbert
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.2
+description: Easily update the duration of a parent object when child objects are
+  added or removed.
+email:
+- cjilbert504@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/road_to_el_duration.rb
+- lib/road_to_el_duration/calculations.rb
+- lib/road_to_el_duration/duration_coder.rb
+- lib/road_to_el_duration/railtie.rb
+- lib/road_to_el_duration/version.rb
+- lib/tasks/road_to_el_duration_tasks.rake
+homepage: https://github.com/cjilbert504/road_to_el_duration
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/cjilbert504/road_to_el_duration
+  source_code_uri: https://github.com/cjilbert504/road_to_el_duration
+  changelog_uri: https://github.com/cjilbert504/road_to_el_duration/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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Easily update the duration of a parent object when child objects are added
+  or removed.
+test_files: []