bullet 6.0.0 → 6.1.0

data/lib/bullet/notification/unused_eager_loading.rb

@@ -10,7 +10,7 @@ module Bullet
       end
 
       def body
-        "#{klazz_associations_str}\n  Remove from your finder: #{associations_str}"
+        "#{klazz_associations_str}\n  Remove from your query: #{associations_str}"
       end
 
       def title
@@ -18,9 +18,7 @@ module Bullet
       end
 
       def notification_data
-        super.merge(
-          backtrace: []
-        )
+        super.merge(backtrace: [])
       end
 
       protected

data/lib/bullet/rack.rb

@@ -15,8 +15,9 @@ module Bullet
       status, headers, response = @app.call(env)
 
       response_body = nil
+
       if Bullet.notification?
-        if !file?(headers) && !sse?(headers) && !empty?(response) && status == 200
+        if !Bullet.skip_html_injection? && !file?(headers) && !sse?(headers) && !empty?(response) && status == 200
           if html_request?(headers, response)
             response_body = response_body(response)
             response_body = append_to_html_body(response_body, footer_note) if Bullet.add_footer
@@ -61,7 +62,7 @@ module Bullet
       # Many proxy applications such as Nginx and AWS ELB limit
       # the size a header to 8KB, so truncate the list of reports to
       # be under that limit
-      header_array.pop while header_array.to_json.length > 8 * 1024
+      header_array.pop while header_array.to_json.length > 8 * 1_024
       headers[header_name] = header_array.to_json
     end
 
@@ -98,7 +99,8 @@ module Bullet
     end
 
     def footer_header
-      cancel_button = "<span onclick='this.parentNode.remove()' style='position:absolute; right: 10px; top: 0px; font-weight: bold; color: #333;'>&times;</span>"
+      cancel_button =
+        "<span onclick='this.parentNode.remove()' style='position:absolute; right: 10px; top: 0px; font-weight: bold; color: #333;'>&times;</span>"
       if Bullet.console_enabled?
         "<span>See 'Uniform Notifier' in JS Console for Stacktrace</span>#{cancel_button}"
       else

data/lib/bullet/stack_trace_filter.rb

@@ -9,7 +9,8 @@ module Bullet
       bundler_path = Bundler.bundle_path.to_s
       select_caller_locations do |location|
         caller_path = location_as_path(location)
-        caller_path.include?(Bullet.app_root) && !caller_path.include?(vendor_root) && !caller_path.include?(bundler_path) ||
+        caller_path.include?(Bullet.app_root) && !caller_path.include?(vendor_root) &&
+          !caller_path.include?(bundler_path) ||
           Bullet.stacktrace_includes.any? { |include_pattern| pattern_matches?(location, include_pattern) }
       end
     end
@@ -51,20 +52,14 @@ module Bullet
 
     def select_caller_locations
       if ruby_19?
-        caller.select do |caller_path|
-          yield caller_path
-        end
+        caller.select { |caller_path| yield caller_path }
       else
-        caller_locations.select do |location|
-          yield location
-        end
+        caller_locations.select { |location| yield location }
       end
     end
 
     def ruby_19?
-      if @ruby_19.nil?
-        @ruby_19 = Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
-      end
+      @ruby_19 = Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0') if @ruby_19.nil?
       @ruby_19
     end
   end

data/lib/bullet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bullet
-  VERSION = '6.0.0'
+  VERSION = '6.1.0'
 end

data/lib/generators/bullet/install_generator.rb

@@ -10,7 +10,7 @@ module Bullet
 
       def enable_in_development
         environment(nil, env: 'development') do
-          <<-"FILE".strip
+          <<-"FILE"
 
   config.after_initialize do
     Bullet.enable        = true
@@ -22,6 +22,7 @@ module Bullet
     Bullet.add_footer    = true
   end
           FILE
+            .strip
         end
 
         say 'Enabled bullet in config/environments/development.rb'
@@ -30,7 +31,7 @@ module Bullet
       def enable_in_test
         if yes?('Would you like to enable bullet in test environment? (y/n)')
           environment(nil, env: 'test') do
-            <<-"FILE".strip
+            <<-"FILE"
 
   config.after_initialize do
     Bullet.enable        = true
@@ -38,6 +39,7 @@ module Bullet
     Bullet.raise         = true # raise an error if n+1 query occurs
   end
             FILE
