bullet 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbcef4cb1e9b0db722674cc600a456767eb5d2dd
-  data.tar.gz: 27107041da317defb0433329dc55375b305cc7b8
+  metadata.gz: ed73722e74144833068cf4572e3624687a9db64b
+  data.tar.gz: e882a8f5c7e4bfbe1d37254e1255ed79fc3f3948
 SHA512:
-  metadata.gz: ea8208a3a4f1a1ef3f4f247667f9485b951a00ba5036cc87b8049005813e8f7452a5d340c1fdb09ea525fd5996b0050587a758afc8ff2a421f93acb21424f605
-  data.tar.gz: 456466364914301c30c4622bba947888bd16d92dad0603759c8b1108c4bc11ed417a8fca5a8ee2c983f119fa16e587cc140498393d2ec31f1a79c410082f1874
+  metadata.gz: a62b1a339dccad8b79e97971c8d7fc73f977eb9d0b1c19758f59259e85531116fb57a9ef51c90e013d6051a27616ec861380d0940f658102155a163f52eb1873
+  data.tar.gz: de637d2bb853c67a5e7f2b269f698b18b59a481f5988025407d094e0442df03de805bc3890945e49accba76d3ae3c7a62c4185a8fde8d584550eac251a281836

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Next Release
 
+## 5.3.0 (15/08/2016)
+
+* Fix false alert on through association with join sql #301
+* Fix association.target in through_association can be singular #302
+* Support find_by_sql #303
+* Fix env REQUEST_URI
+
 ## 5.2.0 (07/26/2016)
 
 * Fix `has_cached_counter?` is not defined in HABTM #297

data/lib/bullet/active_record3.rb

@@ -4,6 +4,25 @@ module Bullet
 
     def self.enable
       require 'active_record'
+      ::ActiveRecord::Base.class_eval do
+        class <<self
+          alias_method :origin_find_by_sql, :find_by_sql
+          def find_by_sql(sql)
+            result = origin_find_by_sql(sql)
+            if Bullet.start?
+              if result.is_a? Array
+                Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
+                Bullet::Detector::CounterCache.add_possible_objects(result)
+              elsif result.is_a? ::ActiveRecord::Base
+                Bullet::Detector::NPlusOneQuery.add_impossible_object(result)
+                Bullet::Detector::CounterCache.add_impossible_object(result)
+              end
+            end
+            result
+          end
+        end
+      end
+
       ::ActiveRecord::Relation.class_eval do
         alias_method :origin_to_a, :to_a
         # if select a collection of objects, then these objects have possible to cause N+1 query.

data/lib/bullet/active_record3x.rb

@@ -2,6 +2,25 @@ module Bullet
   module ActiveRecord
     def self.enable
       require 'active_record'
+      ::ActiveRecord::Base.class_eval do
+        class <<self
+          alias_method :origin_find_by_sql, :find_by_sql
+          def find_by_sql(sql, binds = [])
+            result = origin_find_by_sql(sql, binds)
+            if Bullet.start?
+              if result.is_a? Array
+                Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
+                Bullet::Detector::CounterCache.add_possible_objects(result)
+              elsif result.is_a? ::ActiveRecord::Base
+                Bullet::Detector::NPlusOneQuery.add_impossible_object(result)
+                Bullet::Detector::CounterCache.add_impossible_object(result)
+              end
+            end
+            result
+          end
+        end
+      end
+
       ::ActiveRecord::Relation.class_eval do
         alias_method :origin_to_a, :to_a
         # if select a collection of objects, then these objects have possible to cause N+1 query.

data/lib/bullet/active_record4.rb

@@ -2,6 +2,25 @@ module Bullet
   module ActiveRecord
     def self.enable
       require 'active_record'
