bullet 6.1.4 → 6.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74ea4e863bfe254dde17af73253ffe7041cd2b2dabee2dad05d1eccb6904f229
-  data.tar.gz: 284dcd1a516922384bdaf1b3dd9e6a5e6776c213c3ecbc9ca41b223c5b92d36b
+  metadata.gz: b21c2c4ca3caf6c41961a7182a5c8d37f6b89aa78b8dfb7badfb940f11a23191
+  data.tar.gz: 0f432034f9b4cb2fe6c6572481c797aefcfa69373839fbd0985a7efd2a0bbea9
 SHA512:
-  metadata.gz: 26c43bfdac9582f059d067d4f56d4d85ed28416654ff5fd4686bf9977cbfbc8d92f887079954662e904fbe3d1b861d02482ac2fefac30a859fbdad8c3833e225
-  data.tar.gz: 48decfa9d28b9936f5c1f39c669b6e8061fae649f9036c29d4b28138083a43db8739f3b73bb9c390e9f6baea62aa1f66f79e8ced69cf13e789b8f116c101f25f
+  metadata.gz: d2457987f11f034fa457030cf7161d7508fb26230cf9e88a2571c54a934ad9a1330b48dd3d38eede3033bd7ef6c920e564dcbfa43a15354bf72d14ed799aefe2
+  data.tar.gz: ed6690fcb3bd778d6d5a27538a0ee78d298c749be1e445c305b9884448ca13f97e5a62c76ac48229a250041bb09ba609d6b154b12cf42a0f3dca66fbb9c83021

data/.github/workflows/main.yml

@@ -0,0 +1,66 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test_rails_4:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        gemfile: ['Gemfile.rails-4.0', 'Gemfile.rails-4.1', 'Gemfile.rails-4.2']
+    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.3
+        bundler: 1
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake
+  test_rails_5:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        gemfile: ['Gemfile.rails-5.0', 'Gemfile.rails-5.1', 'Gemfile.rails-5.2']
+    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.5
+        bundler: 1
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake
+  test_rails_6:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        gemfile: ['Gemfile.rails-6.0', 'Gemfile.rails-6.1']
+    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Next Release
 
+## 6.1.5 (08/16/2021)
+
+* Rename whitelist to safelist
+* Fix onload called twice
+* Support Rack::Files::Iterator responses
+* Ensure HABTM associations are not incorrectly labeled n+1
+
 ## 6.1.4 (02/26/2021)
 
 * Added an option to stop adding HTTP headers to API requests

data/README.md

@@ -1,7 +1,7 @@
 # Bullet
 
