bullet 8.1.3 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebbf526d81da50f5e04ae03c0e33af01ab71071747711f62dd3790a6debc0551
-  data.tar.gz: 7a1551a54344f9c363402854bf8129bc58ec21927b1ee9a9ce2f0b6a5b8f3e16
+  metadata.gz: fff8caa10888c5cc1aee062b08ac4c4df6e5911e9b4c592b3e0c89c3faedf089
+  data.tar.gz: aebe5eb8c7b8624fc2bbe05f42c4c6e8ba5ef8122f519e4e2f984f83d1ac8762
 SHA512:
-  metadata.gz: 5b24c5aea3986b30399e0456268bdb00462540324b745aa4ccc451f77b0e4d78222fec5c4fb781b72114f5f497c12069ad5daf3b3678ae674ae7c58d688d824a
-  data.tar.gz: 449c1c448f20f778053ec7ea032956f7446c2a14c1ea11293f3bc13cf7cf0d794beecf46dfb8052d58c644f35679a5d671f7def8b6d3b6f8eafd0a4689f7b565
+  metadata.gz: 6d60f48c25171229b660274b31ae90689f402d0ea1f46fdf2c63467a550765520b46afb70ff683a8beca75da7ddb86629ba5f58e276667a784d37653f3a94688
+  data.tar.gz: '06973354f3d5158e1ade0f2898577d772b6669d622b176010b6176dbb8b02e5f67c611fbb55668bfee9c93ea873c1183cd28ba30e778a5a6692d0e050a9a3794'

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## Unreleased
 
+## 8.2.0 (08/29/2026)
+
+* Add thread-safe `Bullet.pause`, `Bullet.resume`, `Bullet.paused?`, and `Bullet.skip` APIs
+* Add configurable footer positioning
+* Fix unused eager loading false positives when N+1 detection is disabled
+* Fix unused eager loading false positives for conditional `has_many :through` associations
+* Fix Ruby 4.0 compatibility issues
+* Drop support for ActiveRecord versions older than 7 and Mongoid versions older than 8
+
 ## 8.1.3 (06/02/2026)
 
 * Handle inversed polymorphic belongs_to false positives

data/README.md

@@ -69,6 +69,7 @@ config.after_initialize do
   Bullet.airbrake = true
   Bullet.rollbar = true
   Bullet.add_footer = true
+  Bullet.footer_position = 'bottom_left'  # or 'bottom_right', 'top_left', 'top_right'
   Bullet.skip_html_injection = false
   Bullet.skip_http_headers = false
   Bullet.stacktrace_includes = [ 'your_gem', 'your_middleware' ]
@@ -97,6 +98,7 @@ The code above will enable all of the Bullet notification systems:
 * `Bullet.airbrake`: add notifications to airbrake
 * `Bullet.rollbar`: add notifications to rollbar
 * `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.
+* `Bullet.footer_position`: position of the footer on the page. Valid values are 'bottom_left' (default), 'bottom_right', 'top_left', or 'top_right'. This is useful when the default position clashes with browser UI elements like Chrome's URL preview.
 * `Bullet.skip_html_injection`: prevents Bullet from injecting code into the returned HTML. This must be false for receiving alerts, showing the footer or console logging.
 * `Bullet.skip_http_headers`: don't add headers to API requests, and remove the javascript that relies on them. Note that this prevents bullet from logging warnings to the browser console or updating the footer.
 * `Bullet.stacktrace_includes`: include paths with any of these substrings in the stack trace, even if they are not in your main app
@@ -137,23 +139,34 @@ Bullet.add_safelist :type => :unused_eager_loading, :class_name => "Post", :asso
 Bullet.add_safelist :type => :counter_cache, :class_name => "Country", :association => :cities
 ```
 
+## Skip Bullet in specific actions
+
 If you want to skip bullet in some specific controller actions, you can
-do like
+use `Bullet.skip`, which is thread-safe and works correctly in multi-threaded
+environments like Puma.
 
 ```ruby
 class ApplicationController < ActionController::Base
   around_action :skip_bullet, if: -> { defined?(Bullet) }
 
   def skip_bullet
-    previous_value = Bullet.enable?
-    Bullet.enable = false
-    yield
-  ensure
-    Bullet.enable = previous_value
+    Bullet.skip { yield }
   end
 end
 ```
 