+      ::ActiveRecord::Base.class_eval do
+        class <<self
+          alias_method :origin_find_by_sql, :find_by_sql
+          def find_by_sql(sql, binds = [])
+            result = origin_find_by_sql(sql, binds)
+            if Bullet.start?
+              if result.is_a? Array
+                Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
+                Bullet::Detector::CounterCache.add_possible_objects(result)
+              elsif result.is_a? ::ActiveRecord::Base
+                Bullet::Detector::NPlusOneQuery.add_impossible_object(result)
+                Bullet::Detector::CounterCache.add_impossible_object(result)
+              end
+            end
+            result
+          end
+        end
+      end
+
       ::ActiveRecord::Relation.class_eval do
         alias_method :origin_to_a, :to_a
         # if select a collection of objects, then these objects have possible to cause N+1 query.

data/lib/bullet/active_record41.rb

@@ -2,6 +2,25 @@ module Bullet
   module ActiveRecord
     def self.enable
       require 'active_record'
+      ::ActiveRecord::Base.class_eval do
+        class <<self
+          alias_method :origin_find_by_sql, :find_by_sql
+          def find_by_sql(sql, binds = [])
+            result = origin_find_by_sql(sql, binds)
+            if Bullet.start?
+              if result.is_a? Array
+                Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
+                Bullet::Detector::CounterCache.add_possible_objects(result)
+              elsif result.is_a? ::ActiveRecord::Base
+                Bullet::Detector::NPlusOneQuery.add_impossible_object(result)
+                Bullet::Detector::CounterCache.add_impossible_object(result)
+              end
+            end
+            result
+          end
+        end
+      end
+
       ::ActiveRecord::Relation.class_eval do
         alias_method :origin_to_a, :to_a
         # if select a collection of objects, then these objects have possible to cause N+1 query.

data/lib/bullet/active_record42.rb

@@ -18,6 +18,21 @@ module Bullet
             end
             result
           end
+
+          alias_method :origin_find_by_sql, :find_by_sql
+          def find_by_sql(sql, binds = [])
+            result = origin_find_by_sql(sql, binds)
+            if Bullet.start?
+              if result.is_a? Array
+                Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
+                Bullet::Detector::CounterCache.add_possible_objects(result)
+              elsif result.is_a? ::ActiveRecord::Base
+                Bullet::Detector::NPlusOneQuery.add_impossible_object(result)
+                Bullet::Detector::CounterCache.add_impossible_object(result)
+              end
+            end
+            result
+          end
         end
       end
 
@@ -96,6 +111,7 @@ module Bullet
 
       ::ActiveRecord::Associations::JoinDependency.class_eval do
         alias_method :origin_instantiate, :instantiate
+        alias_method :origin_construct, :construct
         alias_method :origin_construct_model, :construct_model
 
         def instantiate(result_set, aliases)
@@ -111,6 +127,27 @@ module Bullet
           records
         end
 
+        def construct(ar_parent, parent, row, rs, seen, model_cache, aliases)
+          if Bullet.start?
+            unless ar_parent.nil?
+              parent.children.each do |node|
+                key = aliases.column_alias(node, node.primary_key)
+                id = row[key]
+                if id.nil?
+                  associations = node.reflection.name
+                  Bullet::Detector::Association.add_object_associations(ar_parent, associations)
+                  Bullet::Detector::NPlusOneQuery.call_association(ar_parent, associations)
+                  @bullet_eager_loadings[ar_parent.class] ||= {}
+                  @bullet_eager_loadings[ar_parent.class][ar_parent] ||= Set.new
+                  @bullet_eager_loadings[ar_parent.class][ar_parent] << associations
+                end
+              end
+            end
+          end
+
+          origin_construct(ar_parent, parent, row, rs, seen, model_cache, aliases)
+        end
+
         # call join associations
         def construct_model(record, node, row, model_cache, id, aliases)
           result = origin_construct_model(record, node, row, model_cache, id, aliases)
@@ -135,9 +172,7 @@ module Bullet
           records = origin_load_target
 
           if Bullet.start?
-            if records.size > 1
-              Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless @inversed
-            end
+            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless @inversed
             if records.first.class.name !~ /^HABTM_/
               if records.size > 1
                 Bullet::Detector::NPlusOneQuery.add_possible_objects(records)

data/lib/bullet/active_record5.rb

@@ -20,9 +20,9 @@ module Bullet
       require 'active_record'
       ::ActiveRecord::Base.class_eval do
         class <<self
