bullet 5.7.0 → 6.0.0

data/spec/bullet/detector/base_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Bullet

data/spec/bullet/detector/counter_cache_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Bullet

data/spec/bullet/detector/n_plus_one_query_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Bullet
@@ -91,21 +93,44 @@ module Bullet
           after { Bullet.stacktrace_excludes = nil }
 
           it 'should not create notification when stacktrace contains paths that are in the exclude list' do
-            in_project = OpenStruct.new(:absolute_path => File.join(Dir.pwd, 'abc', 'abc.rb'))
-            included_path = OpenStruct.new(:absolute_path => '/ghi/ghi.rb')
-            excluded_path = OpenStruct.new(:absolute_path => '/def/def.rb')
+            in_project = OpenStruct.new(absolute_path: File.join(Dir.pwd, 'abc', 'abc.rb'))
+            included_path = OpenStruct.new(absolute_path: '/ghi/ghi.rb')
+            excluded_path = OpenStruct.new(absolute_path: '/def/def.rb')
 
             expect(NPlusOneQuery).to receive(:caller_locations).and_return([in_project, included_path, excluded_path])
             expect(NPlusOneQuery).to_not receive(:create_notification)
             NPlusOneQuery.call_association(@post, :association)
           end
+
+          # just a sanity spec to make sure the following spec works correctly
+          it "should create notification when stacktrace contains methods that aren't in the exclude list" do
+            method = NPlusOneQuery.method(:excluded_stacktrace_path?).source_location
+            in_project = OpenStruct.new(absolute_path: File.join(Dir.pwd, 'abc', 'abc.rb'))
+            excluded_path = OpenStruct.new(absolute_path: method.first, lineno: method.last)
+
+            expect(NPlusOneQuery).to receive(:caller_locations).at_least(1).and_return([in_project, excluded_path])
+            expect(NPlusOneQuery).to receive(:conditions_met?).and_return(true)
+            expect(NPlusOneQuery).to receive(:create_notification)
+            NPlusOneQuery.call_association(@post, :association)
+          end
+
+          it 'should not create notification when stacktrace contains methods that are in the exclude list' do
+            method = NPlusOneQuery.method(:excluded_stacktrace_path?).source_location
+            Bullet.stacktrace_excludes = [method]
+            in_project = OpenStruct.new(absolute_path: File.join(Dir.pwd, 'abc', 'abc.rb'))
+            excluded_path = OpenStruct.new(absolute_path: method.first, lineno: method.last)
+
+            expect(NPlusOneQuery).to receive(:caller_locations).and_return([in_project, excluded_path])
+            expect(NPlusOneQuery).to_not receive(:create_notification)
+            NPlusOneQuery.call_association(@post, :association)
+          end
         end
       end
 
       context '.caller_in_project' do
         it 'should include only paths that are in the project' do
-          in_project = OpenStruct.new(:absolute_path => File.join(Dir.pwd, 'abc', 'abc.rb'))
-          not_in_project = OpenStruct.new(:absolute_path => '/def/def.rb')
+          in_project = OpenStruct.new(absolute_path: File.join(Dir.pwd, 'abc', 'abc.rb'))
+          not_in_project = OpenStruct.new(absolute_path: '/def/def.rb')
 
           expect(NPlusOneQuery).to receive(:caller_locations).and_return([in_project, not_in_project])
           expect(NPlusOneQuery).to receive(:conditions_met?).with(@post, :association).and_return(true)
@@ -118,9 +143,9 @@ module Bullet
           after { Bullet.stacktrace_includes = nil }
 
           it 'should include paths that are in the stacktrace_include list' do
-            in_project = OpenStruct.new(:absolute_path => File.join(Dir.pwd, 'abc', 'abc.rb'))
-            included_gems = [OpenStruct.new(:absolute_path => '/def/def.rb'), OpenStruct.new(:absolute_path => 'xyz/xyz.rb')]
-            excluded_gem = OpenStruct.new(:absolute_path => '/ghi/ghi.rb')
+            in_project = OpenStruct.new(absolute_path: File.join(Dir.pwd, 'abc', 'abc.rb'))
+            included_gems = [OpenStruct.new(absolute_path: '/def/def.rb'), OpenStruct.new(absolute_path: 'xyz/xyz.rb')]
+            excluded_gem = OpenStruct.new(absolute_path: '/ghi/ghi.rb')
 
             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)

data/spec/bullet/detector/unused_eager_loading_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Bullet

