flyerhzm-bullet 1.2.0 → 1.3.0

data/README.textile

@@ -150,7 +150,11 @@ $ script/plugin install git://github.com/flyerhzm/bullet.git
 6. enable the bullet plugin in development, add a line to <code>config/environments/development.rb</code>
 
 <pre><code>
-Bullet.enable = true
+config.after_initialize do
+  Bullet.enable = true 
+  Bullet::Association.alert = true
+  Bullet::Association.bullet_logger = true  
+end
 </code></pre>
 
 7. start server

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/bullet.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bullet}
-  s.version = "1.2.0"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
-  s.date = %q{2009-08-29}
+  s.date = %q{2009-08-31}
   s.description = %q{The Bullet plugin 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) or when you're using eager loading that isn't necessary.}
   s.email = %q{flyerhzm@gmail.com}
   s.extra_rdoc_files = [
@@ -38,8 +38,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{A plugin to kill N+1 queries and unused eager loading}
   s.test_files = [
-    "spec/spec_helper.rb",
-     "spec/bullet_association_spec.rb"
+    "spec/bullet_association_spec.rb",
+     "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/bullet/active_record.rb

@@ -3,11 +3,11 @@ module Bullet
     def self.enable
       ::ActiveRecord::Base.class_eval do
         class << self
-          alias_method :bullet_find_every, :find_every
+          alias_method :origin_find_every, :find_every
           # if select a collection of objects, then these objects have possible to cause N+1 query
           # if select only one object, then the only one object has impossible to cause N+1 query
           def find_every(options)
-            records = bullet_find_every(options)
+            records = origin_find_every(options)
 
             if records 
               if records.size > 1
@@ -23,7 +23,7 @@ module Bullet
       end
 
       ::ActiveRecord::AssociationPreload::ClassMethods.class_eval do
-        alias_method :bullet_preload_associations, :preload_associations
+        alias_method :origin_preload_associations, :preload_associations
         # add include for one to many associations query
         def preload_associations(records, associations, preload_options={})
           records = [records].flatten.compact.uniq
@@ -31,34 +31,35 @@ module Bullet
           records.each do |record|
             Bullet::Association.add_association(record, associations)
           end
-          bullet_preload_associations(records, associations, preload_options={})
+          Bullet::Association.add_eager_loadings(records, associations)
+          origin_preload_associations(records, associations, preload_options={})
         end
       end
 
       ::ActiveRecord::Associations::ClassMethods.class_eval do
         # define one to many associations
-        alias_method :bullet_collection_reader_method, :collection_reader_method
+        alias_method :origin_collection_reader_method, :collection_reader_method
         def collection_reader_method(reflection, association_proxy_class)
           Bullet::Association.define_association(self, reflection.name)
-          bullet_collection_reader_method(reflection, association_proxy_class)
+          origin_collection_reader_method(reflection, association_proxy_class)
         end
       end
 
       ::ActiveRecord::Associations::AssociationCollection.class_eval do
         # call one to many associations
-        alias_method :bullet_load_target, :load_target
+        alias_method :origin_load_target, :load_target
         def load_target
           Bullet::Association.call_association(@owner, @reflection.name)
-          bullet_load_target
+          origin_load_target
         end  
       end
       
       ::ActiveRecord::Associations::AssociationProxy.class_eval do
-        # call has_one association
-        alias_method :bullet_load_target, :load_target
+        # call has_one and belong_to association
+        alias_method :origin_load_target, :load_target
         def load_target
           Bullet::Association.call_association(@owner, @reflection.name)
-          bullet_load_target
+          origin_load_target
         end
       end
     end

data/lib/bullet/association.rb

@@ -24,6 +24,7 @@ module Bullet
         @@possible_objects = nil
         @@impossible_objects = nil
         @@call_object_associations = nil
+        @@eager_loadings = nil
       end
 
       def alert=(alert)
@@ -64,8 +65,10 @@ module Bullet
 
       def check_unused_preload_associations
         object_associations.each do |object, association|
-          call_object_association = call_object_associations[object] || []
-          add_unused_preload_associations(object.class, association - call_object_association) unless (association - call_object_association).empty?
+          related_objects = eager_loadings.select {|key, value| key.include?(object) and value == association}.collect(&:first).flatten
+          call_object_association = related_objects.collect { |related_object| call_object_associations[related_object] }.compact.flatten.uniq
+          diff_object_association = (association - call_object_association).reject {|a| a.is_a? Hash}
+          add_unused_preload_associations(object.class, diff_object_association) unless diff_object_association.empty?
         end
       end
       
@@ -88,11 +91,11 @@ module Bullet
           response = []
           if has_unused_preload_associations?
             response.push("Unused eager loadings detected:\n")
-            response.push(*@@unused_preload_associations.to_a.collect{|klazz, associations| klazz_associations_str(klazz, associations)}.join('\n'))
+            response.push(*@@unused_preload_associations.to_a.collect{|klazz, associations| klazz_associations_str(klazz, associations)}.join("\n"))
           end
           if has_unpreload_associations?
             response.push("#{"\n" unless response.empty?}N+1 queries detected:\n")
-            response.push(*@@unpreload_associations.to_a.collect{|klazz, associations| "  #{klazz} => [#{associations.map(&:inspect).join(', ')}]"}.join('\n'))
+            response.push(*@@unpreload_associations.to_a.collect{|klazz, associations| "  #{klazz} => [#{associations.map(&:inspect).join(', ')}]"}.join("\n"))
           end
         end
         if @@alert
@@ -143,7 +146,7 @@ module Bullet
       
       def bad_associations_str(bad_associations)
         # puts bad_associations.inspect
-        bad_associations.to_a.collect{|klazz, associations| klazz_associations_str(klazz, associations)}.join('\\n')
+        bad_associations.to_a.collect{|klazz, associations| klazz_associations_str(klazz, associations)}.join("\n")
       end
       
       def klazz_associations_str(klazz, associations)
@@ -229,6 +232,14 @@ module Bullet
         klazz_associations[klazz] << associations
         unique(klazz_associations[klazz])
       end
+
+      def add_eager_loadings(objects, associations)
+        # puts "add eager loadings, #{objects.inspect} => #{associations.inspect}"
+        objects = Array(objects)
+        eager_loadings[objects] ||= []
+        eager_loadings[objects] << associations
+        unique(eager_loadings[objects])
+      end
       
       def unique(array)
         array.flatten!
@@ -262,6 +273,10 @@ module Bullet
       def klazz_associations
         @@klazz_associations ||= {}
       end
+
+      def eager_loadings
+        @@eager_loadings ||= {}
+      end
       
       VENDOR_ROOT = File.join(RAILS_ROOT, 'vendor')
       def caller_in_project

data/spec/bullet_association_spec.rb

@@ -56,8 +56,6 @@ describe Bullet::Association, 'has_many' do
     
     post1 = category1.posts.create(:name => 'first')
     post2 = category1.posts.create(:name => 'second')
-    post3 = category2.posts.create(:name => 'third')
-    post4 = category2.posts.create(:name => 'fourth')
     
     comment1 = post1.comments.create(:name => 'first')
     comment2 = post1.comments.create(:name => 'second')
@@ -228,12 +226,36 @@ describe Bullet::Association, 'has_many' do
   end
 
   context "no preload" do
+    it "should no preload only display only one post => comment" do
+      Post.find(:all, :include => :comments).each do |post|
+        post.comments.first.name
+      end
+      Bullet::Association.should_not be_has_unpreload_associations
+    end
+
     it "should no preload only one post => commnets" do
       Post.first.comments.collect(&:name)
       Bullet::Association.should_not be_has_unpreload_associations
     end
   end
 
+  context "no unused" do
+    it "should no unused only display only one post => comment" do
+      Post.find(:all, :include => :comments).each do |post|
+        i = 0
+        post.comments.each do |comment|
+          if i == 0
+            comment.name
+          else
+            i += 1
+          end
+        end
+      end
+      Bullet::Association.check_unused_preload_associations
+      Bullet::Association.should_not be_has_unused_preload_associations
+    end
+  end
+
   context "belongs_to" do
     it "should preload comments => post" do
       Comment.find(:all).each do |comment|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: flyerhzm-bullet
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Richard Huang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-29 00:00:00 -07:00
+date: 2009-08-31 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -39,7 +39,6 @@ files:
 - tasks/bullet_tasks.rake
 has_rdoc: false
 homepage: http://github.com/flyerhzm/bullet
-licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -60,10 +59,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
 summary: A plugin to kill N+1 queries and unused eager loading
 test_files: 
-- spec/spec_helper.rb
 - spec/bullet_association_spec.rb
+- spec/spec_helper.rb