bullet 2.0.0.beta.2 → 2.0.0.beta.3

data/spec/bullet/counter_spec.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/../spec_helper'
 
 ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
 
-describe Bullet::Counter do
+describe Bullet::Detector::Counter do
   def setup_db
     ActiveRecord::Schema.define(:version => 1) do
       create_table :countries do |t|
@@ -47,34 +47,34 @@ describe Bullet::Counter do
   end
 
   before(:each) do
-    Bullet::Counter.start_request
+    Bullet.start_request
   end
   
   after(:each) do
-    Bullet::Counter.end_request
+    Bullet.end_request
   end
 
   it "should need counter cache with all cities" do
     Country.all.each do |country|
       country.cities.size
     end
-    Bullet::Counter.should be_need_counter_caches
+    Bullet.collected_counter_cache_notifications.should_not be_empty
   end
   
   it "should not need coounter cache with only one object" do
     Country.first.cities.size
-    Bullet::Counter.should_not be_need_counter_caches
+    Bullet.collected_counter_cache_notifications.should be_empty
   end
 
   it "should not need counter cache with part of cities" do
     Country.all.each do |country|
       country.cities.where(:name => 'first').size
     end
-    Bullet::Counter.should_not be_need_counter_caches
+    Bullet.collected_counter_cache_notifications.should be_empty
   end
 end
 
-describe Bullet::Counter do
+describe Bullet::Detector::Counter do
   def setup_db
     ActiveRecord::Schema.define(:version => 1) do
       create_table :people do |t|
@@ -120,17 +120,17 @@ describe Bullet::Counter do
   end
 
   before(:each) do
-    Bullet::Counter.start_request
+    Bullet.start_request
   end
   
   after(:each) do
-    Bullet::Counter.end_request
+    Bullet.end_request
   end
 
   it "should not need counter cache" do
     Person.all.each do |person|
       person.pets.size
     end
-    Bullet::Counter.should_not be_need_counter_caches
+    Bullet.collected_counter_cache_notifications.should be_empty
   end
 end

data/spec/spec_helper.rb

@@ -19,26 +19,60 @@ Bullet.enable = true
 ActiveRecord::Migration.verbose = false
 
 module Bullet
-  class Association
-    class <<self
-      # returns true if all associations are preloaded
-      def completely_preloading_associations?
-        !has_unpreload_associations?
-      end
+  def self.collected_notifications_of_class( notification_class )
+    Bullet.notification_collector.collection.select do |notification| 
+      notification.is_a? notification_class 
+    end
+  end
 
-      # returns true if a given object has a specific association
-      def creating_object_association_for?(object, association)
-        object_associations[object].present? && object_associations[object].include?(association)
-      end
+  def self.collected_counter_cache_notifications
+    collected_notifications_of_class Bullet::Notification::CounterCache
+  end
 
-      # returns true if a given class includes the specific unpreloaded association
-      def detecting_unpreloaded_association_for?(klazz, association)
-        unpreload_associations[klazz].present? && unpreload_associations[klazz].include?(association)
-      end
+  def self.collected_n_plus_one_query_notifications
+    collected_notifications_of_class Bullet::Notification::NPlusOneQuery
+  end
+
+  def self.collected_unused_eager_association_notifications
+    collected_notifications_of_class Bullet::Notification::UnusedEagerLoading
+  end
+end
+
+module Bullet
+  module Detector
+    class Association
+      class <<self
+        # returns true if all associations are preloaded
+        def completely_preloading_associations?
+          Bullet.collected_n_plus_one_query_notifications.empty?
+        end
+
+        def has_unused_preload_associations?
+          Bullet.collected_unused_eager_association_notifications.present?
+        end
+
+        # returns true if a given object has a specific association
+        def creating_object_association_for?(object, association)
+          object_associations[object].present? && object_associations[object].include?(association)
+        end
+
+        # returns true if a given class includes the specific unpreloaded association
+        def detecting_unpreloaded_association_for?(klass, association)
+          for_class_and_assoc = Bullet.collected_n_plus_one_query_notifications.select do |notification|
+            notification.base_class == klass and 
+            notification.associations.include?( association )
+          end
+          for_class_and_assoc.present?
+        end
 
