bullet 5.0.0 → 5.2.0

data/lib/bullet/active_record42.rb

@@ -29,6 +29,14 @@ module Bullet
           end
         end
         alias_method_chain :save, :bullet
+
+        def save_with_bullet!(*args, &proc)
+          was_new_record = new_record?
+          save_without_bullet!(*args, &proc).tap do |result|
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(self) if result && was_new_record
+          end
+        end
+        alias_method_chain :save!, :bullet
       end
 
       ::ActiveRecord::Relation.class_eval do
@@ -127,7 +135,9 @@ module Bullet
           records = origin_load_target
 
           if Bullet.start?
-            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless @inversed
+            if records.size > 1
+              Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless @inversed
+            end
             if records.first.class.name !~ /^HABTM_/
               if records.size > 1
                 Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
@@ -143,7 +153,7 @@ module Bullet
 
         alias_method :origin_empty?, :empty?
         def empty?
-          if Bullet.start?
+          if Bullet.start? && !has_cached_counter?(@reflection)
             Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
           end
           origin_empty?
@@ -183,7 +193,7 @@ module Bullet
           Thread.current[:bullet_collection_empty] = true
           result = origin_many_empty?
           Thread.current[:bullet_collection_empty] = nil
-          if Bullet.start?
+          if Bullet.start? && !has_cached_counter?(@reflection)
             Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
           end
           result

data/lib/bullet/active_record5.rb

@@ -1,4 +1,20 @@
 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
+      end
+    end
+  end
+
   module ActiveRecord
     def self.enable
       require 'active_record'
@@ -21,49 +37,33 @@ module Bullet
         end
       end
 
-      ::ActiveRecord::Persistence.class_eval do
-        def save_with_bullet(*args, &proc)
-          was_new_record = new_record?
-          save_without_bullet(*args, &proc).tap do |result|
-            Bullet::Detector::NPlusOneQuery.add_impossible_object(self) if result && was_new_record
-          end
-        end
-        alias_method_chain :save, :bullet
-      end
+      ::ActiveRecord::Base.prepend(SaveWithBulletSupport)
 
       ::ActiveRecord::Relation.class_eval do
-        alias_method :origin_to_a, :to_a
+        alias_method :origin_records, :records
         # 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
+        def records
+          result = origin_records
           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)
+            if result.first.class.name !~ /^HABTM_/
+              if result.size > 1
+                Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
+                Bullet::Detector::CounterCache.add_possible_objects(result)
+              elsif result.size == 1
+                Bullet::Detector::NPlusOneQuery.add_impossible_object(result.first)
+                Bullet::Detector::CounterCache.add_impossible_object(result.first)
               end
             end
           end
-          records
-        end
-      end
-
-      ::ActiveRecord::Associations::Association.class_eval do
-        alias_method :origin_initialize, :initialize
-        def initialize(owner, reflection)
-          origin_initialize(owner, reflection)
-          reflection.set_owner owner
+          result
         end
       end
 
       ::ActiveRecord::Associations::Preloader.class_eval do
-        alias_method :origin_preloaders_on, :preloaders_on
+        alias_method :origin_preloaders_for_one, :preloaders_for_one
 
-        def preloaders_on(association, records, scope)
+        def preloaders_for_one(association, records, scope)
           if Bullet.start?
             records.compact!
             if records.first.class.name !~ /^HABTM_/
@@ -73,7 +73,7 @@ module Bullet
               Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, association)
             end
           end
-          origin_preloaders_on(association, records, scope)
+          origin_preloaders_for_one(association, records, scope)
         end
       end
 
@@ -135,7 +135,16 @@ module Bullet
           records = origin_load_target
 
           if Bullet.start?
-            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless @inversed
+            if records.size > 1
+              if self.is_a? ::ActiveRecord::Associations::ThroughAssociation
+                Bullet::Detector::NPlusOneQuery.call_association(owner, through_reflection.name)
+                association = self.owner.association self.through_reflection.name
+                association.target.each do |through_record|
+                  Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
+                end
+              end
+              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) unless @inversed
+            end
             if records.first.class.name !~ /^HABTM_/
               if records.size > 1
                 Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
