bullet 5.7.5 → 6.1.4

data/lib/bullet/detector/association.rb

@@ -3,22 +3,28 @@
 module Bullet
   module Detector
     class Association < Base
-      class <<self
+      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 object.primary_key_value
+          return unless object.bullet_primary_key_value
 
-          Bullet.debug('Detector::Association#add_object_associations'.freeze, "object: #{object.bullet_key}, associations: #{associations}")
+          Bullet.debug(
+            'Detector::Association#add_object_associations',
+            "object: #{object.bullet_key}, associations: #{associations}"
+          )
           object_associations.add(object.bullet_key, associations)
         end
 
         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 object.primary_key_value
+          return unless object.bullet_primary_key_value
 
-          Bullet.debug('Detector::Association#add_call_object_associations'.freeze, "object: #{object.bullet_key}, associations: #{associations}")
+          Bullet.debug(
+            'Detector::Association#add_call_object_associations',
+            "object: #{object.bullet_key}, associations: #{associations}"
+          )
           call_object_associations.add(object.bullet_key, associations)
         end
 
@@ -40,33 +46,33 @@ module Bullet
 
         private
 
-          # object_associations keep the object relationships
-          # that the object has many associations.
-          # e.g. { "Post:1" => [:comments] }
-          # the object_associations keep all associations that may be or may no be
-          # unpreload associations or unused preload associations.
+        # object_associations keep the object relationships
+        # that the object has many associations.
+        # e.g. { "Post:1" => [:comments] }
+        # the object_associations keep all associations that may be or may no be
+        # unpreload associations or unused preload associations.
         def object_associations
           Thread.current[:bullet_object_associations]
         end
 
-          # call_object_associations keep the object relationships
-          # that object.associations is called.
-          # e.g. { "Post:1" => [:comments] }
-          # they are used to detect unused preload associations.
+        # call_object_associations keep the object relationships
+        # that object.associations is called.
+        # e.g. { "Post:1" => [:comments] }
+        # they are used to detect unused preload associations.
         def call_object_associations
           Thread.current[:bullet_call_object_associations]
         end
 
-          # inversed_objects keeps object relationships
-          # that association is inversed.
-          # e.g. { "Comment:1" => ["post"] }
+        # inversed_objects keeps object relationships
+        # that association is inversed.
+        # e.g. { "Comment:1" => ["post"] }
         def inversed_objects
           Thread.current[:bullet_inversed_objects]
         end
 
-          # eager_loadings keep the object relationships
-          # that the associations are preloaded by find :include.
-          # e.g. { ["Post:1", "Post:2"] => [:comments, :user] }
+        # eager_loadings keep the object relationships
+        # that the associations are preloaded by find :include.
+        # e.g. { ["Post:1", "Post:2"] => [:comments, :user] }
         def eager_loadings
           Thread.current[:bullet_eager_loadings]
         end

data/lib/bullet/detector/base.rb

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

data/lib/bullet/detector/counter_cache.rb

@@ -3,32 +3,37 @@
 module Bullet
   module Detector
     class CounterCache < Base
-      class <<self
+      class << self
         def add_counter_cache(object, associations)
           return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
-          return unless object.primary_key_value
+          return unless object.bullet_primary_key_value
 
-          Bullet.debug('Detector::CounterCache#add_counter_cache', "object: #{object.bullet_key}, associations: #{associations}")
-          if conditions_met?(object, associations)
-            create_notification object.class.to_s, associations
-          end
+          Bullet.debug(
+            'Detector::CounterCache#add_counter_cache',
+            "object: #{object.bullet_key}, associations: #{associations}"
+          )
+          create_notification object.class.to_s, associations if conditions_met?(object, associations)
         end
 
         def add_possible_objects(object_or_objects)
           return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
+
           objects = Array(object_or_objects)
-          return if objects.map(&:primary_key_value).compact.empty?
+          return if objects.map(&:bullet_primary_key_value).compact.empty?
 
-          Bullet.debug('Detector::CounterCache#add_possible_objects', "objects: #{objects.map(&:bullet_key).join(', ')}")
+          Bullet.debug(
+            'Detector::CounterCache#add_possible_objects',
+            "objects: #{objects.map(&:bullet_key).join(', ')}"
+          )
           objects.each { |object| possible_objects.add object.bullet_key }
         end
 
         def add_impossible_object(object)
           return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
-          return unless object.primary_key_value
+          return unless object.bullet_primary_key_value
 
           Bullet.debug('Detector::CounterCache#add_impossible_object', "object: #{object.bullet_key}")
           impossible_objects.add object.bullet_key

data/lib/bullet/detector/n_plus_one_query.rb

@@ -6,7 +6,7 @@ module Bullet
       extend Dependency
       extend StackTraceFilter
 
