grape-entity-preloader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3d32cc4a359717abe3519c7f8bee48d9e35029d1348057a7fa35b043594dd1b5
+  data.tar.gz: 9ef42ce05db679a5cf7830aeaae698b1557452957648e668ced0ced0cd1e4a3a
+SHA512:
+  metadata.gz: e9101088f6433f7372ad46b061c34341553259a91a3f903ec1d2dde1112bd2e2d944aec61fcb4ba1ac5ae5828719b3d9eb9dfda88134351e739982e8a8e03149
+  data.tar.gz: 6d46c749603a41caff0bec514091adc6b630d521c2d0b84aa62f879f76058b4d81185a493f1684eb5f54548290d702462a946cd1c3617af420fd469f16bb023a

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-10-12 UTC
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 OuYangJinTing
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,188 @@
+# Grape::Entity::Preloader
+
+Grape::Entity::Preloader allows preload associations and callbacks for avoiding N+1 operations in Grape::Entity.
+
+## Installation
+
+```bash
+bundle add grape-entity-preloader
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install grape-entity-preloader
+```
+
+## Usage
+
+### Activation
+
+#### Global Activation
+
+You can enable the preloader globally. This is useful in environments where you want preloading to be the default behavior.
+
+```ruby
+# config/initializers/grape_entity_preloader.rb
+Grape::Entity::Preloader.enabled!
+```
+
+#### Local Activation and Deactivation
+
+You can control preloading for specific `represent` calls.
+
+##### 1. Using options
+
+Pass `grape_entity_preloader: :enabled` or `grape_entity_preloader: :disabled` to the options hash. This overrides the global setting.
+
+```ruby
+# Locally enable
+MyEntity.represent(users, grape_entity_preloader: :enabled)
+
+# Locally disable
+MyEntity.represent(users, grape_entity_preloader: :disabled)
+```
+
+##### 2. Using a block
+
+For a specific block of code, you can use `with_enable` or `with_disable`. This is useful in contexts like API endpoints or middlewares.
+
+```ruby
+Grape::Entity::Preloader.with_enable do
+  # Preloading is enabled for all represent calls inside this block
+  MyAPI::Entities::User.represent(User.all)
+end
+
+Grape::Entity::Preloader.with_disable do
+  # Preloading is disabled for all represent calls inside this block
+  MyAPI::Entities::User.represent(User.all)
+end
+```
+
+### `preload_association`
+
+Use `preload_association` to preload ActiveRecord associations. This helps to avoid N+1 queries when an exposure represents an association.
+
+```ruby
+class UserEntity < Grape::Entity
+  expose :id
+  expose :name
+  # This will preload the `books` association for all users being represented.
+  expose :books, using: BookEntity, preload_association: :books
+end
+
+# In your API
+users = User.limit(10)
+# When UserEntity represents users, it will execute two queries:
+# 1. SELECT * FROM users LIMIT 10
+# 2. SELECT * FROM books WHERE books.user_id IN (...)
+UserEntity.represent(users)
+```
+
+For nested preloading:
+
+```ruby
+class BookEntity < Grape::Entity
+  expose :id
+  expose :title
+  # This will preload tags for each book
+  expose :tags, using: TagEntity, preload_association: :tags
+end
+
+class UserEntity < Grape::Entity
+  expose :id
+  expose :name
+  expose :books, using: BookEntity, preload_association: :books
+end
+
+# It will generate 3 queries instead of 1 + 10 (for books) + N (for tags)
+UserEntity.represent(User.limit(10))
+```
+
+### `preload_callback`
+
+For more complex scenarios that `preload_association` doesn't cover (e.g., loading data from other services, custom caching logic), you can use `preload_callback`.
+
+It must be a `Proc` that accepts two arguments:
+1. `objects`: An array of the parent objects being represented.
+2. `options`: The `Grape::Entity::Options` object for the current representation context.
+
+**The `Proc` should return an array of objects that will be used for the nested entity representation. These returned objects will then be passed to the preloader for that nested entity, allowing for further nested preloading.**
+
+```ruby
+class UserStatsEntity < Grape::Entity
+  expose :likes
+  expose :followers
+end
+
+class UserEntity < Grape::Entity
+  expose :id
+  expose :name
+
+  expose :stats, using: UserStatsEntity, preload_callback: ->(users, _options) do
+    # `users` is an array of User objects.
+    # Here you can fetch stats for all users in one batch.
+    user_ids = users.map(&:id)
+    stats_data = StatsService.batch_get_by_user_ids(user_ids) # returns a hash { user_id => stats_object }
+
+    # The preloader needs to associate the loaded data back to the original objects.
+    # A common pattern is to attach the data to a new attribute on the object.
+    users.each { |user| user.instance_variable_set(:@stats, stats_data[user.id]) }
+
+    # The block must return the objects that will be presented by the nested entity.
+    # In this case, it's the stats objects we just loaded.
+    users.map { |user| user.instance_variable_get(:@stats) }
+  end
+end
+
+# In the entity, you need to define how to access the preloaded data.
+class UserEntity < Grape::Entity
+  # ...
+  expose :stats, using: UserStatsEntity, preload_callback: ... do |user, _options|
+    user.instance_variable_get(:@stats)
+  end
+end
+```
+
+### `preload_condition`
+
+Use `preload_condition` to conditionally enable or disable preloading for an exposure. It must be a `Proc` that accepts one argument: `options`, which is the `Grape::Entity::Options` object.
+
+If the `Proc` returns a falsy value, preloading for that exposure will be skipped.
+
+```ruby
+class UserEntity < Grape::Entity
+  expose :id
+  expose :name
+
+  # The :audit_log association will only be preloaded if `include_audit_log` is true in the options.
+  expose :audit_log,
+         using: AuditLogEntity,
+         preload_association: :audit_log,
+         preload_condition: ->(options) { options[:include_audit_log] }
+end
+
+# Preloading for :audit_log is skipped
+UserEntity.represent(user)
+
+# Preloading for :audit_log is executed
+UserEntity.represent(user, include_audit_log: true)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/OuYangJinTing/grape-entity-preloader. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/OuYangJinTing/grape-entity-preloader/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Grape::Entity::Preloader project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/OuYangJinTing/grape-entity-preloader/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/grape/entity/preloader/entity.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Grape
+  class Entity
+    class Preloader
+      module Entity # rubocop:disable Style/Documentation
+        extend ActiveSupport::Concern
+
+        module ClassMethods # rubocop:disable Style/Documentation
+          def represent(objects, options = {})
+            options = Grape::Entity::Options.new(options) unless options.is_a?(Grape::Entity::Options)
+
+            options[:grape_entity_preloader] ||= Preloader.enabled? ? :enabled : :disabled
+            Preloader.new(root_exposures, objects, options).call if options[:grape_entity_preloader] == :enabled
+            options[:grape_entity_preloader] = :finished
+
+            super(objects, options)
+          end
+        end
+      end
+    end
+  end
+end
+
+Grape::Entity.prepend(Grape::Entity::Preloader::Entity)
+silence_warnings do
+  Grape::Entity::OPTIONS = (Grape::Entity::OPTIONS + %i[preload_association preload_callback preload_condition]).freeze
+end

data/lib/grape/entity/preloader/exposure/base.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Grape
+  class Entity
+    class Preloader
+      module Exposure
+        module Base # rubocop:disable Style/Documentation
+          extend ActiveSupport::Concern
+
+          attr_reader :preload_association, :preload_callback, :preload_condition
+
+          def initialize(_attribute, options, _conditions)
+            @preload_association = options[:preload_association]
+            @preload_callback = options[:preload_callback]
+            @preload_condition = options[:preload_condition]
+            validate_preload_options
+
+            super
+          end
+
+          private
+
+          def validate_preload_options # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/MethodLength
+            if preload_association && !preload_association.is_a?(Symbol)
+              raise ArgumentError, 'The :preload_association option must be a Symbol.'
+            end
+
+            if preload_callback && (!preload_callback.is_a?(Proc) || preload_callback.arity != 2)
+              raise ArgumentError, 'The :preload_callback option must be a Proc with 2 arguments.'
+            end
+
+            if preload_condition && (!preload_condition.is_a?(Proc) || preload_condition.arity != 1)
+              raise ArgumentError, 'The :preload_condition option must be a Proc with 1 argument.'
+            end
+
+            return unless preload_association && preload_callback
+
+            raise ArgumentError, 'The :preload_association and :preload_callback options cannot be used together.'
+          end
+        end
+      end
+    end
+  end
+end
+
+Grape::Entity::Exposure::Base.prepend(Grape::Entity::Preloader::Exposure::Base)

data/lib/grape/entity/preloader/options.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Grape
+  class Entity
+    class Preloader
+      module Options # rubocop:disable Style/Documentation
+        extend ActiveSupport::Concern
+
+        included do
+          def_delegators :opts_hash, :delete, :[]=
+        end
+      end
+    end
+  end
+end
+
+Grape::Entity::Options.include(Grape::Entity::Preloader::Options)

data/lib/grape/entity/preloader/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Grape
+  class Entity
+    class Preloader
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/grape/entity/preloader.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require 'grape-entity'
+require_relative 'preloader/version'
+require_relative 'preloader/entity'
+require_relative 'preloader/options'
+require_relative 'preloader/exposure/base'
+
+module Grape
+  class Entity
+    class Preloader # rubocop:disable Style/Documentation,Metrics/ClassLength
+      attr_reader :exposures, :objects, :options, :associations, :callbacks, :nested_association_chain
+
+      singleton_class.attr_accessor :enabled
+      self.enabled = false
+
+      def self.enabled!
+        self.enabled = true
+      end
+
+      def self.enabled?
+        if ActiveSupport::IsolatedExecutionState.key?(:grape_entity_preloader)
+          ActiveSupport::IsolatedExecutionState[:grape_entity_preloader]
+        else
+          enabled
+        end
+      end
+
+      def self.with_enable
+        return yield if enabled?
+
+        old_value = ActiveSupport::IsolatedExecutionState[:grape_entity_preloader]
+        ActiveSupport::IsolatedExecutionState[:grape_entity_preloader] = true
+
+        yield
+
+        if old_value.nil?
+          ActiveSupport::IsolatedExecutionState.delete(:grape_entity_preloader)
+        else
+          ActiveSupport::IsolatedExecutionState[:grape_entity_preloader] = old_value
+        end
+      end
+
+      def self.disabled!
+        self.enabled = false
+      end
+
+      def self.disabled?
+        !enabled?
+      end
+
+      def self.with_disable
+        return yield if disabled?
+
+        old_value = ActiveSupport::IsolatedExecutionState[:grape_entity_preloader]
+        ActiveSupport::IsolatedExecutionState[:grape_entity_preloader] = false
+
+        yield
+
+        if old_value.nil?
+          ActiveSupport::IsolatedExecutionState.delete(:grape_entity_preloader)
+        else
+          ActiveSupport::IsolatedExecutionState[:grape_entity_preloader] = old_value
+        end
+      end
+
+      def self.activerecord_gte_7_0?
+        unless defined?(ActiveRecord) && ActiveRecord.respond_to?(:version) && ActiveRecord.version >= Gem::Version.new('7.0')
+          warn 'ActiveRecord 7.0 or later is required for preload association'
+          return false
+        end
+
+        true
+      end
+
+      def initialize(exposures, objects, options)
+        @exposures = exposures
+        @objects = Array.wrap(objects)
+        @options = options
+
+        @associations = {}
+        @callbacks = Hash.new { |hash, key| hash[key] = [] }
+        @nested_association_chain = []
+      end
+
+      def call
+        return if objects.empty?
+
+        extract_preload_options(exposures, options, associations)
+        execute_preload_associations
+        execute_preload_callbacks
+      end
+
+      private
+
+      def execute_preload_associations
+        return unless Preloader.activerecord_gte_7_0?
+        return if associations.empty?
+
+        # TODO: Change ActiveRecord async query
+        ActiveRecord::Associations::Preloader.new(records: objects, associations: associations).call
+      end
+
+      def execute_preload_callbacks # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/CyclomaticComplexity
+        callbacks.each do |association_chain, exposures_with_options|
+          association_objects = association_chain.inject(objects) do |items, association|
+            items.filter_map(&association).flatten(1)
+          end
+          next if association_objects.empty?
+
+          exposures_with_options.each do |exposure, options|
+            callback_objects = exposure.preload_callback.call(association_objects, options)
+            # Dynamic keys are difficult to handle and less used, skipped directly
+            next if !exposure.is_a?(Grape::Entity::Exposure::RepresentExposure) || exposure_with_dynamic_key?(exposure)
+
+            Preloader.new(
+              exposure.using_class.root_exposures,
+              callback_objects,
+              nesting_options(exposure, options)
+            ).call
+          end
+        end
+      end
+
+      def extract_preload_options(exposures, options, associations) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/MethodLength
+        exposures.each do |exposure|
+          next unless exposure.should_return_key?(options)
+          next if exposure.preload_condition && !exposure.preload_condition.call(options)
+
+          if exposure.preload_callback
+            callbacks[nested_association_chain.dup] << [exposure, options]
+          elsif exposure.preload_association && Preloader.activerecord_gte_7_0?
+            associations[exposure.preload_association] ||= {}
+          end
+
+          # Dynamic keys are difficult to handle and less used, skipped directly
+          next if exposure_with_dynamic_key?(exposure)
+
+          if exposure.is_a?(Grape::Entity::Exposure::NestingExposure)
+            extract_preload_options(
+              exposure.nested_exposures,
+              nesting_options(exposure, options),
+              associations
+            )
+          elsif exposure.is_a?(Grape::Entity::Exposure::RepresentExposure) && associations[exposure.preload_association]
+            nested_association_chain.push(exposure.preload_association)
+            extract_preload_options(
+              exposure.using_class.root_exposures,
+              nesting_options(exposure, options),
+              associations[exposure.preload_association]
+            )
+            nested_association_chain.pop
+          end
+        end
+      end
+
+      def nesting_options(exposure, options)
+        options.for_nesting(exposure.instance_variable_get(:@key))
+      end
+
+      def exposure_with_dynamic_key?(exposure)
+        exposure.instance_variable_get(:@key).respond_to?(:call)
+      end
+    end
+  end
+end

data/sig/grape/entity/preloader.rbs

@@ -0,0 +1,8 @@
+module Grape
+  module Entity
+    module Preloader
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

data/spec/grape/entity/preloader_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe Grape::Entity::Preloader do
+  it 'has a version number' do
+    expect(Grape::Entity::Preloader::VERSION).not_to be_nil
+  end
+end

data/spec/n_plus_one_op_spec.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+RSpec.describe 'N+1 operation' do # rubocop:disable RSpec/DescribeClass
+  before(:context) do
+    Grape::Entity::Preloader.enabled!
+
+    user1 = User.create(name: 'User1')
+    user2 = User.create(name: 'User2')
+
+    book1 = Book.create(name: 'Book1', author: user1)
+    book2 = Book.create(name: 'Book2', author: user2)
+
+    Tag.create(name: 'UserTag1', target: user1)
+    Tag.create(name: 'UserTag2', target: user1)
+
+    Tag.create(name: 'BookTag1', target: book1)
+    Tag.create(name: 'BookTag2', target: book2)
+  end
+
+  describe 'preloader enabled & disabled' do
+    let!(:books) { Book.all.load }
+
+    before do
+      Grape::Entity::Preloader.enabled = false # restore default value
+    end
+
+    describe 'enabled' do
+      it '.enabled!' do
+        Grape::Entity::Preloader.enabled!
+        expect(Grape::Entity::Preloader.enabled?).to be(true)
+
+        expect do
+          Book::Entity.represent(books, serializable: true, only: [:tags_by_association])
+        end.to make_database_queries(count: 1)
+           .and make_database_queries(
+             count: 1,
+             matching: /SELECT "tags".* FROM "tags" WHERE "tags"."target_type" = \? AND "tags"."target_id" IN/
+           )
+      end
+
+      it '.with_enable' do
+        Grape::Entity::Preloader.with_enable do
+          expect(Grape::Entity::Preloader.enabled?).to be(true)
+
+          expect do
+            Book::Entity.represent(books, serializable: true, only: [:tags_by_association])
+          end.to make_database_queries(count: 1)
+             .and make_database_queries(
+               count: 1,
+               matching: /SELECT "tags".* FROM "tags" WHERE "tags"."target_type" = \? AND "tags"."target_id" IN/
+             )
+        end
+
+        expect(Grape::Entity::Preloader.disabled?).to be(true)
+      end
+    end
+
+    describe 'disabled' do
+      it '.disabled!' do
+        Grape::Entity::Preloader.disabled!
+        expect(Grape::Entity::Preloader.disabled?).to be(true)
+
+        expect do
+          Book::Entity.represent(books, serializable: true, only: [:tags_by_association])
+        end.to make_database_queries(count: 2)
+           .and make_database_queries(
+             count: 2,
+             matching: /SELECT "tags".* FROM "tags" WHERE "tags"."target_id" = \? AND "tags"."target_type" = \?/
+           )
+      end
+
+      it '.with_disable' do
+        Grape::Entity::Preloader.enabled!
+        Grape::Entity::Preloader.with_disable do
+          expect(Grape::Entity::Preloader.disabled?).to be(true)
+
+          expect do
+            Book::Entity.represent(books, serializable: true, only: [:tags_by_association])
+          end.to make_database_queries(count: 2)
+             .and make_database_queries(
+               count: 2,
+               matching: /SELECT "tags".* FROM "tags" WHERE "tags"."target_id" = \? AND "tags"."target_type" = \?/
+             )
+        end
+        expect(Grape::Entity::Preloader.enabled?).to be(true)
+      end
+    end
+  end
+
+  describe 'preload' do
+    let!(:users) { User.all.load }
+    let!(:books) { Book.all.load }
+
+    describe 'association' do
+      it 'single' do
+        books = Book.all.load
+        expect do
+          Book::Entity.represent(books, serializable: true, only: %i[tags_by_association])
+        end.to make_database_queries(count: 1)
+          .and make_database_queries(count: 1, matching: /book_tags_by_association/)
+      end
+
+      it 'nested' do
+        expect do
+          User::Entity.represent(
+            users,
+            serializable: true,
+            only: [books_by_association: %i[tags_by_association tags_by_callback]]
+          )
+        end.to make_database_queries(count: 3)
+          .and make_database_queries(count: 1, matching: /user_books_by_association/)
+          .and make_database_queries(count: 1, matching: /book_tags_by_association/)
+          .and make_database_queries(count: 1, matching: /book_tags_by_callback/)
+      end
+
+      it 'same preload_association(single preload_association after nested preload_association)' do
+        options = {
+          serializable: true,
+          expose_books_count_by_association: true,
+          only: %i[books_count_by_association]
+        }
+
+        expect do
+          User::Entity.represent(users, options.dup)
+        end.to make_database_queries(count: 1)
+          .and make_database_queries(count: 1, matching: /user_books_by_association/)
+
+        users.map(&:reload)
+
+        options[:only] << { books_by_association: [:tags_by_association] }
+        expect do
+          User::Entity.represent(users, options.dup)
+        end.to make_database_queries(count: 2)
+          .and make_database_queries(count: 1, matching: /user_books_by_association/)
+          .and make_database_queries(count: 1, matching: /book_tags_by_association/)
+      end
+    end
+
+    describe 'callback' do
+      it 'single' do
+        expect do
+          Book::Entity.represent(books, serializable: true, only: %i[tags_by_callback])
+        end.to make_database_queries(count: 1)
+          .and make_database_queries(count: 1, matching: /book_tags_by_callback/)
+      end
+
+      it 'nested' do
+        expect do
+          User::Entity.represent(
+            users,
+            serializable: true,
+            only: [books_by_callback: %i[tags_by_association tags_by_callback]]
+          )
+        end.to make_database_queries(count: 3)
+          .and make_database_queries(count: 1, matching: /books_by_callback/)
+          .and make_database_queries(count: 1, matching: /book_tags_by_association/)
+          .and make_database_queries(count: 1, matching: /book_tags_by_callback/)
+      end
+    end
+
+    describe 'condition' do
+      it 'true' do
+        expect do
+          Book::Entity.represent(
+            books,
+            serializable: true,
+            expose_book_tags_count_by_association: true,
+            only: %i[tags_count_by_association]
+          )
+        end.to make_database_queries(count: 1)
+          .and make_database_queries(count: 1, matching: /book_tags_by_association/)
+      end
+
+      it 'false' do
+        expect do
+          Book::Entity.represent(
+            books,
+            serializable: true,
+            expose_book_tags_count_by_association: false,
+            only: %i[tags_count_by_association]
+          )
+        end.to make_database_queries(count: 2)
+          .and make_database_queries(count: 2, matching: /book_tags_by_association/)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'sqlite3'
+require 'active_record'
+require 'db-query-matchers'
+require 'grape/entity/preloader'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+# ActiveRecord::Base.logger = Logger.new($stdout)
+
+Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].sort.each { |f| require f }
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/support/models/application_record.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/support/models/book.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class Book < ApplicationRecord
+  include Grape::Entity::DSL
+
+  connection.create_table(:books, if_not_exists: true) do |t|
+    t.string :name
+    t.references :author
+  end
+
+  belongs_to :author, foreign_key: :author_id, class_name: 'User'
+  with_options(class_name: 'Tag', as: :target, dependent: :destroy) do |assoc|
+    assoc.has_many :tags_by_association, -> { annotate('book_tags_by_association') }
+    assoc.has_many :tags_by_callback, -> { annotate('book_tags_by_callback') }
+  end
+
+  entity do
+    expose :name
+    expose :tags_by_association, using: 'Tag::Entity', preload_association: :tags_by_association
+    expose :tags_by_callback, using: 'Tag::Entity', preload_callback: lambda { |objects, _options|
+      ActiveRecord::Associations::Preloader.new(
+        records: objects,
+        associations: :tags_by_callback
+      ).call.first.preloaded_records
+    }
+    expose :tags_count_by_association, preload_association: :tags_by_association,
+                                       preload_condition: ->(options) { options[:expose_book_tags_count_by_association] } # rubocop:disable Layout/LineLength
+    expose :tags_count_by_callback, preload_condition: ->(options) { options[:expose_book_tags_count_by_callback] },
+                                    preload_callback: lambda { |objects, _options|
+                                      ActiveRecord::Associations::Preloader.new(
+                                        records: objects,
+                                        associations: :tags_by_callback
+                                      ).call.first.preloaded_records
+                                    }
+
+    def tags_count_by_association
+      object.tags_by_association.size
+    end
+
+    def tags_count_by_callback
+      object.tags_by_callback.size
+    end
+  end
+end

data/spec/support/models/tag.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class Tag < ApplicationRecord
+  include Grape::Entity::DSL
+
+  connection.create_table(:tags, if_not_exists: true) do |t|
+    t.string :name
+    t.references :target, polymorphic: true
+  end
+
+  belongs_to :target, polymorphic: true
+
+  entity do
+    expose :name
+  end
+end

data/spec/support/models/user.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+class User < ApplicationRecord
+  include Grape::Entity::DSL
+
+  connection.create_table(:users, if_not_exists: true) do |t|
+    t.string :name
+  end
+
+  with_options(class_name: 'Book', foreign_key: :author_id, dependent: :destroy) do |assoc|
+    assoc.has_many :books_by_association, -> { annotate('user_books_by_association') }
+    assoc.has_many :books_by_callback, -> { annotate('user_books_by_callback') }
+  end
+
+  with_options(class_name: 'Tag', as: :target, dependent: :destroy) do |assoc|
+    assoc.has_many :tags_by_association, -> { annotate('user_tags_by_association') }
+    assoc.has_many :tags_by_callback, -> { annotate('user_tags_by_callback') }
+  end
+
+  entity do
+    expose :name
+
+    expose :books_by_association, using: 'Book::Entity', preload_association: :books_by_association
+    expose :books_by_callback, using: 'Book::Entity', preload_callback: lambda { |objects, _options|
+      ActiveRecord::Associations::Preloader.new(
+        records: objects,
+        associations: :books_by_callback
+      ).call.first.preloaded_records
+    }
+    expose :books_count_by_association, preload_association: :books_by_association,
+                                        preload_condition: ->(options) { options[:expose_books_count_by_association] }
+    expose :books_count_by_callback, preload_condition: ->(options) { options[:expose_books_count_by_callback] },
+                                     preload_callback: lambda { |objects, _options|
+                                       ActiveRecord::Associations::Preloader.new(
+                                         records: objects,
+                                         associations: :books_by_callback
+                                       ).call.first.preloaded_records
+                                     }
+
+    expose :tags_by_association, using: 'Tag::Entity', preload_association: :tags_by_association
+    expose :tags_by_callback, using: 'Tag::Entity', preload_callback: lambda { |objects, _options|
+      ActiveRecord::Associations::Preloader.new(
+        records: objects,
+        associations: :tags_by_callback
+      ).call.first.preloaded_records
+    }
+    expose :tags_count_by_association, preload_association: :tags_by_association,
+                                       preload_condition: ->(options) { options[:expose_user_tags_count_by_association] } # rubocop:disable Layout/LineLength
+    expose :tags_count_by_callback, preload_condition: ->(options) { options[:expose_user_tags_count_by_callback] },
+                                    preload_callback: lambda { |objects, _options|
+                                      ActiveRecord::Associations::Preloader.new(
+                                        records: objects,
+                                        associations: :tags_by_callback
+                                      ).call.first.preloaded_records
+                                    }
+
+    def books_count_by_association
+      object.books_by_association.size
+    end
+
+    def books_count_by_callback
+      object.books_by_callback.size
+    end
+
+    def tags_count_by_association
+      object.tags_by_association.size
+    end
+
+    def tags_count_by_callback
+      object.tags_by_callback.size
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: grape-entity-preloader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- OuYangJinTing
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape-entity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Grape::Entity::Preloader allows preload associations and callbacks for
+  avoiding N+1 operations in Grape::Entity.
+email:
+- Ou.Yang.Jin.Ting.X@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/grape/entity/preloader.rb
+- lib/grape/entity/preloader/entity.rb
+- lib/grape/entity/preloader/exposure/base.rb
+- lib/grape/entity/preloader/options.rb
+- lib/grape/entity/preloader/version.rb
+- sig/grape/entity/preloader.rbs
+- spec/grape/entity/preloader_spec.rb
+- spec/n_plus_one_op_spec.rb
+- spec/spec_helper.rb
+- spec/support/models/application_record.rb
+- spec/support/models/book.rb
+- spec/support/models/tag.rb
+- spec/support/models/user.rb
+homepage: https://github.com/OuYangJinTing/grape-entity-preloader
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/OuYangJinTing/grape-entity-preloader
+  source_code_uri: https://github.com/OuYangJinTing/grape-entity-preloader
+  changelog_uri: https://github.com/OuYangJinTing/grape-entity-preloader/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Grape::Entity::Preloader allows preload associations and callbacks for avoiding
+  N+1 operations in Grape::Entity.
+test_files: []