@@ -151,8 +160,8 @@ module Bullet
 
         alias_method :origin_empty?, :empty?
         def empty?
-          if Bullet.start?
-            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          if Bullet.start? && !reflection.has_cached_counter?
+            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
           end
           origin_empty?
         end
@@ -160,7 +169,7 @@ module Bullet
         alias_method :origin_include?, :include?
         def include?(object)
           if Bullet.start?
-            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
           end
           origin_include?(object)
         end
@@ -172,9 +181,9 @@ module Bullet
         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)
+            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
@@ -188,28 +197,20 @@ module Bullet
       ::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)
+          if Bullet.start? && !reflection.has_cached_counter?
+            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
           end
           result
         end
-      end
-
-      ::ActiveRecord::Reflection::AbstractReflection.class_eval do
-        def set_owner(owner)
-          @owner = owner
-        end
 
-        alias_method :origin_has_cached_counter?, :has_cached_counter?
-        def has_cached_counter?
-          result = origin_has_cached_counter?
-          if Bullet.start? && !result && !Thread.current[:bullet_collection_empty]
-            Bullet::Detector::CounterCache.add_counter_cache(@owner, @name)
+        alias_method :origin_count_records, :count_records
+        def count_records
+          result = reflection.has_cached_counter?
+          if Bullet.start? && !result && !self.is_a?(::ActiveRecord::Associations::ThroughAssociation)
+            Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
           end
-          result
+          origin_count_records
         end
       end
     end

data/lib/bullet/detector/unused_eager_loading.rb

@@ -27,27 +27,25 @@ 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 = nil
-          to_merge, to_delete = [], []
+          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
             if key_objects_overlap == k
-              to_add = [k, associations]
-              break
+              to_add << [k, associations]
             else
               to_merge << [key_objects_overlap, ( eager_loadings[k].dup  << associations )]
 
-              keys_without_objects = k - bullet_keys
+              keys_without_objects = k - key_objects_overlap
               to_merge << [keys_without_objects, eager_loadings[k]]
               to_delete << k
-              bullet_keys = bullet_keys - k
             end
           end
 
-          eager_loadings.add(*to_add) if to_add
+          to_add.each { |k, val| eager_loadings.add k, val }
           to_merge.each { |k, val| eager_loadings.merge k, val }
           to_delete.each { |k| eager_loadings.delete k }
 

data/lib/bullet/notification/base.rb

@@ -57,11 +57,11 @@ module Bullet
       end
 
       def eql?(other)
-        klazz_associations_str == other.klazz_associations_str
+        self.class == other.class && klazz_associations_str == other.klazz_associations_str
       end
 
       def hash
-        klazz_associations_str.hash
+        [self.class, klazz_associations_str].hash
       end
 
       protected

data/lib/bullet/rack.rb

@@ -67,7 +67,7 @@ module Bullet
     end
 
     def response_body(response)
-      if rails?
+      if response.respond_to?(:body)
         Array === response.body ? response.body.first : response.body
       else
         response.first

data/lib/bullet/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Bullet
-  VERSION = "5.0.0"
+  VERSION = "5.2.0"
 end

data/lib/bullet.rb

@@ -82,8 +82,8 @@ module Bullet
 
     def add_whitelist(options)
       reset_whitelist
-      @whitelist[options[:type]][options[:class_name].classify] ||= []
-      @whitelist[options[:type]][options[:class_name].classify] << options[:association].to_sym
+      @whitelist[options[:type]][options[:class_name]] ||= []
+      @whitelist[options[:type]][options[:class_name]] << options[:association].to_sym
     end
 
     def get_whitelist_associations(type, class_name)
@@ -190,17 +190,22 @@ module Bullet
     end
 
     def profile
+      return_value = nil
       if Bullet.enable?
         begin
           Bullet.start_request
 
-          yield
+          return_value = yield
 
           Bullet.perform_out_of_channel_notifications if Bullet.notification?
         ensure
           Bullet.end_request
         end
+      else
+        return_value = yield
       end
+
+      return_value
     end
 
     private

