RubyGems - bullet - Versions diffs - 5.5.0 → 5.8.0 - Mend

bullet 5.5.0 → 5.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (109) hide show

checksums.yaml +4 -4
data/.travis.yml +1 -5
data/CHANGELOG.md +31 -1
data/Gemfile +6 -1
data/Gemfile.rails-5.0 +1 -1
data/Gemfile.rails-5.1 +15 -0
data/Gemfile.rails-5.2 +15 -0
data/Guardfile +2 -2
data/Hacking.md +1 -1
data/README.md +20 -23
data/Rakefile +20 -21
data/bullet.gemspec +20 -15
data/lib/bullet/active_record4.rb +18 -14
data/lib/bullet/active_record41.rb +16 -14
data/lib/bullet/active_record42.rb +24 -22
data/lib/bullet/active_record5.rb +102 -91
data/lib/bullet/active_record52.rb +232 -0
data/lib/bullet/dependency.rb +9 -1
data/lib/bullet/detector/association.rb +17 -14
data/lib/bullet/detector/base.rb +2 -0
data/lib/bullet/detector/counter_cache.rb +14 -10
data/lib/bullet/detector/n_plus_one_query.rb +21 -17
data/lib/bullet/detector/unused_eager_loading.rb +30 -24
data/lib/bullet/detector.rb +2 -0
data/lib/bullet/ext/object.rb +6 -4
data/lib/bullet/ext/string.rb +3 -1
data/lib/bullet/mongoid4x.rb +7 -2
data/lib/bullet/mongoid5x.rb +7 -2
data/lib/bullet/mongoid6x.rb +11 -6
data/lib/bullet/notification/base.rb +26 -19
data/lib/bullet/notification/counter_cache.rb +3 -1
data/lib/bullet/notification/n_plus_one_query.rb +7 -4
data/lib/bullet/notification/unused_eager_loading.rb +7 -4
data/lib/bullet/notification.rb +2 -0
data/lib/bullet/notification_collector.rb +2 -1
data/lib/bullet/rack.rb +22 -18
data/lib/bullet/registry/association.rb +2 -0
data/lib/bullet/registry/base.rb +2 -0
data/lib/bullet/registry/object.rb +2 -0
data/lib/bullet/registry.rb +2 -0
data/lib/bullet/stack_trace_filter.rb +56 -18
data/lib/bullet/version.rb +3 -2
data/lib/bullet.rb +43 -33
data/lib/generators/bullet/install_generator.rb +48 -0
data/perf/benchmark.rb +12 -12
data/rails/init.rb +2 -0
data/spec/bullet/detector/association_spec.rb +6 -4
data/spec/bullet/detector/base_spec.rb +2 -0
data/spec/bullet/detector/counter_cache_spec.rb +13 -11
data/spec/bullet/detector/n_plus_one_query_spec.rb +71 -46
data/spec/bullet/detector/unused_eager_loading_spec.rb +21 -19
data/spec/bullet/ext/object_spec.rb +10 -8
data/spec/bullet/ext/string_spec.rb +7 -5
data/spec/bullet/notification/base_spec.rb +39 -38
data/spec/bullet/notification/counter_cache_spec.rb +5 -3
data/spec/bullet/notification/n_plus_one_query_spec.rb +5 -3
data/spec/bullet/notification/unused_eager_loading_spec.rb +4 -2
data/spec/bullet/notification_collector_spec.rb +12 -10
data/spec/bullet/rack_spec.rb +48 -47
data/spec/bullet/registry/association_spec.rb +12 -10
data/spec/bullet/registry/base_spec.rb +22 -20
data/spec/bullet/registry/object_spec.rb +6 -4
data/spec/bullet_spec.rb +24 -3
data/spec/integration/{active_record4 → active_record}/association_spec.rb +176 -114
data/spec/integration/counter_cache_spec.rb +15 -13
data/spec/integration/mongoid/association_spec.rb +35 -33
data/spec/models/address.rb +2 -0
data/spec/models/author.rb +2 -0
data/spec/models/base_user.rb +2 -0
data/spec/models/category.rb +2 -0
data/spec/models/city.rb +2 -0
data/spec/models/client.rb +4 -0
data/spec/models/comment.rb +3 -1
data/spec/models/company.rb +2 -0
data/spec/models/country.rb +2 -0
data/spec/models/document.rb +4 -2
data/spec/models/entry.rb +2 -0
data/spec/models/firm.rb +3 -0
data/spec/models/folder.rb +2 -0
data/spec/models/group.rb +4 -0
data/spec/models/mongoid/address.rb +3 -1
data/spec/models/mongoid/category.rb +4 -2
data/spec/models/mongoid/comment.rb +3 -1
data/spec/models/mongoid/company.rb +3 -1
data/spec/models/mongoid/entry.rb +3 -1
data/spec/models/mongoid/post.rb +6 -4
data/spec/models/mongoid/user.rb +2 -0
data/spec/models/newspaper.rb +3 -1
data/spec/models/page.rb +2 -0
data/spec/models/person.rb +2 -0
data/spec/models/pet.rb +2 -0
data/spec/models/post.rb +17 -0
data/spec/models/relationship.rb +2 -0
data/spec/models/reply.rb +2 -0
data/spec/models/student.rb +2 -0
data/spec/models/submission.rb +2 -0
data/spec/models/teacher.rb +2 -0
data/spec/models/user.rb +2 -0
data/spec/models/writer.rb +2 -0
data/spec/spec_helper.rb +15 -13
data/spec/support/bullet_ext.rb +2 -0
data/spec/support/mongo_seed.rb +36 -42
data/spec/support/rack_double.rb +13 -19
data/spec/support/sqlite_seed.rb +84 -76
data/tasks/bullet_tasks.rake +4 -2
data/test.sh +2 -0
data/update.sh +2 -0
metadata +17 -11
data/spec/integration/active_record5/association_spec.rb +0 -768

