flyerhzm-bullet 1.0.0 → 1.1.0

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/bullet.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bullet}
-  s.version = "1.0.0"
+  s.version = "1.1.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-26}
+  s.date = %q{2009-08-27}
   s.description = %q{This plugin is aimed to give you some performance suggestion about ActiveRecord usage, what should use but not use, such as eager loading, counter cache and so on, what should not use but use, such as unused eager loading. Now it provides you the suggestion of eager loading and unused eager loading. The others are todo, next may be couter cache.}
   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/association.rb

@@ -7,13 +7,6 @@ module Bullet
       
       def start_request
         # puts "start request"
-        @@object_associations ||= {}
-        @@call_object_associations ||= {}
-        @@unpreload_associations ||= {}
-        @@unused_preload_associations ||= {}
-        @@callers ||= []
-        @@possible_objects ||= {}
-        @@impossible_objects ||= {}
       end
 
       def end_request
@@ -38,16 +31,12 @@ module Bullet
       end
       
       def check_unused_preload_associations
-        @@object_associations.each do |object, association|
-          call_association = @@call_object_associations[object] || []
+        object_associations.each do |object, association|
+          call_association = call_object_associations[object] || []
           association.uniq! unless association.flatten!.nil?
           call_association.uniq! unless call_association.flatten!.nil?
-          klazz = object.class
-          unless (association - call_association).empty?
-            @@unused_preload_associations[klazz] ||= []
-            @@unused_preload_associations[klazz] << (association - call_association) 
-            @@unused_preload_associations[klazz].flatten!.uniq!
-          end
+          
+          add_unused_preload_associations(object.class, association - call_association) unless (association - call_association).empty?
         end
       end
       
@@ -57,11 +46,11 @@ module Bullet
       end
 
       def has_unused_preload_associations?
-        !@@unused_preload_associations.empty?
+        !unused_preload_associations.empty?
       end
       
       def has_unpreload_associations?
-        !@@unpreload_associations.empty?
+        !unpreload_associations.empty?
       end
 
       def bad_associations_alert
@@ -69,24 +58,37 @@ module Bullet
         if @@alert
           str = "<script type='text/javascript'>"
           str << "alert('The request has unused preload assocations as follows:\\n"
-          str << (has_unused_preload_associations? ? @@unused_preload_associations.to_a.collect{|klazz, associations| "model: #{klazz} => associations: [#{associations.join(', ')}]"}.join('\\n') : "None")
+          str << (has_unused_preload_associations? ? bad_associations_str(unused_preload_associations) : "None")
           str << "\\nThe request has N+1 queries as follows:\\n"
-          str << (has_unpreload_associations? ? @@unpreload_associations.to_a.collect{|klazz, associations| "model: #{klazz} => associations: [#{associations.join(', ')}]"}.join('\\n') : "None")
+          str << (has_unpreload_associations? ? bad_associations_str(unpreload_associations) : "None")
           str << "')"
           str << "</script>\n"
         end
         str
       end
+      
+      def bad_associations_str(bad_associations)
+        puts bad_associations.inspect
+        bad_associations.to_a.collect{|klazz, associations| klazz_associations_str(klazz, associations)}.join('\\n')
+      end
+      
+      def klazz_associations_str(klazz, associations)
+        "model: #{klazz} => associations: [#{associations.join(', ')}]"
+      end
+      
+      def associations_str(associations)
+        ":include => #{associations.map{|a| a.to_sym unless a.is_a? Hash}.inspect}"
+      end
 
       def log_bad_associations(path)
         if @@logger
-          @@unused_preload_associations.each do |klazz, associations|
-            @@logger.info "Unused preload associations: PATH_INFO: #{path};    model: #{klazz} => associations: [#{associations.join(', ')}] \n Remove from your finder: :include => #{associations.map{|a| a.to_sym}.inspect}"
+          unused_preload_associations.each do |klazz, associations|
+            @@logger.info "Unused preload associations: PATH_INFO: #{path};    " + klazz_associations_str(klazz, associations) + "\n Remove from your finder: " + associations_str(associations)
           end
-          @@unpreload_associations.each do |klazz, associations| 
-            @@logger.info "N+1 Query: PATH_INFO: #{path};    model: #{klazz} => associations: [#{associations.join(', ')}] \n Add to your finder: :include => #{associations.map{|a| a.to_sym}.inspect}"
+          unpreload_associations.each do |klazz, associations| 
+            @@logger.info "N+1 Query: PATH_INFO: #{path};    " + klazz_associations_str(klazz, associations) + "\n Add to your finder: " + associations_str(associations)
           end  
-          @@callers.each do |c|
+          callers.each do |c|
             @@logger.info "N+1 Query: method call stack: \n" + c.join("\n")
           end
           @@logger_file.flush
@@ -94,56 +96,113 @@ module Bullet
       end
 
       def has_klazz_association(klazz)
-        !@@klazz_associations[klazz].nil? and @@klazz_associations.keys.include?(klazz)
+        !klazz_associations[klazz].nil? and klazz_associations.keys.include?(klazz)
       end
       
       def define_association(klazz, associations)
         # puts "define association, #{klazz} => #{associations}"
