bullet 4.13.1 → 5.0.0

data/spec/bullet/detector/n_plus_one_query_spec.rb

@@ -18,73 +18,88 @@ module Bullet
       context ".possible?" do
         it "should be true if possible_objects contain" do
           NPlusOneQuery.add_possible_objects(@post)
-          expect(NPlusOneQuery.send(:possible?, @post.bullet_key)).to eq true
+          expect(NPlusOneQuery.possible?(@post)).to eq true
         end
       end
 
       context ".impossible?" do
         it "should be true if impossible_objects contain" do
           NPlusOneQuery.add_impossible_object(@post)
-          expect(NPlusOneQuery.send(:impossible?, @post.bullet_key)).to eq true
+          expect(NPlusOneQuery.impossible?(@post)).to eq true
         end
       end
 
       context ".association?" do
         it "should be true if object, associations pair is already existed" do
           NPlusOneQuery.add_object_associations(@post, :association)
-          expect(NPlusOneQuery.send(:association?, @post.bullet_key, :association)).to eq true
+          expect(NPlusOneQuery.association?(@post, :association)).to eq true
         end
 
         it "should be false if object, association pair is not existed" do
           NPlusOneQuery.add_object_associations(@post, :association1)
-          expect(NPlusOneQuery.send(:association?, @post.bullet_key, :associatio2)).to eq false
+          expect(NPlusOneQuery.association?(@post, :associatio2)).to eq false
         end
       end
 
       context ".conditions_met?" do
         it "should be true if object is possible, not impossible and object, associations pair is not already existed" do
-          allow(NPlusOneQuery).to receive(:possible?).with(@post.bullet_key).and_return(true)
-          allow(NPlusOneQuery).to receive(:impossible?).with(@post.bullet_key).and_return(false)
-          allow(NPlusOneQuery).to receive(:association?).with(@post.bullet_key, :associations).and_return(false)
-          expect(NPlusOneQuery.send(:conditions_met?, @post.bullet_key, :associations)).to eq true
+          allow(NPlusOneQuery).to receive(:possible?).with(@post).and_return(true)
+          allow(NPlusOneQuery).to receive(:impossible?).with(@post).and_return(false)
+          allow(NPlusOneQuery).to receive(:association?).with(@post, :associations).and_return(false)
+          expect(NPlusOneQuery.conditions_met?(@post, :associations)).to eq true
         end
 
         it "should be false if object is not possible, not impossible and object, associations pair is not already existed" do
-          allow(NPlusOneQuery).to receive(:possible?).with(@post.bullet_key).and_return(false)
-          allow(NPlusOneQuery).to receive(:impossible?).with(@post.bullet_key).and_return(false)
-          allow(NPlusOneQuery).to receive(:association?).with(@post.bullet_key, :associations).and_return(false)
-          expect(NPlusOneQuery.send(:conditions_met?, @post.bullet_key, :associations)).to eq false
+          allow(NPlusOneQuery).to receive(:possible?).with(@post).and_return(false)
+          allow(NPlusOneQuery).to receive(:impossible?).with(@post).and_return(false)
+          allow(NPlusOneQuery).to receive(:association?).with(@post, :associations).and_return(false)
+          expect(NPlusOneQuery.conditions_met?(@post, :associations)).to eq false
         end
 
         it "should be false if object is possible, but impossible and object, associations pair is not already existed" do
-          allow(NPlusOneQuery).to receive(:possible?).with(@post.bullet_key).and_return(true)
-          allow(NPlusOneQuery).to receive(:impossible?).with(@post.bullet_key).and_return(true)
-          allow(NPlusOneQuery).to receive(:association?).with(@post.bullet_key, :associations).and_return(false)
-          expect(NPlusOneQuery.send(:conditions_met?, @post.bullet_key, :associations)).to eq false
+          allow(NPlusOneQuery).to receive(:possible?).with(@post).and_return(true)
+          allow(NPlusOneQuery).to receive(:impossible?).with(@post).and_return(true)
+          allow(NPlusOneQuery).to receive(:association?).with(@post, :associations).and_return(false)
+          expect(NPlusOneQuery.conditions_met?(@post, :associations)).to eq false
         end
 
         it "should be false if object is possible, not impossible and object, associations pair is already existed" do