data/spec/bullet/rack_spec.rb CHANGED Viewed

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
 require 'spec_helper'
 module Bullet
@@ -6,120 +7,120 @@ module Bullet
     let(:middleware) { Bullet::Rack.new app }
     let(:app) { Support::AppDouble.new }
-    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>")
+    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>')
         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>")
+      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>")
         expect(middleware).to be_html_request(headers, response)
       end
-      it "should be false if there is no Content-Type header" do
+      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>")
+      it 'should be false if Content-Type is javascript' do
+        headers = { 'Content-Type' => 'text/javascript' }
+        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>")
+        headers = { 'Content-Type' => 'text/html' }
+        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>")
+    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>')
         expect(middleware).not_to be_empty(response)
       end
-      it "should be true if response is not found" do
-        response = ["Not Found"]
+      it 'should be true if response is not found' do
+        response = ['Not Found']
         expect(middleware).to be_empty(response)
       end
-      it "should be true if response body is empty" do
-        response = double(:body => "")
+      it 'should be true if response body is empty' do
+        response = double(body: '')
         expect(middleware).to be_empty(response)
       end
     end
-    context "#call" do
-      context "when Bullet is enabled" do
-        it "should return original response body" do
-          expected_response = Support::ResponseDouble.new "Actual body"
+    context '#call' do
+      context 'when Bullet is enabled' do
+        it 'should return original response body' do
+          expected_response = Support::ResponseDouble.new 'Actual body'
           app.response = expected_response
           _, _, response = middleware.call({})
           expect(response).to eq(expected_response)
         end
-        it "should change response body if notification is active" do
+        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(Bullet).to receive(:gather_inline_notifications).and_return('<bullet></bullet>')
           expect(Bullet).to receive(:perform_out_of_channel_notifications)
-          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>"])
+          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
-        it "should set the right Content-Length if response body contains accents" do
+        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>"
+          response.body = '<html><head></head><body>é</body></html>'
           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")
+          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')
         end
       end
-      context "when Bullet is disabled" do
+      context 'when Bullet is disabled' do
         before(:each) { allow(Bullet).to receive(:enable?).and_return(false) }
-        it "should not call Bullet.start_request" do
+        it 'should not call Bullet.start_request' do
           expect(Bullet).not_to receive(:start_request)
           middleware.call({})
         end
       end
     end
-    describe "#response_body" do
+    describe '#response_body' do
       let(:response) { double }
-      let(:body_string) { "<html><body>My Body</body></html>" }
+      let(:body_string) { '<html><body>My Body</body></html>' }
-      context "when `response` responds to `body`" do
+      context 'when `response` responds to `body`' do
         before { allow(response).to receive(:body).and_return(body) }
