flyerhzm-bullet 1.1.0 → 1.2.0

data/README.textile

@@ -1,57 +1,59 @@
 h1. Bullet
 
-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.
+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.
 
-Now it provides you the suggestion of eager loading and unused eager loading.
-
-The others are todo, next may be couter 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.
 
 ****************************************************************************
 
-h2. Install
+h2. Thanks
 
-install as gem:
-<pre><code>
-gem sources -a http://gems.github.com
-gem install flyerhzm-bullet
-</code></pre>
-
-install as plugin:
-<pre><code>script/plugin install git://github.com/flyerhzm/bullet.git</code></pre>
+flipsasser added Growl, console.log and Rails.log support, very awesome. And he improved README.
 
 ****************************************************************************
 
-h2. Usage
-
-* "Eager Loading, protect N+1 query and protect from unused eager loading":#EagerLoading
-
-****************************************************************************
+h2. Install
 
-h2. Step by step example
+You can add Bullet to your Rails gem requirements:
+<pre><code>config.gem 'flyerhzm-bullet', :lib => 'bullet', :source => 'http://gems.github.com'</code></pre>
 
-* "Eager Loading, protect N+1 query and protect from unused eager loading":#EagerLoadingExample
+You can install it as a gem:
+<pre><code>sudo gem install flyerhzm-bullet --source http://gems.github.com</code></pre>
 
+Or you can install it as a rails plugin:
+<pre><code>script/plugin install git://github.com/flyerhzm/bullet.git</code></pre>
 
 ****************************************************************************
 
-h3. Eager Loading, protect N+1 query and protect from unused eager loading, usage
-<a id="EagerLoading"/></a>
-
-*important*: It is strongly recommended to disable cache in browser.
+h2. Configuration
 
-* add configuration to environment 
+Bullet won't do ANYTHING unless you tell it to explicitly. Append to <code>config/environments/development.rb</code> initializer with the following code:
 <pre><code>
-Bullet.enable = true
-Bullet::Association.logger = true 
-Bullet::Association.alert = true 
+config.after_initialize do
+  Bullet.enable = true 
+  Bullet::Association.alert = true
+  Bullet::Association.bullet_logger = true  
+  Bullet::Association.console = true
+  Bullet::Association.growl = true
+  Bullet::Association.rails_logger = true
+end
 </code></pre>
-** Bullet.enable (required), if enable is true (default is false), Bullet plugin is enabled. Otherwise, Bullet plugin is disabled.
-** Bullet::Association.logger (optional), if logger is true (default is true), the N+1 query hints will be appended to <code>log/bullet.log</code> with N+1 query method call stack. Otherwise, no hint to log/bullet.log.
-** Bullet::Association.alert (optional), if alert is true (default value), alert box will popup if there is N+1 query when browsing web page. Otherwise, no alert box.
 
-* browse the webpage, if there are N+1 queries or unused eager loading, alert box and bullet log will generate according to configurations. Alert box will only popup when the request's Content-Type is text/html, and <code>log/bullet.log</code> will produce whatever the request is.
+The code above will enable all five of the Bullet notification systems:
+* <code>Bullet.enable</code>: enable Bullet plugin, otherwise do nothing
+* <code>Bullet::Association.alert</code>: pop up a JavaScript alert in the browser
+* <code>Bullet::Association.bullet_logger</code>: log to the Bullet log file (RAILS_ROOT/log/bullet.log)
+* <code>Bullet::Association.rails_logger</code>: add warnings directly to the Rails log
+* <code>Bullet::Association.console</code>: log warnings to your browser's console.log (Safari/Webkit browsers or Firefox w/Firebug installed)
+* <code>Bullet::Association.growl</code>: pop up Growl warnings if your system has Growl installed. Requires a little bit of configuration
+
+****************************************************************************
+
+h2. Log
 
-* example of <code>log/bullet.log</code>
+The Bullet log <code>log/bullet.log</code> will look something like this:
+
+* N+1 Query:
 <pre><code>
 2009-08-25 20:40:17[INFO] N+1 Query: PATH_INFO: /posts;    model: Post => associations: [comments]·
 Add to your finder: :include => [:comments]
@@ -61,22 +63,36 @@ Add to your finder: :include => [:comments]
 /Users/richard/Downloads/test/app/views/posts/index.html.erb:8:in `_run_erb_app47views47posts47index46html46erb'
 /Users/richard/Downloads/test/app/controllers/posts_controller.rb:7:in `index'
 </code></pre>
-It represents that in request '/posts', there is a N+1 query from Post to comments. It means you may have a logic code in controller <code>@posts = Post.find(:all)</code> should be changed to <code>@posts = Post.find(:all, :include => :comments)</code>
+
+The first two lines are notifications that N+1 queries have been encountered. The remaining lines are stack traces so you can find exactly where the queries were invoked in your code, and fix them.
+
+* Unsed eager loading:
 <pre><code>
-2009-08-25 20:53:56[INFO] Unused preload associations: PATH_INFO: /posts;    model: Post => associations: [comments]·
+2009-08-25 20:53:56[INFO] Unused eager loadings: PATH_INFO: /posts;    model: Post => associations: [comments]·
 Remove from your finder: :include => [:comments]
 </code></pre>
-It represents that in request '/posts', there is a used eager loading from Post to comments. It means you may have a logic code in controller <code>@posts = Post.find(:all, :include => :comments)</code> should be changed to <code>@posts = Post.find(:all)</code>
 
-* To see what causes N+1 queries, check the <code>spec/bullet_association_spec.rb</code>
+These two lines are notifications that unused eager loadings have been encountered.
 
-* Rake tasks
-<code>rake bullet:log:clear</code>, clear the <code>log/bullet.log</code>
+****************************************************************************
+
+h2. Growl Support
+
+To get Growl support up-and-running for Bullet, follow the steps below:
+* Install the ruby-growl gem: <code>sudo gem install ruby-growl</code>
+* Open the Growl preference pane in Systems Preferences
+* Click the "Network" tab
+* Make sure both "Listen for incoming notifications" and "Allow remote application registration" are checked. *Note*: If you set a password, you will need to set <code>Bullet::Association.growl_password = 'your_growl_password</code>' in the config file.
+* Restart Growl ("General" tab -> Stop Growl -> Start Growl)
+* Boot up your application. Bullet will automatically send a Growl notification when Growl is turned on. If you do not see it when your application loads, make sure it is enabled in your initializer and double-check the steps above.
 
 ****************************************************************************
 
-h3. Eager Loading, protect N+1 query and protect from unused eager loading, step by step example
-<a id="EagerLoadingExample"/></a>
+h2. Step by step example
+
+Bullet is designed to function as you browse through your application in development. It will alert you whenever it encounters N+1 queries or unused eager loading.
+
+*Important*: It is strongly recommended you disable your browser's cache.
 
 1. setup test environment
 

data/Rakefile

@@ -23,10 +23,10 @@ end
 Jeweler::Tasks.new do |gemspec|
   gemspec.name = "bullet"
   gemspec.summary = "A plugin to kill N+1 queries and unused eager loading"
-  gemspec.description = "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."
+  gemspec.description = "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."
   gemspec.email = "flyerhzm@gmail.com"
-  gemspec.homepage = "http://www.huangzhimin.com/projects/4-bullet"
+  gemspec.homepage = "http://github.com/flyerhzm/bullet"
   gemspec.authors = ["Richard Huang"]
   gemspec.files.exclude '.gitignore'
-  gemspec.files.exclude 'log/'
+  gemspec.files.exclude 'log/*'
 end

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/bullet.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bullet}
-  s.version = "1.1.0"
+  s.version = "1.2.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-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.date = %q{2009-08-29}
+  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 = [
     "README.textile"
@@ -22,24 +22,24 @@ Gem::Specification.new do |s|
      "VERSION",
      "bullet.gemspec",
      "lib/bullet.rb",
+     "lib/bullet/active_record.rb",
      "lib/bullet/association.rb",
      "lib/bullet/logger.rb",
      "lib/bulletware.rb",
-     "lib/hack/active_record.rb",
      "rails/init.rb",
      "spec/bullet_association_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "tasks/bullet_tasks.rake"
   ]
-  s.homepage = %q{http://www.huangzhimin.com/projects/4-bullet}
+  s.homepage = %q{http://github.com/flyerhzm/bullet}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   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_spec.rb",
-     "spec/spec_helper.rb"
+    "spec/spec_helper.rb",
+     "spec/bullet_association_spec.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/bullet.rb

@@ -1,14 +1,21 @@
 module Bullet
+  @@enable = nil
+
   class <<self
     def enable=(enable)
       @@enable = enable
+      if enable? 
+        Bullet::ActiveRecord.enable
+        ActionController::Dispatcher.middleware.use Bulletware
+      end
     end
 
     def enable?
-      class_variables.include?('@@enable') and @@enable == true
+      @@enable == true
     end
   end
 
+  autoload :ActiveRecord, 'bullet/active_record'
   autoload :Association, 'bullet/association'
   autoload :BulletLogger, 'bullet/logger'
 end

data/lib/bullet/active_record.rb

@@ -0,0 +1,66 @@
+module Bullet
+  module ActiveRecord
+    def self.enable
+      ::ActiveRecord::Base.class_eval do
+        class << self
+          alias_method :bullet_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)
+
+            if records 
+              if records.size > 1
+                Bullet::Association.add_possible_objects(records)
+              elsif records.size == 1
+                Bullet::Association.add_impossible_object(records.first)
+              end
+            end
+
+            records
+          end
+        end
+      end
+
+      ::ActiveRecord::AssociationPreload::ClassMethods.class_eval do
+        alias_method :bullet_preload_associations, :preload_associations
+        # add include for one to many associations query
+        def preload_associations(records, associations, preload_options={})
+          records = [records].flatten.compact.uniq
+          return if records.empty?
+          records.each do |record|
+            Bullet::Association.add_association(record, associations)
+          end
+          bullet_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
+        def collection_reader_method(reflection, association_proxy_class)
+          Bullet::Association.define_association(self, reflection.name)
+          bullet_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
+        def load_target
+          Bullet::Association.call_association(@owner, @reflection.name)
+          bullet_load_target
+        end  
+      end
+      
+      ::ActiveRecord::Associations::AssociationProxy.class_eval do
+        # call has_one association
+        alias_method :bullet_load_target, :load_target
+        def load_target
+          Bullet::Association.call_association(@owner, @reflection.name)
+          bullet_load_target
+        end
+      end
+    end
+  end
+end

data/lib/bullet/association.rb

@@ -1,10 +1,16 @@
 module Bullet
+  class BulletAssociationError < StandardError
+  end
+
   class Association
     class <<self
-      @@logger_file = File.open(Bullet::BulletLogger::LOG_FILE, 'a+')
-      @@logger = Bullet::BulletLogger.new(@@logger_file)
-      @@alert = true
-      
+      @@alert = nil
+      @@bullet_logger = nil
+      @@console = nil
+      @@growl = nil
+      @@growl_password = nil
+      @@rails_logger = nil
+
       def start_request
         # puts "start request"
       end
@@ -24,19 +30,42 @@ module Bullet
         @@alert = alert
       end
 
-      def logger=(logger)
-        if logger == false
-          @@logger = nil
+      def bullet_logger=(bullet_logger)
+        if @@bullet_logger = bullet_logger
+          @@logger_file = File.open(Bullet::BulletLogger::LOG_FILE, 'a+')
+          @@logger = Bullet::BulletLogger.new(@@logger_file)
         end
       end
-      
+
+      def console=(console)
+        @@console = console
+      end
+
+      def growl=(growl)
+        if growl
+          begin
+            require 'ruby-growl'
+            growl = Growl.new('localhost', 'ruby-growl', ['Bullet Notification'], nil, @@growl_password)
+            growl.notify('Bullet Notification', 'Bullet Notification', 'Bullet Growl notifications have been turned on')
+          rescue MissingSourceFile
+            raise BulletAssociationError.new('You must install the ruby-growl gem to use Growl notifications: `sudo gem install ruby-growl`')
+          end
+        end
+        @@growl = growl
+      end
+
+      def growl_password=(growl_password)
+        @@growl_password = growl_password
+      end
+
+      def rails_logger=(rails_logger)
+        @@rails_logger = rails_logger
+      end
+
       def check_unused_preload_associations
         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?
-          
-          add_unused_preload_associations(object.class, association - call_association) unless (association - call_association).empty?
+          call_object_association = call_object_associations[object] || []
+          add_unused_preload_associations(object.class, association - call_object_association) unless (association - call_object_association).empty?
         end
       end
       
@@ -55,60 +84,90 @@ module Bullet
 
       def bad_associations_alert
         str = ''
+        if @@alert || @@console || @@growl
+          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'))
+          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'))
+          end
+        end
         if @@alert
-          str = "<script type='text/javascript'>"
-          str << "alert('The request has unused preload assocations as follows:\\n"
-          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? ? bad_associations_str(unpreload_associations) : "None")
-          str << "')"
-          str << "</script>\n"
+          str << wrap_js_association("alert(#{response.join("\n").inspect});")
+        end
+        if @@console
+          str << wrap_js_association("if (typeof(console) != 'undefined' && console.log) console.log(#{response.join("\n").inspect});")
+        end
+        if @@growl
+          begin
+            growl = Growl.new('localhost', 'ruby-growl', ['Bullet Notification'], nil, @@growl_password)
+            growl.notify('Bullet Notification', 'Bullet Notification', response.join("\n"))
+          rescue
+          end
+          str << '<!-- Sent Growl notification -->'
         end
         str
       end
+
+      def wrap_js_association(message)
+        str = ''
+        str << "<script type=\"text/javascript\">/*<![CDATA[*/"
+        str << message
+        str << "/*]]>*/</script>\n"
+      end
+
+      def log_bad_associations(path)
+        if (@@bullet_logger || @@rails_logger) && (!unpreload_associations.empty? || !unused_preload_associations.empty?)
+          Rails.logger.warn '' if @@rails_logger
+          unused_preload_associations.each do |klazz, associations|
+            log = ["Unused eager loadings: #{path}", klazz_associations_str(klazz, associations), "  Remove from your finder: #{associations_str(associations)}"].join("\n")
+            @@logger.info(log) if @@bullet_logger
+            Rails.logger.warn(log) if @@rails_logger
+          end
+          unpreload_associations.each do |klazz, associations|
+            log = ["N+1 Query in #{path}", klazz_associations_str(klazz, associations), "  Add to your finder: #{associations_str(associations)}"].join("\n")
+            @@logger.info(log) if @@bullet_logger
+            Rails.logger.warn(log) if @@rails_logger
+          end  
+          callers.each do |c|
+            log = ["N+1 Query method call stack", c.map{|line| "  #{line}"}].flatten.join("\n")
+            @@logger.info(log) if @@bullet_logger
+            Rails.logger.warn(log) if @@rails_logger
+          end
+          @@logger_file.flush if @@bullet_logger
+        end
+      end
       
       def bad_associations_str(bad_associations)
-        puts bad_associations.inspect
+        # 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(', ')}]"
+        "  #{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 log_bad_associations(path)
-        if @@logger
-          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};    " + klazz_associations_str(klazz, associations) + "\n Add to your finder: " + associations_str(associations)
-          end  
-          callers.each do |c|
-            @@logger.info "N+1 Query: method call stack: \n" + c.join("\n")
-          end
-          @@logger_file.flush
-        end
-      end
-
       def has_klazz_association(klazz)
         !klazz_associations[klazz].nil? and klazz_associations.keys.include?(klazz)
       end
       
       def define_association(klazz, associations)
-        # puts "define association, #{klazz} => #{associations}"
+        # puts "define association, #{klazz} => #{associations.inspect}"
         add_klazz_associations(klazz, associations)
       end
 
       def call_association(object, associations)
-        # puts "call association, #{object} => #{associations}"
+        # puts "call association, #{object} => #{associations.inspect}"
+        add_call_object_associations(object, associations)
         if unpreload_associations?(object, associations)
           add_unpreload_associations(object.class, associations)
-          add_call_object_associations(object, associations)
           caller_in_project
         end
       end
@@ -124,26 +183,28 @@ module Bullet
         # puts "add unpreload associations, #{klazz} => #{associations.inspect}"
         unpreload_associations[klazz] ||= []
         unpreload_associations[klazz] << associations
-        unpreload_associations[klazz].uniq!
+        unique(unpreload_associations[klazz])
       end
       
       def add_unused_preload_associations(klazz, associations)
-        # puts "add unused preload associations, #{object} => #{associations.inspect}"
+        # puts "add unused preload associations, #{klazz} => #{associations.inspect}"
         unused_preload_associations[klazz] ||= []
         unused_preload_associations[klazz] << associations
-        unused_preload_associations[klazz].flatten!.uniq!
+        unique(unused_preload_associations[klazz])
       end
 
       def add_association(object, associations)
         # puts "add associations, #{object} => #{associations.inspect}"
         object_associations[object] ||= []
         object_associations[object] << associations
+        unique(object_associations[object])
       end
 
       def add_call_object_associations(object, associations)
         # puts "add call object associations, #{object} => #{associations.inspect}"
         call_object_associations[object] ||= []
         call_object_associations[object] << associations
+        unique(call_object_associations[object])
       end
 
       def add_possible_objects(objects)
@@ -151,7 +212,7 @@ module Bullet
         klazz= objects.first.class
         possible_objects[klazz] ||= []
         possible_objects[klazz] << objects
-        possible_objects[klazz].flatten!.uniq!
+        unique(possible_objects[klazz])
       end
 
       def add_impossible_object(object)
@@ -159,12 +220,19 @@ module Bullet
         klazz = object.class
         impossible_objects[klazz] ||= []
         impossible_objects[klazz] << object
+        impossible_objects[klazz].uniq!
       end
       
       def add_klazz_associations(klazz, associations)
         # puts "define associations, #{klazz} => #{associations.inspect}"
         klazz_associations[klazz] ||= []
         klazz_associations[klazz] << associations
+        unique(klazz_associations[klazz])
+      end
+      
+      def unique(array)
+        array.flatten!
+        array.uniq!
       end
       
       def unpreload_associations

data/lib/bulletware.rb

@@ -12,7 +12,7 @@ class Bulletware
 
     if Bullet::Association.has_bad_assocations?
       if !headers['Content-Type'].nil? and headers['Content-Type'].include? 'text/html'
-        response_body = response.body.insert(-17, Bullet::Association.bad_associations_alert)
+        response_body = response.body << Bullet::Association.bad_associations_alert
         headers['Content-Length'] = response_body.length.to_s
       end
 

data/rails/init.rb

@@ -1,4 +1 @@
-# Include hook code here
 require 'bullet'
-require 'hack/active_record'
-ActionController::Dispatcher.middleware.use Bulletware

data/spec/bullet_association_spec.rb

@@ -95,17 +95,34 @@ describe Bullet::Association, 'has_many' do
       Bullet::Association.should be_has_unpreload_associations
     end
     
-    it "should detect unused preload post => comments" do
+    it "should detect unused preload post => comments for post" do
       Post.find(:all, :include => :comments).collect(&:name)
       Bullet::Association.check_unused_preload_associations
       Bullet::Association.should be_has_unused_preload_associations
     end
 
-    it "should no detect unused preload post => comments" do
+    it "should detect no unused preload post => comments for post" do
       Post.find(:all).collect(&:name)
       Bullet::Association.check_unused_preload_associations
       Bullet::Association.should_not be_has_unused_preload_associations
     end
+    
+    it "should detect no unused preload post => comments for comment" do
+      Post.find(:all).each do |post|
+        post.comments.collect(&:name)
+      end
+      Bullet::Association.check_unused_preload_associations
+      Bullet::Association.should_not be_has_unused_preload_associations
+   
+      Bullet::Association.end_request
+      Bullet::Association.start_request
+      
+      Post.find(:all).each do |post|
+        post.comments.collect(&:name)
+      end
+      Bullet::Association.check_unused_preload_associations
+      Bullet::Association.should_not be_has_unused_preload_associations
+    end
   end
   
   context "category => posts => comments" do
@@ -224,7 +241,7 @@ describe Bullet::Association, 'has_many' do
       end
       Bullet::Association.should be_has_unpreload_associations
     end
-
+    
     it "should no preload comment => post" do
       Comment.first.post.name
       Bullet::Association.should_not be_has_unpreload_associations
@@ -236,7 +253,7 @@ describe Bullet::Association, 'has_many' do
       end
       Bullet::Association.should_not be_has_unpreload_associations
     end
-
+    
     it "should detect no unused preload comments => post" do
       Comment.find(:all).collect(&:name)
       Bullet::Association.check_unused_preload_associations
@@ -248,6 +265,22 @@ describe Bullet::Association, 'has_many' do
       Bullet::Association.check_unused_preload_associations
       Bullet::Association.should be_has_unused_preload_associations
     end