-          allow(NPlusOneQuery).to receive(:possible?).with(@post.bullet_key).and_return(true)
-          allow(NPlusOneQuery).to receive(:impossible?).with(@post.bullet_key).and_return(false)
-          allow(NPlusOneQuery).to receive(:association?).with(@post.bullet_key, :associations).and_return(true)
-          expect(NPlusOneQuery.send(:conditions_met?, @post.bullet_key, :associations)).to eq false
+          allow(NPlusOneQuery).to receive(:possible?).with(@post).and_return(true)
+          allow(NPlusOneQuery).to receive(:impossible?).with(@post).and_return(false)
+          allow(NPlusOneQuery).to receive(:association?).with(@post, :associations).and_return(true)
+          expect(NPlusOneQuery.conditions_met?(@post, :associations)).to eq false
         end
       end
 
       context ".call_association" do
         it "should create notification if conditions met" do
-          expect(NPlusOneQuery).to receive(:conditions_met?).with(@post.bullet_key, :association).and_return(true)
+          expect(NPlusOneQuery).to receive(:conditions_met?).with(@post, :association).and_return(true)
           expect(NPlusOneQuery).to receive(:caller_in_project).and_return(["caller"])
           expect(NPlusOneQuery).to receive(:create_notification).with(["caller"], "Post", :association)
           NPlusOneQuery.call_association(@post, :association)
         end
 
         it "should not create notification if conditions not met" do
-          expect(NPlusOneQuery).to receive(:conditions_met?).with(@post.bullet_key, :association).and_return(false)
+          expect(NPlusOneQuery).to receive(:conditions_met?).with(@post, :association).and_return(false)
           expect(NPlusOneQuery).not_to receive(:caller_in_project!)
           expect(NPlusOneQuery).not_to receive(:create_notification).with("Post", :association)
           NPlusOneQuery.call_association(@post, :association)
         end
+
+        context "stacktrace_excludes" do
+          before { Bullet.stacktrace_excludes = [ 'def' ] }
+          after { Bullet.stacktrace_excludes = nil }
+
+          it "should not create notification when stacktrace contains paths that are in the exclude list" do
+            in_project = File.join(Dir.pwd, 'abc', 'abc.rb')
+            included_path = '/ghi/ghi.rb'
+            excluded_path = '/def/def.rb'
+
+            expect(NPlusOneQuery).to receive(:caller).and_return([in_project, included_path, excluded_path])
+            expect(NPlusOneQuery).to_not receive(:create_notification)
+            NPlusOneQuery.call_association(@post, :association)
+          end
+        end
       end
 
       context ".caller_in_project" do
@@ -93,7 +108,7 @@ module Bullet
           not_in_project = '/def/def.rb'
 
           expect(NPlusOneQuery).to receive(:caller).and_return([in_project, not_in_project])
-          expect(NPlusOneQuery).to receive(:conditions_met?).with(@post.bullet_key, :association).and_return(true)
+          expect(NPlusOneQuery).to receive(:conditions_met?).with(@post, :association).and_return(true)
           expect(NPlusOneQuery).to receive(:create_notification).with([in_project], "Post", :association)
           NPlusOneQuery.call_association(@post, :association)
         end
@@ -108,7 +123,7 @@ module Bullet
             excluded_gem = '/ghi/ghi.rb'
 
             expect(NPlusOneQuery).to receive(:caller).and_return([in_project, included_gem, excluded_gem])
-            expect(NPlusOneQuery).to receive(:conditions_met?).with(@post.bullet_key, :association).and_return(true)
+            expect(NPlusOneQuery).to receive(:conditions_met?).with(@post, :association).and_return(true)
             expect(NPlusOneQuery).to receive(:create_notification).with([in_project, included_gem], "Post", :association)
             NPlusOneQuery.call_association(@post, :association)
           end
@@ -118,8 +133,8 @@ module Bullet
       context ".add_possible_objects" do
         it "should add possible objects" do
           NPlusOneQuery.add_possible_objects([@post, @post2])