+![Main workflow](https://github.com/flyerhzm/bullet/actions/workflows/main.yml/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/bullet.svg)](http://badge.fury.io/rb/bullet)
-[![Build Status](https://secure.travis-ci.org/flyerhzm/bullet.svg)](http://travis-ci.org/flyerhzm/bullet)
 [![AwesomeCode Status for flyerhzm/bullet](https://awesomecode.io/projects/6755235b-e2c1-459e-bf92-b8b13d0c0472/status)](https://awesomecode.io/repos/flyerhzm/bullet)
 [![Coderwall Endorse](http://api.coderwall.com/flyerhzm/endorsecount.png)](http://coderwall.com/flyerhzm)
 
@@ -67,6 +67,7 @@ config.after_initialize do
   Bullet.rails_logger = true
   Bullet.honeybadger = true
   Bullet.bugsnag = true
+  Bullet.appsignal = true
   Bullet.airbrake = true
   Bullet.rollbar = true
   Bullet.add_footer = true
@@ -90,6 +91,7 @@ The code above will enable all of the Bullet notification systems:
 * `Bullet.honeybadger`: add notifications to Honeybadger
 * `Bullet.bugsnag`: add notifications to bugsnag
 * `Bullet.airbrake`: add notifications to airbrake
+* `Bullet.appsignal`: add notifications to AppSignal
 * `Bullet.rollbar`: add notifications to rollbar
 * `Bullet.sentry`: add notifications to sentry
 * `Bullet.add_footer`: adds the details in the bottom left corner of the page. Double click the footer or use close button to hide footer.
@@ -119,15 +121,15 @@ Bullet.unused_eager_loading_enable = false
 Bullet.counter_cache_enable        = false
 ```
 
-## Whitelist
+## Safe list
 
 Sometimes Bullet may notify you of query problems you don't care to fix, or
-which come from outside your code. You can whitelist these to ignore them:
+which come from outside your code. You can add them to a safe list to ignore them:
 
 ```ruby
-Bullet.add_whitelist :type => :n_plus_one_query, :class_name => "Post", :association => :comments
-Bullet.add_whitelist :type => :unused_eager_loading, :class_name => "Post", :association => :comments
-Bullet.add_whitelist :type => :counter_cache, :class_name => "Country", :association => :cities
+Bullet.add_safelist :type => :n_plus_one_query, :class_name => "Post", :association => :comments
+Bullet.add_safelist :type => :unused_eager_loading, :class_name => "Post", :association => :comments
+Bullet.add_safelist :type => :counter_cache, :class_name => "Country", :association => :cities
 ```
 
 If you want to skip bullet in some specific controller actions, you can

data/lib/bullet.rb

@@ -20,9 +20,6 @@ module Bullet
   autoload :Registry, 'bullet/registry'
   autoload :NotificationCollector, 'bullet/notification_collector'
 
-  BULLET_DEBUG = 'BULLET_DEBUG'
-  TRUE = 'true'
-
   if defined?(Rails::Railtie)
     class BulletRailtie < Rails::Railtie
       initializer 'bullet.configure_rails_initialization' do |app|
@@ -38,10 +35,11 @@ module Bullet
                 :stacktrace_includes,
                 :stacktrace_excludes,
                 :skip_html_injection
-    attr_reader :whitelist
+    attr_reader :safelist
     attr_accessor :add_footer, :orm_patches_applied, :skip_http_headers
 
-    available_notifiers = UniformNotifier::AVAILABLE_NOTIFIERS.select { |notifier| notifier != :raise }.map { |notifier| "#{notifier}=" }
+    available_notifiers =
+      UniformNotifier::AVAILABLE_NOTIFIERS.select { |notifier| notifier != :raise }.map { |notifier| "#{notifier}=" }
     available_notifiers_options = { to: UniformNotifier }
     delegate(*available_notifiers, **available_notifiers_options)
 
@@ -59,7 +57,7 @@ module Bullet
       @enable = @n_plus_one_query_enable = @unused_eager_loading_enable = @counter_cache_enable = enable
 
       if enable?
-        reset_whitelist
+        reset_safelist
         unless orm_patches_applied
           self.orm_patches_applied = true
           Bullet::Mongoid.enable if mongoid?
@@ -72,8 +70,9 @@ module Bullet
       !!@enable
     end
 
+    # Rails.root might be nil if `railties` is a dependency on a project that does not use Rails
     def app_root
-      @app_root ||= (defined?(::Rails.root) ? Rails.root.to_s : Dir.pwd).to_s
+      @app_root ||= (defined?(::Rails.root) && !::Rails.root.nil? ? Rails.root.to_s : Dir.pwd).to_s
     end
 
     def n_plus_one_query_enable?
@@ -96,29 +95,74 @@ module Bullet
       @stacktrace_excludes ||= []
     end
 
+    def add_safelist(options)
+      reset_safelist
+      @safelist[options[:type]][options[:class_name]] ||= []
+      @safelist[options[:type]][options[:class_name]] << options[:association].to_sym
+    end
+
+    def delete_safelist(options)
+      reset_safelist
+      @safelist[options[:type]][options[:class_name]] ||= []
+      @safelist[options[:type]][options[:class_name]].delete(options[:association].to_sym)
+      @safelist[options[:type]].delete_if { |_key, val| val.empty? }
+    end
+
+    def get_safelist_associations(type, class_name)
+      Array(@safelist[type][class_name])
+    end
+
+    def reset_safelist
+      @safelist ||= { n_plus_one_query: {}, unused_eager_loading: {}, counter_cache: {} }
+    end
+
+    def clear_safelist
+      @safelist = nil
+    end
+
     def add_whitelist(options)
-      reset_whitelist
-      @whitelist[options[:type]][options[:class_name]] ||= []
-      @whitelist[options[:type]][options[:class_name]] << options[:association].to_sym
+      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)
-      reset_whitelist
-      @whitelist[options[:type]][options[:class_name]] ||= []
-      @whitelist[options[:type]][options[:class_name]].delete(options[:association].to_sym)
-      @whitelist[options[:type]].delete_if { |_key, val| val.empty? }
+      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)
-      Array(@whitelist[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
-      @whitelist ||= { n_plus_one_query: {}, unused_eager_loading: {}, counter_cache: {} }
+      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
-      @whitelist = nil
+      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)
@@ -132,7 +176,7 @@ module Bullet
     end
 
     def debug(title, message)
-      puts "[Bullet][#{title}] #{message}" if ENV[BULLET_DEBUG] == TRUE
+      puts "[Bullet][#{title}] #{message}" if ENV['BULLET_DEBUG'] == 'true'
     end
 
     def start_request

data/lib/bullet/active_record41.rb

@@ -30,6 +30,7 @@ module Bullet
 
       ::ActiveRecord::Relation.class_eval do
         alias_method :origin_to_a, :to_a
+
         # if select a collection of objects, then these objects have possible to cause N+1 query.
         # if select only one object, then the only one object has impossible to cause N+1 query.
         def to_a

data/lib/bullet/active_record42.rb

@@ -52,6 +52,7 @@ module Bullet
 
       ::ActiveRecord::Relation.class_eval do
         alias_method :origin_to_a, :to_a
+
         # if select a collection of objects, then these objects have possible to cause N+1 query.
         # if select only one object, then the only one object has impossible to cause N+1 query.
         def to_a

data/lib/bullet/bullet_xhr.js

@@ -20,6 +20,7 @@
     if (this.onload) {
       this._storedOnload = this.onload;
     }
+    this.onload = null
     this.addEventListener("load", bulletXHROnload);
     return Reflect.apply(oldSend, this, arguments);
   }

data/lib/bullet/detector/base.rb

@@ -2,6 +2,7 @@
 
 module Bullet
   module Detector
-    class Base; end
+    class Base
+    end
   end
 end

data/lib/bullet/detector/counter_cache.rb

@@ -54,7 +54,7 @@ module Bullet
         private
 
         def create_notification(klazz, associations)
-          notify_associations = Array(associations) - Bullet.get_whitelist_associations(:counter_cache, klazz)
+          notify_associations = Array(associations) - Bullet.get_safelist_associations(:counter_cache, klazz)
 
           if notify_associations.present?
             notice = Bullet::Notification::CounterCache.new klazz, notify_associations

data/lib/bullet/detector/n_plus_one_query.rb

@@ -35,6 +35,7 @@ module Bullet
 
           objects = Array(object_or_objects)
           return if objects.map(&:bullet_primary_key_value).compact.empty?
+          return if objects.all? { |obj| obj.class.name =~ /^HABTM_/ }
 
           Bullet.debug(
             'Detector::NPlusOneQuery#add_possible_objects',
@@ -84,8 +85,7 @@ module Bullet
             # associations == v comparison order is important here because
             # v variable might be a squeel node where :== method is redefined,
             # so it does not compare values at all and return unexpected results
-            result =
-              v.is_a?(Hash) ? v.key?(associations) : associations == v
+            result = v.is_a?(Hash) ? v.key?(associations) : associations == v
             return true if result
           end
 
@@ -95,7 +95,7 @@ module Bullet
         private
 
         def create_notification(callers, klazz, associations)
-          notify_associations = Array(associations) - Bullet.get_whitelist_associations(:n_plus_one_query, klazz)
+          notify_associations = Array(associations) - Bullet.get_safelist_associations(:n_plus_one_query, klazz)
 
           if notify_associations.present?
             notice = Bullet::Notification::NPlusOneQuery.new(callers, klazz, notify_associations)

data/lib/bullet/detector/unused_eager_loading.rb

@@ -65,7 +65,7 @@ module Bullet
         private
 
         def create_notification(callers, klazz, associations)
-          notify_associations = Array(associations) - Bullet.get_whitelist_associations(:unused_eager_loading, klazz)
+          notify_associations = Array(associations) - Bullet.get_safelist_associations(:unused_eager_loading, klazz)
 
           if notify_associations.present?
             notice = Bullet::Notification::UnusedEagerLoading.new(callers, klazz, notify_associations)

data/lib/bullet/notification.rb

@@ -7,6 +7,7 @@ module Bullet
     autoload :NPlusOneQuery, 'bullet/notification/n_plus_one_query'
     autoload :CounterCache, 'bullet/notification/counter_cache'
 
-    class UnoptimizedQueryError < StandardError; end
+    class UnoptimizedQueryError < StandardError
+    end
   end
 end

data/lib/bullet/rack.rb

@@ -22,7 +22,9 @@ module Bullet
             response_body = response_body(response)
             response_body = append_to_html_body(response_body, footer_note) if Bullet.add_footer
             response_body = append_to_html_body(response_body, Bullet.gather_inline_notifications)
-            response_body = append_to_html_body(response_body, xhr_script) if Bullet.add_footer && !Bullet.skip_http_headers
+            if Bullet.add_footer && !Bullet.skip_http_headers
+              response_body = append_to_html_body(response_body, xhr_script)
+            end
             headers['Content-Length'] = response_body.bytesize.to_s
           elsif !Bullet.skip_http_headers
             set_header(headers, 'X-bullet-footer-text', Bullet.footer_info.uniq) if Bullet.add_footer
@@ -82,7 +84,7 @@ module Bullet
     def response_body(response)
       if response.respond_to?(:body)
         Array === response.body ? response.body.first : response.body
-      else
+      elsif response.respond_to?(:first)
         response.first
       end
     end

data/lib/bullet/stack_trace_filter.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require "bundler"
 
 module Bullet
   module StackTraceFilter
@@ -11,8 +12,9 @@ module Bullet
       select_caller_locations do |location|
         caller_path = location_as_path(location)
         caller_path.include?(Bullet.app_root) && !caller_path.include?(vendor_root) &&
-          !caller_path.include?(bundler_path) ||
-          Bullet.stacktrace_includes.any? { |include_pattern| pattern_matches?(location, include_pattern) }
+          !caller_path.include?(bundler_path) || Bullet.stacktrace_includes.any? { |include_pattern|
+          pattern_matches?(location, include_pattern)
+        }
       end
     end
 

data/lib/bullet/version.rb

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

data/perf/benchmark.rb

@@ -30,7 +30,10 @@ end
 
 # create database bullet_benchmark;
 ActiveRecord::Base.establish_connection(
-  adapter: 'mysql2', database: 'bullet_benchmark', server: '/tmp/mysql.socket', username: 'root'
+  adapter: 'mysql2',
+  database: 'bullet_benchmark',
+  server: '/tmp/mysql.socket',
+  username: 'root'
 )
 
 ActiveRecord::Base.connection.tables.each { |table| ActiveRecord::Base.connection.drop_table(table) }

data/spec/bullet/detector/unused_eager_loading_spec.rb

@@ -19,7 +19,9 @@ module Bullet
         it 'should get call associations if object and association are both in eager_loadings and call_object_associations' do
           UnusedEagerLoading.add_eager_loadings([@post], :association)
           UnusedEagerLoading.add_call_object_associations(@post, :association)
-          expect(UnusedEagerLoading.send(:call_associations, @post.bullet_key, Set.new([:association]))).to eq([:association])
+          expect(UnusedEagerLoading.send(:call_associations, @post.bullet_key, Set.new([:association]))).to eq(
+            [:association]
+          )
         end
 
         it 'should not get call associations if not exist in call_object_associations' do
@@ -30,7 +32,9 @@ module Bullet
 
       context '.diff_object_associations' do
         it 'should return associations not exist in call_association' do
-          expect(UnusedEagerLoading.send(:diff_object_associations, @post.bullet_key, Set.new([:association]))).to eq([:association])
+          expect(UnusedEagerLoading.send(:diff_object_associations, @post.bullet_key, Set.new([:association]))).to eq(
+            [:association]
+          )
         end
 
         it 'should return empty if associations exist in call_association' do

data/spec/bullet/ext/object_spec.rb

@@ -10,7 +10,7 @@ describe Object do
     end
 
     if mongoid?
-      it 'should return class with namesapce and id composition' do
+      it 'should return class with namespace and id composition' do
         post = Mongoid::Post.first
         expect(post.bullet_key).to eq("Mongoid::Post:#{post.id}")
       end

data/spec/bullet/rack_spec.rb

@@ -105,9 +105,10 @@ module Bullet
 
           it 'should change response body for html safe string if add_footer is true' do
             expect(Bullet).to receive(:add_footer).exactly(3).times.and_return(true)
-            app.response = Support::ResponseDouble.new.tap do |response|
-              response.body = ActiveSupport::SafeBuffer.new('<html><head></head><body></body></html>')
-            end
+            app.response =
+              Support::ResponseDouble.new.tap do |response|
+                response.body = ActiveSupport::SafeBuffer.new('<html><head></head><body></body></html>')
+              end
             _, headers, response = middleware.call('Content-Type' => 'text/html')
 
             expect(headers['Content-Length']).to eq((73 + middleware.send(:footer_note).length).to_s)
@@ -117,7 +118,7 @@ module Bullet
           it 'should add the footer-text header for non-html requests when add_footer is true' do
             allow(Bullet).to receive(:add_footer).at_least(:once).and_return(true)
             allow(Bullet).to receive(:footer_info).and_return(['footer text'])
-            app.headers = {'Content-Type' => 'application/json'}
+            app.headers = { 'Content-Type' => 'application/json' }
             _, headers, _response = middleware.call({})
             expect(headers).to include('X-bullet-footer-text' => '["footer text"]')
           end
@@ -131,9 +132,10 @@ module Bullet
 
           it 'should change response body for html safe string if console_enabled is true' do
             expect(Bullet).to receive(:console_enabled?).and_return(true)
-            app.response = Support::ResponseDouble.new.tap do |response|
-              response.body = ActiveSupport::SafeBuffer.new('<html><head></head><body></body></html>')
-            end
+            app.response =
+              Support::ResponseDouble.new.tap do |response|
+                response.body = ActiveSupport::SafeBuffer.new('<html><head></head><body></body></html>')
+              end
             _, headers, response = middleware.call('Content-Type' => 'text/html')
             expect(headers['Content-Length']).to eq('56')
             expect(response).to eq(%w[<html><head></head><body><bullet></bullet></body></html>])
@@ -142,7 +144,7 @@ module Bullet
           it 'should add headers for non-html requests when console_enabled is true' do
             allow(Bullet).to receive(:console_enabled?).at_least(:once).and_return(true)
             allow(Bullet).to receive(:text_notifications).and_return(['text notifications'])
-            app.headers = {'Content-Type' => 'application/json'}
+            app.headers = { 'Content-Type' => 'application/json' }
             _, headers, _response = middleware.call({})
             expect(headers).to include('X-bullet-console-text' => '["text notifications"]')
           end
@@ -155,13 +157,13 @@ module Bullet
           end
 
           it "shouldn't add headers unnecessarily" do
-            app.headers = {'Content-Type' => 'application/json'}
+            app.headers = { 'Content-Type' => 'application/json' }
             _, headers, _response = middleware.call({})
             expect(headers).not_to include('X-bullet-footer-text')
             expect(headers).not_to include('X-bullet-console-text')
           end
 
-          context "when skip_http_headers is enabled" do
+          context 'when skip_http_headers is enabled' do
             before do
               allow(Bullet).to receive(:skip_http_headers).and_return(true)
             end
@@ -183,14 +185,14 @@ module Bullet
 
             it 'should not add the footer-text header for non-html requests when add_footer is true' do
               allow(Bullet).to receive(:add_footer).at_least(:once).and_return(true)
-              app.headers = {'Content-Type' => 'application/json'}
+              app.headers = { 'Content-Type' => 'application/json' }
               _, headers, _response = middleware.call({})
               expect(headers).not_to include('X-bullet-footer-text')
             end
 
             it 'should not add headers for non-html requests when console_enabled is true' do
               allow(Bullet).to receive(:console_enabled?).at_least(:once).and_return(true)
-              app.headers = {'Content-Type' => 'application/json'}
+              app.headers = { 'Content-Type' => 'application/json' }
               _, headers, _response = middleware.call({})
               expect(headers).not_to include('X-bullet-console-text')
             end
@@ -259,6 +261,20 @@ module Bullet
           expect(middleware.response_body(response)).to eq body_string
         end
       end
+
+      begin
+        require 'rack/files'
+
+        context 'when `response` is a Rack::Files::Iterator' do
+          let(:response) { instance_double(::Rack::Files::Iterator) }
+          before { allow(response).to receive(:is_a?).with(::Rack::Files::Iterator) { true } }
+
+          it 'should return nil' do
+            expect(middleware.response_body(response)).to be_nil
+          end
+        end
+      rescue LoadError
+      end
     end
   end
 end

data/spec/bullet_spec.rb

@@ -74,31 +74,60 @@ describe Bullet, focused: true do
     end
   end
 
+  describe '#add_safelist' do
+    context "for 'special' class names" do
+      it 'is added to the safelist successfully' do
+        Bullet.add_safelist(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 '#add_whitelist' do
     context "for 'special' class names" do
-      it 'is added to the whitelist successfully' 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_whitelist_associations(:n_plus_one_query, 'Klass')).to include :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
+        Bullet.add_safelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
+        Bullet.delete_safelist(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_safelist(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 '#delete_whitelist' do
     context "for 'special' class names" do
-      it 'is deleted from the whitelist successfully' do
-        Bullet.add_whitelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
+      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.whitelist[:n_plus_one_query]).to eq({})
+        expect(Bullet.safelist[:n_plus_one_query]).to eq({})
       end
     end
 
     context 'when exists multiple definitions' do
-      it 'is deleted from the whitelist successfully' do
-        Bullet.add_whitelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
-        Bullet.add_whitelist(type: :n_plus_one_query, class_name: 'Klass', association: :team)
+      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_whitelist_associations(:n_plus_one_query, 'Klass')).to include :department
-        expect(Bullet.get_whitelist_associations(:n_plus_one_query, 'Klass')).to_not include :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

data/spec/integration/active_record/association_spec.rb

@@ -129,7 +129,7 @@ if active_record?
         expect(Bullet::Detector::Association).to be_completely_preloading_associations
       end
 
-      it 'should detect unused preload with post => commnets, no category => posts' do
+      it 'should detect unused preload with post => comments, no category => posts' do
         Category.includes(posts: :comments).each { |category| category.posts.map(&:name) }
         Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
         expect(Bullet::Detector::Association).to be_unused_preload_associations_for(Post, :comments)
@@ -202,7 +202,7 @@ if active_record?
         expect(Bullet::Detector::Association).to be_completely_preloading_associations
       end
 
-      it 'should detect preload with post => commnets' do
+      it 'should detect preload with post => comments' do
         Post.first.comments.map(&:name)
         Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
         expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
@@ -401,6 +401,15 @@ if active_record?
   end
 
   describe Bullet::Detector::Association, 'has_and_belongs_to_many' do
+    context 'posts <=> deals' do
+      it 'should detect preload associations with join tables that have identifier' do
+        Post.includes(:deals).each { |post| post.deals.map(&:name) }
+        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
     context 'students <=> teachers' do
       it 'should detect non preload associations' do
         Student.all.each { |student| student.teachers.map(&:name) }
@@ -729,9 +738,9 @@ if active_record?
       end
     end
 
-    context 'whitelist n plus one query' do
-      before { Bullet.add_whitelist type: :n_plus_one_query, class_name: 'Post', association: :comments }
-      after { Bullet.clear_whitelist }
+    context 'add n plus one query to safelist' do
+      before { Bullet.add_safelist type: :n_plus_one_query, class_name: 'Post', association: :comments }
+      after { Bullet.clear_safelist }
 
       it 'should not detect n plus one query' do
         Post.all.each { |post| post.comments.map(&:name) }
@@ -750,9 +759,9 @@ if active_record?
       end
     end
 
-    context 'whitelist unused eager loading' do
-      before { Bullet.add_whitelist type: :unused_eager_loading, class_name: 'Post', association: :comments }
-      after { Bullet.clear_whitelist }
+    context 'add unused eager loading to safelist' do
+      before { Bullet.add_safelist type: :unused_eager_loading, class_name: 'Post', association: :comments }
+      after { Bullet.clear_safelist }
 
       it 'should not detect unused eager loading' do
         Post.includes(:comments).map(&:name)

data/spec/integration/counter_cache_spec.rb

@@ -55,9 +55,9 @@ if !mongoid? && active_record?
       end
     end
 
-    context 'whitelist' do
-      before { Bullet.add_whitelist type: :counter_cache, class_name: 'Country', association: :cities }
-      after { Bullet.clear_whitelist }
+    context 'safelist' do
+      before { Bullet.add_safelist type: :counter_cache, class_name: 'Country', association: :cities }
+      after { Bullet.clear_safelist }
 
       it 'should not detect counter cache' do
         Country.all.each { |country| country.cities.size }

data/spec/integration/mongoid/association_spec.rb

@@ -118,7 +118,7 @@ if mongoid?
           expect(Bullet::Detector::Association).to be_completely_preloading_associations
         end
 
-        it 'should detect preload with post => commnets' do
+        it 'should detect preload with post => comments' do
           Mongoid::Post.first.comments.map(&:name)
           Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
           expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations

data/spec/models/deal.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Deal < ActiveRecord::Base
+  has_and_belongs_to_many :posts
+end

data/spec/models/folder.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
-class Folder < Document; end
+class Folder < Document
+end

data/spec/models/group.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
-class Group < ActiveRecord::Base; end
+class Group < ActiveRecord::Base
+end

data/spec/models/page.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
-class Page < Document; end
+class Page < Document
+end

data/spec/models/post.rb

@@ -4,6 +4,7 @@ class Post < ActiveRecord::Base
   belongs_to :category, inverse_of: :posts
   belongs_to :writer
   has_many :comments, inverse_of: :post
+  has_and_belongs_to_many :deals
 
   validates :category, presence: true
 
@@ -21,6 +22,7 @@ class Post < ActiveRecord::Base
     next unless trigger_after_save
 
     temp_comment = Comment.new(post: self)
+
     # this triggers self to be "possible", even though it's
     # not saved yet
     temp_comment.post

data/spec/models/writer.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
-class Writer < BaseUser; end
+class Writer < BaseUser
+end

data/spec/spec_helper.rb

@@ -4,12 +4,10 @@ require 'rspec'
 begin
   require 'active_record'
 rescue LoadError
-
 end
 begin
   require 'mongoid'
 rescue LoadError
-
 end
 
 module Rails

data/spec/support/mongo_seed.rb

@@ -45,6 +45,7 @@ module Support
         Mongoid.configure do |config|
           config.load_configuration(clients: { default: { database: 'bullet', hosts: %w[localhost:27017] } })
         end
+
         # Increase the level from DEBUG in order to avoid excessive logging to the screen
         Mongo::Logger.logger.level = Logger::WARN
       end

data/spec/support/sqlite_seed.rb

@@ -21,6 +21,13 @@ module Support
       post2 = category2.posts.create(name: 'second', writer: writer2)
       post3 = category2.posts.create(name: 'third', writer: writer2)
 
+      deal1 = Deal.new(name: 'Deal 1')
+      deal1.posts << post1
+      deal1.posts << post2
+      deal2 = Deal.new(name: 'Deal 2')
+      post1.deals << deal1
+      post1.deals << deal2
+
       comment1 = post1.comments.create(name: 'first', author: writer1)
       comment2 = post1.comments.create(name: 'first2', author: writer1)
       comment3 = post1.comments.create(name: 'first3', author: writer1)
@@ -156,6 +163,11 @@ module Support
           t.column :hotel_id, :integer
         end
 
+        create_table :deals_posts do |t|
+          t.column :deal_id, :integer
+          t.column :post_id, :integer
+        end
+
         create_table :documents do |t|
           t.string :name
           t.string :type

data/test.sh

@@ -1,5 +1,6 @@
 #bundle update rails && bundle exec rspec spec
 #BUNDLE_GEMFILE=Gemfile.mongoid bundle update mongoid && BUNDLE_GEMFILE=Gemfile.mongoid bundle exec rspec spec
+BUNDLE_GEMFILE=Gemfile.rails-6.1 bundle && BUNDLE_GEMFILE=Gemfile.rails-6.1 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.rails-6.0 bundle && BUNDLE_GEMFILE=Gemfile.rails-6.0 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.rails-5.2 bundle && BUNDLE_GEMFILE=Gemfile.rails-5.2 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.rails-5.1 bundle && BUNDLE_GEMFILE=Gemfile.rails-5.1 bundle exec rspec spec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet
 version: !ruby/object:Gem::Version
-  version: 6.1.4
+  version: 6.1.5
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -45,9 +45,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.mongoid
@@ -138,6 +138,7 @@ files:
 - spec/models/comment.rb
 - spec/models/company.rb
 - spec/models/country.rb
+- spec/models/deal.rb
 - spec/models/document.rb
 - spec/models/entry.rb
 - spec/models/firm.rb
@@ -191,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: help to kill N+1 queries and unused eager loading.
@@ -226,6 +227,7 @@ test_files:
 - spec/models/comment.rb
 - spec/models/company.rb
 - spec/models/country.rb
+- spec/models/deal.rb
 - spec/models/document.rb
 - spec/models/entry.rb
 - spec/models/firm.rb

data/.travis.yml

@@ -1,33 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.0
-  - 2.6.0
-gemfile:
-  - Gemfile.rails-6.0
-  - Gemfile.rails-5.2
-  - Gemfile.rails-5.1
-  - Gemfile.rails-5.0
-  - Gemfile.rails-4.2
-  - Gemfile.rails-4.1
-  - Gemfile.rails-4.0
-matrix:
-  exclude:
-    - rvm: 2.3.0
-      gemfile: Gemfile.rails-6.0
-    - rvm: 2.6.0
-      gemfile: Gemfile.rails-5.2
-    - rvm: 2.6.0
-      gemfile: Gemfile.rails-5.1
-    - rvm: 2.6.0
-      gemfile: Gemfile.rails-5.0
-    - rvm: 2.6.0
-      gemfile: Gemfile.rails-4.2
-    - rvm: 2.6.0
-      gemfile: Gemfile.rails-4.1
-    - rvm: 2.6.0
-      gemfile: Gemfile.rails-4.0
-env:
-  - DB=sqlite
-before_install:
-  - "find /home/travis/.rvm/rubies -wholename '*default/bundler-*.gemspec' -delete"
-  - gem install bundler -v '< 2'