data/spec/bullet/ext/object_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Object do
@@ -15,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([:category_id, :writer_id])
-      expect(post.primary_key_value).to eq("#{post.category_id},#{post.writer_id}")
+      allow(Post).to receive(:primary_keys).and_return(%i[category_id 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/ext/string_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe String do

data/spec/bullet/notification/base_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Bullet
   module Notification
     describe Base do
-      subject { Base.new(Post, [:comments, :votes]) }
+      subject { Base.new(Post, %i[comments votes]) }
 
       context '#title' do
         it 'should raise NoMethodError' do
@@ -66,7 +68,7 @@ module Bullet
           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.notification_data).to eq(:user => 'whoami', :url => 'url', :title => 'title', :body => 'body_with_caller')
+          expect(subject.notification_data).to eq(user: 'whoami', url: 'url', title: 'title', body: 'body_with_caller')
         end
       end
 
@@ -74,8 +76,8 @@ module Bullet
         it 'should send full_notice to notifier' do
           notifier = double
           allow(subject).to receive(:notifier).and_return(notifier)
-          allow(subject).to receive(:notification_data).and_return(:foo => :bar)
-          expect(notifier).to receive(:inline_notify).with(:foo => :bar)
+          allow(subject).to receive(:notification_data).and_return(foo: :bar)
+          expect(notifier).to receive(:inline_notify).with(foo: :bar)
           subject.notify_inline
         end
       end
@@ -84,8 +86,8 @@ module Bullet
         it 'should send full_out_of_channel to notifier' do
           notifier = double
           allow(subject).to receive(:notifier).and_return(notifier)
-          allow(subject).to receive(:notification_data).and_return(:foo => :bar)
-          expect(notifier).to receive(:out_of_channel_notify).with(:foo => :bar)
+          allow(subject).to receive(:notification_data).and_return(foo: :bar)
+          expect(notifier).to receive(:out_of_channel_notify).with(foo: :bar)
           subject.notify_out_of_channel
         end
       end

data/spec/bullet/notification/counter_cache_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Bullet
   module Notification
     describe CounterCache do
-      subject { CounterCache.new(Post, [:comments, :votes]) }
+      subject { CounterCache.new(Post, %i[comments votes]) }
 
       it { expect(subject.body).to eq('  Post => [:comments, :votes]') }
       it { expect(subject.title).to eq('Need Counter Cache') }

data/spec/bullet/notification/n_plus_one_query_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Bullet
   module Notification
     describe NPlusOneQuery do
-      subject { NPlusOneQuery.new([['caller1', 'caller2']], Post, [:comments, :votes], 'path') }
+      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"]) }

data/spec/bullet/notification/unused_eager_loading_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Bullet
   module Notification
     describe UnusedEagerLoading do
-      subject { UnusedEagerLoading.new([''], Post, [:comments, :votes], 'path') }
+      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 { expect(subject.title).to eq('AVOID eager loading in path') }

data/spec/bullet/notification_collector_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Bullet

data/spec/bullet/rack_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'spec_helper'
 
@@ -9,48 +10,48 @@ module Bullet
     context '#html_request?' do
       it 'should be true if Content-Type is text/html and http body contains html tag' do
         headers = { 'Content-Type' => 'text/html' }
-        response = double(:body => '<html><head></head><body></body></html>')
+        response = double(body: '<html><head></head><body></body></html>')
         expect(middleware).to be_html_request(headers, response)
       end
 
       it 'should be true if Content-Type is text/html and http body contains html tag with attributes' do
         headers = { 'Content-Type' => 'text/html' }
-        response = double(:body => "<html attr='hello'><head></head><body></body></html>")
+        response = double(body: "<html attr='hello'><head></head><body></body></html>")
         expect(middleware).to be_html_request(headers, response)
       end
 
       it 'should be false if there is no Content-Type header' do
         headers = {}
-        response = double(:body => '<html><head></head><body></body></html>')
+        response = double(body: '<html><head></head><body></body></html>')
         expect(middleware).not_to be_html_request(headers, response)
       end
 
       it 'should be false if Content-Type is javascript' do
         headers = { 'Content-Type' => 'text/javascript' }
-        response = double(:body => '<html><head></head><body></body></html>')
+        response = double(body: '<html><head></head><body></body></html>')
         expect(middleware).not_to be_html_request(headers, response)
       end
 
       it "should be false if response body doesn't contain html tag" do
         headers = { 'Content-Type' => 'text/html' }
-        response = double(:body => '<div>Partial</div>')
+        response = double(body: '<div>Partial</div>')
         expect(middleware).not_to be_html_request(headers, response)
       end
     end
 
     context 'empty?' do
       it 'should be false if response is a string and not empty' do
-        response = double(:body => '<html><head></head><body></body></html>')
+        response = double(body: '<html><head></head><body></body></html>')
         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
-        response = double(:body => '')
+        response = double(body: '')
         expect(middleware).to be_empty(response)
       end
     end
@@ -67,8 +68,9 @@ module Bullet
         it 'should change response body if notification is active' do
           expect(Bullet).to receive(:notification?).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' })
+          status, 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>'])
         end
@@ -79,8 +81,8 @@ 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' })
-          expect(headers['Content-Length']).to eq('58')
+          status, headers, response = middleware.call('Content-Type' => 'text/html')
+          expect(headers['Content-Length']).to eq((58 + middleware.send(:xhr_script).length).to_s)
         end
       end
 
@@ -94,6 +96,14 @@ module Bullet
       end
     end
 
+    context '#set_header' do
+      it 'should truncate headers to under 8kb' do
+        long_header = ['a' * 1024] * 10
+        expected_res = (['a' * 1024] * 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>' }

data/spec/bullet/registry/association_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Bullet
   module Registry
     describe Association do
-      subject { Association.new.tap { |association| association.add(['key1', 'key2'], 'value') } }
+      subject { Association.new.tap { |association| association.add(%w[key1 key2], 'value') } }
 
       context '#merge' do
         it 'should merge key/value' do
@@ -14,7 +16,7 @@ module Bullet
 
       context '#similarly_associated' do
         it 'should return similarly associated keys' do
-          expect(subject.similarly_associated('key1', Set.new(['value']))).to eq(['key1', 'key2'])
+          expect(subject.similarly_associated('key1', Set.new(['value']))).to eq(%w[key1 key2])
         end
 
         it 'should return empty if key does not exist' do

data/spec/bullet/registry/base_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Bullet
@@ -21,12 +23,12 @@ module Bullet
       context '#add' do
         it 'should add value with string' do
           subject.add('key', 'new_value')
-          expect(subject['key']).to eq(Set.new(['value', 'new_value']))
+          expect(subject['key']).to eq(Set.new(%w[value new_value]))
         end
 
         it 'should add value with array' do
-          subject.add('key', ['value1', 'value2'])
-          expect(subject['key']).to eq(Set.new(['value', 'value1', 'value2']))
+          subject.add('key', %w[value1 value2])
+          expect(subject['key']).to eq(Set.new(%w[value value1 value2]))
         end
       end
 

data/spec/bullet/registry/object_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Bullet

data/spec/bullet_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Bullet, focused: true do
@@ -88,7 +90,7 @@ describe Bullet, focused: true do
   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)
+        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
@@ -97,17 +99,17 @@ describe Bullet, focused: true do
   describe '#delete_whitelist' do
     context "for 'special' class names" do
       it 'is deleted from the whitelist successfully' do
-        Bullet.add_whitelist(:type => :n_plus_one_query, :class_name => 'Klass', :association => :department)
-        Bullet.delete_whitelist(:type => :n_plus_one_query, :class_name => 'Klass', :association => :department)
+        Bullet.add_whitelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
+        Bullet.delete_whitelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
         expect(Bullet.whitelist[:n_plus_one_query]).to eq({})
       end
     end
 
     context 'when exists multiple definitions' do
       it 'is deleted from the whitelist successfully' do
-        Bullet.add_whitelist(:type => :n_plus_one_query, :class_name => 'Klass', :association => :department)
-        Bullet.add_whitelist(:type => :n_plus_one_query, :class_name => 'Klass', :association => :team)
-        Bullet.delete_whitelist(:type => :n_plus_one_query, :class_name => 'Klass', :association => :team)
+        Bullet.add_whitelist(type: :n_plus_one_query, class_name: 'Klass', association: :department)
+        Bullet.add_whitelist(type: :n_plus_one_query, class_name: 'Klass', association: :team)
+        Bullet.delete_whitelist(type: :n_plus_one_query, class_name: 'Klass', association: :team)
         expect(Bullet.get_whitelist_associations(:n_plus_one_query, 'Klass')).to include :department
         expect(Bullet.get_whitelist_associations(:n_plus_one_query, 'Klass')).to_not include :team
       end
@@ -127,7 +129,7 @@ describe Bullet, focused: true do
         {
           'REQUEST_METHOD' => 'GET',
           'PATH_INFO' => '/path',
-          'QUERY_STRING' => 'foo=bar',
+          'QUERY_STRING' => 'foo=bar'
         }
       }