-          expect(NPlusOneQuery.send(:possible_objects)).to be_include(@post.bullet_key)
-          expect(NPlusOneQuery.send(:possible_objects)).to be_include(@post2.bullet_key)
+          expect(NPlusOneQuery.possible_objects).to be_include(@post.bullet_key)
+          expect(NPlusOneQuery.possible_objects).to be_include(@post2.bullet_key)
         end
 
         it "should not raise error if object is nil" do
@@ -130,7 +145,7 @@ module Bullet
       context ".add_impossible_object" do
         it "should add impossible object" do
           NPlusOneQuery.add_impossible_object(@post)
-          expect(NPlusOneQuery.send(:impossible_objects)).to be_include(@post.bullet_key)
+          expect(NPlusOneQuery.impossible_objects).to be_include(@post.bullet_key)
         end
       end
     end

data/spec/bullet/ext/object_spec.rb

@@ -27,5 +27,11 @@ describe Object do
       expect(post.primary_key_value).to eq(post.name)
       Post.primary_key = 'id'
     end
+
+    it "should return value for multiple primary keys" do
+      post = Post.first
+      allow(Post).to receive(:primary_keys).and_return([:category_id, :writer_id])
+      expect(post.primary_key_value).to eq("#{post.category_id},#{post.writer_id}")
+    end
   end
 end

data/spec/bullet/notification/base_spec.rb

@@ -30,14 +30,14 @@ module Bullet
         end
 
         it "should return blank if no user available" do
-          temp_env_variable("USER","") do
+          temp_env_variable("USER", "") do
             expect(subject).to receive(:`).with("whoami").and_return("")
             expect(subject.whoami).to eq("")
           end
         end
 
         it "should return blank if whoami is not available" do
-          temp_env_variable("USER","") do
+          temp_env_variable("USER", "") do
             expect(subject).to receive(:`).with("whoami").and_raise(Errno::ENOENT)
             expect(subject.whoami).to eq("")
           end
@@ -56,33 +56,8 @@ module Bullet
       context "#body_with_caller" do
         it "should return body" do
           allow(subject).to receive(:body).and_return("body")
-          expect(subject.body_with_caller).to eq("body")
-        end
-      end
-
-      context "#standard_notice" do
-        it "should return title + body" do
-          allow(subject).to receive(:title).and_return("title")
-          allow(subject).to receive(:body).and_return("body")
-          expect(subject.standard_notice).to eq("title\nbody")
-        end
-      end
-
-      context "#full_notice" do
-        it "should return whoami + url + title + body_with_caller" do
-          allow(subject).to receive(:whoami).and_return("whoami")
-          allow(subject).to receive(:url).and_return("url")
-          allow(subject).to receive(:title).and_return("title")
-          allow(subject).to receive(:body_with_caller).and_return("body_with_caller")
-          expect(subject.full_notice).to eq("whoami\nurl\ntitle\nbody_with_caller")
-        end
-
-        it "should return url + title + body_with_caller" do
-          allow(subject).to receive(:whoami).and_return("")
-          allow(subject).to receive(:url).and_return("url")
-          allow(subject).to receive(:title).and_return("title")
-          allow(subject).to receive(:body_with_caller).and_return("body_with_caller")
-          expect(subject.full_notice).to eq("url\ntitle\nbody_with_caller")
+          allow(subject).to receive(:call_stack_messages).and_return("call_stack_messages")
+          expect(subject.body_with_caller).to eq("body\ncall_stack_messages\n")
         end
       end
 

data/spec/bullet/notification/n_plus_one_query_spec.rb

@@ -5,9 +5,9 @@ module Bullet
     describe NPlusOneQuery do
       subject { NPlusOneQuery.new([["caller1", "caller2"]], Post, [:comments, :votes], "path") }
 
