blueprinter-activerecord 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6a85ca09945cbc4bd824aef6b755904df11ac6438efb639a7f07789ace4834d
-  data.tar.gz: c851665fed8b689589f3cde2a176cb7a50292f48d46bcddd8b4b88790a6adb83
+  metadata.gz: 1a433613eafed67560509b44a75f9d8468eb98addf5262865cef731b63c2175b
+  data.tar.gz: 37ed9a65f70a441dfc23806b0c67bf7a1622170bb607f416e280a4739cc1c472
 SHA512:
-  metadata.gz: 49f97296a38d1765754c31ba00c585ec78c978ca29ac4642eba4c100dc5f2cec52703349150feddca1f55cacf5a8bb2addb2dce50db33ca35c7ab20851615faf
-  data.tar.gz: e5e92ab4e1fc3b7c9b3124d1b56573283e525539e0212bcbf73e38913dea83f8ee34775e85c3511e6b6d12f39100aff9f17d11a6b7e097e37a380fb9612f6381
+  metadata.gz: f5ca1480aeaae70cef964408594dd4b72b12101925daf12d8233c0c454652c451c427a0e91c430ad18612d1bb47002496289caffdb0b8cdd48d8a537056fcb36
+  data.tar.gz: ae53e10d27f7c93cab9920151bee1b3a10ed3d1b46b807b5420a297ee3cdfa2bae05ebae5f26ca1e5809616d05609771b5a9368537e9c980d43b6031e1f0622f

data/lib/blueprinter-activerecord/preloader.rb

@@ -28,16 +28,17 @@ module BlueprinterActiveRecord
 
     #
     # Implements the "pre_render" Blueprinter Extension to preload associations from a view.
-    # If auto is true, all ActiveRecord::Relation objects will be preloaded. If auto is false,
-    # only queries that have called `.preload_blueprint` will be preloaded.
+    # If auto is true, all ActiveRecord::Relation and ActiveRecord::AssociationRelation objects
+    # will be preloaded. If auto is false, only queries that have called `.preload_blueprint`
+    # will be preloaded.
     #
     # NOTE: If auto is on, *don't* be concerned that you'll end up with duplicate preloads. Even if
     # the query ends up with overlapping members in 'preload' and 'includes', ActiveRecord
     # intelligently handles them. There are several unit tests which confirm this behavior.
     #
     def pre_render(object, blueprint, view, options)
-      case object
-      when ActiveRecord::Relation
+      case object.class.name
+      when "ActiveRecord::Relation", "ActiveRecord::AssociationRelation"
         if object.preload_blueprint_method || auto || auto_proc&.call(object, blueprint, view, options) == true
           object.before_preload_blueprint = extract_preloads object
           blueprint_preloads = self.class.preloads(blueprint, view, object.model)
@@ -56,6 +57,10 @@ module BlueprinterActiveRecord
     #
     # Returns an ActiveRecord preload plan extracted from the Blueprint and view (recursive).
     #
+    # Preloads are found when one of the model's associations matches:
+    # 1. A Blueprint association name.
+    # 2. A :preload option on a field or association.
+    #
     # Example:
     #
     #   preloads = BlueprinterActiveRecord::Preloader.preloads(WidgetBlueprint, :extended, Widget)
@@ -68,12 +73,25 @@ module BlueprinterActiveRecord
     #
     def self.preloads(blueprint, view_name, model=nil)
       view = blueprint.reflections.fetch(view_name)
-      view.associations.each_with_object({}) { |(_name, assoc), acc|
+      preload_vals = view.associations.each_with_object({}) { |(_name, assoc), acc|
+        # look for a matching association on the model
         ref = model ? model.reflections[assoc.name.to_s] : nil
         if (ref || model.nil?) && !assoc.blueprint.is_a?(Proc)
           ref_model = ref && !(ref.belongs_to? && ref.polymorphic?) ? ref.klass : nil
           acc[assoc.name] = preloads(assoc.blueprint, assoc.view, ref_model)
         end
+
+        # look for a :preload option on the association
+        if (custom = assoc.options[:preload])
+          Helpers.merge_values custom, acc
+        end
+      }
+
+      # look for a :preload options on fields
+      view.fields.each_with_object(preload_vals) { |(_name, field), acc|
+        if (custom = field.options[:preload])
+          Helpers.merge_values custom, acc
+        end
       }
     end
   end

data/lib/blueprinter-activerecord/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BlueprinterActiveRecord
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter-activerecord
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Procore Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-09 00:00:00.000000000 Z
+date: 2024-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -148,7 +148,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="