bullet 5.5.0 → 6.1.5

data/lib/bullet/dependency.rb

@@ -1,47 +1,55 @@
+# frozen_string_literal: true
+
 module Bullet
   module Dependency
     def mongoid?
-      @mongoid ||= defined? ::Mongoid
+      @mongoid ||= defined?(::Mongoid)
     end
 
     def active_record?
-      @active_record ||= defined? ::ActiveRecord
-    end
-
-    def rails?
-      @rails ||= defined? ::Rails
+      @active_record ||= defined?(::ActiveRecord)
     end
 
     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'
-                                   else
-                                     raise "Bullet does not support active_record #{::ActiveRecord::VERSION} yet"
-                                   end
-                                 end
+      @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'
+          else
+            raise "Bullet does not support active_record #{::ActiveRecord::VERSION::STRING} yet"
+          end
+        end
     end
 
     def mongoid_version
-      @mongoid_version ||= begin
-                             if mongoid4x?
-                               'mongoid4x'
-                             elsif mongoid5x?
-                               'mongoid5x'
-                             elsif mongoid6x?
-                               'mongoid6x'
-                             else
-                               raise "Bullet does not support mongoid #{::Mongoid::VERSION} yet"
-                             end
-                           end
+      @mongoid_version ||=
+        begin
+          if mongoid4x?
+            'mongoid4x'
+          elsif mongoid5x?
+            'mongoid5x'
+          elsif mongoid6x?
+            'mongoid6x'
+          elsif mongoid7x?
+            'mongoid7x'
+          else
+            raise "Bullet does not support mongoid #{::Mongoid::VERSION} yet"
+          end
+        end
     end
 
     def active_record4?
@@ -52,6 +60,10 @@ module Bullet
       active_record? && ::ActiveRecord::VERSION::MAJOR == 5
     end
 
+    def active_record6?
+      active_record? && ::ActiveRecord::VERSION::MAJOR == 6
+    end
+
     def active_record40?
       active_record4? && ::ActiveRecord::VERSION::MINOR == 0
     end
@@ -72,6 +84,18 @@ module Bullet
       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 mongoid4x?
       mongoid? && ::Mongoid::VERSION =~ /\A4/
     end
@@ -83,5 +107,9 @@ module Bullet
     def mongoid6x?
       mongoid? && ::Mongoid::VERSION =~ /\A6/
     end
+
+    def mongoid7x?
+      mongoid? && ::Mongoid::VERSION =~ /\A7/
+    end
   end
 end

data/lib/bullet/detector/association.rb

@@ -1,22 +1,30 @@
+# frozen_string_literal: true
+
 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", "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", "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
 
@@ -37,36 +45,37 @@ module Bullet
         end
 
         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.
-          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.
-          def call_object_associations
-            Thread.current[:bullet_call_object_associations]
-          end
+        # 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.
+        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"] }
-          def inversed_objects
-            Thread.current[:bullet_inversed_objects]
-          end
+        # 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] }
-          def eager_loadings
-            Thread.current[:bullet_eager_loadings]
-          end
+        # 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
       end
     end
   end

data/lib/bullet/detector/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Detector
     class Base

data/lib/bullet/detector/counter_cache.rb

@@ -1,38 +1,45 @@
+# frozen_string_literal: true
+
 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}")
+          Bullet.debug('Detector::CounterCache#add_impossible_object', "object: #{object.bullet_key}")
           impossible_objects.add object.bullet_key
         end
 
-        def conditions_met?(object, associations)
+        def conditions_met?(object, _associations)
           possible_objects.include?(object.bullet_key) && !impossible_objects.include?(object.bullet_key)
         end
 
@@ -45,14 +52,15 @@ module Bullet
         end
 
         private
-          def create_notification(klazz, associations)
-            notify_associations = Array(associations) - Bullet.get_whitelist_associations(:counter_cache, klazz)
 
-            if notify_associations.present?
-              notice = Bullet::Notification::CounterCache.new klazz, notify_associations
-              Bullet.notification_collector.add notice
-            end
+        def create_notification(klazz, associations)
+          notify_associations = Array(associations) - Bullet.get_safelist_associations(:counter_cache, klazz)
+
+          if notify_associations.present?
+            notice = Bullet::Notification::CounterCache.new klazz, notify_associations
+            Bullet.notification_collector.add notice
           end
+        end
       end
     end
   end

data/lib/bullet/detector/n_plus_one_query.rb

@@ -1,23 +1,30 @@
+# frozen_string_literal: true
+
 module Bullet
   module Detector
     class NPlusOneQuery < Association
       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.
         #   if it is, keeps this unpreload associations and caller.
         def call_association(object, associations)
           return unless Bullet.start?
-          return unless object.primary_key_value
+          return unless Bullet.n_plus_one_query_enable?
+          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", "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}")
+            Bullet.debug('detect n + 1 query', "object: #{object.bullet_key}, associations: #{associations}")
             create_notification caller_in_project, object.class.to_s, associations
           end
         end
