bullet 2.3.1 → 4.0.0

data/README.textile

@@ -2,11 +2,11 @@ h1. Bullet !https://gemnasium.com/flyerhzm/bullet.png?travis(Dependency Status)!
 
 !https://secure.travis-ci.org/flyerhzm/bullet.png!:http://travis-ci.org/flyerhzm/bullet
 
-The Bullet plugin/gem is designed to help you increase your application's performance by reducing the number of queries it makes. It will watch your queries while you develop your application and notify you when you should add eager loading (N+1 queries), when you're using eager loading that isn't necessary and when you should use counter cache.
+The Bullet gem is designed to help you increase your application's performance by reducing the number of queries it makes. It will watch your queries while you develop your application and notify you when you should add eager loading (N+1 queries), when you're using eager loading that isn't necessary and when you should use counter cache.
 
 Best practice is to use Bullet in development mode or custom mode (staging, profile, etc.). The last thing you want is your clients getting alerts about how lazy you are.
 
-The Bullet plugin/gem now supports rails 2.1, 2.2, 2.3, 3.0, 3.1 and 3.2.
+The Bullet gem now supports **activerecord** 2.1, 2.2, 2.3, 3.0, 3.1, 3.2 and **mongoid** >= 2.4.1.
 
 ****************************************************************************
 
@@ -46,7 +46,7 @@ end
 The notifier of bullet is a wrap of "uniform_notifier":https://github.com/flyerhzm/uniform_notifier
 
 The code above will enable all six of the Bullet notification systems:
-* <code>Bullet.enable</code>: enable Bullet plugin/gem, otherwise do nothing
+* <code>Bullet.enable</code>: enable Bullet gem, otherwise do nothing
 * <code>Bullet.alert</code>: pop up a JavaScript alert in the browser
 * <code>Bullet.bullet_logger</code>: log to the Bullet log file (Rails.root/log/bullet.log)
 * <code>Bullet.rails_logger</code>: add warnings directly to the Rails log
@@ -127,7 +127,7 @@ If you find bullet does not work for you, *please disable your browser's cache*.
 
 h2. Advance
 
-The bullet plugin/gem use rack middleware for http request. If you want to bullet for without http server, such as job server. You can do like this:
+The bullet gem use rack middleware for http request. If you want to bullet for without http server, such as job server. You can do like this:
 
 <pre><code>
 Bullet.start_request if Bullet.enable?
@@ -233,7 +233,7 @@ And run
 
 <pre><code>bundle install</code></pre>
 
-6. enable the bullet plugin in development, add a line to <code>config/environments/development.rb</code>
+6. enable the bullet gem in development, add a line to <code>config/environments/development.rb</code>
 
 <pre><code>
 config.after_initialize do

data/lib/bullet.rb

@@ -1,11 +1,7 @@
 require 'set'
 require 'uniform_notifier'
-
-class Object
-  def ar_key
-    "#{self.class}:#{self.id}"
-  end
-end
+require 'bullet/ext/object'
+require 'bullet/ext/string'
 
 module Bullet
   if Rails.version =~ /\A3\.0/
@@ -16,6 +12,7 @@ module Bullet
     autoload :ActiveRecord, 'bullet/active_record2'
     autoload :ActionController, 'bullet/action_controller2'
   end
+  autoload :Mongoid, 'bullet/mongoid'
   autoload :Rack, 'bullet/rack'
   autoload :BulletLogger, 'bullet/logger'
   autoload :Notification, 'bullet/notification'
@@ -44,9 +41,18 @@ module Bullet
     def enable=(enable)
       @enable = enable
       if enable?
-        Bullet::ActiveRecord.enable
-        if Rails.version =~ /\A2./
-          Bullet::ActionController.enable
+        begin
+          require 'mongoid'
+          Bullet::Mongoid.enable
+        rescue LoadError
+        end
+        begin
+          require 'active_record'
+          Bullet::ActiveRecord.enable
+          if Rails.version =~ /\A2./
+            Bullet::ActionController.enable
+          end
+        rescue LoadError
         end
       end
     end

data/lib/bullet/active_record2.rb

@@ -73,6 +73,18 @@ module Bullet
           Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
           origin_load_target
         end
+
+        alias_method :origin_first, :first
+        def first(*args)
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          origin_first(*args)
+        end
+
+        alias_method :origin_last, :last
+        def last(*args)
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          origin_last(*args)
+        end
       end
 
       ::ActiveRecord::Associations::AssociationProxy.class_eval do

data/lib/bullet/active_record3.rb

@@ -67,6 +67,18 @@ module Bullet
           Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
           origin_load_target
         end
+
+        alias_method :origin_first, :first
+        def first(*args)
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          origin_first(*args)
+        end
+
+        alias_method :origin_last, :last
+        def last(*args)
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          origin_last(*args)
+        end
       end
 
       ::ActiveRecord::Associations::AssociationProxy.class_eval do

data/lib/bullet/detector/association.rb

@@ -20,34 +20,33 @@ module Bullet
         end
 
         def add_object_associations(object, associations)
-          object_associations.add(object.ar_key, associations) if object.id
+          object_associations.add(object.bullet_ar_key, associations) if object.id
         end
 
         def add_call_object_associations(object, associations)
-          call_object_associations.add(object.ar_key, associations) if object.id
+          call_object_associations.add(object.bullet_ar_key, associations) if object.id
         end
 
         def add_possible_objects(object_or_objects)
+          return unless object_or_objects
           if object_or_objects.is_a? Array
-            object_or_objects.each { |object| possible_objects.add object.ar_key }
-          elsif object_or_objects.is_a? ::ActiveRecord::Base
-            possible_objects.add object_or_objects.ar_key if object_or_objects.id
+            object_or_objects.each { |object| possible_objects.add object.bullet_ar_key }
           else
-            # do nothing
+            possible_objects.add object_or_objects.bullet_ar_key if object_or_objects.id
           end
         end
 
         def add_impossible_object(object)
-          impossible_objects.add object.ar_key if object.id
+          impossible_objects.add object.bullet_ar_key if object.id
         end
 
         def add_eager_loadings(objects, associations)
-          object_ar_keys = objects.map(&:ar_key)
+          bullet_ar_keys = objects.map(&:bullet_ar_key)
 
           to_add = nil
           to_merge, to_delete = [], []
           eager_loadings.each do |k, v|
-            key_objects_overlap = k & object_ar_keys
+            key_objects_overlap = k & bullet_ar_keys
 
             next if key_objects_overlap.empty?
 
@@ -57,10 +56,10 @@ module Bullet
             else
               to_merge << [key_objects_overlap, ( eager_loadings[k].dup  << associations )]
 
-              keys_without_objects = k - object_ar_keys
+              keys_without_objects = k - bullet_ar_keys
               to_merge << [keys_without_objects, eager_loadings[k]]
               to_delete << k
-              object_ar_keys = object_ar_keys - k
+              bullet_ar_keys = bullet_ar_keys - k
             end
           end
 
@@ -68,7 +67,7 @@ module Bullet
           to_merge.each { |k,val| eager_loadings.merge k, val }
           to_delete.each { |k| eager_loadings.delete k }
 
-          eager_loadings.add object_ar_keys, associations unless object_ar_keys.empty?
+          eager_loadings.add bullet_ar_keys, associations unless bullet_ar_keys.empty?
         end
 
         private

data/lib/bullet/detector/counter.rb

@@ -8,21 +8,21 @@ module Bullet
         end
 
         def add_counter_cache(object, associations)
-          if conditions_met?(object.ar_key, associations)
+          if conditions_met?(object.bullet_ar_key, associations)
             create_notification object.class.to_s, associations
           end
         end
 
         def add_possible_objects(object_or_objects)
           if object_or_objects.is_a? Array
-            object_or_objects.each { |object| possible_objects.add object.ar_key }
+            object_or_objects.each { |object| possible_objects.add object.bullet_ar_key }
           else
-            possible_objects.add object_or_objects.ar_key
+            possible_objects.add object_or_objects.bullet_ar_key
           end
         end
 
         def add_impossible_object(object)
-          impossible_objects.add object.ar_key
+          impossible_objects.add object.bullet_ar_key
         end
 
         private
@@ -39,8 +39,8 @@ module Bullet
             @@impossible_objects ||= Bullet::Registry::Object.new
           end
 
-          def conditions_met?(object_ar_key, associations)
-            possible_objects.include?(object_ar_key) && !impossible_objects.include?(object_ar_key)
+          def conditions_met?(bullet_ar_key, associations)
+            possible_objects.include?(bullet_ar_key) && !impossible_objects.include?(bullet_ar_key)
           end
       end
     end

data/lib/bullet/detector/n_plus_one_query.rb

@@ -10,7 +10,7 @@ module Bullet
           @@checked = true
           add_call_object_associations(object, associations)
 
-          if conditions_met?(object.ar_key, associations)
+          if conditions_met?(object.bullet_ar_key, associations)
             create_notification caller_in_project, object.class.to_s, associations
           end
         end
@@ -22,8 +22,8 @@ module Bullet
           end
 
           # decide whether the object.associations is unpreloaded or not.
-          def conditions_met?(object_ar_key, associations)
-            possible?(object_ar_key) && !impossible?(object_ar_key) && !association?(object_ar_key, associations)
+          def conditions_met?(bullet_ar_key, associations)
+            possible?(bullet_ar_key) && !impossible?(bullet_ar_key) && !association?(bullet_ar_key, associations)
           end
 
           def caller_in_project
@@ -32,17 +32,17 @@ module Bullet
             caller.select { |c| c.include?(rails_root) && !c.include?(vendor_root) }
           end
 
-          def possible?(object_ar_key)
-            possible_objects.include? object_ar_key
+          def possible?(bullet_ar_key)
+            possible_objects.include? bullet_ar_key
           end
 
-          def impossible?(object_ar_key)
-            impossible_objects.include? object_ar_key
+          def impossible?(bullet_ar_key)
+            impossible_objects.include? bullet_ar_key
           end
 
           # check if object => associations already exists in object_associations.
-          def association?(object_ar_key, associations)
-            value = object_associations[object_ar_key]
+          def association?(bullet_ar_key, associations)
+            value = object_associations[bullet_ar_key]
             if value
               value.each do |v|
                 result = v.is_a?(Hash) ? v.has_key?(associations) : v == associations

data/lib/bullet/detector/unused_eager_association.rb

@@ -8,11 +8,11 @@ module Bullet
         #   if association not in call_object_association, then the object => association - call_object_association is ununsed preload assocations
         def check_unused_preload_associations
           @@checked = true
-          object_associations.each do |object_ar_key, association|
-            object_association_diff = diff_object_association object_ar_key, association
+          object_associations.each do |bullet_ar_key, associations|
+            object_association_diff = diff_object_associations bullet_ar_key, associations
             next if object_association_diff.empty?
 
-            create_notification object_ar_key.split(":").first, object_association_diff
+            create_notification bullet_ar_key.bullet_class_name, object_association_diff
           end
         end
 
@@ -22,19 +22,19 @@ module Bullet
             Bullet.notification_collector.add(notice)
           end
 
-          def call_associations(object_ar_key, association)
+          def call_associations(bullet_ar_key, associations)
             all = Set.new
-            eager_loadings.similarly_associated(object_ar_key, association).each do |related_object_ar_key|
-              coa = call_object_associations[related_object_ar_key]
+            eager_loadings.similarly_associated(bullet_ar_key, associations).each do |related_bullet_ar_key|
+              coa = call_object_associations[related_bullet_ar_key]
               next if coa.nil?
               all.merge coa
             end
             all.to_a
           end
 
-          def diff_object_association(object_ar_key, association)
-            potential_objects = association - call_associations(object_ar_key, association)
-            potential_objects.reject { |a| a.is_a?(Hash) }
+          def diff_object_associations(bullet_ar_key, associations)
+            potential_associations = associations - call_associations(bullet_ar_key, associations)
+            potential_associations.reject { |a| a.is_a?(Hash) }
           end
       end
     end

data/lib/bullet/ext/object.rb

@@ -0,0 +1,5 @@
+class Object
+  def bullet_ar_key
+    "#{self.class}:#{self.id}"
+  end
+end

data/lib/bullet/ext/string.rb

@@ -0,0 +1,5 @@
+class String
+  def bullet_class_name
+    self.sub(/:[^:]*?$/, "")
+  end
+end

data/lib/bullet/mongoid.rb

@@ -0,0 +1,56 @@
+module Bullet
+  module Mongoid
+    def self.enable
+      require 'mongoid'
+      ::Mongoid::Contexts::Mongo.class_eval do
+        alias_method :origin_first, :first
+        alias_method :origin_last, :last
+        alias_method :origin_iterate, :iterate
+
+        def first
+          result = origin_first
+          Bullet::Detector::Association.add_impossible_object(result)
+          result
+        end
+
+        def last
+          result = origin_last
+          Bullet::Detector::Association.add_impossible_object(result)
+          result
+        end
+
+        def iterate(&block)
+          records = execute.to_a
+          if records.size > 1
+            Bullet::Detector::Association.add_possible_objects(records)
+          elsif records.size == 1
+            Bullet::Detector::Association.add_impossible_object(records.first)
+          end
+          origin_iterate(&block)
+        end
+      end
+
+      ::Mongoid::Relations::Accessors.class_eval do
+        alias_method :origin_set_relation, :set_relation
+
+        def set_relation(name, relation)
+          Bullet::Detector::NPlusOneQuery.call_association(self, name)
+          origin_set_relation(name, relation)
+        end
+      end
+
+      ::Mongoid::Contexts::Mongo.class_eval do
+        alias_method :origin_eager_load, :eager_load
+
+        def eager_load(docs)
+          associations = criteria.inclusions.map(&:name)
+          docs.each do |doc|
+            Bullet::Detector::Association.add_object_associations(doc, associations)
+          end
+          Bullet::Detector::Association.add_eager_loadings(docs, associations)
+          origin_eager_load(docs)
+        end
+      end
+    end
+  end
+end

data/lib/bullet/registry/object.rb

@@ -1,14 +1,12 @@
 module Bullet
   module Registry
     class Object < Base
-      def add(object_ar_key)
-        klazz = object_ar_key.split(":").first
-        super(klazz, object_ar_key)
+      def add(bullet_ar_key)
+        super(bullet_ar_key.bullet_class_name, bullet_ar_key)
       end
 
-      def include?(object_ar_key)
-        klazz = object_ar_key.split(":").first
-        super(klazz, object_ar_key)
+      def include?(bullet_ar_key)
+        super(bullet_ar_key.bullet_class_name, bullet_ar_key)
       end
     end
   end

data/lib/bullet/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 module Bullet
-  VERSION = "2.3.1"
+  VERSION = "4.0.0"
 end
 

data/spec/bullet/detector/association_spec.rb

@@ -30,22 +30,22 @@ module Bullet
       context ".add_object_association" do
         it "should add object, associations pair" do
           Association.add_object_associations(@post1, :associations)
-          Association.send(:object_associations).should be_include(@post1.ar_key, :associations)
+          Association.send(:object_associations).should be_include(@post1.bullet_ar_key, :associations)
         end
       end
 
       context ".add_call_object_associations" do
         it "should add call object, associations pair" do
           Association.add_call_object_associations(@post1, :associations)
-          Association.send(:call_object_associations).should be_include(@post1.ar_key, :associations)
+          Association.send(:call_object_associations).should be_include(@post1.bullet_ar_key, :associations)
         end
       end
 
       context ".add_possible_objects" do
         it "should add possible objects" do
           Association.add_possible_objects([@post1, @post2])
-          Association.send(:possible_objects).should be_include(@post1.ar_key)
-          Association.send(:possible_objects).should be_include(@post2.ar_key)
+          Association.send(:possible_objects).should be_include(@post1.bullet_ar_key)
+          Association.send(:possible_objects).should be_include(@post2.bullet_ar_key)
         end
 
         it "should not raise error if object is nil" do
@@ -56,37 +56,37 @@ module Bullet
       context ".add_impossible_object" do
         it "should add impossible object" do
           Association.add_impossible_object(@post1)
-          Association.send(:impossible_objects).should be_include(@post1.ar_key)
+          Association.send(:impossible_objects).should be_include(@post1.bullet_ar_key)
         end
       end
 
       context ".add_eager_loadings" do
         it "should add objects, associations pair when eager_loadings are empty" do
           Association.add_eager_loadings([@post1, @post2], :associations)
-          Association.send(:eager_loadings).should be_include([@post1.ar_key, @post2.ar_key], :associations)
+          Association.send(:eager_loadings).should be_include([@post1.bullet_ar_key, @post2.bullet_ar_key], :associations)
         end
 
         it "should add objects, associations pair for existing eager_loadings" do
           Association.add_eager_loadings([@post1, @post2], :association1)
           Association.add_eager_loadings([@post1, @post2], :association2)
-          Association.send(:eager_loadings).should be_include([@post1.ar_key, @post2.ar_key], :association1)
-          Association.send(:eager_loadings).should be_include([@post1.ar_key, @post2.ar_key], :association2)
+          Association.send(:eager_loadings).should be_include([@post1.bullet_ar_key, @post2.bullet_ar_key], :association1)
+          Association.send(:eager_loadings).should be_include([@post1.bullet_ar_key, @post2.bullet_ar_key], :association2)
         end
 
         it "should merge objects, associations pair for existing eager_loadings" do
           Association.add_eager_loadings([@post1], :association1)
           Association.add_eager_loadings([@post1, @post2], :association2)
-          Association.send(:eager_loadings).should be_include([@post1.ar_key], :association1)
-          Association.send(:eager_loadings).should be_include([@post1.ar_key], :association2)
-          Association.send(:eager_loadings).should be_include([@post1.ar_key, @post2.ar_key], :association2)
+          Association.send(:eager_loadings).should be_include([@post1.bullet_ar_key], :association1)
+          Association.send(:eager_loadings).should be_include([@post1.bullet_ar_key], :association2)
+          Association.send(:eager_loadings).should be_include([@post1.bullet_ar_key, @post2.bullet_ar_key], :association2)
         end
 
         it "should delete objects, associations pair for existing eager_loadings" do
           Association.add_eager_loadings([@post1, @post2], :association1)
           Association.add_eager_loadings([@post1], :association2)
-          Association.send(:eager_loadings).should be_include([@post1.ar_key], :association1)
-          Association.send(:eager_loadings).should be_include([@post1.ar_key], :association2)
-          Association.send(:eager_loadings).should be_include([@post2.ar_key], :association1)
+          Association.send(:eager_loadings).should be_include([@post1.bullet_ar_key], :association1)
+          Association.send(:eager_loadings).should be_include([@post1.bullet_ar_key], :association2)
+          Association.send(:eager_loadings).should be_include([@post2.bullet_ar_key], :association1)
         end
       end
     end