bullet 5.7.0 → 5.8.0

data/lib/bullet/active_record52.rb

@@ -1,16 +1,11 @@
+# frozen_string_literal: true
+
 module Bullet
   module SaveWithBulletSupport
-    def save(*args)
-      was_new_record = new_record?
-      super(*args).tap do |result|
-        Bullet::Detector::NPlusOneQuery.add_impossible_object(self) if result && was_new_record
-      end
-    end
-
-    def save!(*args)
-      was_new_record = new_record?
-      super(*args).tap do |result|
-        Bullet::Detector::NPlusOneQuery.add_impossible_object(self) if result && was_new_record
+    def _create_record(*)
+      super do
+        Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
+        yield(self) if block_given?
       end
     end
   end
@@ -18,7 +13,7 @@ module Bullet
   module ActiveRecord
     def self.enable
       require 'active_record'
-      ::ActiveRecord::Base.extend(Module.new {
+      ::ActiveRecord::Base.extend(Module.new do
         def find_by_sql(sql, binds = [], preparable: nil, &block)
           result = super
           if Bullet.start?
@@ -37,11 +32,11 @@ module Bullet
           end
           result
         end
-      })
+      end)
 
       ::ActiveRecord::Base.prepend(SaveWithBulletSupport)
 
-      ::ActiveRecord::Relation.prepend(Module.new {
+      ::ActiveRecord::Relation.prepend(Module.new do
         # 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 records
@@ -59,9 +54,9 @@ module Bullet
           end
           result
         end
-      })
+      end)
 
-      ::ActiveRecord::Associations::Preloader.prepend(Module.new {
+      ::ActiveRecord::Associations::Preloader.prepend(Module.new do
         def preloaders_for_one(association, records, scope)
           if Bullet.start?
             records.compact!
@@ -74,12 +69,13 @@ module Bullet
           end
           super
         end
-      })
+      end)
 
-      ::ActiveRecord::FinderMethods.prepend(Module.new {
+      ::ActiveRecord::FinderMethods.prepend(Module.new do
         # add includes in scope
         def find_with_associations
           return super { |r| yield r } if block_given?
+
           records = super
           if Bullet.start?
             associations = (eager_load_values + includes_values).uniq
@@ -90,15 +86,15 @@ module Bullet
           end
           records
         end
-      })
+      end)
 
-      ::ActiveRecord::Associations::JoinDependency.prepend(Module.new {
+      ::ActiveRecord::Associations::JoinDependency.prepend(Module.new do
         def instantiate(result_set, &block)
           @bullet_eager_loadings = {}
           records = super
 
           if Bullet.start?
-            @bullet_eager_loadings.each do |klazz, eager_loadings_hash|
+            @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
@@ -112,14 +108,14 @@ module Bullet
               parent.children.each do |node|
                 key = aliases.column_alias(node, node.primary_key)
                 id = row[key]
-                if id.nil?
-                  associations = node.reflection.name
-                  Bullet::Detector::Association.add_object_associations(ar_parent, associations)
-                  Bullet::Detector::NPlusOneQuery.call_association(ar_parent, associations)
-                  @bullet_eager_loadings[ar_parent.class] ||= {}
-                  @bullet_eager_loadings[ar_parent.class][ar_parent] ||= Set.new
-                  @bullet_eager_loadings[ar_parent.class][ar_parent] << associations
-                end
+                next unless id.nil?
+
+                associations = node.reflection.name
+                Bullet::Detector::Association.add_object_associations(ar_parent, associations)
+                Bullet::Detector::NPlusOneQuery.call_association(ar_parent, associations)
+                @bullet_eager_loadings[ar_parent.class] ||= {}
+                @bullet_eager_loadings[ar_parent.class][ar_parent] ||= Set.new
+                @bullet_eager_loadings[ar_parent.class][ar_parent] << associations
               end
             end
           end
@@ -142,19 +138,23 @@ module Bullet
 
           result
         end
-      })
+      end)
 
-      ::ActiveRecord::Associations::CollectionAssociation.prepend(Module.new {
+      ::ActiveRecord::Associations::CollectionAssociation.prepend(Module.new do
         def load_target
           records = super
 
           if Bullet.start?
-            if self.is_a? ::ActiveRecord::Associations::ThroughAssociation
-              Bullet::Detector::NPlusOneQuery.call_association(owner, through_reflection.name)
-              association = self.owner.association self.through_reflection.name
+            if is_a? ::ActiveRecord::Associations::ThroughAssociation
+              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.through_reflection.name)
+              association = owner.association reflection.through_reflection.name
               Array(association.target).each do |through_record|
                 Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
               end
+
+              if reflection.through_reflection != through_reflection
+                Bullet::Detector::NPlusOneQuery.call_association(owner, through_reflection.name)
+              end
             end
             Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) unless @inversed
             if records.first.class.name !~ /^HABTM_/
@@ -183,9 +183,9 @@ module Bullet
           end
           super
         end
-      })
+      end)
 
-      ::ActiveRecord::Associations::SingularAssociation.prepend(Module.new {
+      ::ActiveRecord::Associations::SingularAssociation.prepend(Module.new do
         # call has_one and belongs_to associations
         def target
           result = super()
@@ -201,9 +201,9 @@ module Bullet
           end
           result
         end
-      })
+      end)
 