-        context "when `body` returns an Array" do
+        context 'when `body` returns an Array' do
           let(:body) { [body_string, 'random string'] }
-          it "should return the plain body string" do
+          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
+        context 'when `body` does not return an Array' do
           let(:body) { body_string }
-          it "should return the plain body string" do
+          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
+      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
+        it 'should return the plain body string' do
           expect(middleware.response_body(response)).to eq body_string
         end
       end

data/spec/bullet/registry/association_spec.rb CHANGED Viewed

@@ -1,24 +1,26 @@
+# 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
-          subject.merge("key0", "value0")
-          expect(subject["key0"]).to be_include("value0")
+      context '#merge' do
+        it 'should merge key/value' do
+          subject.merge('key0', 'value0')
+          expect(subject['key0']).to be_include('value0')
         end
       end
-      context "#similarly_associated" do
-        it "should return similarly associated keys" do
-          expect(subject.similarly_associated("key1", Set.new(["value"]))).to eq(["key1", "key2"])
+      context '#similarly_associated' do
+        it 'should return similarly associated keys' do
+          expect(subject.similarly_associated('key1', Set.new(['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
+        it 'should return empty if key does not exist' do
+          expect(subject.similarly_associated('key3', Set.new(['value']))).to be_empty
         end
       end
     end

data/spec/bullet/registry/base_spec.rb CHANGED Viewed

@@ -1,42 +1,44 @@
+# frozen_string_literal: true
 require 'spec_helper'
 module Bullet
   module Registry
     describe Base do
-      subject { Base.new.tap { |base| base.add("key", "value") } }
+      subject { Base.new.tap { |base| base.add('key', 'value') } }
-      context "#[]" do
-        it "should get value by key" do
-          expect(subject["key"]).to eq(Set.new(["value"]))
+      context '#[]' do
+        it 'should get value by key' do
+          expect(subject['key']).to eq(Set.new(['value']))
         end
       end
-      context "#delete" do
-        it "should delete key" do
-          subject.delete("key")
-          expect(subject["key"]).to be_nil
+      context '#delete' do
+        it 'should delete key' do
+          subject.delete('key')
+          expect(subject['key']).to be_nil
         end
       end
-      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"]))
+      context '#add' do
+        it 'should add value with string' do
+          subject.add('key', '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"]))
+        it 'should add value with array' do
+          subject.add('key', %w[value1 value2])
+          expect(subject['key']).to eq(Set.new(%w[value value1 value2]))
         end
       end
-      context "#include?" do
-        it "should include key/value" do
-          expect(subject.include?("key", "value")).to eq true
+      context '#include?' do
+        it 'should include key/value' do
+          expect(subject.include?('key', 'value')).to eq true
         end
-        it "should not include wrong key/value" do
-          expect(subject.include?("key", "val")).to eq false
+        it 'should not include wrong key/value' do
+          expect(subject.include?('key', 'val')).to eq false
         end
       end
     end

data/spec/bullet/registry/object_spec.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
 require 'spec_helper'
 module Bullet
@@ -7,14 +9,14 @@ module Bullet
       let(:another_post) { Post.last }
       subject { Object.new.tap { |object| object.add(post.bullet_key) } }
-      context "#include?" do
-        it "should include the object" do
+      context '#include?' do
+        it 'should include the object' do
           expect(subject).to be_include(post.bullet_key)
         end
       end
-      context "#add" do
-        it "should add an object" do
+      context '#add' do
+        it 'should add an object' do
           subject.add(another_post.bullet_key)
           expect(subject).to be_include(another_post.bullet_key)
         end

data/spec/bullet_spec.rb CHANGED Viewed

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 require 'spec_helper'
 describe Bullet, focused: true do
   subject { Bullet }
   describe '#enable' do
     context 'enable Bullet' do
       before do
         # Bullet.enable
@@ -89,8 +90,28 @@ 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
+  end
+  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)
+        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)
         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
     end
   end
@@ -108,7 +129,7 @@ describe Bullet, focused: true do
         {
           'REQUEST_METHOD' => 'GET',
           'PATH_INFO' => '/path',
-          'QUERY_STRING' => 'foo=bar',
+          'QUERY_STRING' => 'foo=bar'
         }
       }