active_record-associated_object 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3be47b7b9f9789e8fec3167c2ac7ef6cf48eb835b3750475d683330e2dc3a5ca
-  data.tar.gz: a9236b608d99c12701007dc4c65022f64a5e09400349f04cffbf2db863357c70
+  metadata.gz: 5816013890fc0f6868149661030643f47028edbb6a188d5014e7fd699e0138bd
+  data.tar.gz: ef0c4be8afb96727e5f379c988632ec44f0f77d105b8aadde944ac48362b7385
 SHA512:
-  metadata.gz: eb726c3a240636a729997f51878a3228622d46e774a06cf6c32a8c5b2e0fea9de00066215bd2dd04af1e358aae137e34cbc96f9d89f3c7e27cf1af370c3ef21c
-  data.tar.gz: c2ffe5e84e7c0e1ae5666b37d326bf9400db5572aa74ec7872e4ef36acc96484c07f51b2688ed0ee533988798b127b7ce10ea6a3ae91954e63faff9279f128ab
+  metadata.gz: 5f80f20322bf4661515fb6235c9d034e7ac68a22bc17e269971c8b2a1f5782affb28471316b65402bab66deedc9f63f322032fa216100c6966cd514c7421a100
+  data.tar.gz: 9def815025bf60d33b06ba6f7c9c185a59fca016f3e88a72d65fb64408dd0b4e7a34aea63c5a75de61004a64a80b86bd26e368ed021d105ed32bf6cca3a3f037

data/Gemfile.lock

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

data/README.md

@@ -85,6 +85,23 @@ class Post::Publisher < ActiveRecord::AssociatedObject
 end
 ```
 
+### See Associated Objects in action
+
+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`.
+
+See `bin/rails generate associated --help` for more info.
+
 ### Forwarding callbacks onto the associated object
 
 To further help illustrate how your collaborator Associated Objects interact with your domain model, you can forward callbacks.

data/lib/active_record/associated_object/object_association.rb

@@ -14,7 +14,10 @@ module ActiveRecord::AssociatedObject::ObjectAssociation
   module ClassMethods
     def has_object(*names, **callbacks)
       extend_source_from(names) do |name|
-        "def #{name}; (@associated_objects ||= {})[:#{name}] ||= #{const_get(name.to_s.camelize)}.new(self); end"
+        const_get object_name = name.to_s.camelize
+        "def #{name}; (@associated_objects ||= {})[:#{name}] ||= #{object_name}.new(self); end"
+      rescue NameError
+        raise "The #{self}::#{object_name} associated object referenced from #{self} doesn't exist"
       end
 
       extend_source_from(names) do |name|

data/lib/active_record/associated_object/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   class AssociatedObject
-    VERSION = "0.8.0"
+    VERSION = "0.8.2"
   end
 end

data/lib/generators/associated/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Create a PORO collaborator associated object inheriting from `ActiveRecord::AssociatedObject` that's associated with an Active Record record class.
+
+    It'll be associated on the record with `has_object`.
+
+    Note: associated object names support pluralized class names. So "Seats" remain "seats" in all cases, and "Seat" remains "seat" in all cases.
+Example:
+    bin/rails generate associated Organization::Seats
+
+    This will create:
+        app/models/organization/seats.rb
+        test/models/organization/seats_test.rb
+
+    And in Organization, this will insert:
+      has_object :seats

data/lib/generators/associated/associated_generator.rb

@@ -0,0 +1,28 @@
+class AssociatedGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  def generate_associated_object_files
+    template "associated.rb",      "app/models/#{name.underscore}.rb"
+    template "associated_test.rb", "test/models/#{name.underscore}_test.rb"
+  end
+
+  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
+      optimize_indentation "has_object :#{associated_object_path}", 2
+    end
+  end
+
+  private
+
+  # 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.camelize.deconstantize
+
+  def associated_object_path  = associated_object_class.underscore
+  def associated_object_class = name.camelize.demodulize
+end

data/lib/generators/associated/templates/associated.rb.tt

@@ -0,0 +1,5 @@
+class <%= name %> < ActiveRecord::AssociatedObject
+  extension do
+    # Extend <%= record_klass %> here
+  end
+end

data/lib/generators/associated/templates/associated_test.rb.tt

@@ -0,0 +1,8 @@
+require "test_helper"
+
+class <%= name %>Test < ActiveSupport::TestCase
+  setup do
+    # @<%= record_path %> = <%= record_path.pluralize %>(:TODO_fixture_name)
+    # @<%= associated_object_path %> = @<%= record_path %>.<%= associated_object_path %>
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record-associated_object
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Kasper Timm Hansen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-13 00:00:00.000000000 Z
+date: 2024-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -43,6 +43,10 @@ files:
 - lib/active_record/associated_object/object_association.rb
 - lib/active_record/associated_object/railtie.rb
 - lib/active_record/associated_object/version.rb
+- lib/generators/associated/USAGE
+- lib/generators/associated/associated_generator.rb
+- lib/generators/associated/templates/associated.rb.tt
+- lib/generators/associated/templates/associated_test.rb.tt
 homepage: https://github.com/kaspth/active_record-associated_object
 licenses:
 - MIT
@@ -65,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