-      ::ActiveRecord::Associations::HasManyAssociation.prepend(Module.new {
+      ::ActiveRecord::Associations::HasManyAssociation.prepend(Module.new do
         def empty?
           result = super
           if Bullet.start? && !reflection.has_cached_counter?
@@ -214,12 +214,19 @@ module Bullet
 
         def count_records
           result = reflection.has_cached_counter?
-          if Bullet.start? && !result && !self.is_a?(::ActiveRecord::Associations::ThroughAssociation)
+          if Bullet.start? && !result && !is_a?(::ActiveRecord::Associations::ThroughAssociation)
             Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
           end
           super
         end
-      })
+      end)
+
+      ::ActiveRecord::Associations::BelongsToAssociation.prepend(Module.new do
+        def writer(record)
+          Bullet::Detector::Association.add_object_associations(owner, reflection.name) if Bullet.start?
+          super
+        end
+      end)
     end
   end
 end

data/lib/bullet/dependency.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Dependency
     def mongoid?
@@ -27,7 +29,7 @@ module Bullet
                                    elsif active_record52?
                                      'active_record52'
                                    else
-                                     raise "Bullet does not support active_record #{::ActiveRecord::VERSION} yet"
+                                     raise "Bullet does not support active_record #{::ActiveRecord::VERSION::STRING} yet"
                                    end
                                  end
     end

data/lib/bullet/detector/association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Detector
     class Association < Base
@@ -7,7 +9,7 @@ module Bullet
           return if !Bullet.n_plus_one_query_enable? && !Bullet.unused_eager_loading_enable?
           return unless object.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
 
@@ -16,7 +18,7 @@ module Bullet
           return if !Bullet.n_plus_one_query_enable? && !Bullet.unused_eager_loading_enable?
           return unless object.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
 
@@ -43,31 +45,31 @@ module Bullet
           # 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
+        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
+        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
+        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
+        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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Detector
     class CounterCache < Base
@@ -16,6 +18,7 @@ module Bullet
         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?
 
@@ -32,7 +35,7 @@ module Bullet
           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
 
@@ -46,14 +49,14 @@ module Bullet
 
         private
 
-          def create_notification(klazz, associations)
-            notify_associations = Array(associations) - Bullet.get_whitelist_associations(:counter_cache, klazz)
+        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
+          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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Detector
     class NPlusOneQuery < Association
@@ -14,9 +16,10 @@ module Bullet
           return unless Bullet.n_plus_one_query_enable?
           return unless object.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
@@ -26,10 +29,11 @@ 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?
 
-          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
 
@@ -38,7 +42,7 @@ module Bullet
           return unless Bullet.n_plus_one_query_enable?
           return unless object.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
 
@@ -47,7 +51,7 @@ module Bullet
           return unless Bullet.n_plus_one_query_enable?
           return unless object.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
 
@@ -67,14 +71,12 @@ 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|
+          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
+            result = v.is_a?(Hash) ? v.key?(associations) : associations == v
+            return true if result
           end
 
           false
@@ -82,14 +84,14 @@ module Bullet
 
         private
 
-          def create_notification(callers, klazz, associations)
-            notify_associations = Array(associations) - Bullet.get_whitelist_associations(:n_plus_one_query, klazz)
+        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
+          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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Detector
     class UnusedEagerLoading < Association
@@ -30,13 +32,15 @@ module Bullet
           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
@@ -57,29 +61,30 @@ module Bullet
 
         private
 
-          def create_notification(callers, klazz, associations)
-            notify_associations = Array(associations) - Bullet.get_whitelist_associations(:unused_eager_loading, klazz)
+        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
+          if notify_associations.present?
+            notice = Bullet::Notification::UnusedEagerLoading.new(callers, klazz, notify_associations)
+            Bullet.notification_collector.add(notice)
           end
+        end
 
-          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 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?
 
-          def diff_object_associations(bullet_key, associations)
-            potential_associations = associations - call_associations(bullet_key, associations)
-            potential_associations.reject { |a| a.is_a?(Hash) }
+            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,17 @@
+# frozen_string_literal: true
+
 class Object
   def bullet_key
-    "#{self.class}:#{self.primary_key_value}"
+    "#{self.class}:#{primary_key_value}"
   end
 
   def primary_key_value
     if self.class.respond_to?(:primary_keys) && self.class.primary_keys
-      self.class.primary_keys.map { |primary_key| self.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
-      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(/:[^:]*?$/, ''.freeze)
+    sub(/:[^:]*?$/, '')
   end
 end

data/lib/bullet/mongoid4x.rb

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

data/lib/bullet/mongoid5x.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Mongoid
     def self.enable
@@ -21,13 +23,16 @@ module Bullet
         end
 
         def each(&block)
-          records = view.map { |doc| ::Mongoid::Factory.from_db(klass, doc) }
+          return to_enum unless block_given?
+
+          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)

data/lib/bullet/mongoid6x.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Mongoid
     def self.enable
@@ -8,26 +10,29 @@ 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)
-          records = view.map { |doc| ::Mongoid::Factory.from_db(klass, doc) }
+          return to_enum unless block_given?
+
+          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)