api-blocks 0.4.11 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 213ea14d1ace477c4e700647a5574a5a9024c62185a9a2e5b656a2ed7b2f3eb0
-  data.tar.gz: 74cf4dd8fb59ff2441e0effa5217b200e6cb4bf4e2539c3882709e93bb46a7d4
+  metadata.gz: 710664013c6c921b9bdfe46c1598143edd489eddcdfc1519f13fb2625462640a
+  data.tar.gz: 245c76d099c43ffa562ed68bbc387deb49d7fd96814ed294eee1eccbf1b3adad
 SHA512:
-  metadata.gz: 648bc25b3c823f66c65edf674e283eb24803d9f9af7afc00e6a8b6683c66099b00510c775d4a66658a4fea2b01f8cd47a380b61e1870889815dd76f0f6523f99
-  data.tar.gz: 87e3687c96f08d74ff264761a89f2642277e58d73da5acf910e035347aa89b62358a0f687ddd4aab3a177a8dd39b0a99bb4cc7ee1b2019895a96d14c304fbe44
+  metadata.gz: 471441ab9dab08080f516f2a8427938f739154b91f24dd0378f48634f9b4bf444e9103af4c6d49905002d847d9b03a2dab1f0f87edafa7661ad2163f00e12272
+  data.tar.gz: 3273523f2ecc5997e7cc0ea04eb8bfc7e88b75723293cd1268b7cf21fd6c07ff45daf969402c0245ddde8eb33753fc25546ca851163f946bd233fddbdbb63c1d

data/lib/api_blocks.rb

@@ -3,6 +3,8 @@
 require 'rubygems'
 require 'bundler/setup'
 
+require 'dry/configurable'
+
 require 'api_blocks/version'
 require 'active_support/concern'
 require 'active_support/dependencies/autoload'
@@ -15,6 +17,12 @@ module ApiBlocks
   autoload :Responder
   autoload :Interactor
   autoload :Doorkeeper
+
+  extend Dry::Configurable
+
+  setting :blueprinter do
+    setting :use_batch_loader, false
+  end
 end
 
 require 'api_blocks/railtie' if defined?(Rails)

data/lib/api_blocks/blueprinter/association_extractor.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# Monkey-patch Blueprinter::AssociationExtractor to use `batch-loader` gem in
+# order to avoid n+1 queries when serializing associations.
+#
+# This does not support associations defined using a `proc` as
+# `options[:blueprint]`
+#
+class Blueprinter::AssociationExtractor < Blueprinter::Extractor
+  def extract(association_name, object, local_options, options = {})
+    if options[:blueprint].is_a?(Proc)
+      raise "Cannot load blueprints with a `proc` blueprint option with batch-loader"
+    end
+
+    association = object.association(association_name)
+
+    join_key = association.reflection.join_keys
+    association_id = object.send(join_key.foreign_key)
+    association_klass = association.reflection.class_name
+
+    default_value = case association
+                    when ActiveRecord::Associations::HasManyAssociation
+                      []
+                    end
+
+    view = options[:view] || :default
+
+    BatchLoader.for(association_id).batch(
+      default_value: default_value,
+      key: [association_name, association_klass, view, options[:blueprint]],
+    ) do |ids, loader, _args|
+      model = association_klass.safe_constantize
+
+      case association
+      when ActiveRecord::Associations::HasManyAssociation
+        model.where(join_key.key => ids).each do |record|
+          loader.call(record.send(join_key.key)) do |memo|
+            memo << render_blueprint(record, local_options, options)
+          end
+        end
+      when ActiveRecord::Associations::HasOneAssociation
+        model.where(join_key.key => ids).each do |record|
+          loader.call(
+            record.send(join_key.key),
+            render_blueprint(record, local_options, options)
+          )
+        end
+      when ActiveRecord::Associations::BelongsToAssociation
+        model.where(join_key.key => ids).each do |record|
+          loader.call(
+            record.id,
+            render_blueprint(record, local_options, options)
+          )
+        end
+      else
+        raise "unsupported association kind #{association.class.name}"
+      end
+    end
+  end
+
+  private
+
+  def render_blueprint(value, local_options, options = {})
+    return default_value(options) if value.nil?
+
+    view = options[:view] || :default
+    blueprint = association_blueprint(options[:blueprint], value)
+    blueprint.prepare(value, view_name: view, local_options: local_options)
+  end
+end

data/lib/api_blocks/railtie.rb

@@ -11,4 +11,12 @@ class ApiBlocks::Railtie < Rails::Railtie
     require_relative 'doorkeeper/passwords/migration_generator'
     require_relative 'doorkeeper/invitations/migration_generator'
   end
+
+  initializer "blueprinter.batch_loader_integration" do |app|
+    app.config.after_initialize do
+      next unless ApiBlocks.config.blueprinter.use_batch_loader
+
+      require_relative "blueprinter/association_extractor"
+    end
+  end
 end

data/lib/api_blocks/responder.rb

@@ -67,7 +67,7 @@ class ApiBlocks::Responder < ActionController::Responder
     super
   end
 
-  def json_resource_errors
+  def json_sesource_errors
     [{ errors: resource.errors }, :unprocessable_entity]
   end
 

data/lib/api_blocks/version.rb

@@ -2,5 +2,5 @@
 
 module ApiBlocks
   # Current version of ApiBlocks
-  VERSION = "0.4.11"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-blocks
 version: !ruby/object:Gem::Version
-  version: 0.4.11
+  version: 0.5.0
 platform: ruby
 authors:
 - Paul d'Hubert
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -256,6 +270,7 @@ extra_rdoc_files: []
 files:
 - lib/api-blocks.rb
 - lib/api_blocks.rb
+- lib/api_blocks/blueprinter/association_extractor.rb
 - lib/api_blocks/controller.rb
 - lib/api_blocks/doorkeeper.rb
 - lib/api_blocks/doorkeeper/invitations.rb