active_record-associated_object 0.8.1 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76dd7495e0e2e855e708737a875ff879a8ec840d68f5c80ad4733ece3b72dda6
-  data.tar.gz: '09b38711104836c6c222a1663ddf4e7248ae784b727b597ed61f6436ab2bf17b'
+  metadata.gz: 4212b6fcecceb21ae133688c2a3332d29b8c0f5760f5a22a8ba3450037a95b20
+  data.tar.gz: 4b96fde3db82d00a3c94153cb9b212f1091bd0040d7d9771d300f2a0a0147d6f
 SHA512:
-  metadata.gz: 06fc0e959dedecab41a3c0d48d846eda454bd69c48fe8042cad1378c408fd919f688c2e07d5a26d675316556210ae25796585bc56438c8c66e3092c52fe3b1f6
-  data.tar.gz: bd35d99fc113f26d2b49e1fde335db7c28af90e7985ea0d2c60dc9dd8188e05cc2c4102bbe4edf5c45998d2b5cc96cd8f00bcd8974acf858450db479432c84f8
+  metadata.gz: 262b75fdf718925e7772b7c1dd4e49ab6b73f6706be97081433712a4f3efef524b1677194ff5376415fe32e770bfa080afd5b347c2ccf78786517dfe5a21a9fb
+  data.tar.gz: 47c40f2a351cd49fe9bc5e0488d37ce79bcb3d30332b3aabbaff681ef7ac7f937d81d01c60d6b7f8393d3fc28f7fa92fb9b4d5eb99ae607d95d0389deea12764

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_record-associated_object (0.8.1)
+    active_record-associated_object (0.8.3)
       activerecord (>= 6.1)
 
 GEM

data/README.md

@@ -60,7 +60,7 @@ We've fixed this so you don't need to care, but this is what's happening.
 > `has_object` only requires a namespace and an initializer that takes a single argument. The above `Post::Publisher` is perfectly valid as an Associated Object — same goes for `class Post::Publisher < Data.define(:post); end`.
 
 > [!TIP]
-> You can pass multiple names too: `has_object :publisher, :classified, :fortification`. I recommend `-[i]er`, `-[i]ed` and `-ion` as the general naming conventions for your Associated Objects.
+> You can pass multiple names too: `has_object :seats, :entitlements, :publisher, :classified, :fortification`. I recommend `-s`, `-[i]er`, `-[i]ed` and `-ion` as the general naming conventions for your Associated Objects.
 
 > [!TIP]
 > Plural Associated Object names are also supported: `Account.has_object :seats` will look up `Account::Seats`.
@@ -85,6 +85,28 @@ class Post::Publisher < ActiveRecord::AssociatedObject
 end
 ```
 
+### See Associated Objects in action
+
+#### RubyVideo.dev
+
+The team at https://www.rubyvideo.dev has been using Associated Objects to clarify the boundaries of their Active Records and collaborator Associated Objects.
+
+See the usage in the source here:
+
+- [`ActiveRecord::AssociatedObject` instances](https://github.com/search?q=repo%3Aadrienpoly%2Frubyvideo%20ActiveRecord%3A%3AAssociatedObject&type=code)
+- [`has_object` calls](https://github.com/search?q=repo%3Aadrienpoly%2Frubyvideo+has_object&type=code)
+
+#### Flipper
+
+The team at [Flipper](https://www.flippercloud.io) used Associated Objects to help keep their new billing structure clean.
+
+You can see real life examples in these blog posts:
+
+- [Organizing Rails Code with ActiveRecord Associated Objects](https://garrettdimon.com/journal/posts/organizing-rails-code-with-activerecord-associated-objects)
+- [Data Modeling Entitlements and Pricing for SaaS Applications](https://garrettdimon.com/journal/posts/data-modeling-saas-entitlements-and-pricing)
+
+If your team is using Associated Objects, we're more than happy to feature any write ups here.
+
 ### Use the generator to help write Associated Objects
 
 To set up the `Post::Publisher` from above, you can call `bin/rails generate associated Post::Publisher`.
@@ -229,6 +251,68 @@ class Post::PublisherTest < ActiveSupport::TestCase
 end
 ```
 