-        @@klazz_associations ||= {}
-        @@klazz_associations[klazz] ||= []
-        @@klazz_associations[klazz] << associations
+        add_klazz_associations(klazz, associations)
       end
 
-      def add_possible_objects(objects)
-        # puts "add possible object, #{objects}"
-        klazz= objects.first.class
-        @@possible_objects[klazz] ||= []
-        @@possible_objects[klazz] << objects
-        @@possible_objects[klazz].flatten!.uniq!
+      def call_association(object, associations)
+        # puts "call association, #{object} => #{associations}"
+        if unpreload_associations?(object, associations)
+          add_unpreload_associations(object.class, associations)
+          add_call_object_associations(object, associations)
+          caller_in_project
+        end
       end
       
-      def add_impossible_object(object)
-        # puts "add impossible object, #{object}"
+      def unpreload_associations?(object, associations)
         klazz = object.class
-        @@impossible_objects[klazz] ||= []
-        @@impossible_objects[klazz] << object
+        (!possible_objects[klazz].nil? and possible_objects[klazz].include?(object)) and 
+        (impossible_objects[klazz].nil? or !impossible_objects[klazz].include?(object)) and 
+        (object_associations[object].nil? or !object_associations[object].include?(associations))
+      end
+
+      def add_unpreload_associations(klazz, associations)
+        # puts "add unpreload associations, #{klazz} => #{associations.inspect}"
+        unpreload_associations[klazz] ||= []
+        unpreload_associations[klazz] << associations
+        unpreload_associations[klazz].uniq!
+      end
+      
+      def add_unused_preload_associations(klazz, associations)
+        # puts "add unused preload associations, #{object} => #{associations.inspect}"
+        unused_preload_associations[klazz] ||= []
+        unused_preload_associations[klazz] << associations
+        unused_preload_associations[klazz].flatten!.uniq!
       end
 
       def add_association(object, associations)
-        # puts "add association, #{object} => #{associations}"
-        @@object_associations[object] ||= []
-        @@object_associations[object] << associations
+        # puts "add associations, #{object} => #{associations.inspect}"
+        object_associations[object] ||= []
+        object_associations[object] << associations
       end
 
-      def call_association(object, associations)
-        # puts "call association, #{object} => #{associations}"
+      def add_call_object_associations(object, associations)
+        # puts "add call object associations, #{object} => #{associations.inspect}"
+        call_object_associations[object] ||= []
+        call_object_associations[object] << associations
+      end
+
+      def add_possible_objects(objects)
+        # puts "add possible objects, #{objects.inspect}"
+        klazz= objects.first.class
+        possible_objects[klazz] ||= []
+        possible_objects[klazz] << objects
+        possible_objects[klazz].flatten!.uniq!
+      end
+
+      def add_impossible_object(object)
+        # puts "add impossible object, #{object}"
         klazz = object.class
+        impossible_objects[klazz] ||= []
+        impossible_objects[klazz] << object
+      end
+      
+      def add_klazz_associations(klazz, associations)
+        # puts "define associations, #{klazz} => #{associations.inspect}"
+        klazz_associations[klazz] ||= []
+        klazz_associations[klazz] << associations
+      end
+      
+      def unpreload_associations
+        @@unpreload_associations ||= {}
+      end
+      
+      def unused_preload_associations
+        @@unused_preload_associations ||= {}
+      end
+      
+      def object_associations
+        @@object_associations ||= {}
+      end
+      
+      def call_object_associations
+        @@call_object_associations ||= {}
+      end
+      
+      def possible_objects
         @@possible_objects ||= {}
+      end
+
+      def impossible_objects
         @@impossible_objects ||= {}
-        if (!@@possible_objects[klazz].nil? and @@possible_objects[klazz].include?(object)) and (@@impossible_objects[klazz].nil? or !@@impossible_objects[klazz].include?(object)) and (@@object_associations[object].nil? or !@@object_associations[object].include?(associations))
-          @@unpreload_associations[klazz] ||= []
-          @@unpreload_associations[klazz] << associations
-          @@unpreload_associations[klazz].uniq!
-          @@call_object_associations[object] ||= []
-          @@call_object_associations[object] << associations
-          caller_in_project
-        end
+      end
+      
+      def klazz_associations
+        @@klazz_associations ||= {}
       end
       
       VENDOR_ROOT = File.join(RAILS_ROOT, 'vendor')
       def caller_in_project
-        @@callers << caller.select {|c| c =~ /#{RAILS_ROOT}/}.reject {|c| c =~ /#{VENDOR_ROOT}/}
-        @@callers.uniq!
+        callers << caller.select {|c| c =~ /#{RAILS_ROOT}/}.reject {|c| c =~ /#{VENDOR_ROOT}/}
+        callers.uniq!
+      end
+      
+      def callers
+        @@callers ||= []
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: flyerhzm-bullet
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Richard Huang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-26 00:00:00 -07:00
+date: 2009-08-27 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -39,7 +39,6 @@ files:
 - tasks/bullet_tasks.rake
 has_rdoc: false
 homepage: http://www.huangzhimin.com/projects/4-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