bullet_instructure 4.0.5 → 4.14.7

data/lib/bullet/active_record41.rb

@@ -8,29 +8,35 @@ module Bullet
         # 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 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)
+          if Bullet.start?
+            if records.first.class.name !~ /^HABTM_/
+              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
           end
           records
         end
       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
-          origin_initialize
-          records = [@records].flatten.compact.uniq
-          return if records.empty?
-          records.each do |record|
-            Bullet::Detector::Association.add_object_associations(record, associations)
+        alias_method :origin_preloaders_on, :preloaders_on
+
+        def preloaders_on(association, records, scope)
+          if Bullet.start?
+            records.compact!
+            if records.first.class.name !~ /^HABTM_/
+              records.each do |record|
+                Bullet::Detector::Association.add_object_associations(record, association)
+              end
+              Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, association)
+            end
           end
-          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
+          origin_preloaders_on(association, records, scope)
         end
       end
 
@@ -38,29 +44,50 @@ module Bullet
         # add includes in scope
         alias_method :origin_find_with_associations, :find_with_associations
         def find_with_associations
-          if block_given?
-            origin_find_with_associations { |r| yield r }
-          else
-            records = origin_find_with_associations
+          return origin_find_with_associations { |r| yield r } if block_given?
+          records = origin_find_with_associations
+          if Bullet.start?
             associations = (eager_load_values + includes_values).uniq
             records.each do |record|
               Bullet::Detector::Association.add_object_associations(record, associations)
-              Bullet::Detector::NPlusOneQuery.call_association(record, associations)
             end
             Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
-            records
           end
+          records
         end
       end
 
       ::ActiveRecord::Associations::JoinDependency.class_eval do
+        alias_method :origin_instantiate, :instantiate
         alias_method :origin_construct_model, :construct_model
+
+        def instantiate(result_set, aliases)
+          @bullet_eager_loadings = {}
+          records = origin_instantiate(result_set, aliases)
+
+          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_model(record, join, row)
-          associations = join.reflection.name
-          Bullet::Detector::Association.add_object_associations(record, associations)
-          Bullet::Detector::NPlusOneQuery.call_association(record, associations)
-          origin_construct_model(record, join, row)
+        def construct_model(record, node, row, model_cache, id, aliases)
+          result = origin_construct_model(record, node, row, model_cache, id, aliases)
+
+          if Bullet.start?
+            associations = node.reflection.name
+            Bullet::Detector::Association.add_object_associations(record, associations)
+            Bullet::Detector::NPlusOneQuery.call_association(record, associations)
+            @bullet_eager_loadings[record.class] ||= {}
+            @bullet_eager_loadings[record.class][record] ||= Set.new
+            @bullet_eager_loadings[record.class][record] << associations
+          end
+
+          result
         end
       end
 
@@ -68,9 +95,27 @@ module Bullet
         # 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?
+            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless @inversed
+          end
           origin_load_target
         end
+
+        alias_method :origin_empty?, :empty?
+        def empty?
+          if Bullet.start?
+            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          end
+          origin_empty?
+        end
+
+        alias_method :origin_include?, :include?
+        def include?(object)
+          if Bullet.start?
+            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          end
+          origin_include?(object)
+        end
       end
 
       ::ActiveRecord::Associations::SingularAssociation.class_eval do
@@ -78,28 +123,24 @@ module Bullet
         alias_method :origin_reader, :reader
         def reader(force_reload = false)
           result = origin_reader(force_reload)
-          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
-          Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
-          result
-        end
-      end
-
-      ::ActiveRecord::Associations::Association.class_eval do
-        alias_method :origin_set_inverse_instance, :set_inverse_instance
-        def set_inverse_instance(record)
-          if record && invertible_for?(record)
-            Bullet::Detector::NPlusOneQuery.add_impossible_object(record)
+          if Bullet.start?
+            if @owner.class.name !~ /^HABTM_/ && !@inversed
+              Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+              Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
+            end
           end
-          origin_set_inverse_instance(record)
+          result
         end
       end
 
       ::ActiveRecord::Associations::HasManyAssociation.class_eval do
         alias_method :origin_has_cached_counter?, :has_cached_counter?
 
-        def has_cached_counter?(reflection = reflection)
+        def has_cached_counter?(reflection = reflection())
           result = origin_has_cached_counter?(reflection)
-          Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name) unless result
+          if Bullet.start?
+            Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name) unless result
+          end
           result
         end
       end