-      # 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)
+        # returns true if the given class includes the specific unused preloaded association
+        def unused_preload_associations_for?(klazz, association)
+          for_class_and_assoc = Bullet.collected_unused_eager_association_notifications.select do |notification|
+            notification.base_class == klass and 
+            notification.associations.include?( association )
+          end
+          for_class_and_assoc.present?
+        end
       end
     end
   end

metadata

@@ -7,8 +7,8 @@ version: !ruby/object:Gem::Version
   - 0
   - 0
   - beta
-  - 2
-  version: 2.0.0.beta.2
+  - 3
+  version: 2.0.0.beta.3
 platform: ruby
 authors: 
 - Richard Huang
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-07 00:00:00 +08:00
+date: 2010-07-14 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
@@ -30,27 +30,50 @@ extra_rdoc_files:
 - README.textile
 - README_for_rails2.textile
 files: 
+- .rspec
+- Hacking.textile
 - MIT-LICENSE
 - README.textile
 - README_for_rails2.textile
 - Rakefile
 - VERSION
+- autotest/discover.rb
 - bullet.gemspec
 - lib/bullet.rb
 - lib/bullet/action_controller2.rb
 - lib/bullet/active_record2.rb
 - lib/bullet/active_record3.rb
-- lib/bullet/association.rb
-- lib/bullet/counter.rb
-- lib/bullet/logger.rb
+- lib/bullet/detector.rb
+- lib/bullet/detector/association.rb
+- lib/bullet/detector/base.rb
+- lib/bullet/detector/counter.rb
+- lib/bullet/detector/n_plus_one_query.rb
+- lib/bullet/detector/unused_eager_association.rb
 - lib/bullet/notification.rb
-- lib/bulletware.rb
+- lib/bullet/notification/base.rb
+- lib/bullet/notification/counter_cache.rb
+- lib/bullet/notification/n_plus_one_query.rb
+- lib/bullet/notification/unused_eager_loading.rb
+- lib/bullet/notification_collector.rb
+- lib/bullet/presenter.rb
+- lib/bullet/presenter/base.rb
+- lib/bullet/presenter/bullet_logger.rb
+- lib/bullet/presenter/growl.rb
+- lib/bullet/presenter/javascript_alert.rb
+- lib/bullet/presenter/javascript_console.rb
+- lib/bullet/presenter/javascript_helpers.rb
+- lib/bullet/presenter/rails_logger.rb
+- lib/bullet/presenter/xmpp.rb
+- lib/bullet/rack.rb
+- lib/bullet/registry.rb
+- lib/bullet/registry/association.rb
+- lib/bullet/registry/base.rb
+- lib/bullet/registry/object.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
 - spec/spec_helper.rb
 - tasks/bullet_tasks.rake
 has_rdoc: true
@@ -84,7 +107,7 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: A plugin to kill N+1 queries and unused eager loading
+summary: A rails plugin to kill N+1 queries and unused eager loading
 test_files: 
 - spec/spec_helper.rb
 - spec/bullet/counter_spec.rb

data/lib/bullet/association.rb