-      it { expect(subject.body_with_caller).to eq("  Post => [:comments, :votes]\n  Add to your finder: :include => [:comments, :votes]\nN+1 Query method call stack\n  caller1\n  caller2") }
-      it { expect([ subject.body_with_caller, subject.body_with_caller]).to eq([ "  Post => [:comments, :votes]\n  Add to your finder: :include => [:comments, :votes]\nN+1 Query method call stack\n  caller1\n  caller2", "  Post => [:comments, :votes]\n  Add to your finder: :include => [:comments, :votes]\nN+1 Query method call stack\n  caller1\n  caller2" ]) }
-      it { expect(subject.body).to eq("  Post => [:comments, :votes]\n  Add to your finder: :include => [:comments, :votes]") }
+      it { expect(subject.body_with_caller).to eq("  Post => [:comments, :votes]\n  Add to your finder: :includes => [:comments, :votes]\nN+1 Query method call stack\n  caller1\n  caller2\n") }
+      it { expect([subject.body_with_caller, subject.body_with_caller]).to eq([ "  Post => [:comments, :votes]\n  Add to your finder: :includes => [:comments, :votes]\nN+1 Query method call stack\n  caller1\n  caller2\n", "  Post => [:comments, :votes]\n  Add to your finder: :includes => [:comments, :votes]\nN+1 Query method call stack\n  caller1\n  caller2\n" ]) }
+      it { expect(subject.body).to eq("  Post => [:comments, :votes]\n  Add to your finder: :includes => [:comments, :votes]") }
       it { expect(subject.title).to eq("N+1 Query in path") }
     end
   end

data/spec/bullet/notification/unused_eager_loading_spec.rb

@@ -5,7 +5,7 @@ module Bullet
     describe UnusedEagerLoading do
       subject { UnusedEagerLoading.new(Post, [:comments, :votes], "path") }
 
-      it { expect(subject.body).to eq("  Post => [:comments, :votes]\n  Remove from your finder: :include => [:comments, :votes]") }
+      it { expect(subject.body).to eq("  Post => [:comments, :votes]\n  Remove from your finder: :includes => [:comments, :votes]") }
       it { expect(subject.title).to eq("Unused Eager Loading in path") }
     end
   end

data/spec/bullet/rack_spec.rb

@@ -65,19 +65,19 @@ module Bullet
         end
 
         it "should change response body if notification is active" do
-          expect(Bullet).to receive(:notification?).and_return(true).twice
+          expect(Bullet).to receive(:notification?).and_return(true)
           expect(Bullet).to receive(:gather_inline_notifications).and_return("<bullet></bullet>")
           expect(Bullet).to receive(:perform_out_of_channel_notifications)
           status, headers, response = middleware.call([200, {"Content-Type" => "text/html"}])
           expect(headers["Content-Length"]).to eq("56")
-          expect(response).to eq(["<html><head></head><body></body></html><bullet></bullet>"])
+          expect(response).to eq(["<html><head></head><body><bullet></bullet></body></html>"])
         end
 
         it "should set the right Content-Length if response body contains accents" do
           response = Support::ResponseDouble.new
           response.body = "<html><head></head><body>é</body></html>"
           app.response = response
-          expect(Bullet).to receive(:notification?).and_return(true).twice
+          expect(Bullet).to receive(:notification?).and_return(true)
           expect(Bullet).to receive(:gather_inline_notifications).and_return("<bullet></bullet>")
           status, headers, response = middleware.call([200, {"Content-Type" => "text/html"}])
           expect(headers["Content-Length"]).to eq("58")

data/spec/bullet_spec.rb

@@ -38,4 +38,51 @@ describe Bullet, focused: true do
       end
     end
   end
+
+  describe '#start?' do
+    context 'when bullet is disabled' do
+      before(:each) do
+        Bullet.enable = false
+      end
+
+      it 'should not be started' do
+        expect(Bullet).not_to be_start
+      end
+    end
+  end
+
+  describe '#debug' do
+    before(:each) do
+      $stdout = StringIO.new
+    end
+
+    after(:each) do
+      $stdout = STDOUT
+    end
+
+    context 'when debug is enabled' do
+      before(:each) do
+        ENV['BULLET_DEBUG'] = 'true'
+      end
+
+      after(:each) do
+        ENV['BULLET_DEBUG'] = 'false'
+      end
+
+      it 'should output debug information' do
+        Bullet.debug('debug_message', 'this is helpful information')
+
+        expect($stdout.string)
+          .to eq("[Bullet][debug_message] this is helpful information\n")
+      end
+    end
+
+    context 'when debug is disabled' do
+      it 'should output debug information' do
+        Bullet.debug('debug_message', 'this is helpful information')
+
+        expect($stdout.string).to be_empty
+      end
+    end
+  end
 end