data/lib/bullet/active_record42.rb

@@ -0,0 +1,195 @@
+module Bullet
+  module ActiveRecord
+    def self.enable
+      require 'active_record'
+      ::ActiveRecord::Base.class_eval do
+        class <<self
+          alias_method :origin_find, :find
+          def find(*args)
+            result = origin_find(*args)
+            if Bullet.start?
+              if result.is_a? Array
+                Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
+                Bullet::Detector::CounterCache.add_possible_objects(result)
+              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.first.class.name !~ /^HABTM_/
+              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
+          end
+          records
+        end
+      end
+
+      ::ActiveRecord::Associations::Preloader.class_eval do
+        alias_method :origin_preloaders_on, :preloaders_on
+
+        def preloaders_on(association, records, scope)
+          if Bullet.start?
+            records.compact!
+            if records.first.class.name !~ /^HABTM_/
+              records.each do |record|
+                Bullet::Detector::Association.add_object_associations(record, association)
+              end
+              Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, association)
+            end
+          end
+          origin_preloaders_on(association, records, scope)
+        end
+      end
+
+      ::ActiveRecord::FinderMethods.class_eval do
+        # add includes in scope
+        alias_method :origin_find_with_associations, :find_with_associations
+        def find_with_associations
+          return origin_find_with_associations { |r| yield r } if block_given?
+          records = origin_find_with_associations
+          if Bullet.start?
+            associations = (eager_load_values + includes_values).uniq
+            records.each do |record|
+              Bullet::Detector::Association.add_object_associations(record, associations)
+            end
+            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_model, :construct_model
+
+        def instantiate(result_set, aliases)
+          @bullet_eager_loadings = {}
+          records = origin_instantiate(result_set, aliases)
+
+          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_model(record, node, row, model_cache, id, aliases)
+          result = origin_construct_model(record, node, row, model_cache, id, aliases)
+
+          if Bullet.start?
+            associations = node.reflection.name
+            Bullet::Detector::Association.add_object_associations(record, associations)
+            Bullet::Detector::NPlusOneQuery.call_association(record, associations)
+            @bullet_eager_loadings[record.class] ||= {}
+            @bullet_eager_loadings[record.class][record] ||= Set.new
+            @bullet_eager_loadings[record.class][record] << associations
+          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
+          records = origin_load_target
+
+          if Bullet.start?
+            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless @inversed
+            if records.first.class.name !~ /^HABTM_/
+              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
+          end
+          records
+        end
+
+        alias_method :origin_empty?, :empty?
+        def empty?
+          if Bullet.start?
+            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          end
+          origin_empty?
+        end
+
+        alias_method :origin_include?, :include?
+        def include?(object)
+          if Bullet.start?
+            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          end
+          origin_include?(object)
+        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?
+            if @owner.class.name !~ /^HABTM_/ && !@inversed
+              Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+              if Bullet::Detector::NPlusOneQuery.impossible?(@owner)
+                Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+              else
+                Bullet::Detector::NPlusOneQuery.add_possible_objects(result) if result
+              end
+            end
+          end
+          result
+        end
+      end
+
+      ::ActiveRecord::Associations::HasManyAssociation.class_eval do
+        alias_method :origin_many_empty?, :empty?
+        def empty?
+          Thread.current[:bullet_collection_empty] = true
+          result = origin_many_empty?
+          Thread.current[:bullet_collection_empty] = nil
+          if Bullet.start?
+            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          end
+          result
+        end
+
+        alias_method :origin_has_cached_counter?, :has_cached_counter?
+        def has_cached_counter?(reflection = reflection())
+          result = origin_has_cached_counter?(reflection)
+          if Bullet.start?
+            if !result && !Thread.current[:bullet_collection_empty]
+              Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
+            end
+          end
+          result
+        end
+      end
+    end
+  end
+end

data/lib/bullet/dependency.rb

@@ -22,6 +22,8 @@ module Bullet
                                      'active_record4'
                                    elsif active_record41?
                                      'active_record41'
+                                   elsif active_record42?
+                                     'active_record42'
                                    end
                                  end
     end
@@ -66,6 +68,10 @@ module Bullet
       active_record4? && ::ActiveRecord::VERSION::MINOR == 1
     end
 
+    def active_record42?
+      active_record4? && ::ActiveRecord::VERSION::MINOR == 2
+    end
+
     def mongoid2x?
       mongoid? && ::Mongoid::VERSION =~ /\A2\.[4-8]/
     end

