bullet 1.7.2 → 1.7.3

data/VERSION

@@ -1 +1 @@
-1.7.2
+1.7.3

data/bullet.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bullet}
-  s.version = "1.7.2"
+  s.version = "1.7.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
-  s.date = %q{2009-11-26}
+  s.date = %q{2010-01-01}
   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 = [
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
      "lib/bulletware.rb",
      "rails/init.rb",
      "spec/bullet/association_for_chris_spec.rb",
+     "spec/bullet/association_for_peschkaj_spec.rb",
      "spec/bullet/association_spec.rb",
      "spec/bullet/counter_spec.rb",
      "spec/spec.opts",
@@ -43,10 +44,11 @@ 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/bullet/association_for_chris_spec.rb",
-     "spec/bullet/association_spec.rb",
+    "spec/spec_helper.rb",
      "spec/bullet/counter_spec.rb",
-     "spec/spec_helper.rb"
+     "spec/bullet/association_spec.rb",
+     "spec/bullet/association_for_chris_spec.rb",
+     "spec/bullet/association_for_peschkaj_spec.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/bullet/active_record.rb

@@ -4,8 +4,8 @@ module Bullet
       ::ActiveRecord::Base.class_eval do
         class << self
           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
+          # 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 = origin_find_every(options)
 
@@ -26,7 +26,8 @@ module Bullet
 
       ::ActiveRecord::AssociationPreload::ClassMethods.class_eval do
         alias_method :origin_preload_associations, :preload_associations
-        # add include for one to many associations query
+        # include query for one to many associations.
+        # keep this eager loadings.
         def preload_associations(records, associations, preload_options={})
           records = [records].flatten.compact.uniq
           return if records.empty?
@@ -38,14 +39,7 @@ module Bullet
         end
       end
 
-      ::ActiveRecord::Associations::ClassMethods.class_eval do
-        # define one to many associations
-        alias_method :origin_collection_reader_method, :collection_reader_method
-        def collection_reader_method(reflection, association_proxy_class)
-          Bullet::Association.define_association(self, reflection.name)
-          origin_collection_reader_method(reflection, association_proxy_class)
-        end
-      
+      ::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)
@@ -77,7 +71,7 @@ module Bullet
         def load_target
           Bullet::Association.call_association(@owner, @reflection.name)
           origin_load_target
-        end  
+        end
       end
       
       ::ActiveRecord::Associations::AssociationProxy.class_eval do

data/lib/bullet/association.rb

@@ -4,6 +4,7 @@ module Bullet
       include Bullet::Notification
 
       def start_request
+        @@checked = false
       end
 
       def end_request
@@ -19,11 +20,10 @@ module Bullet
         @@impossible_objects = nil
         @@call_object_associations = nil
         @@eager_loadings = nil
-        @@klazz_associations = nil
       end
 
       def notification?
-        check_unused_preload_associations
+        check_unused_preload_associations unless @@checked
         has_unpreload_associations? or has_unused_preload_associations?
       end
 
@@ -65,23 +65,17 @@ module Bullet
         impossible_objects[klazz].uniq!
       end
 
-      def add_klazz_associations(klazz, associations)
-        klazz_associations[klazz] ||= []
-        klazz_associations[klazz] << associations
-        unique(klazz_associations[klazz])
-      end
-
       def add_eager_loadings(objects, associations)
         objects = Array(objects)
         eager_loadings[objects] ||= []
         eager_loadings.each do |k, v|
           unless (k & objects).empty?
             if (k & objects) == k
-              eager_loadings[k] = (eager_loadings[k] + Array(associations))
+              eager_loadings[k] << associations
               unique(eager_loadings[k])
               break
             else
-              eager_loadings.merge!({(k & objects) => (eager_loadings[k] + Array(associations))})
+              eager_loadings.merge!({(k & objects) => (eager_loadings[k].dup << associations)})
               unique(eager_loadings[(k & objects)])
               eager_loadings.merge!({(k - objects) => eager_loadings[k]}) unless (k - objects).empty?
               unique(eager_loadings[(k - objects)])
@@ -91,15 +85,15 @@ module Bullet
           end
         end
         unless objects.empty?
-          eager_loadings[objects] << Array(associations) 
+          eager_loadings[objects] << associations
           unique(eager_loadings[objects])
         end
       end
 
-      def define_association(klazz, associations)
-        add_klazz_associations(klazz, associations)
-      end
-
+      # executed when object.assocations is called.
+      # first, it keeps this method call for object.association.
+      # then, it checks if this associations call is unpreload.
+      #   if it is, keeps this unpreload associations and caller.
       def call_association(object, associations)
         add_call_object_associations(object, associations)
         if unpreload_associations?(object, associations)
@@ -108,7 +102,13 @@ module Bullet
         end
       end
 
+      # check if there are unused preload associations.
+      # for each object => association
+      #   get related_objects from eager_loadings associated with object and associations
+      #   get call_object_association from associations of call_object_associations whose object is in related_objects 
+      #   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, association|
           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
@@ -126,6 +126,7 @@ module Bullet
       end
 
       private
+        # decide whether the object.associations is unpreloaded or not.
         def unpreload_associations?(object, associations)
           possible?(object) and !impossible?(object) and !association?(object, associations)
         end
@@ -140,6 +141,7 @@ module Bullet
           impossible_objects[klazz] and impossible_objects[klazz].include?(object)
         end
 
