flyerhzm-bullet 1.4.1 → 1.5.0

data/README.textile

@@ -1,6 +1,6 @@
 h1. Bullet
 
-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.
+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), when you're using eager loading that isn't necessary and when you should use counter 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.
 
@@ -32,11 +32,11 @@ Bullet won't do ANYTHING unless you tell it to explicitly. Append to <code>confi
 <pre><code>
 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
+  Bullet.alert = true
+  Bullet.bullet_logger = true  
+  Bullet.console = true
+  Bullet.growl = true
+  Bullet.rails_logger = true
 end
 </code></pre>
 
@@ -44,18 +44,18 @@ It is recommended to config growl notification as follows if your collaborators
 <pre><code>
   begin
     require 'ruby-growl'
-    Bullet::Association.growl = true
+    Bullet.growl = true
   rescue MissingSourceFile
   end
 </code></pre>
 
 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
+* <code>Bullet.alert</code>: pop up a JavaScript alert in the browser
+* <code>Bullet.bullet_logger</code>: log to the Bullet log file (RAILS_ROOT/log/bullet.log)
+* <code>Bullet.rails_logger</code>: add warnings directly to the Rails log
+* <code>Bullet.console</code>: log warnings to your browser's console.log (Safari/Webkit browsers or Firefox w/Firebug installed)
+* <code>Bullet.growl</code>: pop up Growl warnings if your system has Growl installed. Requires a little bit of configuration
 
 ****************************************************************************
 
@@ -84,6 +84,12 @@ Remove from your finder: :include => [:comments]
 
 These two lines are notifications that unused eager loadings have been encountered.
 
+* Need counter cache:
+<pre><code>
+2009-09-11 09:46:50[INFO] Need Counter Cache
+  Post => [:comments]
+</code></pre>
+
 ****************************************************************************
 
 h2. Growl Support
@@ -92,23 +98,41 @@ 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.
+* 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.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.
 
 ****************************************************************************
 
