bullet 7.0.0 → 7.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fbdfd6fe2f412c6632b877352fdf912b56fd54e255101dc16ae414a218fc2ee
-  data.tar.gz: 0a765e969ccae1ef685051350324052225fea00e80d7d37a6b8cce6d8ad1f28e
+  metadata.gz: 823bcc1af2be934ec4f10df71ea2951223834d3146e9c323afada99ba4ae4254
+  data.tar.gz: 4cda048b45bd219d62bee22e0041027561c943d283ee262ea71686a15e6e4345
 SHA512:
-  metadata.gz: 35c561cc6534f355a56d1aa0e880bb51941c126ce8a9c704bbc8c0f59c67cf5890a00d650919d5a458a913f4d6a125b17e57c92130d48baa9b6a90db190db763
-  data.tar.gz: 4f29d4316862401ad1d5d4edfdf21f6f8045a37e21acc4d12f3cdd80e528b12924a9f0a2ab5fdb366432ea5c8e656210887112fc338da8539a34586da88710e9
+  metadata.gz: 9a2398eb23da7201bb8ab3fb1dbea3d48089d6c51d4a0e473d25009841aab41c68a5b0c27fb6ac6b77084e2465a836a5b848ffda63a2ea3b457a9571b04d428f
+  data.tar.gz: ab3debd03dc9cafbbd8ef9237f747c67d14bf3d8bf116b7dbed4e145176cf3f10045862b32641036e9bb00caca6eee841c75f9b3defad83ca681d0d70a5c6f0d

data/.github/workflows/main.yml

@@ -76,7 +76,7 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0
+        ruby-version: 3.1
         bundler-cache: true
     - name: Run tests
       run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Next Release
 
+## 7.0.1 (01/15/2022)
+
+* Get rid of *_whitelist methods
+* Hack ActiveRecord::Associations::Preloader::Batch in rails 7
+
 ## 7.0.0 (12/18/2021)
 
 * Support rails 7

data/README.md

@@ -270,8 +270,7 @@ Bullet outputs some details info, to enable debug mode, set
 ## Demo
 
 Bullet is designed to function as you browse through your application in development. To see it in action,