+For more granular control, you can also use `Bullet.pause` and `Bullet.resume`:
+
+```ruby
+Bullet.pause   # Temporarily disable detection for current thread
+Bullet.resume  # Re-enable detection for current thread
+Bullet.paused? # Check if detection is paused for current thread
+```
+
+**Note**: Do not toggle `Bullet.enable` at runtime, as it modifies a global
+flag that is not thread-safe. Use `Bullet.skip`, `Bullet.pause`, or
+`Bullet.start_request`/`Bullet.end_request` instead.
+
 ## Log
 
 The Bullet log `log/bullet.log` will look something like this:

data/lib/bullet/active_record70.rb

@@ -109,6 +109,20 @@ module Bullet
               super
             end
           end
+
+          def through_preloaders
+            if Bullet.start? && !defined?(@through_preloaders)
+              preloaders = super
+              preloaders.each do |preloader|
+                reflection_name = preloader.send(:reflection).name
+                preloader.send(:owners).each do |owner|
+                  Bullet::Detector::NPlusOneQuery.call_association(owner, reflection_name)
+                end
+              end
+            else
+              super
+            end
+          end
         end
       )
 

data/lib/bullet/active_record71.rb

@@ -109,6 +109,20 @@ module Bullet
               super
             end
           end
+
+          def through_preloaders
+            if Bullet.start? && !defined?(@through_preloaders)
+              preloaders = super
+              preloaders.each do |preloader|
+                reflection_name = preloader.send(:reflection).name
+                preloader.send(:owners).each do |owner|
+                  Bullet::Detector::NPlusOneQuery.call_association(owner, reflection_name)
+                end
+              end
+            else
+              super
+            end
+          end
         end
       )
 

data/lib/bullet/active_record72.rb

@@ -109,6 +109,20 @@ module Bullet
               super
             end
           end
+
+          def through_preloaders
+            if Bullet.start? && !defined?(@through_preloaders)
+              preloaders = super
+              preloaders.each do |preloader|
+                reflection_name = preloader.send(:reflection).name
+                preloader.send(:owners).each do |owner|
+                  Bullet::Detector::NPlusOneQuery.call_association(owner, reflection_name)
+                end
+              end
+            else
+              super
+            end
+          end
         end
       )
 

data/lib/bullet/active_record80.rb

@@ -109,6 +109,20 @@ module Bullet
               super
             end
           end
+
+          def through_preloaders
+            if Bullet.start? && !defined?(@through_preloaders)
+              preloaders = super
+              preloaders.each do |preloader|
+                reflection_name = preloader.send(:reflection).name
+                preloader.send(:owners).each do |owner|
+                  Bullet::Detector::NPlusOneQuery.call_association(owner, reflection_name)
+                end
+              end
+            else
+              super
+            end
+          end
         end
       )
 

data/lib/bullet/active_record81.rb

@@ -109,6 +109,20 @@ module Bullet
               super
             end
           end
+
+          def through_preloaders
+            if Bullet.start? && !defined?(@through_preloaders)
+              preloaders = super
+              preloaders.each do |preloader|
+                reflection_name = preloader.send(:reflection).name
+                preloader.send(:owners).each do |owner|
+                  Bullet::Detector::NPlusOneQuery.call_association(owner, reflection_name)
+                end
+              end
+            else
+              super
+            end
+          end
         end
       )
 

data/lib/bullet/dependency.rb

@@ -13,22 +13,8 @@ module Bullet
     def active_record_version
       @active_record_version ||=
         begin
-          if active_record40?
-            'active_record4'
-          elsif active_record41?
-            'active_record41'
-          elsif active_record42?
-            'active_record42'
-          elsif active_record50?
-            'active_record5'
-          elsif active_record51?
-            'active_record5'
-          elsif active_record52?
-            'active_record52'
-          elsif active_record60?
-            'active_record60'
-          elsif active_record61?
-            'active_record61'
+          if active_record6_or_older?
+            raise "Bullet no longer supports active_record #{::ActiveRecord::VERSION::STRING}"
           elsif active_record70?
             'active_record70'
           elsif active_record71?
@@ -66,16 +52,8 @@ module Bullet
         end
     end
 
-    def active_record4?
-      active_record? && ::ActiveRecord::VERSION::MAJOR == 4
-    end
-
-    def active_record5?
-      active_record? && ::ActiveRecord::VERSION::MAJOR == 5
-    end
-
-    def active_record6?
-      active_record? && ::ActiveRecord::VERSION::MAJOR == 6
+    def active_record6_or_older?
+      active_record? && ::ActiveRecord::VERSION::MAJOR < 7
     end
 
     def active_record7?