-      class <<self
+      class << self
         # executed when object.assocations is called.
         # first, it keeps this method call for object.association.
         # then, it checks if this associations call is unpreload.
@@ -14,11 +14,15 @@ module Bullet
         def call_association(object, associations)
           return unless Bullet.start?
           return unless Bullet.n_plus_one_query_enable?
-          return unless object.primary_key_value
+          return unless object.bullet_primary_key_value
           return if inversed_objects.include?(object.bullet_key, associations)
+
           add_call_object_associations(object, associations)
 
-          Bullet.debug('Detector::NPlusOneQuery#call_association'.freeze, "object: #{object.bullet_key}, associations: #{associations}")
+          Bullet.debug(
+            'Detector::NPlusOneQuery#call_association',
+            "object: #{object.bullet_key}, associations: #{associations}"
+          )
           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.class.to_s, associations
@@ -28,28 +32,35 @@ module Bullet
         def add_possible_objects(object_or_objects)
           return unless Bullet.start?
           return unless Bullet.n_plus_one_query_enable?
+
           objects = Array(object_or_objects)
-          return if objects.map(&:primary_key_value).compact.empty?
+          return if objects.map(&:bullet_primary_key_value).compact.empty?
 
-          Bullet.debug('Detector::NPlusOneQuery#add_possible_objects'.freeze, "objects: #{objects.map(&:bullet_key).join(', '.freeze)}")
+          Bullet.debug(
+            'Detector::NPlusOneQuery#add_possible_objects',
+            "objects: #{objects.map(&:bullet_key).join(', ')}"
+          )
           objects.each { |object| possible_objects.add object.bullet_key }
         end
 
         def add_impossible_object(object)
           return unless Bullet.start?
           return unless Bullet.n_plus_one_query_enable?
-          return unless object.primary_key_value
+          return unless object.bullet_primary_key_value
 
-          Bullet.debug('Detector::NPlusOneQuery#add_impossible_object'.freeze, "object: #{object.bullet_key}")
+          Bullet.debug('Detector::NPlusOneQuery#add_impossible_object', "object: #{object.bullet_key}")
           impossible_objects.add object.bullet_key
         end
 
         def add_inversed_object(object, association)
           return unless Bullet.start?
           return unless Bullet.n_plus_one_query_enable?
-          return unless object.primary_key_value
+          return unless object.bullet_primary_key_value
 
-          Bullet.debug('Detector::NPlusOneQuery#add_inversed_object'.freeze, "object: #{object.bullet_key}, association: #{association}")
+          Bullet.debug(
+            'Detector::NPlusOneQuery#add_inversed_object',
+            "object: #{object.bullet_key}, association: #{association}"
+          )
           inversed_objects.add object.bullet_key, association
         end
 
@@ -69,14 +80,13 @@ module Bullet
         # check if object => associations already exists in object_associations.
         def association?(object, associations)
           value = object_associations[object.bullet_key]
-          if value
-            value.each do |v|
-              # 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
-              return true if result
-            end
+          value&.each do |v|
+            # 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
+            return true if result
           end
 
           false

data/lib/bullet/detector/unused_eager_loading.rb

@@ -6,7 +6,7 @@ module Bullet
       extend Dependency
       extend StackTraceFilter
 
-      class <<self
+      class << self
         # check if there are unused preload associations.
         #   get related_objects from eager_loadings associated with object and associations
         #   get call_object_association from associations of call_object_associations whose object is in related_objects
@@ -27,9 +27,12 @@ module Bullet
         def add_eager_loadings(objects, associations)
           return unless Bullet.start?
           return unless Bullet.unused_eager_loading_enable?
-          return if objects.map(&:primary_key_value).compact.empty?
+          return if objects.map(&:bullet_primary_key_value).compact.empty?
 
-          Bullet.debug('Detector::UnusedEagerLoading#add_eager_loadings', "objects: #{objects.map(&:bullet_key).join(', ')}, associations: #{associations}")
+          Bullet.debug(
+            'Detector::UnusedEagerLoading#add_eager_loadings',
+            "objects: #{objects.map(&:bullet_key).join(', ')}, associations: #{associations}"
+          )
           bullet_keys = objects.map(&:bullet_key)
 
           to_add = []
@@ -75,6 +78,7 @@ module Bullet
           eager_loadings.similarly_associated(bullet_key, associations).each do |related_bullet_key|
             coa = call_object_associations[related_bullet_key]
             next if coa.nil?
+
             all.merge coa
           end
           all.to_a

data/lib/bullet/ext/object.rb

@@ -2,12 +2,14 @@
 
 class Object
   def bullet_key
-    "#{self.class}:#{primary_key_value}"
+    "#{self.class}:#{bullet_primary_key_value}"
   end
 
