active_record-associated_object 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca7c634684913b4f2f55b96e54036df0590fe963e06beb15bf98a641a450c5e1
-  data.tar.gz: 279780001730e8d339d15dfa3f6659be157169d74a1e4949132c5d7a2b8e596a
+  metadata.gz: d24bf37946a6b4e5ddcb1626e90eb91e27932ae8d9f8f29c10c095ce3c53897c
+  data.tar.gz: 7f7d23788109d020fb1b010e8e6f3956880dfeb012c517dfc43e1f5c7862fd6c
 SHA512:
-  metadata.gz: e4b86186ef2aa86f31535313a22adf2835694829ba3a53c3d6b5847429ab5a002c3e09f36e3718f756370ca12f3d335b7851b42a8939d234f8de00d71970e255
-  data.tar.gz: ff2ac40c52831018085167aa42f9212b4cecdd7cb5dac199d9f258278553752b7cf3b40df2295d240df65bd6cc685981dd82d710b947d32b8192b5b8d39ee3eb
+  metadata.gz: 72675998afa72ea4117fd3601e9df6c9dbd2f62ae1541e1b6677903dd5c32109bd06c281e9be98d7742b92dcf6e48f2792764a5c661729ef2df95d6ce54cd2c4
+  data.tar.gz: 3d4244067099adec3ac04a185019bd99aba3078578ede15315893eb6c8f6b9a98cf8cd6356e74e37a395f39ec20013e83529ab6f9766dd014f154d3d03591718

data/Gemfile.lock

@@ -1,39 +1,40 @@
 PATH
   remote: .
   specs:
-    active_record-associated_object (0.6.0)
+    active_record-associated_object (0.7.0)
       activerecord (>= 6.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.1.1)
-      actionview (= 7.1.1)
-      activesupport (= 7.1.1)
+    actionpack (7.1.2)
+      actionview (= 7.1.2)
+      activesupport (= 7.1.2)
       nokogiri (>= 1.8.5)
+      racc
       rack (>= 2.2.4)
       rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    actionview (7.1.1)
-      activesupport (= 7.1.1)
+    actionview (7.1.2)
+      activesupport (= 7.1.2)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    active_job-performs (0.2.0)
+    active_job-performs (0.3.0)
       activejob (>= 6.1)
-    activejob (7.1.1)
-      activesupport (= 7.1.1)
+    activejob (7.1.2)
+      activesupport (= 7.1.2)
       globalid (>= 0.3.6)
-    activemodel (7.1.1)
-      activesupport (= 7.1.1)
-    activerecord (7.1.1)
-      activemodel (= 7.1.1)
-      activesupport (= 7.1.1)
+    activemodel (7.1.2)
+      activesupport (= 7.1.2)
+    activerecord (7.1.2)
+      activemodel (= 7.1.2)
+      activesupport (= 7.1.2)
       timeout (>= 0.4.0)
-    activesupport (7.1.1)
+    activesupport (7.1.2)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -43,45 +44,45 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
-    base64 (0.1.1)
-    bigdecimal (3.1.4)
+    base64 (0.2.0)
+    bigdecimal (3.1.5)
     builder (3.2.4)
     concurrent-ruby (1.2.2)
     connection_pool (2.4.1)
     crass (1.0.6)
