grape-entity-preloader 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d32cc4a359717abe3519c7f8bee48d9e35029d1348057a7fa35b043594dd1b5
-  data.tar.gz: 9ef42ce05db679a5cf7830aeaae698b1557452957648e668ced0ced0cd1e4a3a
+  metadata.gz: 4435d853f0ac2438cbd9def7d195a78e4ce66dcfc0db4015b29f20c5102846b6
+  data.tar.gz: 2bde5dbb73a91201040bc0e21da30507638c1b61e164e494a6187dacc1ab328d
 SHA512:
-  metadata.gz: e9101088f6433f7372ad46b061c34341553259a91a3f903ec1d2dde1112bd2e2d944aec61fcb4ba1ac5ae5828719b3d9eb9dfda88134351e739982e8a8e03149
-  data.tar.gz: 6d46c749603a41caff0bec514091adc6b630d521c2d0b84aa62f879f76058b4d81185a493f1684eb5f54548290d702462a946cd1c3617af420fd469f16bb023a
+  metadata.gz: 36b9c7316b3cb852024039a2db9ffe0c55215f49c60614b49c95a23a1bf307432b8e564c8c09cd3b56b71a4ed5f212e5fbd756e87675901407acb8acd5a8b642
+  data.tar.gz: 8f9c9b1ed336765001069d34ab27e7b80e5a94d6a829ffd276ff501785ed15d4a8f43d9cdf762c6a79603487e16ddff00669e0a2222833c091e8ff8ebd7a6532

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.2.0] - 2025-10-14 UTC
+
+- ⚠️ [Broken] Remove `:grape_entity_preloader` option functionality, please use `Grape::Entity::Preloader.with_enable` or `Grape::Entity::Preloader.with_disable` instead.
+
 ## [0.1.0] - 2025-10-12 UTC
 
 - Initial release

data/README.md

@@ -1,5 +1,8 @@
 # Grape::Entity::Preloader
 
+[![Ruby](https://github.com/OuYangJinTing/grape-entity-preloader/actions/workflows/main.yml/badge.svg)](https://github.com/OuYangJinTing/grape-entity-preloader/actions/workflows/main.yml)
+[![Gem Version](https://badge.fury.io/rb/grape-entity-preloader.svg?icon=si%3Arubygems&icon_color=%23ff0000)](https://badge.fury.io/rb/grape-entity-preloader)
+
 Grape::Entity::Preloader allows preload associations and callbacks for avoiding N+1 operations in Grape::Entity.
 
 ## Installation
@@ -30,21 +33,6 @@ 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

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

@@ -10,11 +10,8 @@ module Grape
           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)
+            Preloader.new(root_exposures, objects, options).call if Preloader.enabled?
+            Preloader.with_disable { super(objects, options) }
           end
         end
       end

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

@@ -3,7 +3,7 @@
 module Grape
   class Entity
     class Preloader
-      VERSION = '0.1.0'
+      VERSION = '0.3.0'
     end
   end
 end

data/lib/grape/entity/preloader.rb

@@ -26,18 +26,20 @@ module Grape
         end
       end
 
-      def self.with_enable
+      def self.with_enable # rubocop:disable Metrics/MethodLength
         return yield if enabled?
 
-        old_value = ActiveSupport::IsolatedExecutionState[:grape_entity_preloader]
-        ActiveSupport::IsolatedExecutionState[:grape_entity_preloader] = true
+        begin
+          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
+          yield
+        ensure
+          if old_value.nil?
+            ActiveSupport::IsolatedExecutionState.delete(:grape_entity_preloader)
+          else
+            ActiveSupport::IsolatedExecutionState[:grape_entity_preloader] = old_value
+          end
         end
       end
 
@@ -49,18 +51,20 @@ module Grape
         !enabled?
       end
 
-      def self.with_disable
+      def self.with_disable # rubocop:disable Metrics/MethodLength
         return yield if disabled?
 
-        old_value = ActiveSupport::IsolatedExecutionState[:grape_entity_preloader]
-        ActiveSupport::IsolatedExecutionState[:grape_entity_preloader] = false
+        begin
+          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
+          yield
+        ensure
+          if old_value.nil?
+            ActiveSupport::IsolatedExecutionState.delete(:grape_entity_preloader)
+          else
+            ActiveSupport::IsolatedExecutionState[:grape_entity_preloader] = old_value
+          end
         end
       end
 

data/spec/grape/entity/preloader_spec.rb

@@ -4,4 +4,32 @@ RSpec.describe Grape::Entity::Preloader do
   it 'has a version number' do
     expect(Grape::Entity::Preloader::VERSION).not_to be_nil
   end
+
+  describe '.with_enable' do
+    it 'returns the value of the block' do
+      result = described_class.with_enable { 42 }
+      expect(result).to eq(42)
+    end
+
+    it 'returns the value of the block when already enabled' do
+      described_class.enabled!
+      result = described_class.with_enable { 'hello' }
+      expect(result).to eq('hello')
+    ensure
+      described_class.disabled!
+    end
+  end
+
+  describe '.with_disable' do
+    it 'returns the value of the block' do
+      result = described_class.with_disable { 42 }
+      expect(result).to eq(42)
+    end
+
+    it 'returns the value of the block when already disabled' do
+      described_class.disabled!
+      result = described_class.with_disable { 'hello' }
+      expect(result).to eq('hello')
+    end
+  end
 end

data/spec/n_plus_one_op_spec.rb

@@ -105,7 +105,7 @@ RSpec.describe 'N+1 operation' do # rubocop:disable RSpec/DescribeClass
           User::Entity.represent(
             users,
             serializable: true,
-            only: [books_by_association: %i[tags_by_association tags_by_callback]]
+            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/)
@@ -121,7 +121,7 @@ RSpec.describe 'N+1 operation' do # rubocop:disable RSpec/DescribeClass
         }
 
         expect do
-          User::Entity.represent(users, options.dup)
+          User::Entity.represent(users, options)
         end.to make_database_queries(count: 1)
           .and make_database_queries(count: 1, matching: /user_books_by_association/)
 
@@ -129,7 +129,7 @@ RSpec.describe 'N+1 operation' do # rubocop:disable RSpec/DescribeClass
 
         options[:only] << { books_by_association: [:tags_by_association] }
         expect do
-          User::Entity.represent(users, options.dup)
+          User::Entity.represent(users, options)
         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/)
@@ -149,7 +149,7 @@ RSpec.describe 'N+1 operation' do # rubocop:disable RSpec/DescribeClass
           User::Entity.represent(
             users,
             serializable: true,
-            only: [books_by_callback: %i[tags_by_association tags_by_callback]]
+            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/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-entity-preloader
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - OuYangJinTing