data/spec/bullet/detector/unused_eager_loading_spec.rb

@@ -5,7 +5,8 @@ module Bullet
     describe UnusedEagerLoading do
       before(:all) do
         @post = Post.first
-        @post2 = Post.last
+        @post2 = Post.all[1]
+        @post3 = Post.last
       end
 
       context ".call_associations" do
@@ -72,7 +73,18 @@ module Bullet
           UnusedEagerLoading.add_eager_loadings([@post, @post2], :association2)
           expect(UnusedEagerLoading.send(:eager_loadings)).to be_include([@post.bullet_key], :association1)
           expect(UnusedEagerLoading.send(:eager_loadings)).to be_include([@post.bullet_key], :association2)
-          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include([@post.bullet_key, @post2.bullet_key], :association2)
+          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include([@post2.bullet_key], :association2)
+        end
+
+        it "should vmerge objects recursively, associations pair for existing eager_loadings" do
+          UnusedEagerLoading.add_eager_loadings([@post, @post2], :association1)
+          UnusedEagerLoading.add_eager_loadings([@post, @post3], :association1)
+          UnusedEagerLoading.add_eager_loadings([@post, @post3], :association2)
+          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include([@post.bullet_key], :association1)
+          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include([@post.bullet_key], :association2)
+          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include([@post2.bullet_key], :association1)
+          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include([@post3.bullet_key], :association1)
+          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include([@post3.bullet_key], :association2)
         end
 
         it "should delete objects, associations pair for existing eager_loadings" do

data/spec/bullet/rack_spec.rb

@@ -93,5 +93,36 @@ module Bullet
         end
       end
     end
+
+    describe "#response_body" do
+      let(:response) { double }
+      let(:body_string) { "<html><body>My Body</body></html>" }
+
+      context "when `response` responds to `body`" do
+        before { allow(response).to receive(:body).and_return(body) }
+
+        context "when `body` returns an Array" do
+          let(:body) { [body_string, 'random string'] }
+          it "should return the plain body string" do
+            expect(middleware.response_body(response)).to eq body_string
+          end
+        end
+
+        context "when `body` does not return an Array" do
+          let(:body) { body_string }
+          it "should return the plain body string" do
+            expect(middleware.response_body(response)).to eq body_string
+          end
+        end
+      end
+
+      context "when `response` does not respond to `body`" do
+        before { allow(response).to receive(:first).and_return(body_string) }
+
+        it "should return the plain body string" do
+          expect(middleware.response_body(response)).to eq body_string
+        end
+      end
+    end
   end
 end

data/spec/bullet_spec.rb

@@ -85,4 +85,13 @@ describe Bullet, focused: true do
       end
     end
   end
+
+  describe '#add_whitelist' do
+    context "for 'special' class names" do
+      it 'is added to the whitelist successfully' do
+        Bullet.add_whitelist(:type => :n_plus_one_query, :class_name => 'Klass', :association => :department)
+        expect(Bullet.get_whitelist_associations(:n_plus_one_query, 'Klass')).to include :department
+      end
+    end
+  end
 end

data/spec/integration/active_record3/association_spec.rb

@@ -72,6 +72,16 @@ if !mongoid? && active_record3?
 
         expect(Bullet::Detector::Association).to be_detecting_unpreloaded_association_for(Post, :comments)
       end
+
+      it "should not detect unused preload person => pets with empty?" do
+        Person.all.each do |person|
+          person.pets.empty?
+        end
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+        expect(Bullet::Detector::Association).to be_completely_preloading_associations
+      end
     end
 
     context "category => posts => comments" do
@@ -204,7 +214,7 @@ if !mongoid? && active_record3?
     context "post => comment" do
       it "should detect unused preload with post => comments" do
         Post.includes(:comments).each do |post|
-          post.comments.first.name
+          post.comments.first.name if post.comments.first
         end
         Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
         expect(Bullet::Detector::Association).not_to be_unused_preload_associations_for(Post, :comments)
@@ -443,6 +453,16 @@ if !mongoid? && active_record3?
 
         expect(Bullet::Detector::Association).to be_completely_preloading_associations
       end