data/lib/bullet/detector/association.rb

@@ -5,7 +5,7 @@ module Bullet
         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.id
+          return unless object.primary_key_value
 
           Bullet.debug("Detector::Association#add_object_associations", "object: #{object.bullet_key}, associations: #{associations}")
           object_associations.add(object.bullet_key, associations)
@@ -14,12 +14,28 @@ 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 object.id
+          return unless object.primary_key_value
 
           Bullet.debug("Detector::Association#add_call_object_associations", "object: #{object.bullet_key}, associations: #{associations}")
           call_object_associations.add(object.bullet_key, associations)
         end
 
+        # possible_objects keep the class to object relationships
+        # that the objects may cause N+1 query.
+        # e.g. { Post => ["Post:1", "Post:2"] }
+        def possible_objects
+          Thread.current[:bullet_possible_objects]
+        end
+
+        # impossible_objects keep the class to objects relationships
+        # that the objects may not cause N+1 query.
+        # e.g. { Post => ["Post:1", "Post:2"] }
+        # if find collection returns only one object, then the object is impossible object,
+        # impossible_objects are used to avoid treating 1+1 query to N+1 query.
+        def impossible_objects
+          Thread.current[:bullet_impossible_objects]
+        end
+
         private
           # object_associations keep the object relationships
           # that the object has many associations.
@@ -38,21 +54,11 @@ module Bullet
             Thread.current[:bullet_call_object_associations]
           end
 
-          # possible_objects keep the class to object relationships
-          # that the objects may cause N+1 query.
-          # e.g. { Post => ["Post:1", "Post:2"] }
-          def possible_objects
-            Thread.current[:bullet_possible_objects]
-          end
-
-          # impossible_objects keep the class to objects relationships
-          # that the objects may not cause N+1 query.
-          # e.g. { Post => ["Post:1", "Post:2"] }
-          # Notice: impossible_objects are not accurate,
-          # if find collection returns only one object, then the object is impossible object,
-          # impossible_objects are used to avoid treating 1+1 query to N+1 query.
-          def impossible_objects
-            Thread.current[:bullet_impossible_objects]
+          # 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

data/lib/bullet/detector/counter_cache.rb

@@ -5,10 +5,10 @@ module Bullet
         def add_counter_cache(object, associations)
           return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
-          return unless object.id
+          return unless object.primary_key_value
 
           Bullet.debug("Detector::CounterCache#add_counter_cache", "object: #{object.bullet_key}, associations: #{associations}")
-          if conditions_met?(object.bullet_key, associations)
+          if conditions_met?(object, associations)
             create_notification object.class.to_s, associations
           end
         end
@@ -17,7 +17,7 @@ module Bullet
           return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
           objects = Array(object_or_objects)
-          return if objects.map(&:id).compact.empty?
+          return if objects.map(&:primary_key_value).compact.empty?
 
           Bullet.debug("Detector::CounterCache#add_possible_objects", "objects: #{objects.map(&:bullet_key).join(', ')}")
           objects.each { |object| possible_objects.add object.bullet_key }
@@ -26,12 +26,24 @@ module Bullet
         def add_impossible_object(object)
           return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
-          return unless object.id
+          return unless object.primary_key_value
 
           Bullet.debug("Detector::CounterCache#add_impossible_object", "object: #{object.bullet_key}")
           impossible_objects.add object.bullet_key
         end
 
+        def conditions_met?(object, associations)
+          possible_objects.include?(object.bullet_key) && !impossible_objects.include?(object.bullet_key)
+        end
+
+        def possible_objects
+          Thread.current[:bullet_counter_possible_objects]
+        end
+
+        def impossible_objects
+          Thread.current[:bullet_counter_impossible_objects]
+        end
+
         private
           def create_notification(klazz, associations)
             notify_associations = Array(associations) - Bullet.get_whitelist_associations(:counter_cache, klazz)
@@ -41,18 +53,6 @@ module Bullet
               Bullet.notification_collector.add notice
             end
           end
-
-          def possible_objects
-            Thread.current[:bullet_counter_possible_objects]
-          end
-
-          def impossible_objects
-            Thread.current[:bullet_counter_impossible_objects]
-          end
-
-          def conditions_met?(bullet_key, associations)
-            possible_objects.include?(bullet_key) && !impossible_objects.include?(bullet_key)
-          end
       end
     end
   end

data/lib/bullet/detector/n_plus_one_query.rb