@@ -86,38 +64,6 @@ module Bullet
       active_record? && ::ActiveRecord::VERSION::MAJOR == 8
     end
 
-    def active_record40?
-      active_record4? && ::ActiveRecord::VERSION::MINOR == 0
-    end
-
-    def active_record41?
-      active_record4? && ::ActiveRecord::VERSION::MINOR == 1
-    end
-
-    def active_record42?
-      active_record4? && ::ActiveRecord::VERSION::MINOR == 2
-    end
-
-    def active_record50?
-      active_record5? && ::ActiveRecord::VERSION::MINOR == 0
-    end
-
-    def active_record51?
-      active_record5? && ::ActiveRecord::VERSION::MINOR == 1
-    end
-
-    def active_record52?
-      active_record5? && ::ActiveRecord::VERSION::MINOR == 2
-    end
-
-    def active_record60?
-      active_record6? && ::ActiveRecord::VERSION::MINOR == 0
-    end
-
-    def active_record61?
-      active_record6? && ::ActiveRecord::VERSION::MINOR == 1
-    end
-
     def active_record70?
       active_record7? && ::ActiveRecord::VERSION::MINOR == 0
     end

data/lib/bullet/detector/association.rb

@@ -8,7 +8,7 @@ module Bullet
       class << self
         def add_object_associations(object, associations)
           return unless Bullet.start?