+
+      it "should detect non preload student => teachers with empty?" do
+        Student.all.each do |student|
+          student.teachers.empty?
+        end
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+        expect(Bullet::Detector::Association).to be_detecting_unpreloaded_association_for(Student, :teachers)
+      end
     end
   end
 
@@ -537,6 +557,50 @@ if !mongoid? && active_record3?
     end
   end
 
+  describe Bullet::Detector::Association, "query immediately after creation" do
+    context "with save" do
+      context "document => children" do
+        it 'should not detect non preload associations' do
+          document1 = Document.new
+          document1.children.build
+          document1.save
+
+          document2 = Document.new(parent: document1)
+          document2.save
+          document2.parent
+
+          document1.children.each.first
+
+          Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+          expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+          expect(Bullet::Detector::Association).to be_completely_preloading_associations
+        end
+      end
+    end
+
+    context "with save!" do
+      context "document => children" do
+        it 'should not detect non preload associations' do
+          document1 = Document.new
+          document1.children.build
+          document1.save!
+
+          document2 = Document.new(parent: document1)
+          document2.save!
+          document2.parent
+
+          document1.children.each.first
+
+          Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+          expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+          expect(Bullet::Detector::Association).to be_completely_preloading_associations
+        end
+      end
+    end
+  end
+
   describe Bullet::Detector::Association, "STI" do
     context "page => author" do
       it "should detect non preload associations" do

data/spec/integration/active_record4/association_spec.rb

@@ -72,6 +72,16 @@ if !mongoid? && active_record4?
 
         expect(Bullet::Detector::Association).to be_detecting_unpreloaded_association_for(Post, :comments)
       end
+
+      it "should not detect unused preload person => pets with empty?" do
+        Person.all.each do |person|
+          person.pets.empty?
+        end
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+        expect(Bullet::Detector::Association).to be_completely_preloading_associations
+      end
     end
 
     context "category => posts => comments" do
@@ -204,7 +214,7 @@ if !mongoid? && active_record4?
     context "post => comment" do
       it "should detect unused preload with post => comments" do
         Post.includes(:comments).each do |post|
-          post.comments.first.name
+          post.comments.first.name if post.comments.first
         end
         Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
         expect(Bullet::Detector::Association).not_to be_unused_preload_associations_for(Post, :comments)
@@ -455,6 +465,16 @@ if !mongoid? && active_record4?
 
         expect(Bullet::Detector::Association).to be_completely_preloading_associations
       end
+
+      it "should detect non preload student => teachers with empty?" do
+        Student.all.each do |student|
+          student.teachers.empty?
+        end
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+        expect(Bullet::Detector::Association).to be_detecting_unpreloaded_association_for(Student, :teachers)
+      end
     end
   end
 
@@ -561,22 +581,45 @@ if !mongoid? && active_record4?
   end
 
   describe Bullet::Detector::Association, "query immediately after creation" do
-    context "document => children" do
-      it 'should not detect non preload associations' do
-        document1 = Document.new
-        document1.children.build
-        document1.save
+    context "with save" do
+      context "document => children" do
+        it 'should not detect non preload associations' do
+          document1 = Document.new
+          document1.children.build
+          document1.save
 
-        document2 = Document.new(parent: document1)
-        document2.save
-        document2.parent
+          document2 = Document.new(parent: document1)
+          document2.save
+          document2.parent
 
-        document1.children.each.first
+          document1.children.each.first
 
-        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
-        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+          Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+          expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
 
-        expect(Bullet::Detector::Association).to be_completely_preloading_associations
+          expect(Bullet::Detector::Association).to be_completely_preloading_associations
+        end
+      end
+    end
+
+    context "with save!" do
+      context "document => children" do
+        it 'should not detect non preload associations' do
+          document1 = Document.new
+          document1.children.build
+          document1.save!
+
+          document2 = Document.new(parent: document1)
+          document2.save!
+          document2.parent
+
+          document1.children.each.first
+
+          Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+          expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+          expect(Bullet::Detector::Association).to be_completely_preloading_associations
+        end
       end
     end
   end