-you can visit [https://github.com/flyerhzm/bullet_test](https://github.com/flyerhzm/bullet_test) or
-follow these steps to create, detect, and fix example query problems.
+you can follow these steps to create, detect, and fix example query problems.
 
 1\. Create an example application
 
@@ -482,4 +481,4 @@ Meanwhile, there's a line appended to `log/bullet.log`
   Post => [:comments]
 ```
 
-Copyright (c) 2009 - 2019 Richard Huang (flyerhzm@gmail.com), released under the MIT license
+Copyright (c) 2009 - 2022 Richard Huang (flyerhzm@gmail.com), released under the MIT license

data/lib/bullet/active_record70.rb

@@ -60,6 +60,20 @@ module Bullet
         end
       )
 
+      ::ActiveRecord::Associations::Preloader::Batch.prepend(
+        Module.new do
+          def call
+            if Bullet.start?
+              @preloaders.each do |preloader|
+                preloader.records.each { |record| Bullet::Detector::Association.add_object_associations(record, preloader.associations) }
+                Bullet::Detector::UnusedEagerLoading.add_eager_loadings(preloader.records, preloader.associations)
+              end
+            end
+            super
+          end
+        end
+      )
+
       ::ActiveRecord::Associations::Preloader::Branch.prepend(
         Module.new do
           def preloaders_for_reflection(reflection, reflection_records)

data/lib/bullet/rack.rb

@@ -42,6 +42,7 @@ module Bullet
     def empty?(response)
       # response may be ["Not Found"], ["Move Permanently"], etc, but
       # those should not happen if the status is 200
+      return true if !response.respond_to?(:body) && !response.respond_to?(:first)
       body = response_body(response)
       body.nil? || body.empty?
     end

data/lib/bullet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bullet
-  VERSION = '7.0.0'
+  VERSION = '7.0.1'
 end

data/lib/bullet.rb

@@ -120,51 +120,6 @@ module Bullet
       @safelist = nil
     end
 
-    def add_whitelist(options)
-      ActiveSupport::Deprecation.warn(<<~WARN.strip
-        add_whitelist is deprecated in favor of add_safelist. It will be removed from the next major release.
-        WARN
-      )
-
-      add_safelist(options)
-    end
-
-    def delete_whitelist(options)
-      ActiveSupport::Deprecation.warn(<<~WARN.strip
-        delete_whitelist is deprecated in favor of delete_safelist. It will be removed from the next major release.
-        WARN
-      )
-
-      delete_safelist(options)
-    end
-
-    def get_whitelist_associations(type, class_name)
-      ActiveSupport::Deprecation.warn(<<~WARN.strip
-        get_whitelist_associations is deprecated in favor of get_safelist_associations. It will be removed from the next major release.
-        WARN
-      )
-
-      get_safelist_associations(type, class_name)
-    end
-
-    def reset_whitelist
-      ActiveSupport::Deprecation.warn(<<~WARN.strip
-        reset_whitelist is deprecated in favor of reset_safelist. It will be removed from the next major release.
-        WARN
-      )
-
-      reset_safelist
-    end
-
-    def clear_whitelist
-      ActiveSupport::Deprecation.warn(<<~WARN.strip
-        clear_whitelist is deprecated in favor of clear_safelist. It will be removed from the next major release.
-        WARN
-      )
-
-      clear_safelist
-    end
-
     def bullet_logger=(active)
       if active
         require 'fileutils'

data/spec/bullet/rack_spec.rb

@@ -54,6 +54,11 @@ module Bullet
         response = double(body: '')
         expect(middleware).to be_empty(response)
       end
+
+      it 'should be true if no response body' do
+        response = double()
+        expect(middleware).to be_empty(response)
+      end
     end
 
     context '#call' do

data/spec/bullet_spec.rb

@@ -83,15 +83,6 @@ describe Bullet, focused: true do
     end
   end
 
-  describe '#add_whitelist' do
-    context "for 'special' class names" do
-      it 'is added to the safelist successfully' do
-        Bullet.add_whitelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
-        expect(Bullet.get_safelist_associations(:n_plus_one_query, 'Klass')).to include :department
-      end
-    end
-  end
-
   describe '#delete_safelist' do
     context "for 'special' class names" do
       it 'is deleted from the safelist successfully' do
@@ -112,26 +103,6 @@ describe Bullet, focused: true do
     end
   end
 
-  describe '#delete_whitelist' do
-    context "for 'special' class names" do
-      it 'is deleted from the safelist successfully' do
-        Bullet.add_safelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
-        Bullet.delete_whitelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
-        expect(Bullet.safelist[:n_plus_one_query]).to eq({})
-      end
-    end
-
-    context 'when exists multiple definitions' do
-      it 'is deleted from the safelist successfully' do
-        Bullet.add_safelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
-        Bullet.add_safelist(type: :n_plus_one_query, class_name: 'Klass', association: :team)
-        Bullet.delete_whitelist(type: :n_plus_one_query, class_name: 'Klass', association: :team)
-        expect(Bullet.get_safelist_associations(:n_plus_one_query, 'Klass')).to include :department
-        expect(Bullet.get_safelist_associations(:n_plus_one_query, 'Klass')).to_not include :team
-      end
-    end
-  end
-
   describe '#perform_out_of_channel_notifications' do
     let(:notification) { double }
 

data/spec/integration/active_record/association_spec.rb

@@ -451,6 +451,16 @@ if active_record?
         expect(Bullet::Detector::Association).to be_detecting_unpreloaded_association_for(Student, :teachers)
       end
     end
+
+    context 'user => roles' do
+      it 'should detect preload associations' do
+        User.first.roles.includes(:resource).each { |role| role.resource }
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+        expect(Bullet::Detector::Association).to be_completely_preloading_associations
+      end
+    end
   end
 
   describe Bullet::Detector::Association, 'has_many :through' do

data/spec/models/role.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Role < ActiveRecord::Base
+  has_and_belongs_to_many :users
+
+  belongs_to :resource, polymorphic: true
+end

data/spec/models/user.rb

@@ -4,4 +4,5 @@ class User < ActiveRecord::Base
   has_one :submission
   has_one :submission_attachment, through: :submission, source: :attachment, class_name: 'Attachment'
   belongs_to :category
+  has_and_belongs_to_many :roles
 end

data/spec/support/sqlite_seed.rb

@@ -92,9 +92,16 @@ module Support
       page3 = Page.create(name: 'page3', parent_id: folder2.id, author_id: author2.id)
       page4 = Page.create(name: 'page4', parent_id: folder2.id, author_id: author2.id)
 
+      role1 = Role.create(name: 'Amdin')
+      role2 = Role.create(name: 'User')
+
       user1 = User.create(name: 'user1', category: category1)
       user2 = User.create(name: 'user2', category: category1)
 
+      user1.roles << role1
+      user1.roles << role2
+      user2.roles << role2
+
       submission1 = user1.create_submission(name: 'submission1')
       submission2 = user2.create_submission(name: 'submission2')
 
@@ -246,6 +253,17 @@ module Support
           t.column :submission_id, :integer
         end
 
+        create_table :roles do |t|
+          t.column :name, :string
+          t.column :resource_id, :integer
+          t.column :resource_type, :string
+        end
+
+        create_table :roles_users do |t|
+          t.column :role_id, :integer
+          t.column :user_id, :integer
+        end
+
         create_table :submissions do |t|
           t.column :name, :string
           t.column :user_id, :integer

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.0.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-18 00:00:00.000000000 Z
+date: 2022-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -160,6 +160,7 @@ files:
 - spec/models/post.rb
 - spec/models/relationship.rb
 - spec/models/reply.rb
+- spec/models/role.rb
 - spec/models/student.rb
 - spec/models/submission.rb
 - spec/models/teacher.rb
@@ -194,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: help to kill N+1 queries and unused eager loading.
@@ -249,6 +250,7 @@ test_files:
 - spec/models/post.rb
 - spec/models/relationship.rb
 - spec/models/reply.rb
+- spec/models/role.rb
 - spec/models/student.rb
 - spec/models/submission.rb
 - spec/models/teacher.rb