-          return if !Bullet.n_plus_one_query_enable? && !Bullet.unused_eager_loading_enable?
+          return unless Bullet.n_plus_one_query_enable? || Bullet.unused_eager_loading_enable?
           return unless object.bullet_primary_key_value
 
           Bullet.debug(
@@ -21,7 +21,7 @@ module Bullet
 
         def add_call_object_associations(object, associations)
           return unless Bullet.start?
-          return if !Bullet.n_plus_one_query_enable? && !Bullet.unused_eager_loading_enable?
+          return unless Bullet.n_plus_one_query_enable? || Bullet.unused_eager_loading_enable?
           return unless object.bullet_primary_key_value
 
           Bullet.debug(

data/lib/bullet/detector/n_plus_one_query.rb

@@ -15,7 +15,7 @@ module Bullet
         #   if it is, keeps this unpreload associations and caller.
         def call_association(object, associations, caller_stack = nil, inversed: false)
           return unless Bullet.start?
-          return unless Bullet.n_plus_one_query_enable?
+          return unless Bullet.n_plus_one_query_enable? || Bullet.unused_eager_loading_enable?
           return unless object.bullet_primary_key_value
 
           # Record before early-returns so legitimate reads that bypass SQL

data/lib/bullet/rack.rb

@@ -76,8 +76,9 @@ module Bullet
 
     # Make footer styles work with ContentSecurityPolicy style-src as self
     def footer_style(nonce = nil)
+      position_css = footer_position_css
       css = <<~CSS
-        details#bullet-footer {cursor: pointer; position: fixed; left: 0px; bottom: 0px; z-index: 9999; background: #fdf2f2; color: #9b1c1c; font-size: 12px; border-radius: 0px 8px 0px 0px; border: 1px solid #9b1c1c;}
+        details#bullet-footer {cursor: pointer; position: fixed; #{position_css}; z-index: 9999; background: #fdf2f2; color: #9b1c1c; font-size: 12px; #{footer_border_radius}; border: 1px solid #9b1c1c;}
         details#bullet-footer summary {font-weight: 600; padding: 2px 8px;}
         details#bullet-footer div {padding: 8px; border-top: 1px solid #9b1c1c;}
       CSS
@@ -88,6 +89,38 @@ module Bullet
       end
     end
 
+    private
+
+    def footer_position_css
+      case Bullet.footer_position
+      when 'bottom_left'
+        'left: 0px; bottom: 0px'
+      when 'bottom_right'
+        'right: 0px; bottom: 0px'
+      when 'top_left'
+        'left: 0px; top: 0px'
+      when 'top_right'
+        'right: 0px; top: 0px'
+      else
+        'left: 0px; bottom: 0px'
+      end
+    end
+
+    def footer_border_radius
+      case Bullet.footer_position
+      when 'bottom_left'
+        'border-radius: 0px 8px 0px 0px'
+      when 'bottom_right'
+        'border-radius: 8px 0px 0px 0px'
+      when 'top_left'
+        'border-radius: 0px 0px 8px 0px'
+      when 'top_right'
+        'border-radius: 0px 0px 0px 8px'
+      else
+        'border-radius: 0px 8px 0px 0px'
+      end
+    end
+
     def set_header(headers, header_name, header_array)
       # Many proxy applications such as Nginx and AWS ELB limit
       # the size a header to 8KB, so truncate the list of reports to
@@ -123,7 +156,7 @@ module Bullet
     end
 
     def html_request?(headers, response)
-      headers['Content-Type']&.include?('text/html')
+      headers['Content-Type']&.include?('text/html') || false
     end
 
     def response_body(response)

data/lib/bullet/version.rb

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

data/lib/bullet.rb

@@ -42,6 +42,7 @@ module Bullet
                 :skip_html_injection
     attr_reader :safelist
     attr_accessor :add_footer,
+                  :footer_position,
                   :orm_patches_applied,
                   :skip_http_headers,
                   :always_append_html_body,
@@ -188,6 +189,26 @@ module Bullet
       enable? && Thread.current.thread_variable_get(:bullet_start)
     end
 
+    def pause
+      Thread.current.thread_variable_set(:bullet_start, false)
+    end
+
+    def resume
+      Thread.current.thread_variable_set(:bullet_start, true)
+    end
+
+    def paused?
+      enable? && !Thread.current.thread_variable_get(:bullet_start)
+    end
+
+    def skip
+      bullet_was_started = start?
+      pause if bullet_was_started
+      yield
+    ensure
+      resume if bullet_was_started
+    end
+
     def notification_collector
       Thread.current.thread_variable_get(:bullet_notification_collector)
     end
@@ -259,6 +280,10 @@ module Bullet
       UniformNotifier.active_notifiers.include?(UniformNotifier::JavascriptConsole)
     end
 
+    def footer_position
+      @footer_position || 'bottom_left'
+    end
+
     def inject_into_page?
       return false if defined?(@skip_html_injection) && @skip_html_injection
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bullet
 version: !ruby/object:Gem::Version
-  version: 8.1.3
+  version: 8.2.0
 platform: ruby
 authors:
 - Richard Huang
@@ -37,6 +37,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: help to kill N+1 queries and unused eager loading.
 email:
 - flyerhzm@gmail.com
@@ -49,13 +77,6 @@ files:
 - README.md
 - lib/bullet.rb
 - lib/bullet/active_job.rb
-- lib/bullet/active_record4.rb
-- lib/bullet/active_record41.rb
-- lib/bullet/active_record42.rb
-- lib/bullet/active_record5.rb
-- lib/bullet/active_record52.rb
-- lib/bullet/active_record60.rb
-- lib/bullet/active_record61.rb
 - lib/bullet/active_record70.rb
 - lib/bullet/active_record71.rb
 - lib/bullet/active_record72.rb

data/lib/bullet/active_record4.rb

@@ -1,197 +0,0 @@
-# frozen_string_literal: true
-
-module Bullet
-  module ActiveRecord
-    def self.enable
-      require 'active_record'
-      ::ActiveRecord::Base.class_eval do
-        class << self
-          alias_method :origin_find_by_sql, :find_by_sql
-          def find_by_sql(sql, binds = [])
-            result = origin_find_by_sql(sql, binds)
-            if Bullet.start?
-              if result.is_a? Array
-                if result.size > 1
-                  Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
-                  Bullet::Detector::CounterCache.add_possible_objects(result)
-                elsif result.size == 1
-                  Bullet::Detector::NPlusOneQuery.add_impossible_object(result.first)
-                  Bullet::Detector::CounterCache.add_impossible_object(result.first)
-                end
-              elsif result.is_a? ::ActiveRecord::Base
-                Bullet::Detector::NPlusOneQuery.add_impossible_object(result)
-                Bullet::Detector::CounterCache.add_impossible_object(result)
-              end
-            end
-            result
-          end
-        end
-      end
-
-      ::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
-          records = origin_to_a
-          if Bullet.start?
-            if records.size > 1
-              Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
-              Bullet::Detector::CounterCache.add_possible_objects(records)
-            elsif records.size == 1
-              Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
-              Bullet::Detector::CounterCache.add_impossible_object(records.first)
-            end
-          end
-          records
-        end
-      end
-
-      ::ActiveRecord::Persistence.class_eval do
-        def _create_record_with_bullet(*args)
-          _create_record_without_bullet(*args).tap do
-            Bullet::Detector::NPlusOneQuery.update_inversed_object(self)
-            Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
-          end
-        end
-        alias_method_chain :_create_record, :bullet
-      end
-
-      ::ActiveRecord::Associations::Preloader.class_eval do
-        # include query for one to many associations.
-        # keep this eager loadings.
-        alias_method :origin_initialize, :initialize
-        def initialize(records, associations, preload_scope = nil)
-          origin_initialize(records, associations, preload_scope)
-
-          if Bullet.start?
-            records = [records].flatten.compact.uniq
-            return if records.empty?
-
-            records.each { |record| Bullet::Detector::Association.add_object_associations(record, associations) }
-            Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
-          end
-        end
-      end
-
-      ::ActiveRecord::FinderMethods.class_eval do
-        # add includes in scope
-        alias_method :origin_find_with_associations, :find_with_associations
-        def find_with_associations
-          records = origin_find_with_associations
-          if Bullet.start?
-            associations = (eager_load_values + includes_values).uniq
-            records.each { |record| Bullet::Detector::Association.add_object_associations(record, associations) }
-            Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
-          end
-          records
-        end
-      end
-
-      ::ActiveRecord::Associations::JoinDependency.class_eval do
-        alias_method :origin_instantiate, :instantiate
-        alias_method :origin_construct_association, :construct_association
-
-        def instantiate(rows)
-          @bullet_eager_loadings = {}
-          records = origin_instantiate(rows)
-
-          if Bullet.start?
-            @bullet_eager_loadings.each do |_klazz, eager_loadings_hash|
-              objects = eager_loadings_hash.keys
-              Bullet::Detector::UnusedEagerLoading.add_eager_loadings(objects, eager_loadings_hash[objects.first].to_a)
-            end
-          end
-          records
-        end
-
-        # call join associations
-        def construct_association(record, join, row)
-          result = origin_construct_association(record, join, row)
-
-          if Bullet.start?
-            associations = [join.reflection.name]
-            if join.reflection.nested?
-              associations << join.reflection.through_reflection.name
-            end
-            associations.each do |association|
-              Bullet::Detector::Association.add_object_associations(record, association)
-              Bullet::Detector::NPlusOneQuery.call_association(record, association)
-              @bullet_eager_loadings[record.class] ||= {}
-              @bullet_eager_loadings[record.class][record] ||= Set.new
-              @bullet_eager_loadings[record.class][record] << association
-            end
-          end
-
-          result
-        end
-      end
-
-      ::ActiveRecord::Associations::CollectionAssociation.class_eval do
-        # call one to many associations
-        alias_method :origin_load_target, :load_target
-        def load_target
-          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) if Bullet.start?
-          origin_load_target
-        end
-
-        alias_method :origin_include?, :include?
-        def include?(object)
-          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) if Bullet.start?
-          origin_include?(object)
-        end
-      end
-
-      ::ActiveRecord::Associations::HasManyAssociation.class_eval do
-        alias_method :origin_empty?, :empty?
-        def empty?
-          if Bullet.start? && !loaded? && !has_cached_counter?(@reflection)
-            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
-          end
-          origin_empty?
-        end
-      end
-
-      ::ActiveRecord::Associations::HasAndBelongsToManyAssociation.class_eval do
-        alias_method :origin_empty?, :empty?
-        def empty?
-          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) if Bullet.start? && !loaded?
-          origin_empty?
-        end
-      end
-
-      ::ActiveRecord::Associations::SingularAssociation.class_eval do
-        # call has_one and belongs_to associations
-        alias_method :origin_reader, :reader
-        def reader(force_reload = false)
-          result = origin_reader(force_reload)
-          if Bullet.start?
-            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name, inversed: @inversed)
-            Bullet::Detector::NPlusOneQuery.add_possible_objects(result) unless @inversed
-          end
-          result
-        end
-      end
-
-      ::ActiveRecord::Associations::HasManyAssociation.class_eval do
-        alias_method :origin_has_cached_counter?, :has_cached_counter?
-
-        def has_cached_counter?(reflection = reflection())
-          result = origin_has_cached_counter?(reflection)
-          Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name) if Bullet.start? && !result
-          result
-        end
-      end
-
-      ::ActiveRecord::Associations::CollectionProxy.class_eval do
-        def count(column_name = nil, options = {})
-          if Bullet.start?
-            Bullet::Detector::CounterCache.add_counter_cache(proxy_association.owner, proxy_association.reflection.name)
-            Bullet::Detector::NPlusOneQuery.call_association(proxy_association.owner, proxy_association.reflection.name)
-          end
-          super(column_name, options)
-        end
-      end
-    end
-  end
-end