bullet 5.9.0 → 6.1.1

data/lib/bullet/stack_trace_filter.rb

@@ -5,12 +5,12 @@ module Bullet
     VENDOR_PATH = '/vendor'
 
     def caller_in_project
-      app_root = rails? ? Rails.root.to_s : Dir.pwd
-      vendor_root = app_root + VENDOR_PATH
+      vendor_root = Bullet.app_root + VENDOR_PATH
       bundler_path = Bundler.bundle_path.to_s
       select_caller_locations do |location|
         caller_path = location_as_path(location)
-        caller_path.include?(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
@@ -52,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 = '5.9.0'
+  VERSION = '6.1.1'
 end

data/lib/generators/bullet/install_generator.rb

@@ -10,17 +10,17 @@ module Bullet
 
       def enable_in_development
         environment(nil, env: 'development') do
-          <<-"FILE".strip
-
-  config.after_initialize do
-    Bullet.enable        = true
-    Bullet.alert         = true
-    Bullet.bullet_logger = true
-    Bullet.console       = true
-  # Bullet.growl         = true
-    Bullet.rails_logger  = true
-    Bullet.add_footer    = true
-  end
+          <<~FILE
+            config.after_initialize do
+              Bullet.enable        = true
+              Bullet.alert         = true
+              Bullet.bullet_logger = true
+              Bullet.console       = true
+            # Bullet.growl         = true
+              Bullet.rails_logger  = true
+              Bullet.add_footer    = true
+            end
+
           FILE
         end
 
@@ -28,20 +28,20 @@ module Bullet
       end
 
       def enable_in_test
-        if yes?('Would you like to enable bullet in test environment? (y/n)')
-          environment(nil, env: 'test') do
-            <<-"FILE".strip
-
-  config.after_initialize do
-    Bullet.enable        = true
-    Bullet.bullet_logger = true
-    Bullet.raise         = true # raise an error if n+1 query occurs
-  end
-            FILE
-          end
+        return unless yes?('Would you like to enable bullet in test environment? (y/n)')
 
-          say 'Enabled bullet in config/environments/test.rb'
+        environment(nil, env: 'test') do
+          <<~FILE
+            config.after_initialize do
+              Bullet.enable        = true
+              Bullet.bullet_logger = true
+              Bullet.raise         = true # raise an error if n+1 query occurs
+            end
+
+          FILE
         end
+
+        say 'Enabled bullet in config/environments/test.rb'
       end
     end
   end

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
 
@@ -47,7 +47,7 @@ module Bullet
           expect(CounterCache.conditions_met?(@post1, :associations)).to eq false
         end
 
-        it 'should be true when object is possible, and impossible' do
+        it 'should be false when object is possible, and impossible' do
           CounterCache.add_possible_objects(@post1)
           CounterCache.add_impossible_object(@post1)
           expect(CounterCache.conditions_met?(@post1, :associations)).to eq false

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

@@ -36,12 +36,14 @@ module Bullet
         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([: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)
@@ -53,7 +55,9 @@ 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.send(:diff_object_associations, @post.bullet_key, Set.new([:association]))
+          ).to be_empty
           expect(UnusedEagerLoading).not_to receive(:create_notification).with('Post', [:association])
           UnusedEagerLoading.check_unused_preload_associations
         end
@@ -62,14 +66,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/ext/object_spec.rb

@@ -17,23 +17,28 @@ describe Object do
     end
   end
 
-  context 'primary_key_value' do
+  context 'bullet_primary_key_value' do
     it 'should return id' do
       post = Post.first
-      expect(post.primary_key_value).to eq(post.id)
+      expect(post.bullet_primary_key_value).to eq(post.id)
     end
 
     it 'should return primary key value' do
       post = Post.first
       Post.primary_key = 'name'
-      expect(post.primary_key_value).to eq(post.name)
+      expect(post.bullet_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(%i[category_id writer_id])
-      expect(post.primary_key_value).to eq("#{post.category_id},#{post.writer_id}")
+      expect(post.bullet_primary_key_value).to eq("#{post.category_id},#{post.writer_id}")
+    end
+
+    it 'it should return nil for unpersisted records' do
+      post = Post.new(id: 123)
+      expect(post.bullet_primary_key_value).to be_nil
     end
   end
 end

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,22 @@ 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

@@ -45,9 +45,9 @@ module Bullet
         expect(middleware).not_to be_empty(response)
       end
 
-      it 'should be true if response is not found' do
+      it 'should be false if response is not found' do
         response = ['Not Found']
-        expect(middleware).to be_empty(response)
+        expect(middleware).not_to be_empty(response)
       end
 
       it 'should be true if response body is empty' do
@@ -67,11 +67,13 @@ module Bullet
 
         it 'should change response body if notification is active' do
           expect(Bullet).to receive(:notification?).and_return(true)
+          expect(Bullet).to receive(:console_enabled?).and_return(true)
           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
@@ -79,9 +81,79 @@ module Bullet
           response.body = '<html><head></head><body>é</body></html>'
           app.response = response
           expect(Bullet).to receive(:notification?).and_return(true)
+          allow(Bullet).to receive(:console_enabled?).and_return(true)
           expect(Bullet).to receive(:gather_inline_notifications).and_return('<bullet></bullet>')
-          status, headers, response = middleware.call('Content-Type' => 'text/html')
-          expect(headers['Content-Length']).to eq('58')
+          _, headers, response = middleware.call('Content-Type' => 'text/html')
+          expect(headers['Content-Length']).to eq((58 + middleware.send(:xhr_script).length).to_s)
+        end
+
+        context 'with injection notifiers' do
+          before do
+            expect(Bullet).to receive(:notification?).and_return(true)
+            allow(Bullet).to receive(:gather_inline_notifications).and_return('<bullet></bullet>')
+            allow(middleware).to receive(:xhr_script).and_return('')
+            allow(middleware).to receive(:footer_note).and_return('footer')
+            expect(Bullet).to receive(:perform_out_of_channel_notifications)
+          end
+
+          it 'should change response body if add_footer is true' do
+            expect(Bullet).to receive(:add_footer).twice.and_return(true)
+            _, headers, response = middleware.call('Content-Type' => 'text/html')
+
+            expect(headers['Content-Length']).to eq((56 + middleware.send(:footer_note).length).to_s)
+            expect(response.first).to start_with('<html><head></head><body>')
+            expect(response.first).to include('<bullet></bullet><')
+          end
+
+          it 'should change response body for html safe string if add_footer is true' do
+            expect(Bullet).to receive(:add_footer).twice.and_return(true)
+            app.response = Support::ResponseDouble.new.tap do |response|
+              response.body = ActiveSupport::SafeBuffer.new('<html><head></head><body></body></html>')
+            end
+            _, headers, response = middleware.call('Content-Type' => 'text/html')
+
+            expect(headers['Content-Length']).to eq((56 + middleware.send(:footer_note).length).to_s)
+            expect(response.first).to start_with('<html><head></head><body>')
+            expect(response.first).to include('<bullet></bullet><')
+          end
+
+          it 'should change response body if console_enabled is true' do
+            expect(Bullet).to receive(:console_enabled?).and_return(true)
+            _, headers, response = middleware.call('Content-Type' => 'text/html')
+            expect(headers['Content-Length']).to eq('56')
+            expect(response).to eq(%w[<html><head></head><body><bullet></bullet></body></html>])
+          end
+
+          it 'should change response body for html safe string if console_enabled is true' do
+            expect(Bullet).to receive(:console_enabled?).and_return(true)
+            app.response = Support::ResponseDouble.new.tap do |response|
+              response.body = ActiveSupport::SafeBuffer.new('<html><head></head><body></body></html>')
+            end
+            _, headers, response = middleware.call('Content-Type' => 'text/html')
+            expect(headers['Content-Length']).to eq('56')
+            expect(response).to eq(%w[<html><head></head><body><bullet></bullet></body></html>])
+          end
+
+          it "shouldn't change response body unnecessarily" do
+            expected_response = Support::ResponseDouble.new 'Actual body'
+            app.response = expected_response
+            _, _, response = middleware.call({})
+            expect(response).to eq(expected_response)
+          end
+        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
 
@@ -95,6 +167,14 @@ module Bullet
       end
     end
 
+    context '#set_header' do
+      it 'should truncate headers to under 8kb' do
+        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
+
     describe '#response_body' do
       let(:response) { double }
       let(:body_string) { '<html><body>My Body</body></html>' }