+              .strip
           end
 
           say 'Enabled bullet in config/environments/test.rb'

data/perf/benchmark.rb

@@ -29,11 +29,11 @@ class User < ActiveRecord::Base
 end
 
 # create database bullet_benchmark;
-ActiveRecord::Base.establish_connection(adapter: 'mysql2', database: 'bullet_benchmark', server: '/tmp/mysql.socket', username: 'root')
+ActiveRecord::Base.establish_connection(
+  adapter: 'mysql2', database: 'bullet_benchmark', server: '/tmp/mysql.socket', username: 'root'
+)
 
-ActiveRecord::Base.connection.tables.each do |table|
-  ActiveRecord::Base.connection.drop_table(table)
-end
+ActiveRecord::Base.connection.tables.each { |table| ActiveRecord::Base.connection.drop_table(table) }
 
 ActiveRecord::Schema.define(version: 1) do
   create_table :posts do |t|
@@ -54,26 +54,20 @@ ActiveRecord::Schema.define(version: 1) do
 end
 
 users_size = 100
-posts_size = 1000
+posts_size = 1_000
 comments_size = 10_000
 users = []
-users_size.times do |i|
-  users << User.new(name: "user#{i}")
-end
+users_size.times { |i| users << User.new(name: "user#{i}") }
 User.import users
 users = User.all
 
 posts = []
-posts_size.times do |i|
-  posts << Post.new(title: "Title #{i}", body: "Body #{i}", user: users[i % 100])
-end
+posts_size.times { |i| posts << Post.new(title: "Title #{i}", body: "Body #{i}", user: users[i % 100]) }
 Post.import posts
 posts = Post.all
 
 comments = []
-comments_size.times do |i|
-  comments << Comment.new(body: "Comment #{i}", post: posts[i % 1000], user: users[i % 100])
-end
+comments_size.times { |i| comments << Comment.new(body: "Comment #{i}", post: posts[i % 1_000], user: users[i % 100]) }
 Comment.import comments
 
 puts 'Start benchmarking...'

data/spec/bullet/detector/counter_cache_spec.rb

@@ -12,15 +12,15 @@ module Bullet
 
       context '.add_counter_cache' do
         it 'should create notification if conditions met' do
-          expect(CounterCache).to receive(:conditions_met?).with(@post1, [:comments]).and_return(true)
-          expect(CounterCache).to receive(:create_notification).with('Post', [:comments])
-          CounterCache.add_counter_cache(@post1, [:comments])
+          expect(CounterCache).to receive(:conditions_met?).with(@post1, %i[comments]).and_return(true)
+          expect(CounterCache).to receive(:create_notification).with('Post', %i[comments])
+          CounterCache.add_counter_cache(@post1, %i[comments])
         end
 
         it 'should not create notification if conditions not met' do
-          expect(CounterCache).to receive(:conditions_met?).with(@post1, [:comments]).and_return(false)
+          expect(CounterCache).to receive(:conditions_met?).with(@post1, %i[comments]).and_return(false)
           expect(CounterCache).to receive(:create_notification).never
-          CounterCache.add_counter_cache(@post1, [:comments])
+          CounterCache.add_counter_cache(@post1, %i[comments])
         end
       end
 

data/spec/bullet/detector/n_plus_one_query_spec.rb

@@ -76,8 +76,8 @@ module Bullet
       context '.call_association' do
         it 'should create notification if conditions met' do
           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)
+          expect(NPlusOneQuery).to receive(:caller_in_project).and_return(%w[caller])
+          expect(NPlusOneQuery).to receive(:create_notification).with(%w[caller], 'Post', :association)
           NPlusOneQuery.call_association(@post, :association)
         end
 
@@ -149,7 +149,11 @@ module Bullet
 
             expect(NPlusOneQuery).to receive(:caller_locations).and_return([in_project, *included_gems, excluded_gem])
             expect(NPlusOneQuery).to receive(:conditions_met?).with(@post, :association).and_return(true)
-            expect(NPlusOneQuery).to receive(:create_notification).with([in_project, *included_gems], 'Post', :association)
+            expect(NPlusOneQuery).to receive(:create_notification).with(
+              [in_project, *included_gems],
+              'Post',
+              :association
+            )
             NPlusOneQuery.call_association(@post, :association)
           end
         end

data/spec/bullet/detector/unused_eager_loading_spec.rb