@@ -1,294 +0,0 @@
-module Bullet
-  class Association
-    class <<self
-      include Bullet::Notification
-
-      def start_request
-        @@checked = false
-      end
-
-      def end_request
-        clear
-      end
-      
-      def clear
-        @@object_associations = nil
-        @@unpreload_associations = nil
-        @@unused_preload_associations = nil
-        @@callers = nil
-        @@possible_objects = nil
-        @@impossible_objects = nil
-        @@call_object_associations = nil
-        @@eager_loadings = nil
-      end
-
-      def notification?
-        check_unused_preload_associations unless @@checked
-        has_unpreload_associations? or has_unused_preload_associations?
-      end
-
-      def add_unpreload_associations(klazz, associations)
-        unpreload_associations[klazz] ||= []
-        unpreload_associations[klazz] << associations
-        unique(unpreload_associations[klazz])
-      end
-
-      def add_unused_preload_associations(klazz, associations)
-        unused_preload_associations[klazz] ||= []
-        unused_preload_associations[klazz] << associations
-        unique(unused_preload_associations[klazz])
-      end
-
-      def add_object_associations(object, associations)
-        object_associations[object] ||= []
-        object_associations[object] << associations
-        unique(object_associations[object])
-      end
-
-      def add_call_object_associations(object, associations)
-        call_object_associations[object] ||= []
-        call_object_associations[object] << associations
-        unique(call_object_associations[object])
-      end
-
-      def add_possible_objects(objects)
-        klazz = objects.is_a?(Array) ? objects.first.class : objects.class
-        possible_objects[klazz] ||= []
-        possible_objects[klazz] << objects
-        unique(possible_objects[klazz])
-      end
-
-      def add_impossible_object(object)
-        klazz = object.class
-        impossible_objects[klazz] ||= []
-        impossible_objects[klazz] << object
-        impossible_objects[klazz].uniq!
-      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] << associations
-              unique(eager_loadings[k])
-              break
-            else
-              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)])
-              eager_loadings.delete(k)
-              objects = objects - k
-            end
-          end
-        end
-        unless objects.empty?
-          eager_loadings[objects] << associations
-          unique(eager_loadings[objects])
-        end
-      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)
-          add_unpreload_associations(object.class, associations)
-          caller_in_project
-        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
-          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
-
-      def has_unused_preload_associations?
-        !unused_preload_associations.empty?
-      end
-
-      def has_unpreload_associations?
-        !unpreload_associations.empty?
-      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
-
-        def possible?(object)
-          klazz = object.class
-          possible_objects[klazz] and possible_objects[klazz].include?(object)
-        end
-
-        def impossible?(object)
-          klazz = object.class
-          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
-              value.each do |v|
-                result = v.is_a?(Hash) ? v.has_key?(associations) : v == associations
-                return true if result
-              end
-            end
-          end
-          return false
-        end
-
-        def notification_response
-          response = []
-          if has_unused_preload_associations?
-            response << unused_preload_messages.join("\n")
-          end
-          if has_unpreload_associations?
-            response << unpreload_messages.join("\n")
-          end
-          response
-        end
-
-        def console_title
-          title = []
-          title << unused_preload_messages.first.first unless unused_preload_messages.empty?
-          title << unpreload_messages.first.first unless unpreload_messages.empty?
-          title
-        end
-
-        def log_messages(path = nil)
-          messages = []
-          messages << unused_preload_messages(path)
-          messages << unpreload_messages(path)
-          messages << call_stack_messages
-          messages
-        end
-
-        def unused_preload_messages(path = nil)
-          messages = []
-          unused_preload_associations.each do |klazz, associations|
-            messages << [
-              "Unused Eager Loading #{path ? "in #{path}" : 'detected'}",
-              klazz_associations_str(klazz, associations),
-              "  Remove from your finder: #{associations_str(associations)}"
-            ]
-          end
-          messages
-        end
-
-        def unpreload_messages(path = nil)
-          messages = []
-          unpreload_associations.each do |klazz, associations|
-            messages << [
-              "N+1 Query #{path ? "in #{path}" : 'detected'}",
-              klazz_associations_str(klazz, associations),
-              "  Add to your finder: #{associations_str(associations)}"
-            ]
-          end
-          messages
-        end
-
-        def call_stack_messages
-          callers.inject([]) do |messages, c|
-            messages << ['N+1 Query method call stack', c.collect {|line| "  #{line}"}].flatten
-          end
-        end
-
-        def klazz_associations_str(klazz, associations)
-          "  #{klazz} => [#{associations.map(&:inspect).join(', ')}]"
-        end
-
-        def associations_str(associations)
-          ":include => #{associations.map{|a| a.to_sym unless a.is_a? Hash}.inspect}"
-        end
-        
-        def unique(array)
-          array.flatten!
-          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
-
-        # 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
-
-        def caller_in_project
-          vender_root ||= File.join(Rails.root, 'vendor')
-          callers << caller.select {|c| c =~ /#{Rails.root}/}.reject {|c| c =~ /#{vender_root}/}
-          callers.uniq!
-        end
-
-        def callers
-          @@callers ||= []
-        end
-    end
-  end
-end