+h2. Important
+
+If you encounter the following errors in development environment:
+
+<pre><code>
+You might have expected an instance of Array.
+The error occurred while evaluating nil.include?
+    /usr/lib/ruby/gems/1.8/gems/activerecord-2.3.2/lib/active_record/attribute_methods.rb:142:in `create_time_zone_conversion_attribute?'
+    /usr/lib/ruby/gems/1.8/gems/activerecord-2.3.2/lib/active_record/attribute_methods.rb:75:in `define_attribute_methods'
+    /usr/lib/ruby/gems/1.8/gems/activerecord-2.3.2/lib/active_record/attribute_methods.rb:71:in `each'
+    /usr/lib/ruby/gems/1.8/gems/activerecord-2.3.2/lib/active_record/attribute_methods.rb:71:in `define_attribute_methods'
+    /usr/lib/ruby/gems/1.8/gems/activerecord-2.3.2/lib/active_record/attribute_methods.rb:242:in `method_missing'
+</code></pre>
+
+Or any strange behavior of bullet plugin/gem, *please disable your browser's cache*.
+
+****************************************************************************
+
 h2. Advance
 
 The bullet plugin use rack middleware for http request. If you want to bullet for without http server, such as job server. You can do like this:
 
 <pre><code>
-Bullet::Association.start_request if Bullet.enable?
+Bullet.start_request if Bullet.enable?
 # run job
 if Bullet.enable?
-  Bullet::Association.growl_notification
-  Bullet::Association.log_notificatioin('JobServer: ')
-  Bullet::Association.end_request
+  Bullet.growl_notification
+  Bullet.log_notificatioin('JobServer: ')
+  Bullet.end_request
 end
 </code></pre>
 
@@ -118,8 +142,6 @@ 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
 
 <pre><code>
@@ -178,8 +200,8 @@ $ script/plugin install git://github.com/flyerhzm/bullet.git
 <pre><code>
 config.after_initialize do
   Bullet.enable = true 
-  Bullet::Association.alert = true
-  Bullet::Association.bullet_logger = true  
+  Bullet.alert = true
+  Bullet.bullet_logger = true  
 end
 </code></pre>
 
@@ -285,5 +307,44 @@ In the meanwhile, there's a log appended into <code>log/bullet.log</code> file
 Remove from your finder: :include => [:comments]
 </code></pre>
 
+13. simulate counter_cache. Change <code>app/controllers/posts_controller.rb</code> and <code>app/views/posts/index.html.erb</code>
+
+<pre><code>
+  def index
+    @posts = Post.find(:all)
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @posts }
+    end 
+  end 
+</code></pre>
+
+<pre><code>
+<% @posts.each do |post| %>
+  <tr>
+    <td><%=h post.name %></td>
+    <td><%=h post.comments.size %></td>
+    <td><%= link_to 'Show', post %></td>
+    <td><%= link_to 'Edit', edit_post_path(post) %></td>
+    <td><%= link_to 'Destroy', post, :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<% end %>
+</code></pre>
+
+14. refresh http://localhost:3000/posts page, then you will see a popup alert box says
+
+<pre><code>
+Need counter cache
+  Post => [:comments]
+</code></pre>
+
+In the meanwhile, there's a log appended into <code>log/bullet.log</code> file.
+
+<pre><code>
+2009-09-11 10:07:10[INFO] Need Counter Cache
+  Post => [:comments]
+</code></pre>
+
 
 Copyright (c) 2009 Richard Huang (flyerhzm@gmail.com), released under the MIT license

data/VERSION

@@ -1 +1 @@
-1.4.1
+1.5.0

data/bullet.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bullet}
-  s.version = "1.4.1"
+  s.version = "1.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
-  s.date = %q{2009-09-09}
+  s.date = %q{2009-09-11}
   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 = [
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
      "lib/bullet/association.rb",
      "lib/bullet/counter.rb",
      "lib/bullet/logger.rb",
+     "lib/bullet/notification.rb",
      "lib/bulletware.rb",
      "rails/init.rb",
      "spec/bullet_association_spec.rb",
@@ -40,9 +41,9 @@ 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_spec.rb",
-     "spec/bullet_counter_spec.rb",
-     "spec/spec_helper.rb"
+    "spec/bullet_counter_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/bullet_association_spec.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/bullet.rb

@@ -1,11 +1,11 @@
 require 'bulletware'
 
 module Bullet
-  @@enable = nil
-
   class <<self
+    attr_accessor :enable, :alert, :console, :growl, :growl_password, :rails_logger, :bullet_logger, :logger, :logger_file
+
     def enable=(enable)
-      @@enable = enable
+      @enable = enable
       if enable? 
         Bullet::ActiveRecord.enable
         ActionController::Dispatcher.middleware.use Bulletware
@@ -13,11 +13,59 @@ module Bullet
     end
 
     def enable?
-      @@enable == true
+      @enable == true
+    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 NotificationError.new('You must install the ruby-growl gem to use Growl notifications: `sudo gem install ruby-growl`')
+        end
+      end
+      @growl = growl
+    end
+
+    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
+
+    BULLETS = [Bullet::Association, Bullet::Counter]
+
+    def start_request
+      BULLETS.each {|bullet| bullet.start_request}
+    end
+
+    def end_request
+      BULLETS.each {|bullet| bullet.end_request}
+    end
+
+    def notification?
+      BULLETS.any? {|bullet| bullet.notification?}
+    end
+
+    def javascript_notification
+      BULLETS.collect {|bullet| bullet.javascript_notification if bullet.notification?}.join("\n")
+    end
+
+    def growl_notification
+      BULLETS.each {|bullet| bullet.growl_notification if bullet.notification?}
+    end
+
+    def log_notification(path)
+      BULLETS.each {|bullet| bullet.log_notification(path) if bullet.notification?}
     end
   end
 
   autoload :ActiveRecord, 'bullet/active_record'
   autoload :Association, 'bullet/association'
+  autoload :Counter, 'bullet/counter'
   autoload :BulletLogger, 'bullet/logger'
+  autoload :Notification, 'bullet/notification'
 end

data/lib/bullet/association.rb

@@ -1,64 +1,12 @@
 module Bullet
-  class BulletAssociationError < StandardError
-  end
-
   class Association
     class <<self
-      @@alert = nil
-      @@bullet_logger = nil
-      @@console = nil
-      @@growl = nil
-      @@growl_password = nil
-      @@rails_logger = nil
-
-      ###################################################
-      # Configurations
-      ###################################################
-      def alert=(alert)
-        @@alert = alert
-      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
+      include Bullet::Notification
 
-      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 rails_logger=(rails_logger)
-        @@rails_logger = rails_logger
-      end
-
-      #####################################################
-      # login control interface
-      #####################################################
       def start_request
-        # puts "start request"
       end
 
       def end_request
-        # puts "end request"
         @@object_associations = nil
         @@unpreload_associations = nil
         @@unused_preload_associations = nil
@@ -69,110 +17,36 @@ module Bullet
         @@eager_loadings = nil
       end
 
-      def has_bad_assocations?
+      def notification?
         check_unused_preload_associations
         has_unpreload_associations? or has_unused_preload_associations?
       end
 
-      ######################################################
-      # Notifications
-      ######################################################
-      def javascript_notification
-        str = ''
-        if @@alert || @@console
-          response = notification_response
-        end
-        if @@alert
-          str << wrap_js_association("alert(#{response.join("\n").inspect});")
-        end
-        if @@console
-          title = []
-          title << unused_preload_messages.first.first unless unused_preload_messages.empty?
-          title << unpreload_messages.first.first unless unpreload_messages.empty?
-          code = <<-CODE
-            if (typeof(console) !== 'undefined') {
-
-              if (console.groupCollapsed && console.groupEnd && console.log) {
-
-                console.groupCollapsed(#{title.join(', ').inspect});
-                console.log(#{response.join("\n").inspect});
-                console.log(#{call_stack_messages.join("\n").inspect});
-                console.groupEnd();
-
-              } else if (console.log) {
-
-                console.log(#{response.join("\n").inspect});
-              }
-            }
-          CODE
-          str << wrap_js_association(code)
-        end
-        str
-      end
-
-      def growl_notification
-        if @@growl
-          response = notification_response
-          begin
-            growl = Growl.new('localhost', 'ruby-growl', ['Bullet Notification'], nil, @@growl_password)
-            growl.notify('Bullet Notification', 'Bullet Notification', response.join("\n"))
-          rescue
-          end
-        end
-      end
-
-      def log_notificatioin(path)
-        if (@@bullet_logger || @@rails_logger) && (!unpreload_associations.empty? || !unused_preload_associations.empty?)
-          Rails.logger.warn '' if @@rails_logger
-          unused_preload_messages(path).each do |message|
-            @@logger.info(message.join("\n")) if @@bullet_logger
-            Rails.logger.warn(message.join("\n")) if @@rails_logger
-          end
-          unpreload_messages(path).each do |message|
-            @@logger.info(message.join("\n")) if @@bullet_logger
-            Rails.logger.warn(message.join("\n")) if @@rails_logger
-          end
-          call_stack_messages.each do |message|
-            @@logger.info(message.join("\n")) if @@bullet_logger
-            Rails.logger.warn(message.join("\n")) if @@rails_logger
-          end
-          @@logger_file.flush if @@bullet_logger
-        end
-      end
-
       def add_unpreload_associations(klazz, associations)
-        # puts "add unpreload associations, #{klazz} => #{associations.inspect}"
         unpreload_associations[klazz] ||= []
         unpreload_associations[klazz] << associations
         unique(unpreload_associations[klazz])
       end
 
       def add_unused_preload_associations(klazz, associations)
-        # puts "add unused preload associations, #{klazz} => #{associations.inspect}"
         unused_preload_associations[klazz] ||= []
         unused_preload_associations[klazz] << associations
         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
 
-      ###################################################
-      # interface for active record
-      ###################################################
       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)
-        # puts "add possible objects, #{objects.inspect}"
         klazz= objects.first.class
         possible_objects[klazz] ||= []
         possible_objects[klazz] << objects
@@ -180,7 +54,6 @@ module Bullet
       end
 
       def add_impossible_object(object)
-        # puts "add impossible object, #{object}"
         klazz = object.class
         impossible_objects[klazz] ||= []
         impossible_objects[klazz] << object
@@ -188,14 +61,12 @@ module Bullet
       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 add_eager_loadings(objects, associations)
-        # puts "add eager loadings, #{objects.inspect} => #{associations.inspect}"
         objects = Array(objects)
         eager_loadings[objects] ||= []
         eager_loadings[objects] << associations
@@ -203,12 +74,10 @@ module Bullet
       end
 
       def 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.inspect}"
         add_call_object_associations(object, associations)
         if unpreload_associations?(object, associations)
           add_unpreload_associations(object.class, associations)
@@ -216,9 +85,6 @@ module Bullet
         end
       end
 
-      ############################################
-      # for rspec
-      ############################################
       def check_unused_preload_associations
         object_associations.each do |object, association|
           related_objects = eager_loadings.select {|key, value| key.include?(object) and value == association}.collect(&:first).flatten
@@ -236,117 +102,122 @@ module Bullet
         !unpreload_associations.empty?
       end
 
-
       private
-      def unpreload_associations?(object, associations)
-        klazz = object.class
-        (!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 unpreload_associations?(object, associations)
+          klazz = object.class
+          (!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 notification_response
-        response = []
-        if has_unused_preload_associations?
-          response << unused_preload_messages.join("\n")
+        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
-        if has_unpreload_associations?
-          response << unpreload_messages.join("\n")
+
+        def console_title
+          title = []
+          title << unused_preload_messages.first.first unless unused_preload_messages.empty?
+          title << unpreload_messages.first.first unless unpreload_messages.empty?
         end
-        response
-      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)}"
-          ]
+        def log_messages(path = nil)
+          messages = []
+          messages << unused_preload_messages(path)
+          messages << unpreload_messages(path)
+          messages << call_stack_messages
         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)}"
-          ]
+        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
-        messages
-      end
 
-      def klazz_associations_str(klazz, associations)
-        "  #{klazz} => [#{associations.map(&:inspect).join(', ')}]"
-      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 associations_str(associations)
-        ":include => #{associations.map{|a| a.to_sym unless a.is_a? Hash}.inspect}"
-      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 wrap_js_association(message)
-        str = ''
-        str << "<script type=\"text/javascript\">/*<![CDATA[*/"
-        str << message
-        str << "/*]]>*/</script>\n"
-      end
+        def klazz_associations_str(klazz, associations)
+          "  #{klazz} => [#{associations.map(&:inspect).join(', ')}]"
+        end
 
-      def call_stack_messages
-        callers.inject([]) do |messages, c|
-          messages << ['N+1 Query method call stack', c.collect {|line| "  #{line}"}].flatten
+        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
-      end
-      
-      def unique(array)
-        array.flatten!
-        array.uniq!
-      end
 
-      def unpreload_associations
-        @@unpreload_associations ||= {}
-      end
+        def unpreload_associations
+          @@unpreload_associations ||= {}
+        end
 
-      def unused_preload_associations
-        @@unused_preload_associations ||= {}
-      end
+        def unused_preload_associations
+          @@unused_preload_associations ||= {}
+        end
 
-      def object_associations
-        @@object_associations ||= {}
-      end
+        def object_associations
+          @@object_associations ||= {}
+        end
 
-      def call_object_associations
-        @@call_object_associations ||= {}
-      end
+        def call_object_associations
+          @@call_object_associations ||= {}
+        end
 
-      def possible_objects
-        @@possible_objects ||= {}
-      end
+        def possible_objects
+          @@possible_objects ||= {}
+        end
 
-      def impossible_objects
-        @@impossible_objects ||= {}
-      end
+        def impossible_objects
+          @@impossible_objects ||= {}
+        end
 
-      def klazz_associations
-        @@klazz_associations ||= {}
-      end
+        def klazz_associations
+          @@klazz_associations ||= {}
+        end
 
-      def eager_loadings
-        @@eager_loadings ||= {}
-      end
+        def eager_loadings
+          @@eager_loadings ||= {}
+        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!
-      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!
+        end
 
-      def callers
-        @@callers ||= []
-      end
+        def callers
+          @@callers ||= []
+        end
     end
   end
 end

data/lib/bullet/counter.rb

@@ -1,8 +1,9 @@
 module Bullet
   class Counter
     class <<self
-      def start_request
+      include Bullet::Notification
 
+      def start_request
       end
 
       def end_request
@@ -12,6 +13,26 @@ module Bullet
       def need_counter_caches?
         !klazz_associations.empty?
       end
+
+      def notification?
+        need_counter_caches?
+      end
+
+      def notification_response
+        response = []
+        if need_counter_caches?
+          response << counter_cache_messages.join("\n")
+        end
+        response
+      end
+
+      def console_title
+        title = ["Need Counter Cache"]
+      end
+
+      def log_messages(path = nil)
+        [counter_cache_messages(path)]
+      end
       
       def add_counter_cache(object, associations)
         klazz = object.class
@@ -21,9 +42,25 @@ module Bullet
         klazz_associations[klazz].uniq!
       end
       
-      def klazz_associations
-        @@klazz_associations ||= {}
-      end
+      private
+        def counter_cache_messages(path = nil)
+          messages = []
+          klazz_associations.each do |klazz, associations|
+            messages << [
+              "Need Counter Cache",
+              "  #{klazz} => [#{associations.map(&:inspect).join(', ')}]"
+            ]
+          end
+          messages
+        end
+
+        def call_stack_messages
+          []
+        end
+        
+        def klazz_associations
+          @@klazz_associations ||= {}
+        end
     end
   end
 end

data/lib/bullet/notification.rb

@@ -0,0 +1,79 @@
+module Bullet
+  class NotificationError < StandardError
+  end
+
+  module Notification
+    def notification?
+    end
+
+    def notification_response
+    end
+
+    def console_title
+    end
+
+    def log_message(path = nil)
+    end
+
+    def javascript_notification
+      str = ''
+      if Bullet.alert || Bullet.console
+        response = notification_response
+      end
+      if Bullet.alert
+        str << wrap_js_association("alert(#{response.join("\n").inspect});")
+      end
+      if Bullet.console
+        code = <<-CODE
+          if (typeof(console) !== 'undefined') {
+
+            if (console.groupCollapsed && console.groupEnd && console.log) {
+
+              console.groupCollapsed(#{console_title.join(', ').inspect});
+              console.log(#{response.join("\n").inspect});
+              console.log(#{call_stack_messages.join("\n").inspect});
+              console.groupEnd();
+
+            } else if (console.log) {
+
+              console.log(#{response.join("\n").inspect});
+            }
+          }
+        CODE
+        str << wrap_js_association(code)
+      end
+      str
+    end
+
+    def growl_notification
+      if Bullet.growl
+        response = notification_response
+        begin
+          growl = Growl.new('localhost', 'ruby-growl', ['Bullet Notification'], nil, Bullet.growl_password)
+          growl.notify('Bullet Notification', 'Bullet Notification', response.join("\n"))
+        rescue
+        end
+      end
+    end
+
+    def log_notification(path)
+      if Bullet.bullet_logger || Bullet.rails_logger
+        Rails.logger.warn '' if Bullet.rails_logger
+        messages = log_messages(path)
+        messages.each do |message|
+          Bullet.logger.info(message.join("\n")) if Bullet.bullet_logger
+          Rails.logger.warn(message.join("\n")) if Bullet.rails_logger
+        end
+        Bullet.logger_file.flush if Bullet.bullet_logger
+      end
+    end
+
+    private
+      def wrap_js_association(message)
+        str = ''
+        str << "<script type=\"text/javascript\">/*<![CDATA[*/"
+        str << message
+        str << "/*]]>*/</script>\n"
+      end
+  end
+end

data/lib/bulletware.rb

@@ -6,21 +6,21 @@ class Bulletware
   def call(env)
     return @app.call(env) unless Bullet.enable?
 
-    Bullet::Association.start_request
+    Bullet.start_request
     status, headers, response = @app.call(env)
     return [status, headers, response] if response.empty?
 
-    if Bullet::Association.has_bad_assocations?
+    if Bullet.notification?
       if check_html?(headers, response)
-        response_body = response.body << Bullet::Association.javascript_notification
+        response_body = response.body << Bullet.javascript_notification
         headers['Content-Length'] = response_body.length.to_s
       end
 
-      Bullet::Association.growl_notification
-      Bullet::Association.log_notificatioin(env['PATH_INFO'])
+      Bullet.growl_notification
+      Bullet.log_notification(env['PATH_INFO'])
     end
     response_body ||= response.body
-    Bullet::Association.end_request
+    Bullet.end_request
     [status, headers, response_body]
   end
   

data/spec/bullet_counter_spec.rb

@@ -54,12 +54,19 @@ describe Bullet::Counter do
     Bullet::Counter.end_request
   end
 
-  it "should need counter cache with count" do
+  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
   end
+
+  it "should not need counter cache with part of cities" do
+    Country.all.each do |country|
+      country.cities(:conditions => ["name = ?", 'first']).size
+    end
+    Bullet::Counter.should_not be_need_counter_cache
+  end
 end
 
 describe Bullet::Counter do
@@ -115,7 +122,7 @@ describe Bullet::Counter do
     Bullet::Counter.end_request
   end
 
-  it "should need counter cache with count" do
+  it "should not need counter cache" do
     Person.all.each do |person|
       person.pets.size
     end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ require 'active_record'
 require 'action_controller'
 
 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/notification'))
 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'))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: flyerhzm-bullet
 version: !ruby/object:Gem::Version 
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors: 
 - Richard Huang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-09 00:00:00 -07:00
+date: 2009-09-11 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -32,6 +32,7 @@ files:
 - lib/bullet/association.rb
 - lib/bullet/counter.rb
 - lib/bullet/logger.rb
+- lib/bullet/notification.rb
 - lib/bulletware.rb
 - rails/init.rb
 - spec/bullet_association_spec.rb
@@ -66,6 +67,6 @@ 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/bullet_counter_spec.rb
 - spec/spec_helper.rb
+- spec/bullet_association_spec.rb