bullet 8.0.0 → 8.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0309ea5abf7ab699c893c093abed5605b8afbb93ca1034cac1af01d8afcbd0da'
-  data.tar.gz: fe9a9a6b61d3c2d9235fb9bfe9f7ba4f141fca5dccf10707ffee86dfcd84b9c3
+  metadata.gz: 69ace15062b915463985d5257ca7b054b482ca842f05f832dc45c1134bc7c8cd
+  data.tar.gz: a43533c8d894791edffcb4cbd9ad4ceba1dd238a8b736d23e3444ca7f766c57c
 SHA512:
-  metadata.gz: dbc0c561b35efc8a3e131aae16f75382c319f2a6cffeeb48bee8cfa738d88eacd2b53026c59cdcf923e691bc785f9413fa0754cccb2419f2589c36193a25b7da
-  data.tar.gz: f9a723c0531c67c673612da26db9d1a3a365f9d912fd8d9dbdf2e4bcd24ec89f18f3662c743e5a201d89c6e886aacea92880b0f3460613b9a8f10be0dff2ef7b
+  metadata.gz: 262e12b9be4eeae23494a06eb71d6c6823674ecfa8ec9a0c5a5eaff7d7bf268a52cb35ee8198cf0712312745735bc4ad2a6474e3a6a5a6fa8820ed896754795a
+  data.tar.gz: b16503b483682cb94121442f8ee1d74145cb835031e62a864765629b0dbffd6b360136ee3b09f1b14d1e35a25794c06ace1579415829ad0dfdcff1ae2be0b3bf

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## Next Release
 
+## 8.0.2 (04/02/2025)
+
+* Do not cache `bullet_key` if object is not persisted
+
+## 8.0.1 (02/10/2025)
+
+* Update benchmark to use sqlite
+* Reduce mem allocations
+* Require active_support's inflections module before requiring the delegation module
+
 ## 8.0.0 (11/10/2024)
 
 * Support Rails 8

data/README.md

@@ -121,8 +121,6 @@ Bullet.unused_eager_loading_enable = false
 Bullet.counter_cache_enable        = false
 ```
 
-Note: When calling `Bullet.enable`, all other detectors are reset to their defaults (`true`) and need reconfiguring.
-
 ## Safe list
 
 Sometimes Bullet may notify you of query problems you don't care to fix, or
@@ -240,7 +238,7 @@ If your application generates a Content-Security-Policy via a separate middlewar
 
 ### Run in tests
 
-First you need to enable Bullet in test environment.
+First you need to enable Bullet in the test environment.
 
 ```ruby
 # config/environments/test.rb
@@ -251,11 +249,13 @@ config.after_initialize do
 end
 ```
 
-Then wrap each test in Bullet api.
+Then wrap each test in the Bullet api.
+
+With RSpec:
 
 ```ruby
 # spec/rails_helper.rb
-if Bullet.enable?
+RSpec.configure do |config|
   config.before(:each) do
     Bullet.start_request
   end