@@ -25,28 +32,36 @@ 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?
+          return if objects.all? { |obj| obj.class.name =~ /^HABTM_/ }
 
-          Bullet.debug("Detector::NPlusOneQuery#add_possible_objects", "objects: #{objects.map(&:bullet_key).join(', ')}")
+          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", "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", "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
 
@@ -66,28 +81,27 @@ 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 comparision 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
         end
 
         private
-          def create_notification(callers, klazz, associations)
-            notify_associations = Array(associations) - Bullet.get_whitelist_associations(:n_plus_one_query, klazz)
 
-            if notify_associations.present?
-              notice = Bullet::Notification::NPlusOneQuery.new(callers, klazz, notify_associations)
-              Bullet.notification_collector.add(notice)
-            end
+        def create_notification(callers, klazz, associations)
+          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)
+            Bullet.notification_collector.add(notice)
           end
+        end
       end
     end
   end

data/lib/bullet/detector/unused_eager_loading.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Bullet
   module Detector
     class UnusedEagerLoading < Association
       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
@@ -17,7 +19,7 @@ module Bullet
             object_association_diff = diff_object_associations bullet_key, associations
             next if object_association_diff.empty?
 
-            Bullet.debug("detect unused preload", "object: #{bullet_key}, associations: #{object_association_diff}")
+            Bullet.debug('detect unused preload', "object: #{bullet_key}, associations: #{object_association_diff}")
             create_notification(caller_in_project, bullet_key.bullet_class_name, object_association_diff)
           end
         end
@@ -25,22 +27,27 @@ 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, to_merge, to_delete = [], [], []
-          eager_loadings.each do |k, v|
+          to_add = []
+          to_merge = []
+          to_delete = []
+          eager_loadings.each do |k, _v|
             key_objects_overlap = k & bullet_keys
 
             next if key_objects_overlap.empty?
 
-            bullet_keys = bullet_keys - k
+            bullet_keys -= k
             if key_objects_overlap == k
               to_add << [k, associations]
             else
-              to_merge << [key_objects_overlap, ( eager_loadings[k].dup  << associations )]
+              to_merge << [key_objects_overlap, (eager_loadings[k].dup << associations)]
 
               keys_without_objects = k - key_objects_overlap
               to_merge << [keys_without_objects, eager_loadings[k]]
@@ -56,29 +63,31 @@ module Bullet
         end
 
         private
-          def create_notification(callers, klazz, associations)
-            notify_associations = Array(associations) - Bullet.get_whitelist_associations(:unused_eager_loading, klazz)
 
-            if notify_associations.present?
-              notice = Bullet::Notification::UnusedEagerLoading.new(callers, klazz, notify_associations)
-              Bullet.notification_collector.add(notice)
-            end
-          end
+        def create_notification(callers, klazz, associations)
+          notify_associations = Array(associations) - Bullet.get_safelist_associations(:unused_eager_loading, klazz)
 
-          def call_associations(bullet_key, associations)
-            all = Set.new
-            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
+          if notify_associations.present?
+            notice = Bullet::Notification::UnusedEagerLoading.new(callers, klazz, notify_associations)
+            Bullet.notification_collector.add(notice)
           end
+        end
 
-          def diff_object_associations(bullet_key, associations)
-            potential_associations = associations - call_associations(bullet_key, associations)
-            potential_associations.reject { |a| a.is_a?(Hash) }
+        def call_associations(bullet_key, associations)
+          all = Set.new
+          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
+        end
+
+        def diff_object_associations(bullet_key, associations)
+          potential_associations = associations - call_associations(bullet_key, associations)
+          potential_associations.reject { |a| a.is_a?(Hash) }
+        end
       end
     end
   end

data/lib/bullet/detector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Detector
     autoload :Base, 'bullet/detector/base'

data/lib/bullet/ext/object.rb

@@ -1,15 +1,19 @@
+# frozen_string_literal: true
+
 class Object
   def bullet_key
-    "#{self.class}:#{self.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| self.send primary_key }.join(',')
+      self.class.primary_keys.map { |primary_key| send primary_key }.join(',')
     elsif self.class.respond_to?(:primary_key) && self.class.primary_key
-      self.send self.class.primary_key
+      send self.class.primary_key
     else
-      self.id
+      id
     end
   end
 end

data/lib/bullet/ext/string.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 class String
   def bullet_class_name
-    self.sub(/:[^:]*?$/, "")
+    sub(/:[^:]*?$/, '')
   end
 end

data/lib/bullet/mongoid4x.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Mongoid
     def self.enable
@@ -21,20 +23,21 @@ module Bullet
         end
 
         def each(&block)
-          records = query.map{ |doc| ::Mongoid::Factory.from_db(klass, doc) }
+          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
-          origin_each(&block)
+          records.each(&block)
         end
 
         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
@@ -45,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