-    debug (1.8.0)
-      irb (>= 1.5.0)
-      reline (>= 0.3.1)
-    drb (2.1.1)
+    debug (1.9.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    drb (2.2.0)
       ruby2_keywords
     erubi (1.12.0)
     globalid (1.2.1)
       activesupport (>= 6.1)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    io-console (0.6.0)
-    irb (1.8.3)
+    io-console (0.7.1)
+    irb (1.11.0)
       rdoc
       reline (>= 0.3.8)
-    kredis (1.6.0)
+    kredis (1.7.0)
       activemodel (>= 6.0.0)
       activesupport (>= 6.0.0)
       redis (>= 4.2, < 6)
-    loofah (2.21.4)
+    loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     minitest (5.20.0)
     minitest-sprint (1.2.2)
       path_expander (~> 1.1)
-    mutex_m (0.1.2)
-    nokogiri (1.15.4-arm64-darwin)
+    mutex_m (0.2.0)
+    nokogiri (1.16.0-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.4-x86_64-linux)
+    nokogiri (1.16.0-x86_64-linux)
       racc (~> 1.4)
     path_expander (1.1.1)
-    psych (5.1.1.1)
+    psych (5.1.2)
       stringio
-    racc (1.7.1)
+    racc (1.7.3)
     rack (3.0.8)
     rack-session (2.0.0)
       rack (>= 3.0.0)
@@ -97,29 +98,29 @@ GEM
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
-    railties (7.1.1)
-      actionpack (= 7.1.1)
-      activesupport (= 7.1.1)
+    railties (7.1.2)
+      actionpack (= 7.1.2)
+      activesupport (= 7.1.2)
       irb
       rackup (>= 1.0.0)
       rake (>= 12.2)
       thor (~> 1.0, >= 1.2.2)
       zeitwerk (~> 2.6)
     rake (13.1.0)
-    rdoc (6.5.0)
+    rdoc (6.6.2)
       psych (>= 4.0.0)
     redis (5.0.8)
       redis-client (>= 0.17.0)
-    redis-client (0.18.0)
+    redis-client (0.19.1)
       connection_pool
-    reline (0.3.9)
+    reline (0.4.2)
       io-console (~> 0.5)
     ruby2_keywords (0.0.5)
-    sqlite3 (1.6.7-arm64-darwin)
-    sqlite3 (1.6.7-x86_64-linux)
-    stringio (3.0.8)
+    sqlite3 (1.7.0-arm64-darwin)
+    sqlite3 (1.7.0-x86_64-linux)
+    stringio (3.1.0)
     thor (1.3.0)
-    timeout (0.4.0)
+    timeout (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     webrick (1.8.1)
@@ -129,6 +130,7 @@ PLATFORMS
   arm64-darwin-20
   arm64-darwin-21
   arm64-darwin-22
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES
@@ -144,4 +146,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.4.21
+   2.5.4

data/README.md

@@ -49,13 +49,19 @@ class Post::Publisher
 end
 
 class Post < ApplicationRecord
-  def publisher = @publisher ||= Post::Publisher.new(self)
+  def publisher = (@associated_objects ||= {})[:publisher] ||= Post::Publisher.new(self)
 end
 ```
 
+Note: due to Ruby's Object Shapes, we use a single `@associated_objects` instance variable that's assigned to `nil` on `Post.new`. This prevents Active Record's from ballooning into many different shapes in Ruby's internals.
+We've fixed this so you don't need to care, but this is what's happening.
+
 > [!TIP]
 > `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.
+
 See how we're always expecting a link to the model, here `post`?
 
 Because of that, you can rely on `post` from the associated object:
@@ -86,9 +92,9 @@ So `has_object` can state this and forward those callbacks onto the Associated O
 
 ```ruby
 class Post < ActiveRecord::Base
-  # Passing `true`
-  has_object :publisher, after_create_commit: :publish,
-    after_touch: true, before_destroy: :prevent_errant_post_destroy
+  # Passing `true` forwards the same name, e.g. `after_touch`.
+  has_object :publisher, after_touch: true, after_create_commit: :publish,
+    before_destroy: :prevent_errant_post_destroy
 
   # The above is the same as writing:
   after_create_commit { publisher.publish }
@@ -111,6 +117,69 @@ class Post::Publisher < ActiveRecord::AssociatedObject
 end
 ```
 
+### Extending the Active Record from within the Associated Object
+
+Since `has_object` eager-loads the Associated Object class, you can also move
+any integrating code into a provided `extension` block:
+
+> [!NOTE]
+> Technically, `extension` is just `Post.class_eval` but with syntactic sugar.
+
+```ruby
+class Post::Publisher < ActiveRecord::AssociatedObject
+  extension do
+    # Here we're within Post and can extend it:
+    has_many :contracts, dependent: :destroy do
+      def signed? = all?(&:signed?)
+    end
+
+    def self.with_contracts = includes(:contracts)
+
+    after_create_commit :publish_later, if: -> { contracts.signed? }
+
+    # An integrating method that operates on `publisher`.
+    private def publish_later = publisher.publish_later
+  end
+end
+```
+
+This is meant as an alternative to having a wrapping `ActiveSupport::Concern` in yet-another file like this:
+
+```ruby
+class Post < ApplicationRecord
+  include Published
+end
+
+# app/models/post/published.rb
+module Post::Published
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :contracts, dependent: :destroy do
+      def signed? = all?(&:signed?)
+    end
+
+    has_object :publisher
+    after_create_commit :publish_later, if: -> { contracts.signed? }
+  end
+
+  class_methods do
+    def with_contracts = includes(:contracts)
+  end
+
+  # An integrating method that operates on `publisher`.
+  private def publish_later = publisher.publish_later
+end
+```
+
+> [!NOTE]
+> Notice how in the `extension` version you don't need to:
+>
+> - have a naming convention for Concerns and where to place them.
+> - look up two files to read the feature (the concern and the associated object).
+> - wrap integrating code in an `included` block.
+> - wrap class methods in a `class_methods` block.
+
 ### Primary Benefit: Organization through Convention
 
 The primary benefit for right now is that by focusing the concept of namespaced Collaborator Objects through Associated Objects, you will start seeing them when you're modelling new features and it'll change how you structure and write your apps.
@@ -231,7 +300,20 @@ performs :publish, queue_as: :important, discard_on: SomeError do
 end
 ```
 
-See the `ActiveJob::Performs` README for more details.
+See [the `ActiveJob::Performs` README](https://github.com/kaspth/active_job-performs) for more details.
+
+### Automatic Kredis integration
+
+We've got automatic Kredis integration for Associated Objects, so you can use any `kredis_*` type just like in Active Record classes:
+
+```ruby
+class Post::Publisher < ActiveRecord::AssociatedObject
+  kredis_datetime :publish_at # Uses a namespaced "post:publishers:<post_id>:publish_at" key.
+end
+```
+
+> [!NOTE]
+> Under the hood, this reuses the same info we needed for automatic Active Job support. Namely, the Active Record class, here `Post`, and its `id`.
 
 ### Namespaced models
 

data/lib/active_record/associated_object/object_association.rb

@@ -1,4 +1,6 @@
 module ActiveRecord::AssociatedObject::ObjectAssociation
+  def self.included(klass) = klass.extend(ClassMethods)
+
   using Module.new {
     refine Module do
       def extend_source_from(chunks, &block)
@@ -9,15 +11,22 @@ module ActiveRecord::AssociatedObject::ObjectAssociation
     end
   }
 
-  def has_object(*names, **callbacks)
-    extend_source_from(names) do |name|
-      "def #{name}; @#{name} ||= #{self.name}::#{name.to_s.classify}.new(self); end"
-    end
+  module ClassMethods
+    def has_object(*names, **callbacks)
+      extend_source_from(names) do |name|
+        "def #{name}; (@associated_objects ||= {})[:#{name}] ||= #{name.to_s.classify}.new(self); end"
+      end
 
-    extend_source_from(names) do |name|
-      callbacks.map do |callback, method|
-        "#{callback} { #{name}.#{method == true ? callback : method} }"
+      extend_source_from(names) do |name|
+        callbacks.map do |callback, method|
+          "#{callback} { #{name}.#{method == true ? callback : method} }"
+        end
       end
     end
   end
+
+  def init_internals
+    @associated_objects = nil
+    super
+  end
 end

data/lib/active_record/associated_object/railtie.rb

@@ -16,7 +16,7 @@ class ActiveRecord::AssociatedObject::Railtie < Rails::Railtie
 
     ActiveSupport.on_load :active_record do
       require "active_record/associated_object/object_association"
-      extend ActiveRecord::AssociatedObject::ObjectAssociation
+      include ActiveRecord::AssociatedObject::ObjectAssociation
     end
   end
 end

data/lib/active_record/associated_object/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   class AssociatedObject
-    VERSION = "0.6.0"
+    VERSION = "0.7.0"
   end
 end

data/lib/active_record/associated_object.rb

@@ -15,6 +15,10 @@ class ActiveRecord::AssociatedObject
       klass.delegate :record_klass, :attribute_name, to: :class
     end
 
+    def extension(&block)
+      record_klass.class_eval(&block)
+    end
+
     def respond_to_missing?(...) = record_klass.respond_to?(...) || super
     delegate :unscoped, :transaction, :primary_key, to: :record_klass
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record-associated_object
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Kasper Timm Hansen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-18 00:00:00.000000000 Z
+date: 2024-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -65,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Associate a Ruby PORO with an Active Record class and have it quack like