@@ -267,6 +267,26 @@ if Bullet.enable?
 end
 ```
 
+With Minitest:
+
+```ruby
+# test/test_helper.rb
+module ActiveSupport
+  class TestCase
+    def before_setup
+      Bullet.start_request
+      super
+    end
+
+    def after_teardown
+      super
+      Bullet.perform_out_of_channel_notifications if Bullet.notification?
+      Bullet.end_request
+    end
+  end
+end
+```
+
 ## Debug Mode
 
 Bullet outputs some details info, to enable debug mode, set

data/lib/bullet/dependency.rb

@@ -56,6 +56,8 @@ module Bullet
             'mongoid7x'
           elsif mongoid8x?
             'mongoid8x'
+          elsif mongoid9x?
+            'mongoid9x'
           else
             raise "Bullet does not support mongoid #{::Mongoid::VERSION} yet"
           end
@@ -149,5 +151,9 @@ module Bullet
     def mongoid8x?
       mongoid? && ::Mongoid::VERSION =~ /\A8/
     end
+
+    def mongoid9x?
+      mongoid? && ::Mongoid::VERSION =~ /\A9/
+    end
   end
 end

data/lib/bullet/detector/association.rb

@@ -81,7 +81,7 @@ module Bullet
           Thread.current.thread_variable_get(:bullet_eager_loadings)
         end
 
-        # cal_stacks keeps stacktraces where querie-objects were called from.
+        # call_stacks keeps stacktraces where querie-objects were called from.
         # e.g. { 'Object:111' => [SomeProject/app/controllers/...] }
         def call_stacks
           Thread.current.thread_variable_get(:bullet_call_stacks)

data/lib/bullet/detector/n_plus_one_query.rb

@@ -27,7 +27,7 @@ module Bullet
           )
           if !excluded_stacktrace_path? && conditions_met?(object, associations)
             Bullet.debug('detect n + 1 query', "object: #{object.bullet_key}, associations: #{associations}")
-            create_notification caller_in_project(object.bullet_key), object.class.to_s, associations
+            create_notification(caller_in_project(object.bullet_key), object.class.to_s, associations)
           end
         end
 
@@ -38,16 +38,17 @@ module Bullet
           objects = Array.wrap(object_or_objects)
           class_names_match_regex = true
           primary_key_values_are_empty = true
-          keys_joined = ""
-          objects.each do |obj|
+
+          keys_joined = objects.map do |obj|
             unless obj.class.name =~ /^HABTM_/
               class_names_match_regex = false
             end
             unless obj.bullet_primary_key_value.nil?
               primary_key_values_are_empty = false
             end
-            keys_joined += "#{(keys_joined.empty? ? '' : ', ')}#{obj.bullet_key}"
-          end
+            obj.bullet_key
+          end.join(", ")
+
           unless class_names_match_regex || primary_key_values_are_empty
             Bullet.debug('Detector::NPlusOneQuery#add_possible_objects', "objects: #{keys_joined}")
             objects.each { |object| possible_objects.add object.bullet_key }

data/lib/bullet/ext/object.rb

@@ -4,22 +4,23 @@ module Bullet
   module Ext
     module Object
       refine ::Object do
+        attr_writer :bullet_key, :bullet_primary_key_value
+
         def bullet_key
-          "#{self.class}:#{bullet_primary_key_value}"
+          return "#{self.class}:" if respond_to?(:persisted?) && !persisted?
+
+          @bullet_key ||= "#{self.class}:#{bullet_primary_key_value}"
         end
 
         def bullet_primary_key_value
           return if respond_to?(:persisted?) && !persisted?
 
-          if self.class.respond_to?(:primary_keys) && self.class.primary_keys
-            primary_key = self.class.primary_keys
-          elsif self.class.respond_to?(:primary_key) && self.class.primary_key
-            primary_key = self.class.primary_key
-          else
-            primary_key = :id
-          end
+          @bullet_primary_key_value ||=
+            begin
+              primary_key = self.class.try(:primary_keys) || self.class.try(:primary_key) || :id
 
-          bullet_join_potential_composite_primary_key(primary_key)
+              bullet_join_potential_composite_primary_key(primary_key)
+            end
         end
 
         private

data/lib/bullet/ext/string.rb

@@ -5,7 +5,8 @@ module Bullet
     module String
       refine ::String do
         def bullet_class_name
-          sub(/:[^:]*?$/, '')
+          last_colon = self.rindex(':')
+          last_colon ? self[0...last_colon].dup : self.dup
         end
       end
     end

data/lib/bullet/mongoid9x.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Bullet
+  module Mongoid
+    def self.enable
+      require 'mongoid'
+      require 'rubygems'
+      ::Mongoid::Contextual::Mongo.class_eval do
+        alias_method :origin_first, :first
+        alias_method :origin_last, :last
+        alias_method :origin_each, :each
+        alias_method :origin_eager_load, :eager_load
+
+        %i[first last].each do |context|
+          default = Gem::Version.new(::Mongoid::VERSION) >= Gem::Version.new('7.5') ? nil : {}
+          define_method(context) do |opts = default|
+            result = send(:"origin_#{context}", opts)
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+            result
+          end
+        end
+
+        def each(&_block)
+          return to_enum unless block_given?
+
+          first_document = nil
+          document_count = 0
+
+          origin_each do |document|
+            document_count += 1
+
+            if document_count == 1
+              first_document = document
+            elsif document_count == 2
+              Bullet::Detector::NPlusOneQuery.add_possible_objects([first_document, document])
+              yield(first_document)
+              first_document = nil
+              yield(document)
+            else
+              Bullet::Detector::NPlusOneQuery.add_possible_objects(document)
+              yield(document)
+            end
+          end
+
+          if document_count == 1
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(first_document)
+            yield(first_document)
+          end
+
+          self
+        end
+
+        def eager_load(docs)
+          associations = criteria.inclusions.map(&:name)
+          docs.each { |doc| Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations) }
+          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(docs, associations)
+          origin_eager_load(docs)
+        end
+      end
+
+      ::Mongoid::Association::Accessors.class_eval do
+        alias_method :origin_get_relation, :get_relation
+
+        def get_relation(name, association, object, reload = false)
+          result = origin_get_relation(name, association, object, reload)
+          Bullet::Detector::NPlusOneQuery.call_association(self, name) unless association.embedded?
+          result
+        end
+      end
+    end
+  end
+end

data/lib/bullet/stack_trace_filter.rb

@@ -7,7 +7,6 @@ using Bullet::Ext::Object
 module Bullet
   module StackTraceFilter
     VENDOR_PATH = '/vendor'
-    IS_RUBY_19 = Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
 
     # @param bullet_key[String] - use this to get stored call stack from call_stacks object.
     def caller_in_project(bullet_key = nil)
@@ -56,13 +55,12 @@ module Bullet
     def location_as_path(location)
       return location if location.is_a?(String)
 
-      IS_RUBY_19 ? location : location.absolute_path.to_s
+      location.absolute_path.to_s
     end
 
     def select_caller_locations(bullet_key = nil)
-      return caller.select { |caller_path| yield caller_path } if IS_RUBY_19
-
       call_stack = bullet_key ? call_stacks[bullet_key] : caller_locations
+
       call_stack.select { |location| yield location }
     end
   end

data/lib/bullet/version.rb

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

data/lib/bullet.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/module/delegation'
 require 'set'
 require 'uniform_notifier'
@@ -63,7 +64,7 @@ module Bullet
     ].freeze
 
     def enable=(enable)
-      @enable = @n_plus_one_query_enable = @unused_eager_loading_enable = @counter_cache_enable = enable
+      @enable = enable
 
       if enable?
         reset_safelist
@@ -89,15 +90,15 @@ module Bullet
     end
 
     def n_plus_one_query_enable?
-      enable? && !!@n_plus_one_query_enable
+      enable? && (@n_plus_one_query_enable.nil? ? true : @n_plus_one_query_enable)
     end
 
     def unused_eager_loading_enable?
-      enable? && !!@unused_eager_loading_enable
+      enable? && (@unused_eager_loading_enable.nil? ? true : @unused_eager_loading_enable)
     end
 
     def counter_cache_enable?
-      enable? && !!@counter_cache_enable
+      enable? && (@counter_cache_enable.nil? ? true : @counter_cache_enable)
     end
 
     def stacktrace_includes

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bullet
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.0.2
 platform: ruby
 authors:
 - Richard Huang
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-10 00:00:00.000000000 Z
+date: 2025-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -76,6 +75,7 @@ files:
 - lib/bullet/mongoid6x.rb
 - lib/bullet/mongoid7x.rb
 - lib/bullet/mongoid8x.rb
+- lib/bullet/mongoid9x.rb
 - lib/bullet/notification.rb
 - lib/bullet/notification/base.rb
 - lib/bullet/notification/counter_cache.rb
@@ -98,7 +98,6 @@ licenses:
 metadata:
   changelog_uri: https://github.com/flyerhzm/bullet/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/flyerhzm/bullet
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,8 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: help to kill N+1 queries and unused eager loading.
 test_files: []