@@ -13,39 +13,45 @@ module Bullet
 
       context '.call_associations' do
         it 'should get empty array if eager_loadings' do
-          expect(UnusedEagerLoading.send(:call_associations, @post.bullet_key, Set.new([:association]))).to be_empty
+          expect(UnusedEagerLoading.send(:call_associations, @post.bullet_key, Set.new(%i[association]))).to be_empty
         end
 
         it 'should get call associations if object and association are both in eager_loadings and call_object_associations' do
           UnusedEagerLoading.add_eager_loadings([@post], :association)
           UnusedEagerLoading.add_call_object_associations(@post, :association)
-          expect(UnusedEagerLoading.send(:call_associations, @post.bullet_key, Set.new([:association]))).to eq([:association])
+          expect(UnusedEagerLoading.send(:call_associations, @post.bullet_key, Set.new(%i[association]))).to eq(
+            %i[association]
+          )
         end
 
         it 'should not get call associations if not exist in call_object_associations' do
           UnusedEagerLoading.add_eager_loadings([@post], :association)
-          expect(UnusedEagerLoading.send(:call_associations, @post.bullet_key, Set.new([:association]))).to be_empty
+          expect(UnusedEagerLoading.send(:call_associations, @post.bullet_key, Set.new(%i[association]))).to be_empty
         end
       end
 
       context '.diff_object_associations' do
         it 'should return associations not exist in call_association' do
-          expect(UnusedEagerLoading.send(:diff_object_associations, @post.bullet_key, Set.new([:association]))).to eq([:association])
+          expect(UnusedEagerLoading.send(:diff_object_associations, @post.bullet_key, Set.new(%i[association]))).to eq(
+            %i[association]
+          )
         end
 
         it 'should return empty if associations exist in call_association' do
           UnusedEagerLoading.add_eager_loadings([@post], :association)
           UnusedEagerLoading.add_call_object_associations(@post, :association)
-          expect(UnusedEagerLoading.send(:diff_object_associations, @post.bullet_key, Set.new([:association]))).to be_empty
+          expect(
+            UnusedEagerLoading.send(:diff_object_associations, @post.bullet_key, Set.new(%i[association]))
+          ).to be_empty
         end
       end
 
       context '.check_unused_preload_associations' do
-        let(:paths) { ['/dir1', '/dir1/subdir'] }
+        let(:paths) { %w[/dir1 /dir1/subdir] }
         it 'should create notification if object_association_diff is not empty' do
           UnusedEagerLoading.add_object_associations(@post, :association)
           allow(UnusedEagerLoading).to receive(:caller_in_project).and_return(paths)
-          expect(UnusedEagerLoading).to receive(:create_notification).with(paths, 'Post', [:association])
+          expect(UnusedEagerLoading).to receive(:create_notification).with(paths, 'Post', %i[association])
           UnusedEagerLoading.check_unused_preload_associations
         end
 
@@ -53,8 +59,10 @@ module Bullet
           UnusedEagerLoading.add_object_associations(@post, :association)
           UnusedEagerLoading.add_eager_loadings([@post], :association)
           UnusedEagerLoading.add_call_object_associations(@post, :association)
-          expect(UnusedEagerLoading.send(:diff_object_associations, @post.bullet_key, Set.new([:association]))).to be_empty
-          expect(UnusedEagerLoading).not_to receive(:create_notification).with('Post', [:association])
+          expect(
+            UnusedEagerLoading.send(:diff_object_associations, @post.bullet_key, Set.new(%i[association]))
+          ).to be_empty
+          expect(UnusedEagerLoading).not_to receive(:create_notification).with('Post', %i[association])
           UnusedEagerLoading.check_unused_preload_associations
         end
       end
@@ -62,14 +70,23 @@ module Bullet
       context '.add_eager_loadings' do
         it 'should add objects, associations pair when eager_loadings are empty' do
           UnusedEagerLoading.add_eager_loadings([@post, @post2], :associations)
-          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include([@post.bullet_key, @post2.bullet_key], :associations)
+          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include(
+            [@post.bullet_key, @post2.bullet_key],
+            :associations
+          )
         end
 
         it 'should add objects, associations pair for existing eager_loadings' do
           UnusedEagerLoading.add_eager_loadings([@post, @post2], :association1)
           UnusedEagerLoading.add_eager_loadings([@post, @post2], :association2)