-          alias_method :origin_find, :find
-          def find(*args)
-            result = origin_find(*args)
+          alias_method :origin_find_by_sql, :find_by_sql
+          def find_by_sql(sql, binds = [], preparable: nil)
+            result = origin_find_by_sql(sql, binds, preparable: nil)
             if Bullet.start?
               if result.is_a? Array
                 Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
@@ -96,6 +96,7 @@ module Bullet
 
       ::ActiveRecord::Associations::JoinDependency.class_eval do
         alias_method :origin_instantiate, :instantiate
+        alias_method :origin_construct, :construct
         alias_method :origin_construct_model, :construct_model
 
         def instantiate(result_set, aliases)
@@ -111,6 +112,27 @@ module Bullet
           records
         end
 
+        def construct(ar_parent, parent, row, rs, seen, model_cache, aliases)
+          if Bullet.start?
+            unless ar_parent.nil?
+              parent.children.each do |node|
+                key = aliases.column_alias(node, node.primary_key)
+                id = row[key]
+                if id.nil?
+                  associations = node.reflection.name
+                  Bullet::Detector::Association.add_object_associations(ar_parent, associations)
+                  Bullet::Detector::NPlusOneQuery.call_association(ar_parent, associations)
+                  @bullet_eager_loadings[ar_parent.class] ||= {}
+                  @bullet_eager_loadings[ar_parent.class][ar_parent] ||= Set.new
+                  @bullet_eager_loadings[ar_parent.class][ar_parent] << associations
+                end
+              end
+            end
+          end
+
+          origin_construct(ar_parent, parent, row, rs, seen, model_cache, aliases)
+        end
+
         # call join associations
         def construct_model(record, node, row, model_cache, id, aliases)
           result = origin_construct_model(record, node, row, model_cache, id, aliases)
@@ -135,16 +157,14 @@ module Bullet
           records = origin_load_target
 
           if Bullet.start?
-            if records.size > 1
-              if self.is_a? ::ActiveRecord::Associations::ThroughAssociation
-                Bullet::Detector::NPlusOneQuery.call_association(owner, through_reflection.name)
-                association = self.owner.association self.through_reflection.name
-                association.target.each do |through_record|
-                  Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
-                end
+            if self.is_a? ::ActiveRecord::Associations::ThroughAssociation
+              Bullet::Detector::NPlusOneQuery.call_association(owner, through_reflection.name)
+              association = self.owner.association self.through_reflection.name
+              Array(association.target).each do |through_record|
+                Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
               end
-              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) unless @inversed
             end
+            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) unless @inversed
             if records.first.class.name !~ /^HABTM_/
               if records.size > 1
                 Bullet::Detector::NPlusOneQuery.add_possible_objects(records)

data/lib/bullet/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Bullet
-  VERSION = "5.2.0"
+  VERSION = "5.3.0"
 end

data/lib/bullet.rb

@@ -166,8 +166,9 @@ module Bullet
     end
 
     def perform_out_of_channel_notifications(env = {})
+      request_uri = env['REQUEST_URI'] || build_request_uri(env)
       for_each_active_notifier_with_notification do |notification|
-        notification.url = env['REQUEST_URI']
+        notification.url = request_uri
         notification.notify_out_of_channel
       end
     end
@@ -217,5 +218,13 @@ module Bullet
           end
         end
       end
+
+      def build_request_uri(env)
+        if env['QUERY_STRING'].present?
+          "#{env['PATH_INFO']}?#{env['QUERY_STRING']}"
+        else
+          env['PATH_INFO']
+        end
+      end
   end
 end

data/spec/bullet/rack_spec.rb

@@ -60,7 +60,7 @@ module Bullet
         it "should return original response body" do
           expected_response = Support::ResponseDouble.new "Actual body"
           app.response = expected_response
-          _, _, response = middleware.call([])
+          _, _, response = middleware.call({})
           expect(response).to eq(expected_response)
         end
 