+### Polymorphic Associated Objects
+
+If you want to share logic between associated objects, you can do so via standard Ruby modules:
+
+```ruby
+# app/models/pricing.rb
+module Pricing
+  # If you need to share an `extension` across associated objects you can override `Module::included` like this:
+  def self.included(object) = object.extension do
+    # Add common integration methods onto `Account`/`User` when the module is included.
+    # See the `extension` block in the `Extending` section above for an example.
+  end
+
+  def price_set?
+    # Instead of referring to `account` or `user`, use the `record` method to target either.
+    record.price_cents.positive?
+  end
+end
+
+# app/models/account/pricing.rb
+class Account::Pricing < ActiveRecord::AssociatedObject
+  include ::Pricing
+end
+
+# app/models/user/pricing.rb
+class User::Pricing < ActiveRecord::AssociatedObject
+  include ::Pricing
+end
+```
+
+Now we can call `account.pricing.price_set?` & `user.pricing.price_set?`.
+
+> [!NOTE]
+> Polymorphic Associated Objects are definitely a more advanced topic,
+> so you need to know your Ruby module hierarchy and how to track what `self` changes to fairly well.
+
+#### Using `ActiveSupport::Concern` as an alternative
+
+If you prefer the look of Active Support concerns, here's the equivalent to the above Ruby module:
+
+```ruby
+# app/models/pricing.rb
+module Pricing
+  extend ActiveSupport::Concern
+
+  included do
+    extension do
+      # Add common integration methods onto `Account`/`User` when the concern is included.
+    end
+  end
+
+  def price_set?
+    # Instead of referring to `account` or `user`, use the `record` method to target either.
+    record.price_cents.positive?
+  end
+end
+```
+
+Active Support concerns have some extra features that standard Ruby modules don't, like support for deeply-nested concerns and `class_methods do`.
+
+In this case, if you're reaching for those, you're probably building something too intricate and potentially brittle.
+
 ### Active Job integration via GlobalID
 
 Associated Objects include `GlobalID::Identification` and have automatic Active Job serialization support that looks like this:

data/lib/active_record/associated_object/railtie.rb

@@ -6,14 +6,14 @@ class ActiveRecord::AssociatedObject::Railtie < Rails::Railtie
     end
   end
 
-  initializer "object_association.setup" do
-    ActiveSupport.on_load :active_job do
-      require "active_job/performs"
-      ActiveRecord::AssociatedObject.extend ActiveJob::Performs
-    rescue LoadError
-      # We haven't bundled active_job-performs, so we're continuing without it.
-    end
+  initializer "active_job.performs" do
+    require "active_job/performs"
+    ActiveRecord::AssociatedObject.extend ActiveJob::Performs if defined?(ActiveJob::Performs)
+  rescue LoadError
+    # We haven't bundled active_job-performs, so we're continuing without it.
+  end
 
+  initializer "object_association.setup" do
     ActiveSupport.on_load :active_record do
       require "active_record/associated_object/object_association"
       include ActiveRecord::AssociatedObject::ObjectAssociation

data/lib/active_record/associated_object/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   class AssociatedObject
-    VERSION = "0.8.1"
+    VERSION = "0.8.3"
   end
 end

data/lib/generators/associated/associated_generator.rb

@@ -8,6 +8,7 @@ class AssociatedGenerator < Rails::Generators::NamedBase
 
   def connect_associated_object
     record_file = "#{destination_root}/app/models/#{record_path}.rb"
+
     raise "Record class '#{record_klass}' does not exist" unless File.exist?(record_file)
 
     inject_into_class record_file, record_klass do
@@ -20,8 +21,8 @@ class AssociatedGenerator < Rails::Generators::NamedBase
   # The `:name` argument can handle model names, but associated object class names aren't singularized.
   # So these record and associated_object methods prevent that.
   def record_path  = record_klass.downcase.underscore
-  def record_klass = name.deconstantize
+  def record_klass = name.camelize.deconstantize
 
-  def associated_object_path  = associated_object_class.downcase.underscore
-  def associated_object_class = name.demodulize
+  def associated_object_path  = associated_object_class.underscore
+  def associated_object_class = name.camelize.demodulize
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record-associated_object
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.3
 platform: ruby
 authors:
 - Kasper Timm Hansen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-19 00:00:00.000000000 Z
+date: 2024-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: Associate a Ruby PORO with an Active Record class and have it quack like