-  def primary_key_value
+  def bullet_primary_key_value
+    return if respond_to?(:persisted?) && !persisted?
+
     if self.class.respond_to?(:primary_keys) && self.class.primary_keys
-      self.class.primary_keys.map { |primary_key| send primary_key }.join(','.freeze)
+      self.class.primary_keys.map { |primary_key| send primary_key }.join(',')
     elsif self.class.respond_to?(:primary_key) && self.class.primary_key
       send self.class.primary_key
     else

data/lib/bullet/ext/string.rb

@@ -2,6 +2,6 @@
 
 class String
   def bullet_class_name
-    sub(/:[^:]*?$/, ''.freeze)
+    sub(/:[^:]*?$/, '')
   end
 end

data/lib/bullet/mongoid4x.rb

@@ -23,7 +23,8 @@ module Bullet
         end
 
         def each(&block)
-          return to_enum unless block_given?
+          return to_enum unless block
+
           records = []
           origin_each { |record| records << record }
           if records.length > 1
@@ -36,9 +37,7 @@ module Bullet
 
         def eager_load(docs)
           associations = criteria.inclusions.map(&:name)
-          docs.each do |doc|
-            Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations)
-          end
+          docs.each { |doc| Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations) }
           Bullet::Detector::UnusedEagerLoading.add_eager_loadings(docs, associations)
           origin_eager_load(docs)
         end
@@ -49,9 +48,7 @@ module Bullet
 
         def get_relation(name, metadata, object, reload = false)
           result = origin_get_relation(name, metadata, object, reload)
-          if metadata.macro !~ /embed/
-            Bullet::Detector::NPlusOneQuery.call_association(self, name)
-          end
+          Bullet::Detector::NPlusOneQuery.call_association(self, name) if metadata.macro !~ /embed/
           result
         end
       end

data/lib/bullet/mongoid5x.rb

@@ -23,7 +23,8 @@ module Bullet
         end
 
         def each(&block)
-          return to_enum unless block_given?
+          return to_enum unless block
+
           records = []
           origin_each { |record| records << record }
           if records.length > 1
@@ -36,9 +37,7 @@ module Bullet
 
         def eager_load(docs)
           associations = criteria.inclusions.map(&:name)
-          docs.each do |doc|
-            Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations)
-          end
+          docs.each { |doc| Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations) }
           Bullet::Detector::UnusedEagerLoading.add_eager_loadings(docs, associations)
           origin_eager_load(docs)
         end
@@ -49,9 +48,7 @@ module Bullet
 
         def get_relation(name, metadata, object, reload = false)
           result = origin_get_relation(name, metadata, object, reload)
-          if metadata.macro !~ /embed/
-            Bullet::Detector::NPlusOneQuery.call_association(self, name)
-          end
+          Bullet::Detector::NPlusOneQuery.call_association(self, name) if metadata.macro !~ /embed/
           result
         end
       end

data/lib/bullet/mongoid6x.rb

@@ -10,20 +10,21 @@ module Bullet
         alias_method :origin_each, :each
         alias_method :origin_eager_load, :eager_load
 
-        def first
-          result = origin_first
+        def first(opt = {})
+          result = origin_first(opt)
           Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
           result
         end
 
-        def last
-          result = origin_last
+        def last(opt = {})
+          result = origin_last(opt)
           Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
           result
         end
 
         def each(&block)
-          return to_enum unless block_given?
+          return to_enum unless block
+
           records = []
           origin_each { |record| records << record }
           if records.length > 1
@@ -36,9 +37,7 @@ module Bullet
 
         def eager_load(docs)
           associations = criteria.inclusions.map(&:name)
-          docs.each do |doc|
-            Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations)
-          end
+          docs.each { |doc| Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations) }
           Bullet::Detector::UnusedEagerLoading.add_eager_loadings(docs, associations)
           origin_eager_load(docs)
         end
@@ -49,9 +48,7 @@ module Bullet
 
         def get_relation(name, metadata, object, reload = false)
           result = origin_get_relation(name, metadata, object, reload)
-          if metadata.macro !~ /embed/
-            Bullet::Detector::NPlusOneQuery.call_association(self, name)
-          end
+          Bullet::Detector::NPlusOneQuery.call_association(self, name) if metadata.macro !~ /embed/
           result
         end
       end

data/lib/bullet/mongoid7x.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Bullet
+  module Mongoid
+    def self.enable
+      require 'mongoid'
+      ::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
+
+        def first(opts = {})
+          result = origin_first(opts)
+          Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+          result
+        end
+
+        def last(opts = {})
+          result = origin_last(opts)
+          Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+          result
+        end
+
+        def each(&block)
+          return to_enum unless block
+
+          records = []
+          origin_each { |record| records << record }
+          if records.length > 1
+            Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
+          elsif records.size == 1
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
+          end
+          records.each(&block)
+        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