road_to_el_duration 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e61bb17754de369f7def0f960b0912e74b90486f88339bfbf37be1540de592dc
-  data.tar.gz: 8d4914de53c504eaa680be2c83aae08a6778aafd5defbe37359f3e734d4a23c1
+  metadata.gz: 1d0a0614c1d994dc0147a886302cb7b1ba5c07af58f36fdfc695618233cade40
+  data.tar.gz: bd8abb6d4dcc62e9071a719f00517938e2d5e1c1df3f2d0646392d09d122b506
 SHA512:
-  metadata.gz: 5aa9cce3f2e8ef38a0f70bd181965bfde0e2e998a3a49d655f5c93c4793ed91a3d8f5f2055bf72f62b00123f4193b5f222c53fbe95c761e46f7a151ff50b8b02
-  data.tar.gz: 65b61abea98d14685197eb37611ff04ee16f0363aafe4726ba8654262a37244d6dfcc14a3cd7aa9ae97df7a225f660613ab74d11b735e71f493eb4969ad0fead
+  metadata.gz: 9100463c5e7a10d7105cc2609d9fd1bdd01a7c612394c6c87fffd96a53298f8bb4d8f62dc6835114ef28305e6e734ebf5c3b485ff47548ac85b02f904ecc7614
+  data.tar.gz: afc0bcbe9b437df54775386c55c2cf61d3722f35931f0c6bd72ea6765652033706db896e635563ad9b79b90edbc54cbdaed2a9c388db1f2e44c1f3d3201663e6

data/README.md

@@ -14,6 +14,15 @@ 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
+
+The gem provides two modules that you can include in your models. One named
+`RoadToElDuration::Calculations` which provides the `calculates_duration_from`
+and `updates_duration_of` methods and the other named `RoadToElDuration::Coder`
+which provides the `coder` class that is used to serialize and deserialize the
+duration columns.
+
+Let's look at a simple example.
+
 ```ruby
 class Episode < ApplicationRecord
   include RoadToElDuration::Calculations
@@ -35,6 +44,44 @@ class Series < ApplicationRecord
 end
 ```
 
+Here we have two models, `Episode` and `Series`. The `Series` model has its
+`duration` column serialized with the `RoadToElDuration::DurationCoder` coder and
+the `Episode` model has its `duration` column serialized with the
+`RoadToElDuration::DurationCoder` coder as well. The `Series` model also
+has its `duration` attribute populated from the sum of episode `duration` that
+belongs to a series.
+
+This setup assumes that both the `Episode` and `Series` models have an integer
+column on their tables named `duration` that is used to store the duration in
+seconds.
+
+If your columns are named differently you can specify the column names in both
+the `calculates_duration_from` and `updates_duration_of` methods by passing
+the column name as a symbol or a string as the `column` keyword argument.
+
+For example:
+```ruby
+class Episode < ApplicationRecord
+  include RoadToElDuration::Calculations
+
+  belongs_to :series
+
+  serialize :duration, coder: RoadToElDuration::DurationCoder
+  updates_duration_of :series, column: :total_length
+end
+
+
+class Series < ApplicationRecord
+  include RoadToElDuration::Calculations
+
+  has_many :episodes
+
+  serialize :duration, coder: RoadToElDuration::DurationCoder
+  calculates_duration_from :episodes, column: :length
+end
+```
+
+
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -47,7 +94,7 @@ And then execute:
 $ bundle
 ```
 ## Contributing
-Contribution directions go here.
+If you would like to contribute something, go for it. 👍
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/road_to_el_duration/calculations.rb

@@ -26,14 +26,16 @@ module RoadToElDuration
       # to calculate the duration.
       #
       def calculates_duration_from(child_association_name, column: :duration)
+        raise ArgumentError, "Please pass a valid child_association argument to the #{__method__} instead of nil" if child_association_name.nil?
         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
+      def updates_duration_of(parent_association_name, column: :duration)
+        raise ArgumentError, "Please pass a valid parent_association argument to the #{__method__} instead of nil" if parent_association_name.nil?
+        self.parent_association_name = parent_association_name
         self.parent_duration_column = column
       end
     end

data/lib/road_to_el_duration/version.rb

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

data/lib/road_to_el_duration.rb

@@ -4,4 +4,5 @@ require "road_to_el_duration/calculations"
 require "road_to_el_duration/duration_coder"
 
 module RoadToElDuration
+  class ArgumentError < ::ArgumentError; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: road_to_el_duration
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Collin Jilbert
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-08 00:00:00.000000000 Z
+date: 2024-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails