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

data/.rspec

@@ -0,0 +1 @@
+--colour --format d

data/Hacking.textile

@@ -0,0 +1,100 @@
+h1. Bullet Overview for Developers
+This file aims to give developers a quick tour of the bullet internals, making
+it (hopefully) easier to extend or enhance the Bullet gem.
+
+h2. General Control Flow aka. 10000 Meter View
+When Rails is initialized, Bullet will extend ActiveRecord (and if you're using
+Rails 2.x ActiveController too) with the relevant modules and methods found
+in lib/bullet/active_recordX.rb and lib/bullet/action_controller2.rb. If you're 
+running Rails 3, Bullet will integrate itself as a middleware into the Rack
+stack, so ActionController does not need to be extended.
+
+The ActiveRecord extensions will call methods in a given detector class, when 
+certain methods are called. 
+
+Detector classes contain all the logic to recognize 
+a noteworthy event. If such an event is detected, an instance of the
+corresponding Notification class is created and stored in a Set instance in the
+main Bullet module (the 'notification collector'). 
+
+Notification instances contain the message that will be displayed, and will
+use a Presenter class to display their message to the user.
+
+Each Presenter knows how to present the message either "inline" (as in: the
+message text will be inlined into the request response, such as javascript
+alerts) or "out-of-channel" (completely independent of the request response,
+such as growl or xmpp).
+
+So the flow of a request goes like this:
+1. Bullet.start_request is called, which resets all the detectors and empties
+   the notification collector
+2. The request is handled by Rails, and the installed ActiveRecord extensions
+   trigger Detector callbacks
+3. Detectors once called, will determine whether something noteworthy happend. 
+   If yes, then a Notification is created and stored in the notification collector.
+4. Rails finishes handling the request
+5. For each notification in the collector, Bullet will iterate over each
+   Presenter and will try to generate an inline message that will be appended to
+   the generated reponse body.
+6. The response is returned to the client.
+7. Bullet will try to generate an out-of-channel message for each notification.
+8. Bullet calls end_request for each detector.
+9. Goto 1.
+
+h2. Adding Presenters
+To add a presenter, you will need to:
+* Add the class to the PRESENTERS constant in the main Bullet module
+* Add an autoload directive to lib/bullet/presenter.rb
+* Create your presenter class in the Bullet::Presenter namespace
+
+Presenter classes will need the following class methods:
+* .active? which returns a boolean to indicate if the presenter is active (so
+* that presenters the user doesn't want can be skipped).
+
+and at least one of:
+* .out_of_channel( notification ) which will display the notification to the
+  user outside of the request response
+or
+* .inline( notification ) which will generate the notification presentation fit
+  to be appended to the generated HTML request response (if you want to inject
+  content on the result page, such as a javascript alert).
+
+Have a look at lib/bullet/javascript_alert.rb as a trivial example for an
+inline presenter and lib/bullet/rails_logger.rb to see how a minimal
+out-of-channel presenter looks like.
+
+h2. Adding Notification Types
+If you want to add more kinds of things that Bullet can detect, a little more
+work is needed than if you were just adding a Presenter, but the concepts are
+similar.
+
+* Add the class to the DETECTORS constant in the main Bullet module
+* Add (if needed) Rails monkey patches to Bullet.enable
+* Create your presenter class in the Bullet::Detector namespace
+* Add an autoload directive to lib/bullet/detector.rb
+* Create a corresponding notification class in the Bullet::Notification namespace
+* Add an autoload directive to lib/bullet/notification.rb
+
+As a rule of thumb, you can assume that each Detector will have its own
+Notification class. If you follow the principle of Separation of Concerns I
+can't really think of an example where one would deviate from this rule.
+
+Since the detection of pathological associations is a bit hairy, I'd recommend
+having a look at the counter cache detector and associated notification to get
+a feel for what is needed to get off the ground.
+
+h3. Detectors
+The only things you'll need to consider when building your Detector class is
+that it will need to supply the .start_request, .end_request and .clear class
+methods. 
+
+Simple implementations are provided by Bullet::Detector::Base for start_request
+and end_request, you will have to supply your own clear method.
+
+h3. Notifications
+For notifications you will want to supply a #title and #body instance method,
+and check to see if the #initialize and #full_notice methods in the
+Bullet::Notification::Base class fit your needs. 
+
+The interaction with the presenters encapsulated in the Base class, so you
+won't have to worry about that.

data/README.textile

@@ -17,6 +17,7 @@ You can install it as a gem:
 <pre><code>
 sudo gem install bullet --pre
 </code></pre>
+
 ****************************************************************************
 
 h2. Configuration
@@ -29,6 +30,10 @@ config.after_initialize do
   Bullet.bullet_logger = true  
   Bullet.console = true
   Bullet.growl = true
+  Bullet.xmpp = { :account => 'bullets_account@jabber.org',
+                  :password => 'bullets_password_for_jabber',
+                  :receiver => 'your_account@jabber.org',
+                  :show_online_status => true }
   Bullet.rails_logger = true
   Bullet.disable_browser_cache = true
 end
@@ -43,13 +48,27 @@ It is recommended to config growl notification as follows if your collaborators
   end
 </code></pre>
 
-The code above will enable all five of the Bullet notification systems:
+and similarly for XMPP:
+<pre><code>
+  begin
+    require 'xmpp4r'
+    Bullet.xmpp = { :account => 'bullets_account@jabber.org',
+                    :password => 'bullets_password_for_jabber',
+                    :receiver => 'your_account@jabber.org',
+                    :show_online_status => true }
+  rescue MissingSourceFile
+  end
+</code></pre>
+
+
+The code above will enable all six of the Bullet notification systems:
 * <code>Bullet.enable</code>: enable Bullet plugin/gem, otherwise do nothing
 * <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
+* <code>Bullet.xmpp</code>: send XMPP/Jabber notifications to the receiver indicated. Note that the code will currently not handle the adding of contacts, so you will need to make both accounts indicated know each other manually before you will receive any notifications. If you restart the development server frequently, the 'coming online' sound for the bullet account may start to annoy - in this case set :show_online_status to false; you will still get notifications, but the bullet account won't announce it's online status anymore.
 * <code>Bullet.disable_browser_cache</code>: disable browser cache which usually causes unexpected problems
 
 ****************************************************************************
@@ -105,6 +124,17 @@ ruby-growl gem has an issue about md5 in ruby 1.9, if you use growl and ruby 1.9
 
 ****************************************************************************
 
+h2. XMPP/Jabber Support
+
+To get XMPP support up-and-running for Bullet, follow the steps below:
+* Install the xmpp4r gem: <code>sudo gem install xmpp4r</code>
+* Make both the bullet and the receipient account add each other as contacts.
+  This will require you to manually log into both accounts, add each other
+  as contact and confirm each others contact request.
+* Boot up your application. Bullet will automatically send an XMPP notification when XMPP is turned on.
+
+****************************************************************************
+
 h2. Important
 
 If you find bullet does not work for you, *please disable your browser's cache*.
@@ -155,6 +185,7 @@ h2. Links
 
 h2. Contributors
 
+sriedel did a lot of awesome refactors, added xmpp notification support, and added Hacking.textile about how to extend to bullet plugin.
 flipsasser added Growl, console.log and Rails.log support, very awesome. And he also improved README.
 rainux added group style console.log.
 2collegebums added some great specs to generate red bar.
@@ -203,7 +234,7 @@ post2.comments.create(:name => 'fourth')
 <pre><code>
 <% @posts.each do |post| %>
   <tr>
-    <td><%=h post.name %></td>
+    <td><%= post.name %></td>
     <td><%= post.comments.collect(&:name) %></td>
     <td><%= link_to 'Show', post %></td>
     <td><%= link_to 'Edit', edit_post_path(post) %></td>
@@ -315,7 +346,7 @@ a N+1 query fixed. Cool!
 <pre><code>
 <% @posts.each do |post| %>
   <tr>
-    <td><%=h post.name %></td>
+    <td><%= post.name %></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>
@@ -355,8 +386,8 @@ Remove from your finder: :include => [:comments]
 <pre><code>
 <% @posts.each do |post| %>
   <tr>
-    <td><%=h post.name %></td>
-    <td><%=h post.comments.size %></td>
+    <td><%= post.name %></td>
+    <td><%= 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>

data/README_for_rails2.textile

@@ -18,6 +18,7 @@ There is a large refactor from gem 1.4 to 1.5, so if you upgrade to 1.5 gem, ple
 
 h2. Contributors
 
+sriedel did a lot of awesome refactors, added xmpp notification support, and added Hacking.textile about how to extend to bullet plugin.
 flipsasser added Growl, console.log and Rails.log support, very awesome. And he also improved README.
 rainux added group style console.log.
 2collegebums added some great specs to generate red bar.
@@ -52,6 +53,10 @@ config.after_initialize do
   Bullet.growl = true
   Bullet.rails_logger = true
   Bullet.disable_browser_cache = true
+  Bullet.xmpp = { :account => 'bullets_account@jabber.org',
+                  :password => 'bullets_password_for_jabber',
+                  :receiver => 'your_account@jabber.org',
+                  :show_online_status => true }
 end
 </code></pre>
 
@@ -64,6 +69,18 @@ It is recommended to config growl notification as follows if your collaborators
   end
 </code></pre>
 
+and similarly for XMPP:
+<pre><code>
+  begin
+    require 'xmpp4r'
+    Bullet.xmpp = { :account => 'bullets_account@jabber.org',
+                    :password => 'bullets_password_for_jabber',
+                    :receiver => 'your_account@jabber.org',
+                    :show_online_status => 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/gem, otherwise do nothing
 * <code>Bullet.alert</code>: pop up a JavaScript alert in the browser

data/Rakefile

@@ -6,7 +6,7 @@ require 'jeweler'
 desc 'Default: run unit tests.'
 task :default => :spec
 
-desc 'Generate documentation for the sitemap plugin.'
+desc 'Generate documentation for the bullet plugin.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Bullet'
@@ -15,20 +15,37 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-# FIXME: 'rake spec' will break the test, just run 'ruby spec/association_spec.rb'
-#desc "Run all specs in spec directory"
-#Rspec::Core::RakeTask.new(:spec) do |t|
-  #t.pattern = FileList['spec/**/*_spec.rb']
-#end
+RSpec::Core::RakeTask.new(:spec)
 
-Jeweler::Tasks.new do |gemspec|
-  gemspec.name = "bullet"
-  gemspec.summary = "A plugin to kill N+1 queries and unused eager loading"
-  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://github.com/flyerhzm/bullet"
-  gemspec.authors = ["Richard Huang"]
-  gemspec.files.exclude '.gitignore'
-  gemspec.files.exclude 'log/*'
+desc "Run all examples using rcov"
+RSpec::Core::RakeTask.new :rcov => :cleanup_rcov_files do |t|
+  t.rcov = true
+  t.rcov_opts =  %[-Ilib -Ispec --exclude "gems/*,spec/spec_helper.rb"]
+  t.rcov_opts << %[--no-html --aggregate coverage.data]
+end
+
+task :cleanup_rcov_files do
+  rm_rf 'coverage.data'
+end
+
+task :clobber do
+  rm_rf 'pkg'
+  rm_rf 'tmp'
+  rm_rf 'coverage'
+end
+
+begin
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "bullet"
+    gemspec.summary = "A rails plugin to kill N+1 queries and unused eager loading"
+    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://github.com/flyerhzm/bullet"
+    gemspec.authors = ["Richard Huang"]
+    gemspec.files.exclude '.gitignore'
+    gemspec.files.exclude 'log/*'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
-Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-2.0.0.beta.2
+2.0.0.beta.3

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/bullet.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bullet}
-  s.version = "2.0.0.beta.2"
+  s.version = "2.0.0.beta.3"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
-  s.date = %q{2010-03-07}
+  s.date = %q{2010-07-14}
   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 = [
@@ -17,27 +17,50 @@ Gem::Specification.new do |s|
      "README_for_rails2.textile"
   ]
   s.files = [
-    "MIT-LICENSE",
+    ".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"
   ]
@@ -45,7 +68,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.6}
-  s.summary = %q{A plugin to kill N+1 queries and unused eager loading}
+  s.summary = %q{A rails plugin to kill N+1 queries and unused eager loading}
   s.test_files = [
     "spec/spec_helper.rb",
      "spec/bullet/counter_spec.rb",

data/lib/bullet.rb

@@ -1,31 +1,52 @@
-require 'bulletware'
+require 'set'
 
 module Bullet
+  class NotificationError < StandardError; end
+
   if Rails.version =~ /^3.0/
     autoload :ActiveRecord, 'bullet/active_record3'
   else
     autoload :ActiveRecord, 'bullet/active_record2'
     autoload :ActionController, 'bullet/action_controller2'
   end
-  autoload :Association, 'bullet/association'
-  autoload :Counter, 'bullet/counter'
+  autoload :Rack, 'bullet/rack'
   autoload :BulletLogger, 'bullet/logger'
   autoload :Notification, 'bullet/notification'
+  autoload :Presenter, 'bullet/presenter'
+  autoload :Detector, 'bullet/detector'
+  autoload :Registry, 'bullet/registry'
+  autoload :NotificationCollector, 'bullet/notification_collector'
+  
+  if defined? Rails::Railtie
+    # compatible with rails 3.0.0.beta4
+    class BulletRailtie < Rails::Railtie
+      initializer "bullet.configure_rails_initialization" do |app|
+        app.middleware.use Bullet::Rack
+      end
+    end
+  end
 
   class <<self
-    attr_accessor :enable, :alert, :console, :growl, :growl_password, :rails_logger, :bullet_logger, :logger, :logger_file, :disable_browser_cache
+    attr_accessor :enable, :alert, :console, :growl, :growl_password, :rails_logger, :bullet_logger, :disable_browser_cache, :xmpp
+    attr_reader :notification_collector
+    
+    DETECTORS = [ Bullet::Detector::NPlusOneQuery, 
+                  Bullet::Detector::UnusedEagerAssociation,
+                  Bullet::Detector::Counter ]
 
+    PRESENTERS = [ Bullet::Presenter::JavascriptAlert,
+                   Bullet::Presenter::JavascriptConsole,
+                   Bullet::Presenter::Growl,
+                   Bullet::Presenter::Xmpp,
+                   Bullet::Presenter::RailsLogger,
+                   Bullet::Presenter::BulletLogger ]
+                   
     def enable=(enable)
       @enable = enable
       if enable? 
         Bullet::ActiveRecord.enable
-        if Rails.version =~ /^3.0/
-          require 'action_controller/metal'
-          ::ActionController::Metal.middleware_stack.use Bulletware
-        elsif Rails.version =~/^2.3/
+        if Rails.version =~ /^2./
           Bullet::ActionController.enable
-          require 'action_controller/dispatcher'
-          ::ActionController::Dispatcher.middleware.use Bulletware
         end
       end
     end
@@ -35,53 +56,63 @@ module Bullet
     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
+      Bullet::Presenter::Growl.setup_connection( self.growl_password ) if 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
+    def xmpp=(xmpp)
+      Bullet::Presenter::Xmpp.setup_connection( xmpp ) if xmpp
     end
 
-    BULLETS = [Bullet::Association, Bullet::Counter]
+    def bullet_logger=(bullet_logger)
+      Bullet::Presenter::BulletLogger.setup if bullet_logger
+    end
 
     def start_request
-      BULLETS.each {|bullet| bullet.start_request}
+      @notification_collector ||= Bullet::NotificationCollector.new
+      @notification_collector.reset
+      DETECTORS.each {|bullet| bullet.start_request}
     end
 
     def end_request
-      BULLETS.each {|bullet| bullet.end_request}
+      DETECTORS.each {|bullet| bullet.end_request}
     end
     
     def clear
-      BULLETS.each {|bullet| bullet.clear}
+      DETECTORS.each {|bullet| bullet.clear}
     end
 
-    def notification?
-      BULLETS.any? {|bullet| bullet.notification?}
+    def active_presenters
+      PRESENTERS.select { |presenter| presenter.send :active? }
     end
 
-    def javascript_notification
-      BULLETS.collect {|bullet| bullet.javascript_notification if bullet.notification?}.join("\n")
+    def notification?
+      Bullet::Detector::UnusedEagerAssociation.check_unused_preload_associations
+      @notification_collector.notifications_present?
     end
 
-    def growl_notification
-      BULLETS.each {|bullet| bullet.growl_notification if bullet.notification?}
+    def gather_inline_notifications
+      responses = []
+      for_each_active_presenter_with_notification do |notification|
+        responses << notification.present_inline
+      end
+      responses.join( "\n" )
     end
 
-    def log_notification(path)
-      BULLETS.each {|bullet| bullet.log_notification(path) if bullet.notification?}
+    def perform_out_of_channel_notifications
+      for_each_active_presenter_with_notification do |notification|
+        notification.present_out_of_channel
+      end
     end
+
+    private
+      def for_each_active_presenter_with_notification
+        active_presenters.each do |presenter|
+          @notification_collector.collection.each do |notification|
+            notification.presenter = presenter
+            yield notification
+          end
+        end
+      end
   end
-end
+
+end