data/spec/integration/active_record3/association_spec.rb

@@ -335,6 +335,15 @@ if !mongoid? && active_record3?
         expect(Bullet::Detector::Association).to be_detecting_unpreloaded_association_for(Comment, :post)
       end
 
+      it "should not detect non preload association with only one comment" do
+        Comment.first.post.category.name
+
+        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
+
       it "should detect non preload association with post => category" do
         Comment.includes(:post).each do |comment|
           comment.post.category.name
@@ -615,7 +624,7 @@ if !mongoid? && active_record3?
 
     context "whitelist n plus one query" do
       before { Bullet.add_whitelist :type => :n_plus_one_query, :class_name => "Post", :association => :comments }
-      after { Bullet.reset_whitelist }
+      after { Bullet.clear_whitelist }
 
       it "should not detect n plus one query" do
         Post.all.each do |post|
@@ -638,7 +647,7 @@ if !mongoid? && active_record3?
 
     context "whitelist unused eager loading" do
       before { Bullet.add_whitelist :type => :unused_eager_loading, :class_name => "Post", :association => :comments }
-      after { Bullet.reset_whitelist }
+      after { Bullet.clear_whitelist }
 
       it "should not detect unused eager loading" do
         Post.includes(:comments).map(&:name)

data/spec/integration/active_record4/association_spec.rb

@@ -219,6 +219,20 @@ if !mongoid? && active_record4?
 
         expect(Bullet::Detector::Association).to be_completely_preloading_associations
       end
+
+      it "should not detect unused preload with category => posts" do
+        category = Category.first
+        category.draft_post.destroy!
+        post = category.draft_post
+        post.update_attributes!(link: true)
+        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
+
+        Support::SqliteSeed.setup_db
+        Support::SqliteSeed.seed_db
+      end
     end
 
     context "category => posts => writer" do
@@ -313,7 +327,7 @@ if !mongoid? && active_record4?
         expect(Bullet::Detector::Association).to be_completely_preloading_associations
       end
 
-      it "should detect unused preload with comments => post" do
+      it "should detect unused preload with comment => post" do
         Comment.includes(:post).map(&:name)
         Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
         expect(Bullet::Detector::Association).to be_unused_preload_associations_for(Comment, :post)
@@ -333,6 +347,15 @@ if !mongoid? && active_record4?
         expect(Bullet::Detector::Association).to be_detecting_unpreloaded_association_for(Comment, :post)
       end
 
+      it "should not detect non preload association with only one comment" do
+        Comment.first.post.category.name
+
+        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
+
       it "should detect non preload association with post => category" do
         Comment.includes(:post).each do |comment|
           comment.post.category.name
@@ -515,6 +538,17 @@ if !mongoid? && active_record4?
     end
   end
 
+  describe Bullet::Detector::Association, "has_one => has_many" do
+    it "should not detect preload association" do
+      user = User.first
+      user.submission.replies.map(&:name)
+      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
+
   describe Bullet::Detector::Association, "call one association that in possible objects" do
     it "should not detect preload association" do
       Post.all
@@ -526,6 +560,27 @@ if !mongoid? && active_record4?
     end
   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
+
+        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
+
   describe Bullet::Detector::Association, "STI" do
     context "page => author" do
       it "should detect non preload associations" do
@@ -613,7 +668,7 @@ if !mongoid? && active_record4?
 
     context "whitelist n plus one query" do
       before { Bullet.add_whitelist :type => :n_plus_one_query, :class_name => "Post", :association => :comments }
-      after { Bullet.reset_whitelist }
+      after { Bullet.clear_whitelist }
 
       it "should not detect n plus one query" do
         Post.all.each do |post|
@@ -636,7 +691,7 @@ if !mongoid? && active_record4?
 
     context "whitelist unused eager loading" do
       before { Bullet.add_whitelist :type => :unused_eager_loading, :class_name => "Post", :association => :comments }
-      after { Bullet.reset_whitelist }
+      after { Bullet.clear_whitelist }
 
       it "should not detect unused eager loading" do
         Post.includes(:comments).map(&:name)