+        # check if object => associations already exists in object_associations.
         def association?(object, associations)
           object_associations.each do |key, value|
             if key == object
@@ -221,34 +223,59 @@ module Bullet
           array.uniq!
         end
 
+        # unpreload_associations keep the class relationships 
+        # that the associations, belongs to the class, are used but not preloaded.
+        # e.g. { Post => [:comments] }
+        # so the unpreload_associations should be preloaded by find :include.
         def unpreload_associations
           @@unpreload_associations ||= {}
         end
-
+        
+        # unused_preload_associations keep the class relationships 
+        # that the associations, belongs to the class, are preloaded but not used.
+        # e.g. { Post => [:comments] }
+        # so the unused_preload_associations should be removed from find :include.
         def unused_preload_associations
           @@unused_preload_associations ||= {}
         end
 
+        # 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 
+        # unpreload associations or unused preload associations.
         def object_associations
           @@object_associations ||= {}
         end
 
+        # call_object_assciations keep the object relationships
+        # that object.associations is called.
+        # e.g. { <Post id:1> => [:comments] }
+        # they are used to detect unused preload associations.
         def call_object_associations
           @@call_object_associations ||= {}
         end
 
+        # 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>] }
         def possible_objects
           @@possible_objects ||= {}
         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>] }
+        # 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.
         def impossible_objects
           @@impossible_objects ||= {}
         end
 
-        def klazz_associations
-          @@klazz_associations ||= {}
-        end
-
+        # eager_loadings keep the object relationships
+        # that the associations are preloaded by find :include.
+        # e.g. { [<Post id:1>, <Post id:2>] => [:comments, :user] }
         def eager_loadings
           @@eager_loadings ||= {}
         end

data/spec/bullet/association_for_peschkaj_spec.rb

@@ -0,0 +1,84 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+# This test is just used for http://github.com/flyerhzm/bullet/issues#issue/20
+describe Bullet::Association, 'for peschkaj' do
+
+  def setup_db
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :categories do |t|
+        t.column :name, :string
+      end
+
+      create_table :submissions do |t|
+        t.column :name, :string
+        t.column :category_id, :integer
+        t.column :user_id, :integer
+      end
+
+      create_table :users do |t|
+        t.column :name, :string
+        t.column :category_id, :integer
+      end
+    end
+  end
+
+  def teardown_db
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+
+  class Category < ActiveRecord::Base
+    has_many :submissions
+    has_many :users
+  end
+  
+  class Submission < ActiveRecord::Base
+    belongs_to :category
+    belongs_to :user
+  end
+  
+  class User < ActiveRecord::Base
+    has_one :submission
+    belongs_to :category
+  end
+
+  before(:all) do
+    setup_db
+    
+    category1 = Category.create(:name => "category1")
+    category2 = Category.create(:name => "category2")
+    
+    user1 = User.create(:name => 'user1', :category => category1)
+    user2 = User.create(:name => 'user2', :category => category1)
+    
+    submission1 = category1.submissions.create(:name => "submission1", :user => user1)
+    submission2 = category1.submissions.create(:name => "submission2", :user => user2)
+    submission3 = category2.submissions.create(:name => "submission3", :user => user1)
+    submission4 = category2.submissions.create(:name => "submission4", :user => user2)
+  end
+
+  after(:all) do
+    teardown_db
+  end
+
+  before(:each) do
+    Bullet::Association.start_request
+  end
+
+  after(:each) do
+    Bullet::Association.end_request
+  end
+  
+  it "should not detect unused preload associations" do
+    category = Category.find_by_name('category1', :include => {:submissions => :user}, :order => "id DESC")
+    category.submissions.map do |submission|
+      submission.name
+      submission.user.name
+    end
+    Bullet::Association.check_unused_preload_associations
+    Bullet::Association.should_not be_unused_preload_associations_for(Category, :submissions)
+    Bullet::Association.should_not be_unused_preload_associations_for(Submission, :user)
+  end
+end

data/spec/spec_helper.rb

@@ -36,7 +36,7 @@ module Bullet
 
       # returns true if the given class includes the specific unused preloaded association
       def unused_preload_associations_for?(klazz, association)
-         unused_preload_associations[klazz].present? && unused_preload_associations[klazz].include?(association)
+        unused_preload_associations[klazz].present? && unused_preload_associations[klazz].include?(association)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bullet
 version: !ruby/object:Gem::Version 
-  version: 1.7.2
+  version: 1.7.3
 platform: ruby
 authors: 
 - Richard Huang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-26 00:00:00 +08:00
+date: 2010-01-01 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
@@ -37,6 +37,7 @@ files:
 - lib/bulletware.rb
 - rails/init.rb
 - spec/bullet/association_for_chris_spec.rb
+- spec/bullet/association_for_peschkaj_spec.rb
 - spec/bullet/association_spec.rb
 - spec/bullet/counter_spec.rb
 - spec/spec.opts
@@ -71,7 +72,8 @@ signing_key:
 specification_version: 3
 summary: A plugin to kill N+1 queries and unused eager loading
 test_files: 
-- spec/bullet/association_for_chris_spec.rb
-- spec/bullet/association_spec.rb
-- spec/bullet/counter_spec.rb
 - spec/spec_helper.rb
+- spec/bullet/counter_spec.rb
+- spec/bullet/association_spec.rb
+- spec/bullet/association_for_chris_spec.rb
+- spec/bullet/association_for_peschkaj_spec.rb