bullet 4.13.1 → 5.5.0

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
@@ -38,9 +39,11 @@ module Bullet
       end
 
       context ".check_unused_preload_associations" do
+        let(:paths) { ["/dir1", "/dir1/subdir"] }
         it "should create notification if object_association_diff is not empty" do
           UnusedEagerLoading.add_object_associations(@post, :association)
-          expect(UnusedEagerLoading).to receive(:create_notification).with("Post", [:association])
+          allow(UnusedEagerLoading).to receive(:caller_in_project).and_return(paths)
+          expect(UnusedEagerLoading).to receive(:create_notification).with(paths, "Post", [:association])
           UnusedEagerLoading.check_unused_preload_associations
         end
 
@@ -72,7 +75,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/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,10 +5,10 @@ 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.title).to eq("N+1 Query in path") }
+      it { expect(subject.body_with_caller).to eq("  Post => [:comments, :votes]\n  Add to your finder: :includes => [:comments, :votes]\nCall 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]\nCall stack\n  caller1\n  caller2\n", "  Post => [:comments, :votes]\n  Add to your finder: :includes => [:comments, :votes]\nCall 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("USE eager loading in path") }
     end
   end
 end

data/spec/bullet/notification/unused_eager_loading_spec.rb

@@ -3,10 +3,10 @@ require 'spec_helper'
 module Bullet
   module Notification
     describe UnusedEagerLoading do
-      subject { UnusedEagerLoading.new(Post, [:comments, :votes], "path") }
+      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.title).to eq("Unused Eager Loading in path") }
+      it { expect(subject.body).to eq("  Post => [:comments, :votes]\n  Remove from your finder: :includes => [:comments, :votes]") }
+      it { expect(subject.title).to eq("AVOID eager loading in path") }
     end
   end
 end

data/spec/bullet/rack_spec.rb

@@ -60,26 +60,26 @@ module Bullet
         it "should return original response body" do
           expected_response = Support::ResponseDouble.new "Actual body"
           app.response = expected_response
-          _, _, response = middleware.call([])
+          _, _, response = middleware.call({})
           expect(response).to eq(expected_response)
         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"}])
+          status, headers, response = middleware.call({"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"}])
+          status, headers, response = middleware.call({"Content-Type" => "text/html"})
           expect(headers["Content-Length"]).to eq("58")
         end
       end
@@ -89,7 +89,38 @@ module Bullet
 
         it "should not call Bullet.start_request" do
           expect(Bullet).not_to receive(:start_request)
-          middleware.call([])
+          middleware.call({})
+        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

data/spec/bullet_spec.rb

@@ -38,4 +38,97 @@ 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
+
+  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
+
+  describe '#perform_out_of_channel_notifications' do
+    let(:notification) { double }
+
+    before do
+      allow(Bullet).to receive(:for_each_active_notifier_with_notification).and_yield(notification)
+      allow(notification).to receive(:notify_out_of_channel)
+    end
+
+    context 'when called with Rack environment hash' do
+      let(:env) {
+        {
+          'REQUEST_METHOD' => 'GET',
+          'PATH_INFO' => '/path',
+          'QUERY_STRING' => 'foo=bar',
+        }
+      }
+
+      context "when env['REQUEST_URI'] is nil" do
+        before { env['REQUEST_URI'] = nil }
+
+        it 'should notification.url is built' do
+          expect(notification).to receive(:url=).with('GET /path?foo=bar')
+          Bullet.perform_out_of_channel_notifications(env)
+        end
+      end
+
+      context "when env['REQUEST_URI'] is present" do
+        before { env['REQUEST_URI'] = 'http://example.com/path' }
+
+        it "should notification.url is env['REQUEST_URI']" do
+          expect(notification).to receive(:url=).with('GET http://example.com/path')
+          Bullet.perform_out_of_channel_notifications(env)
+        end
+      end
+    end
+  end
 end

data/spec/integration/active_record4/association_spec.rb

@@ -13,6 +13,16 @@ if !mongoid? && active_record4?
         expect(Bullet::Detector::Association).to be_detecting_unpreloaded_association_for(Post, :comments)
       end
 
+      it "should detect non preload post => comments for find_by_sql" do
+        Post.find_by_sql("SELECT * FROM posts").each do |post|
+          post.comments.map(&:name)
+        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(Post, :comments)
+      end
+
       it "should detect preload with post => comments" do
         Post.includes(:comments).each do |post|
           post.comments.map(&:name)
@@ -72,6 +82,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 +224,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)
@@ -219,6 +239,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 +347,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 +367,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
@@ -432,6 +475,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
 
@@ -515,6 +568,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 +590,50 @@ if !mongoid? && active_record4?
     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
@@ -613,7 +721,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 +744,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)