@@ -10,11 +10,12 @@ module Bullet
         #   if it is, keeps this unpreload associations and caller.
         def call_association(object, associations)
           return unless Bullet.start?
-          return unless object.id
+          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", "object: #{object.bullet_key}, associations: #{associations}")
-          if conditions_met?(object.bullet_key, associations)
+          if 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
           end
@@ -24,7 +25,7 @@ module Bullet
           return unless Bullet.start?
           return unless Bullet.n_plus_one_query_enable?
           objects = Array(object_or_objects)
-          return if objects.map(&:id).compact.empty?
+          return if objects.map(&:primary_key_value).compact.empty?
 
           Bullet.debug("Detector::NPlusOneQuery#add_possible_objects", "objects: #{objects.map(&:bullet_key).join(', ')}")
           objects.each { |object| possible_objects.add object.bullet_key }
@@ -33,12 +34,50 @@ module Bullet
         def add_impossible_object(object)
           return unless Bullet.start?
           return unless Bullet.n_plus_one_query_enable?
-          return unless object.id
+          return unless object.primary_key_value
 
           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
+
+          Bullet.debug("Detector::NPlusOneQuery#add_inversed_object", "object: #{object.bullet_key}, association: #{association}")
+          inversed_objects.add object.bullet_key, association
+        end
+
+        # decide whether the object.associations is unpreloaded or not.
+        def conditions_met?(object, associations)
+          possible?(object) && !impossible?(object) && !association?(object, associations)
+        end
+
+        def possible?(object)
+          possible_objects.include? object.bullet_key
+        end
+
+        def impossible?(object)
+          impossible_objects.include? object.bullet_key
+        end
+
+        # 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.has_key?(associations) : associations == v
+              return true if result
+            end
+          end
+
+          false
+        end
+
         private
           def create_notification(callers, klazz, associations)
             notify_associations = Array(associations) - Bullet.get_whitelist_associations(:n_plus_one_query, klazz)
@@ -49,11 +88,6 @@ module Bullet
             end
           end
 
-          # decide whether the object.associations is unpreloaded or not.
-          def conditions_met?(bullet_key, associations)
-            possible?(bullet_key) && !impossible?(bullet_key) && !association?(bullet_key, associations)
-          end
-
           def caller_in_project
             app_root = rails? ? Rails.root.to_s : Dir.pwd
             vendor_root = app_root + "/vendor"
@@ -62,27 +96,6 @@ module Bullet
               Bullet.stacktrace_includes.any? { |include| c.include?(include) }
             end
           end
-
-          def possible?(bullet_key)
-            possible_objects.include? bullet_key
-          end
-
-          def impossible?(bullet_key)
-            impossible_objects.include? bullet_key
-          end
-
-          # check if object => associations already exists in object_associations.
-          def association?(bullet_key, associations)
-            value = object_associations[bullet_key]
-            if value
-              value.each do |v|
-                result = v.is_a?(Hash) ? v.has_key?(associations) : v == associations
-                return true if result
-              end
-            end
-
-            return false
-          end
       end
     end
   end

data/lib/bullet/detector/unused_eager_loading.rb

@@ -22,7 +22,7 @@ module Bullet
         def add_eager_loadings(objects, associations)
           return unless Bullet.start?
           return unless Bullet.unused_eager_loading_enable?
-          return if objects.map(&:id).compact.empty?
+          return if objects.map(&:primary_key_value).compact.empty?
 
           Bullet.debug("Detector::UnusedEagerLoading#add_eager_loadings", "objects: #{objects.map(&:bullet_key).join(', ')}, associations: #{associations}")
           bullet_keys = objects.map(&:bullet_key)
@@ -47,7 +47,7 @@ module Bullet
             end
           end
 
-          eager_loadings.add *to_add if to_add
+          eager_loadings.add(*to_add) if to_add
           to_merge.each { |k,val| eager_loadings.merge k, val }
           to_delete.each { |k| eager_loadings.delete k }
 

data/lib/bullet/ext/object.rb

@@ -1,9 +1,13 @@
 class Object
   def bullet_key
+    "#{self.class}:#{self.primary_key_value}"
+  end
+
+  def primary_key_value
     if self.class.respond_to?(:primary_key) && self.class.primary_key
-      "#{self.class}:#{self.send self.class.primary_key}"
+      self.send self.class.primary_key
     else
-      "#{self.class}:#{self.id}"
+      self.id
     end
   end
 end