@@ -68,7 +68,7 @@ module Bullet
           expect(Bullet).to receive(:notification?).and_return(true)
           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([200, {"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,7 +79,7 @@ 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([200, {"Content-Type" => "text/html"}])
+          status, headers, response = middleware.call({"Content-Type" => "text/html"})
           expect(headers["Content-Length"]).to eq("58")
         end
       end
@@ -89,7 +89,7 @@ module Bullet
 
         it "should not call Bullet.start_request" do
           expect(Bullet).not_to receive(:start_request)
-          middleware.call([])
+          middleware.call({})
         end
       end
     end

data/spec/bullet_spec.rb

@@ -94,4 +94,47 @@ describe Bullet, focused: true do
       end
     end
   end
+
+  describe '#perform_out_of_channel_notifications' do
+    let(:notification) { double }
+
+    before do
+      allow(Bullet).to receive(:for_each_active_notifier_with_notification).and_yield(notification)
+      allow(notification).to receive(:notify_out_of_channel)
+    end
+
+    context 'when called with no args' do
+      it 'should notification.url is nil' do
+        expect(notification).to receive(:url=).with(nil)
+        Bullet.perform_out_of_channel_notifications
+      end
+    end
+
+    context 'when called with Rack environment hash' do
+      let(:env) {
+        {
+          'PATH_INFO' => '/path',
+          'QUERY_STRING' => 'foo=bar',
+        }
+      }
+
+      context "when env['REQUEST_URI'] is nil" do
+        before { env['REQUEST_URI'] = nil }
+
+        it 'should notification.url is built' do
+          expect(notification).to receive(:url=).with('/path?foo=bar')
+          Bullet.perform_out_of_channel_notifications(env)
+        end
+      end
+
+      context "when env['REQUEST_URI'] is present" do
+        before { env['REQUEST_URI'] = 'http://example.com/path' }
+
+        it "should notification.url is env['REQUEST_URI']" do
+          expect(notification).to receive(:url=).with(env['REQUEST_URI'])
+          Bullet.perform_out_of_channel_notifications(env)
+        end
+      end
+    end
+  end
 end

data/spec/integration/active_record3/association_spec.rb

@@ -13,6 +13,16 @@ if !mongoid? && active_record3?
         expect(Bullet::Detector::Association).to be_detecting_unpreloaded_association_for(Post, :comments)
       end
 
+      it "should detect non preload post => comments for find_by_sql" do
+        Post.find_by_sql("SELECT * FROM posts").each do |post|
+          post.comments.map(&:name)
+        end
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+        expect(Bullet::Detector::Association).to be_detecting_unpreloaded_association_for(Post, :comments)
+      end
+
       it "should detect preload with post => comments" do
         Post.includes(:comments).each do |post|
           post.comments.map(&:name)

data/spec/integration/active_record4/association_spec.rb

@@ -13,6 +13,16 @@ if !mongoid? && active_record4?
         expect(Bullet::Detector::Association).to be_detecting_unpreloaded_association_for(Post, :comments)
       end
 
+      it "should detect non preload post => comments for find_by_sql" do
+        Post.find_by_sql("SELECT * FROM posts").each do |post|
+          post.comments.map(&:name)
+        end
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+        expect(Bullet::Detector::Association).to be_detecting_unpreloaded_association_for(Post, :comments)
+      end
+
       it "should detect preload with post => comments" do
         Post.includes(:comments).each do |post|
           post.comments.map(&:name)

data/spec/integration/active_record5/association_spec.rb

@@ -13,6 +13,16 @@ if !mongoid? && active_record5?
         expect(Bullet::Detector::Association).to be_detecting_unpreloaded_association_for(Post, :comments)
       end
 
+      it "should detect non preload post => comments for find_by_sql" do
+        Post.find_by_sql("SELECT * FROM posts").each do |post|
+          post.comments.map(&:name)
+        end
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+        expect(Bullet::Detector::Association).to be_detecting_unpreloaded_association_for(Post, :comments)
+      end
+
       it "should detect preload with post => comments" do
         Post.includes(:comments).each do |post|
           post.comments.map(&:name)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-26 00:00:00.000000000 Z
+date: 2016-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport