blueprinter-activerecord 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bec64f8859b0d2cea3346675d4b2a3279245bcb5f7060b0ba0bfcf2f3bb4d83
-  data.tar.gz: 4fe808fc8be1d043bc18d53dbe3e6a02c40904408ed51f6a8d0fbe0fc1349b2f
+  metadata.gz: d4e873acea4991a8ea2761ca16f7564c8dd7ce10b1d0237a7f7fcc7068a64cac
+  data.tar.gz: 6398394fe88e9324ae285a9144cb07f1354a9195df196c48c99c011111f113ea
 SHA512:
-  metadata.gz: 3f20ed5466369e302e0e8d73bae2bade4fa92cd7efa6ae2bba63eb49494af7990cbc74d371f6c7f4efe782a94ae4d001fbc2dfdbce7a2358771ce6fdc748442c
-  data.tar.gz: 86b01a869b55e52ac6cfbac55dacb149112a01409ec004d7c55e4ef79451d5716327aa4aa04b8777aef2d68e000498d66f04c813e25d098ad985948bc103ad77
+  metadata.gz: c5b87d18310bcd54a677aeec768ca5697f427f267059c20f700def7bc7b386a185577a1f87bd15f87342e76bbe86ece3e472bace0626ad3d869678e64b614a9f
+  data.tar.gz: 511f52f12693ce69a8337a74fe7c31cf894d04427a4fa1538ca7570689c0961e8259d559435216c0be1e62417fc93d62f1944e9920c6fcdf4ad56a867f5ae3a2

data/lib/blueprinter-activerecord/added_preloads_logger.rb

@@ -42,7 +42,7 @@ module BlueprinterActiveRecord
     def pre_render(object, blueprint, view, options)
       if object.is_a?(ActiveRecord::Relation) && object.before_preload_blueprint
         from_code = object.before_preload_blueprint
-        from_blueprint = Preloader.preloads(blueprint, view, object.model)
+        from_blueprint = Preloader.preloads(blueprint, view, model: object.model)
         info = PreloadInfo.new(object, from_code, from_blueprint, caller)
         @log_proc&.call(info)
       end

data/lib/blueprinter-activerecord/missing_preloads_logger.rb

@@ -39,7 +39,7 @@ module BlueprinterActiveRecord
     def pre_render(object, blueprint, view, options)
       if object.is_a?(ActiveRecord::Relation) && !object.before_preload_blueprint
         from_code = extract_preloads object
-        from_blueprint = Preloader.preloads(blueprint, view, object.model)
+        from_blueprint = Preloader.preloads(blueprint, view, model: object.model)
         info = PreloadInfo.new(object, from_code, from_blueprint, caller)
         @log_proc&.call(info)
       end

data/lib/blueprinter-activerecord/preloader.rb

@@ -4,6 +4,7 @@ module BlueprinterActiveRecord
   # A Blueprinter extension to automatically preload a Blueprint view's ActiveRecord associations during render
   class Preloader < Blueprinter::Extension
     include Helpers
+    DEFAULT_MAX_RECURSION = 10
 
     attr_reader :use, :auto, :auto_proc
 
@@ -37,11 +38,10 @@ module BlueprinterActiveRecord
     # intelligently handles them. There are several unit tests which confirm this behavior.
     #
     def pre_render(object, blueprint, view, options)
-      case object.class.name
-      when "ActiveRecord::Relation", "ActiveRecord::AssociationRelation"
+      if object.is_a?(ActiveRecord::Relation) && !object.loaded?
         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)
+          blueprint_preloads = self.class.preloads(blueprint, view, model: object.model)
           loader = object.preload_blueprint_method || use
           object.public_send(loader, blueprint_preloads)
         else
@@ -57,25 +57,74 @@ 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)
+    #   preloads = BlueprinterActiveRecord::Preloader.preloads(WidgetBlueprint, :extended, model: Widget)
     #   q = Widget.where(...).order(...).preload(preloads)
     #
     # @param blueprint [Class] The Blueprint class
     # @param view_name [Symbol] Name of the view in blueprint
-    # @param model [Class] The ActiveRecord model class that blueprint represents
+    # @param model [Class|:polymorphic] The ActiveRecord model class that blueprint represents
+    # @param cycles [Hash<String, Integer>] (internal) Preloading will halt if recursion/cycles gets too high
     # @return [Hash] A Hash containing preload/eager_load/etc info for ActiveRecord
     #
-    def self.preloads(blueprint, view_name, model=nil)
+    def self.preloads(blueprint, view_name, model:, cycles: {})
       view = blueprint.reflections.fetch(view_name)
-      view.associations.each_with_object({}) { |(_name, assoc), acc|
-        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)
+      preload_vals = view.associations.each_with_object({}) { |(_name, assoc), acc|
+        # look for a matching association on the model
+        if (preload = association_preloads(assoc, model, cycles))
+          acc[assoc.name] = preload
+        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
+
+    def self.association_preloads(assoc, model, cycles)
+      max_cycles = assoc.options.fetch(:max_recursion, DEFAULT_MAX_RECURSION)
+      if model == :polymorphic
+        if assoc.blueprint.is_a? Proc
+          {}
+        else
+          cycles, count = count_cycles(assoc.blueprint, assoc.view, cycles)
+          count < max_cycles ? preloads(assoc.blueprint, assoc.view, model: model, cycles: cycles) : {}
+        end
+      elsif (ref = model.reflections[assoc.name.to_s])
+        if assoc.blueprint.is_a? Proc
+          {}
+        elsif ref.belongs_to? && ref.polymorphic?
+          cycles, count = count_cycles(assoc.blueprint, assoc.view, cycles)
+          count < max_cycles ? preloads(assoc.blueprint, assoc.view, model: :polymorphic, cycles: cycles) : {}
+        else
+          cycles, count = count_cycles(assoc.blueprint, assoc.view, cycles)
+          count < max_cycles ? preloads(assoc.blueprint, assoc.view, model: ref.klass, cycles: cycles) : {}
+        end
+      end
+    end
+
+    def self.count_cycles(blueprint, view, cycles)
+      id = "#{blueprint.name || blueprint.inspect}/#{view}"
+      cycles = cycles.dup
+      if cycles[id].nil?
+        cycles[id] = 0
+      else
+        cycles[id] += 1
+      end
+      return cycles, cycles[id]
     end
   end
 end

data/lib/blueprinter-activerecord/query_methods.rb

@@ -43,7 +43,7 @@ module BlueprinterActiveRecord
 
       if blueprint and view
         # preload right now
-        preloads = Preloader.preloads(blueprint, view, model)
+        preloads = Preloader.preloads(blueprint, view, model: model)
         public_send(use, preloads)
       else
         # preload during render

data/lib/blueprinter-activerecord/version.rb

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

data/lib/tasks/blueprinter_activerecord.rake

@@ -14,7 +14,7 @@ namespace :blueprinter do
 
       model = args[:model].constantize
       blueprint = args[:blueprint].constantize
-      preloads = BlueprinterActiveRecord::Preloader.preloads(blueprint, args[:view].to_sym, model)
+      preloads = BlueprinterActiveRecord::Preloader.preloads(blueprint, args[:view].to_sym, model: model)
       puts pretty preloads
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter-activerecord
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Procore Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-30 00:00:00.000000000 Z
+date: 2024-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord