bullet 2.2.0 → 2.3.0

data/.gitignore

@@ -7,3 +7,4 @@ coverage.data
 tags
 .bundle
 *.gem
+benchmark_profile*

data/.travis.yml

@@ -1 +1,4 @@
-rvm: 1.9.2
+language: ruby
+rvm:
+  - 1.9.3
+env: DB=sqlite

data/Gemfile

@@ -5,11 +5,12 @@ source "http://rubygems.org"
 gemspec
 
 gem 'rails'
-gem 'sqlite3-ruby', :require => 'sqlite3'
+gem 'sqlite3'
 gem 'mysql'
 gem 'activerecord-import'
 
 gem "rspec"
-gem "watchr"
+gem "guard"
+gem "guard-rspec"
 
 gem "perftools.rb"

data/Gemfile.lock

@@ -1,95 +1,110 @@
 PATH
   remote: .
   specs:
-    bullet (2.2.0)
+    bullet (2.3.0)
       uniform_notifier (~> 1.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    abstract (1.0.0)
-    actionmailer (3.0.11)
-      actionpack (= 3.0.11)
-      mail (~> 2.2.19)
-    actionpack (3.0.11)
-      activemodel (= 3.0.11)
-      activesupport (= 3.0.11)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.5.0)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.14)
-      rack-test (~> 0.5.7)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.11)
-      activesupport (= 3.0.11)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activerecord (3.0.11)
-      activemodel (= 3.0.11)
-      activesupport (= 3.0.11)
-      arel (~> 2.0.10)
-      tzinfo (~> 0.3.23)
-    activerecord-import (0.2.5)
-      activerecord (~> 3.0.0)
-    activeresource (3.0.11)
-      activemodel (= 3.0.11)
-      activesupport (= 3.0.11)
-    activesupport (3.0.11)
-    arel (2.0.10)
-    builder (2.1.2)
+    actionmailer (3.2.2)
+      actionpack (= 3.2.2)
+      mail (~> 2.4.0)
+    actionpack (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.1)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.2)
+      activesupport (= 3.2.2)
+      builder (~> 3.0.0)
+    activerecord (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activerecord-import (0.2.9)
+      activerecord (~> 3.0)
+      activerecord (~> 3.0)
+    activeresource (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+    activesupport (3.2.2)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
     diff-lcs (1.1.3)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    i18n (0.5.0)
-    json (1.6.3)
-    mail (2.2.19)
-      activesupport (>= 2.3.6)
+    erubis (2.7.0)
+    ffi (1.0.11)
+    guard (1.0.1)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-rspec (0.6.0)
+      guard (>= 0.10.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.3)
+    json (1.6.5)
+    mail (2.4.4)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.17.2)
+    mime-types (1.18)
+    multi_json (1.1.0)
     mysql (2.8.1)
-    perftools.rb (0.5.6)
+    perftools.rb (2.0.0)
     polyglot (0.3.3)
-    rack (1.2.4)
-    rack-mount (0.6.14)
-      rack (>= 1.0.0)
-    rack-test (0.5.7)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.0.11)
-      actionmailer (= 3.0.11)
-      actionpack (= 3.0.11)
-      activerecord (= 3.0.11)
-      activeresource (= 3.0.11)
-      activesupport (= 3.0.11)
+    rails (3.2.2)
+      actionmailer (= 3.2.2)
+      actionpack (= 3.2.2)
+      activerecord (= 3.2.2)
+      activeresource (= 3.2.2)
+      activesupport (= 3.2.2)
       bundler (~> 1.0)
-      railties (= 3.0.11)
-    railties (3.0.11)
-      actionpack (= 3.0.11)
-      activesupport (= 3.0.11)
+      railties (= 3.2.2)
+    railties (3.2.2)
+      actionpack (= 3.2.2)
+      activesupport (= 3.2.2)
+      rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
-      thor (~> 0.14.4)
+      thor (~> 0.14.6)
     rake (0.9.2.2)
-    rdoc (3.11)
+    rdoc (3.12)
       json (~> 1.4)
-    rspec (2.7.0)
-      rspec-core (~> 2.7.0)
-      rspec-expectations (~> 2.7.0)
-      rspec-mocks (~> 2.7.0)
-    rspec-core (2.7.1)
-    rspec-expectations (2.7.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.7.0)
-    sqlite3-ruby (1.3.2)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.5)
     thor (0.14.6)
+    tilt (1.3.3)
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.31)
+    tzinfo (0.3.32)
     uniform_notifier (1.0.1)
-    watchr (0.7)
 
 PLATFORMS
   ruby
@@ -97,9 +112,10 @@ PLATFORMS
 DEPENDENCIES
   activerecord-import
   bullet!
+  guard
+  guard-rspec
   mysql
   perftools.rb
   rails
   rspec
-  sqlite3-ruby
-  watchr
+  sqlite3

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :all_after_pass => false, :all_on_start => false, :cli => "--color --format nested --fail-fast" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.textile

@@ -1,12 +1,12 @@
 h1. Bullet
 
-!https://secure.travis-ci.org/flyerhzm/rails_best_practices.png!:http://travis-ci.org/flyerhzm/rails_best_practices
+!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.
 
 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 and 3.1.
+The Bullet plugin/gem now supports rails 2.1, 2.2, 2.3, 3.0, 3.1 and 3.2.
 
 ****************************************************************************
 

data/lib/bullet/action_controller2.rb

@@ -2,8 +2,7 @@ module Bullet
   class ActionController
     def self.enable
       require 'action_controller'
-      case Rails.version
-      when /^2.3/
+      if Rails.version =~ /\A2.3/
         ::ActionController::Dispatcher.middleware.use Bullet::Rack
         ::ActionController::Dispatcher.class_eval do
           class <<self
@@ -14,7 +13,7 @@ module Bullet
             end
           end
         end
-      when /^2.[2|1]/
+      elsif Rails.version =~ /\A2.[12]/
         ::ActionController::Dispatcher.class_eval do
           alias_method :origin_reload_application, :reload_application
           def reload_application
@@ -30,7 +29,8 @@ module Bullet
             response = origin_process(request, response, method = :perform_action, *arguments)
 
             if Bullet.notification?
-              if response.headers["type"] and response.headers["type"].include? 'text/html' and response.body =~ %r{<html.*</html>}m
+              if response.headers["type"] && response.headers["type"].include?('text/html') &&
+                  response.body.include?("<html>") && response.body.include?("</html>")
                 response.body <<= Bullet.gather_inline_notifications
                 response.headers["Content-Length"] = response.body.length.to_s
               end

data/lib/bullet/active_record2.rb

@@ -1,5 +1,4 @@
 module Bullet
-  LOAD_TARGET_RGX = /load_target/
   module ActiveRecord
     def self.enable
       require 'active_record'
@@ -11,7 +10,7 @@ module Bullet
           def find_every(options)
             records = origin_find_every(options)
 
-            if records 
+            if records
               if records.size > 1
                 Bullet::Detector::Association.add_possible_objects(records)
                 Bullet::Detector::Counter.add_possible_objects(records)
@@ -41,7 +40,7 @@ module Bullet
         end
       end
 
-      ::ActiveRecord::Associations::ClassMethods.class_eval do      
+      ::ActiveRecord::Associations::ClassMethods.class_eval do
         # add include in named_scope
         alias_method :origin_find_with_associations, :find_with_associations
         def find_with_associations(options)
@@ -75,19 +74,19 @@ module Bullet
           origin_load_target
         end
       end
-      
+
       ::ActiveRecord::Associations::AssociationProxy.class_eval do
         # call has_one and belong_to association
         alias_method :origin_load_target, :load_target
         def load_target
           # avoid stack level too deep
           result = origin_load_target
-          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless caller.find {|c| c =~ LOAD_TARGET_RGX }
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless caller.any? {|c| c.include?("load_target") }
           Bullet::Detector::Association.add_possible_objects(result)
           result
         end
       end
-      
+
       ::ActiveRecord::Associations::HasManyAssociation.class_eval do
         alias_method :origin_has_cached_counter?, :has_cached_counter?
         def has_cached_counter?

data/lib/bullet/active_record3.rb

@@ -1,5 +1,4 @@
 module Bullet
-  LOAD_TARGET_RGX = /load_target/
   module ActiveRecord
     def self.enable
       require 'active_record'
@@ -69,14 +68,14 @@ module Bullet
           origin_load_target
         end
       end
-      
+
       ::ActiveRecord::Associations::AssociationProxy.class_eval do
         # call has_one and belong_to association
         alias_method :origin_load_target, :load_target
         def load_target
           # avoid stack level too deep
           result = origin_load_target
-          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless caller.find {|c| c =~ LOAD_TARGET_RGX }
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless caller.any? { |c| c.include?("load_target") }
           Bullet::Detector::Association.add_possible_objects(result)
           result
         end

data/lib/bullet/active_record31.rb

@@ -1,5 +1,4 @@
 module Bullet
-  LOAD_TARGET_RGX = /load_target/
   module ActiveRecord
     def self.enable
       require 'active_record'
@@ -69,14 +68,13 @@ module Bullet
           origin_load_target
         end
       end
-      
-      ::ActiveRecord::Associations::Association.class_eval do
-        # call has_one and belong_to association
-        alias_method :origin_load_target, :load_target
-        def load_target
-          # avoid stack level too deep
-          result = origin_load_target
-          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless caller.find {|c| c =~ LOAD_TARGET_RGX }
+
+      ::ActiveRecord::Associations::SingularAssociation.class_eval do
+        # call has_one and belongs_to associations
+        alias_method :origin_reader, :reader
+        def reader(force_reload = false)
+          result = origin_reader(force_reload)
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
           Bullet::Detector::Association.add_possible_objects(result)
           result
         end
@@ -85,9 +83,9 @@ module Bullet
       ::ActiveRecord::Associations::HasManyAssociation.class_eval do
         alias_method :origin_has_cached_counter?, :has_cached_counter?
 
-        def has_cached_counter?
-          result = origin_has_cached_counter?
-          Bullet::Detector::Counter.add_counter_cache(@owner, @reflection.name) unless result
+        def has_cached_counter?(reflection = reflection)
+          result = origin_has_cached_counter?(reflection)
+          Bullet::Detector::Counter.add_counter_cache(owner, reflection.name) unless result
           result
         end
       end

data/lib/bullet/detector/association.rb

@@ -13,7 +13,6 @@ module Bullet
           # derive from Bullet::Detector::Association - changing the variable
           # in one subclass will make the change visible to all subclasses!
           @@object_associations = nil
-          @@callers = nil
           @@possible_objects = nil
           @@impossible_objects = nil
           @@call_object_associations = nil
@@ -21,83 +20,62 @@ module Bullet
         end
 
         def add_object_associations(object, associations)
-          object_associations.add( object, associations )
+          object_associations.add(object.ar_key, associations)
         end
 
         def add_call_object_associations(object, associations)
-          call_object_associations.add( object, associations )
+          if object.id
+            call_object_associations.add(object.ar_key, associations)
+          end
         end
 
-        def add_possible_objects(objects)
-          possible_objects.add objects
+        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 }
+          else
+            possible_objects.add object_or_objects.ar_key
+          end
         end
 
         def add_impossible_object(object)
-          impossible_objects.add object
+          impossible_objects.add object.ar_key
         end
 
         def add_eager_loadings(objects, associations)
-          objects = Array(objects)
+          object_ar_keys = Array(objects).map(&:ar_key)
 
           to_add = nil
           to_merge, to_delete = [], []
           eager_loadings.each do |k, v|
-            key_objects_overlap = k & objects
+            key_objects_overlap = k & object_ar_keys
 
             next if key_objects_overlap.empty?
 
             if key_objects_overlap == k
               to_add = [k, associations]
               break
-
             else
               to_merge << [key_objects_overlap, ( eager_loadings[k].dup  << associations )]
 
-              keys_without_objects = k - objects
+              keys_without_objects = k - object_ar_keys
               to_merge << [keys_without_objects, eager_loadings[k]]
               to_delete << k
-              objects = objects - k
+              object_ar_keys = object_ar_keys - k
             end
           end
-          if to_add
-            eager_loadings.add *to_add
-          end
-          to_merge.each do |k,val|
-            eager_loadings.merge k, val
-          end
-          to_delete.each do |k|
-            eager_loadings.delete k
-          end
 
-          eager_loadings.add objects, associations unless objects.empty?
+          eager_loadings.add *to_add if to_add
+          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?
         end
 
         private
-          def possible?(object)
-            possible_objects.contains? object
-          end
-
-          def impossible?(object)
-            impossible_objects.contains? object
-          end
-
-          # check if object => associations already exists in object_associations.
-          def association?(object, associations)
-            value = object_associations[object]
-            if value
-              value.each do |v|
-                result = v.is_a?(Hash) ? v.has_key?(associations) : v == associations
-                return true if result
-              end
-            end
-
-            return false
-          end
-
-          # object_associations keep the object relationships 
+          # object_associations keep the object relationships
           # that the object has many associations.
-          # e.g. { <Post id:1> => [:comments] }
-          # the object_associations keep all associations that may be or may no be 
+          # e.g. { "Post:1" => [:comments] }
+          # the object_associations keep all associations that may be or may no be
           # unpreload associations or unused preload associations.
           def object_associations
             @@object_associations ||= Bullet::Registry::Base.new
@@ -105,7 +83,7 @@ module Bullet
 
           # call_object_assciations keep the object relationships
           # that object.associations is called.
-          # e.g. { <Post id:1> => [:comments] }
+          # e.g. { "Post:1" => [:comments] }
           # they are used to detect unused preload associations.
           def call_object_associations
             @@call_object_associations ||= Bullet::Registry::Base.new
@@ -113,14 +91,14 @@ module Bullet
 
           # possible_objects keep the class to object relationships
           # that the objects may cause N+1 query.
-          # e.g. { Post => [<Post id:1>, <Post id:2>] }
+          # e.g. { Post => ["Post:1", "Post:2"] }
           def possible_objects
             @@possible_objects ||= Bullet::Registry::Object.new
           end
 
           # impossible_objects keep the class to objects relationships
           # that the objects may not cause N+1 query.
-          # e.g. { Post => [<Post id:1>, <Post id:2>] }
+          # e.g. { Post => ["Post:1", "Post:2"] }
           # Notice: impossible_objects are not accurate,
           # if find collection returns only one object, then the object is impossible object,
           # impossible_objects are used to avoid treating 1+1 query to N+1 query.
@@ -130,14 +108,10 @@ module Bullet
 
           # eager_loadings keep the object relationships
           # that the associations are preloaded by find :include.
-          # e.g. { [<Post id:1>, <Post id:2>] => [:comments, :user] }
+          # e.g. { ["Post:1", "Post:2"] => [:comments, :user] }
           def eager_loadings
             @@eager_loadings ||= Bullet::Registry::Association.new
           end
-
-          def callers
-            @@callers ||= []
-          end
       end
     end
   end

data/lib/bullet/detector/counter.rb

@@ -1,42 +1,47 @@
 module Bullet
   module Detector
     class Counter < Base
-      def self.clear
-        @@possible_objects = nil
-        @@impossible_objects = nil
-      end
+      class <<self
+        def clear
+          @@possible_objects = nil
+          @@impossible_objects = nil
+        end
 
-      def self.add_counter_cache(object, associations)
-        if conditions_met?( object, associations )
-          create_notification object.class, associations
+        def add_counter_cache(object, associations)
+          if conditions_met?(object.ar_key, associations)
+            create_notification object.class.to_s, associations
+          end
         end
-      end
 
-      def self.add_possible_objects(objects)
-        possible_objects.add objects
-      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 }
+          else
+            possible_objects.add object_or_objects.ar_key
+          end
+        end
 
-      def self.add_impossible_object(object)
-        impossible_objects.add object
-      end
-      
-      private
-      def self.create_notification( klazz, associations )
-         notice = Bullet::Notification::CounterCache.new klazz, associations
-         Bullet.notification_collector.add notice
-      end
+        def add_impossible_object(object)
+          impossible_objects.add object.ar_key
+        end
 
-      def self.possible_objects
-        @@possible_objects ||= Bullet::Registry::Object.new
-      end
+        private
+          def create_notification(klazz, associations)
+             notice = Bullet::Notification::CounterCache.new klazz, associations
+             Bullet.notification_collector.add notice
+          end
 
-      def self.impossible_objects
-        @@impossible_objects ||= Bullet::Registry::Object.new
-      end
+          def possible_objects
+            @@possible_objects ||= Bullet::Registry::Object.new
+          end
+
+          def impossible_objects
+            @@impossible_objects ||= Bullet::Registry::Object.new
+          end
 
-      def self.conditions_met?( object, associations )
-        possible_objects.contains?( object ) and
-        !impossible_objects.contains?( object )
+          def conditions_met?(object_ar_key, associations)
+            possible_objects.include?(object_ar_key) && !impossible_objects.include?(object_ar_key)
+          end
       end
     end
   end