bullet 4.14.8 → 5.0.0

data/lib/bullet.rb

@@ -16,6 +16,9 @@ module Bullet
   autoload :Registry, 'bullet/registry'
   autoload :NotificationCollector, 'bullet/notification_collector'
 
+  BULLET_DEBUG = 'BULLET_DEBUG'.freeze
+  TRUE = 'true'.freeze
+
   if defined? Rails::Railtie
     class BulletRailtie < Rails::Railtie
       initializer "bullet.configure_rails_initialization" do |app|
@@ -25,7 +28,7 @@ module Bullet
   end
 
   class << self
-    attr_writer :enable, :n_plus_one_query_enable, :unused_eager_loading_enable, :counter_cache_enable, :stacktrace_includes
+    attr_writer :enable, :n_plus_one_query_enable, :unused_eager_loading_enable, :counter_cache_enable, :stacktrace_includes, :stacktrace_excludes
     attr_reader :notification_collector, :whitelist
     attr_accessor :add_footer, :orm_pathches_applied
 
@@ -73,7 +76,12 @@ module Bullet
       @stacktrace_includes || []
     end
 
+    def stacktrace_excludes
+      @stacktrace_excludes || []
+    end
+
     def add_whitelist(options)
+      reset_whitelist
       @whitelist[options[:type]][options[:class_name].classify] ||= []
       @whitelist[options[:type]][options[:class_name].classify] << options[:association].to_sym
     end
@@ -83,7 +91,11 @@ module Bullet
     end
 
     def reset_whitelist
-      @whitelist = {:n_plus_one_query => {}, :unused_eager_loading => {}, :counter_cache => {}}
+      @whitelist ||= {:n_plus_one_query => {}, :unused_eager_loading => {}, :counter_cache => {}}
+    end
+
+    def clear_whitelist
+      @whitelist = nil
     end
 
     def bullet_logger=(active)
@@ -98,7 +110,7 @@ module Bullet
     end
 
     def debug(title, message)
-      puts "[Bullet][#{title}] #{message}" if ENV['BULLET_DEBUG'] == 'true'
+      puts "[Bullet][#{title}] #{message}" if ENV[BULLET_DEBUG] == TRUE
     end
 
     def start_request
@@ -132,7 +144,7 @@ module Bullet
     end
 
     def start?
-      Thread.current[:bullet_start]
+      enable? && Thread.current[:bullet_start]
     end
 
     def notification_collector

data/spec/bullet/detector/n_plus_one_query_spec.rb

@@ -85,6 +85,21 @@ module Bullet
           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

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

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

@@ -624,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|
@@ -647,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

@@ -560,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
@@ -647,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|
@@ -670,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)