+    
+    it "should dectect no unused preload comments => post" do
+      Comment.find(:all).each do |comment|
+        comment.post.name
+      end
+      Bullet::Association.check_unused_preload_associations
+      Bullet::Association.should_not be_has_unused_preload_associations
+    end
+    
+    it "should dectect no unused preload comments => post" do
+      Comment.find(:all, :include => :post).each do |comment|
+        comment.post.name
+      end
+      Bullet::Association.check_unused_preload_associations
+      Bullet::Association.should_not be_has_unused_preload_associations
+    end
   end
 end
 

data/spec/spec_helper.rb

@@ -1,10 +1,12 @@
 require 'rubygems'
 require 'spec/autorun'
 require 'active_record'
+require 'action_controller'
 
-RAILS_ROOT = File.expand_path(__FILE__).split('/')[0..-3].join('/')
+RAILS_ROOT = File.expand_path(__FILE__).split('/')[0..-3].join('/') unless defined? RAILS_ROOT
 require File.expand_path(File.join(File.dirname(__FILE__), '../lib/bullet/logger'))
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/bullet/active_record'))
 require File.expand_path(File.join(File.dirname(__FILE__), '../lib/bullet/association'))
 require File.expand_path(File.join(File.dirname(__FILE__), '../lib/bullet'))
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/bulletware'))
 Bullet.enable = true
-require File.expand_path(File.join(File.dirname(__FILE__), '../lib/hack/active_record'))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: flyerhzm-bullet
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Richard Huang
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-27 00:00:00 -07:00
+date: 2009-08-29 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: 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.
+description: 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.
 email: flyerhzm@gmail.com
 executables: []
 
@@ -28,17 +28,18 @@ files:
 - VERSION
 - bullet.gemspec
 - lib/bullet.rb
+- lib/bullet/active_record.rb
 - lib/bullet/association.rb
 - lib/bullet/logger.rb
 - lib/bulletware.rb
-- lib/hack/active_record.rb
 - rails/init.rb
 - spec/bullet_association_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - tasks/bullet_tasks.rake
 has_rdoc: false
-homepage: http://www.huangzhimin.com/projects/4-bullet
+homepage: http://github.com/flyerhzm/bullet
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -59,10 +60,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: A plugin to kill N+1 queries and unused eager loading
 test_files: 
-- spec/bullet_association_spec.rb
 - spec/spec_helper.rb
+- spec/bullet_association_spec.rb

data/lib/hack/active_record.rb

@@ -1,95 +0,0 @@
-if Bullet.enable?
-  ActiveRecord::ActiveRecordError # An ActiveRecord bug
-
-  module ActiveRecord
-    class Base
-      class <<self
-        # 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
-        alias_method :origin_find_every, :find_every
-        
-        def find_every(options)
-          records = origin_find_every(options)
-
-          if records 
-            if records.size > 1
-              Bullet::Association.add_possible_objects(records)
-            elsif records.size == 1
-              Bullet::Association.add_impossible_object(records.first)
-            end
-          end
-
-          records
-        end
-      end
-    end
-
-    module AssociationPreload
-      module ClassMethods
-        # add include for one to many associations query
-        alias_method :origin_preload_associations, :preload_associations
-        
-        def preload_associations(records, associations, preload_options={})
-          records = [records].flatten.compact.uniq
-          return if records.empty?
-          records.each do |record|
-            Bullet::Association.add_association(record, associations)
-          end
-          origin_preload_associations(records, associations, preload_options={})
-        end
-      end
-    end
-    
-    module Associations
-      module ClassMethods
-        # 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
-      end
-      
-      class AssociationCollection
-        # call one to many associations
-        alias_method :origin_load_target, :load_target
-
-        def load_target
-          Bullet::Association.call_association(@owner, @reflection.name)
-          origin_load_target
-        end  
-      end
-
-      class HasOneAssociation
-        # call has_one association
-        alias_method :origin_find_target, :find_target
-
-        def find_target
-          Bullet::Association.call_association(@owner, @reflection.name)
-          origin_find_target
-        end
-      end
-
-      class BelongsToAssociation
-        # call belongs_to association
-        alias_method :origin_find_target, :find_target
-
-        def find_target
-          Bullet::Association.call_association(@owner, @reflection.name)
-          origin_find_target
-        end
-      end
-
-      class BelongsToPolymorphicAssociation
-        # call belongs_to association
-        alias_method :origin_find_target, :find_target
-
-        def find_target
-          Bullet::Association.call_association(@owner, @reflection.name)
-          origin_find_target
-        end
-      end
-    end
-  end
-end