-          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include([@post.bullet_key, @post2.bullet_key], :association1)
-          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include([@post.bullet_key, @post2.bullet_key], :association2)
+          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include(
+            [@post.bullet_key, @post2.bullet_key],
+            :association1
+          )
+          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include(
+            [@post.bullet_key, @post2.bullet_key],
+            :association2
+          )
         end
 
         it 'should merge objects, associations pair for existing eager_loadings' do

data/spec/bullet/notification/base_spec.rb

@@ -26,9 +26,7 @@ module Bullet
         end
 
         it 'should leverage ENV parameter' do
-          temp_env_variable('USER', 'bogus') do
-            expect(subject.whoami).to eq('user: bogus')
-          end
+          temp_env_variable('USER', 'bogus') { expect(subject.whoami).to eq('user: bogus') }
         end
 
         it 'should return blank if no user available' do

data/spec/bullet/notification/n_plus_one_query_spec.rb

@@ -7,9 +7,24 @@ module Bullet
     describe NPlusOneQuery do
       subject { NPlusOneQuery.new([%w[caller1 caller2]], Post, %i[comments votes], '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 do
+        expect(subject.body_with_caller).to eq(
+          "  Post => [:comments, :votes]\n  Add to your query: .includes([:comments, :votes])\nCall stack\n  caller1\n  caller2\n"
+        )
+      end
+      it do
+        expect([subject.body_with_caller, subject.body_with_caller]).to eq(
+          [
+            "  Post => [:comments, :votes]\n  Add to your query: .includes([:comments, :votes])\nCall stack\n  caller1\n  caller2\n",
+            "  Post => [:comments, :votes]\n  Add to your query: .includes([:comments, :votes])\nCall stack\n  caller1\n  caller2\n"
+          ]
+        )
+      end
+      it do
+        expect(subject.body).to eq(
+          "  Post => [:comments, :votes]\n  Add to your query: .includes([:comments, :votes])"
+        )
+      end
       it { expect(subject.title).to eq('USE eager loading in path') }
     end
   end

data/spec/bullet/notification/unused_eager_loading_spec.rb

@@ -7,7 +7,11 @@ module Bullet
     describe UnusedEagerLoading do
       subject { UnusedEagerLoading.new([''], Post, %i[comments votes], 'path') }
 
-      it { expect(subject.body).to eq("  Post => [:comments, :votes]\n  Remove from your finder: :includes => [:comments, :votes]") }
+      it do
+        expect(subject.body).to eq(
+          "  Post => [:comments, :votes]\n  Remove from your query: .includes([:comments, :votes])"
+        )
+      end
       it { expect(subject.title).to eq('AVOID eager loading in path') }
     end
   end

data/spec/bullet/rack_spec.rb

@@ -67,12 +67,13 @@ module Bullet
 
         it 'should change response body if notification is active' do
           expect(Bullet).to receive(:notification?).and_return(true)
+          allow(Bullet).to receive(:skip_html_injection?).and_return(false)
           expect(Bullet).to receive(:gather_inline_notifications).and_return('<bullet></bullet>')
           expect(middleware).to receive(:xhr_script).and_return('')
           expect(Bullet).to receive(:perform_out_of_channel_notifications)
-          status, headers, response = middleware.call('Content-Type' => 'text/html')
+          _, headers, response = middleware.call('Content-Type' => 'text/html')
           expect(headers['Content-Length']).to eq('56')
-          expect(response).to eq(['<html><head></head><body><bullet></bullet></body></html>'])
+          expect(response).to eq(%w[<html><head></head><body><bullet></bullet></body></html>])
         end
 
         it 'should set the right Content-Length if response body contains accents' do
@@ -81,9 +82,23 @@ module Bullet
           app.response = response
           expect(Bullet).to receive(:notification?).and_return(true)
           expect(Bullet).to receive(:gather_inline_notifications).and_return('<bullet></bullet>')
-          status, headers, response = middleware.call('Content-Type' => 'text/html')
+          _, headers, response = middleware.call('Content-Type' => 'text/html')
           expect(headers['Content-Length']).to eq((58 + middleware.send(:xhr_script).length).to_s)
         end
+
+        context 'when skip_html_injection is enabled' do
+          it 'should not try to inject html' do
+            expected_response = Support::ResponseDouble.new 'Actual body'
+            app.response = expected_response
+            allow(Bullet).to receive(:notification?).and_return(true)
+            allow(Bullet).to receive(:skip_html_injection?).and_return(true)
+            expect(Bullet).to receive(:gather_inline_notifications).never
+            expect(middleware).to receive(:xhr_script).never
+            expect(Bullet).to receive(:perform_out_of_channel_notifications)
+            _, _, response = middleware.call('Content-Type' => 'text/html')
+            expect(response).to eq(expected_response)
+          end
+        end
       end
 
       context 'when Bullet is disabled' do
@@ -98,8 +113,8 @@ module Bullet
 
     context '#set_header' do
       it 'should truncate headers to under 8kb' do
-        long_header = ['a' * 1024] * 10
-        expected_res = (['a' * 1024] * 7).to_json
+        long_header = ['a' * 1_024] * 10
+        expected_res = (['a' * 1_024] * 7).to_json
         expect(middleware.set_header({}, 'Dummy-Header', long_header)).to eq(expected_res)
       end
     end

data/spec/bullet/registry/association_spec.rb

@@ -16,11 +16,11 @@ module Bullet
 
       context '#similarly_associated' do
         it 'should return similarly associated keys' do
-          expect(subject.similarly_associated('key1', Set.new(['value']))).to eq(%w[key1 key2])
+          expect(subject.similarly_associated('key1', Set.new(%w[value]))).to eq(%w[key1 key2])
         end
 
         it 'should return empty if key does not exist' do
-          expect(subject.similarly_associated('key3', Set.new(['value']))).to be_empty
+          expect(subject.similarly_associated('key3', Set.new(%w[value]))).to be_empty
         end
       end
     end

data/spec/bullet/registry/base_spec.rb

@@ -9,7 +9,7 @@ module Bullet
 
       context '#[]' do
         it 'should get value by key' do
-          expect(subject['key']).to eq(Set.new(['value']))
+          expect(subject['key']).to eq(Set.new(%w[value]))
         end
       end
 

data/spec/bullet_spec.rb

@@ -17,9 +17,7 @@ describe Bullet, focused: true do
       end
 
       context 'disable Bullet' do
-        before do
-          Bullet.enable = false
-        end
+        before { Bullet.enable = false }
 
         it 'should be disabled' do
           expect(subject).to_not be_enable
@@ -27,8 +25,8 @@ describe Bullet, focused: true do
 
         context 'enable Bullet again without patching again the orms' do
           before do
-            expect(Bullet::Mongoid).not_to receive(:enable) if defined? Bullet::Mongoid
-            expect(Bullet::ActiveRecord).not_to receive(:enable) if defined? Bullet::ActiveRecord
+            expect(Bullet::Mongoid).not_to receive(:enable) if defined?(Bullet::Mongoid)
+            expect(Bullet::ActiveRecord).not_to receive(:enable) if defined?(Bullet::ActiveRecord)
             Bullet.enable = true
           end
 
@@ -42,9 +40,7 @@ describe Bullet, focused: true do
 
   describe '#start?' do
     context 'when bullet is disabled' do
-      before(:each) do
-        Bullet.enable = false
-      end
+      before(:each) { Bullet.enable = false }
 
       it 'should not be started' do
         expect(Bullet).not_to be_start
@@ -53,28 +49,19 @@ describe Bullet, focused: true do
   end
 
   describe '#debug' do
-    before(:each) do
-      $stdout = StringIO.new
-    end
+    before(:each) { $stdout = StringIO.new }
 
-    after(:each) do
-      $stdout = STDOUT
-    end
+    after(:each) { $stdout = STDOUT }
 
     context 'when debug is enabled' do
-      before(:each) do
-        ENV['BULLET_DEBUG'] = 'true'
-      end
+      before(:each) { ENV['BULLET_DEBUG'] = 'true' }
 
-      after(:each) do
-        ENV['BULLET_DEBUG'] = 'false'
-      end
+      after(:each) { ENV['BULLET_DEBUG'] = 'false' }
 
       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")
+        expect($stdout.string).to eq("[Bullet][debug_message] this is helpful information\n")
       end
     end
 
@@ -125,13 +112,7 @@ describe Bullet, focused: true do
     end
 
     context 'when called with Rack environment hash' do
-      let(:env) {
-        {
-          'REQUEST_METHOD' => 'GET',
-          'PATH_INFO' => '/path',
-          'QUERY_STRING' => 'foo=bar'
-        }
-      }
+      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 }