bullet 2.0.0.beta.2 → 2.1.0

data/.gitignore

@@ -0,0 +1,9 @@
+log/**
+pkg/**
+.DS_Store
+lib/.DS_Store
+.*.swp
+coverage.data
+tags
+.bundle
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm_gemset_create_on_use_flag=1
+rvm gemset use bullet

data/.rvmrc.example

@@ -0,0 +1,2 @@
+rvm_gemset_create_on_use_flag=1
+rvm gemset use bullet

data/.watchr

@@ -0,0 +1,24 @@
+# vim:set filetype=ruby:
+def run(cmd)
+  puts cmd
+  system cmd
+end
+
+def spec(file)
+  if File.exists?(file)
+    run("rspec #{file}")
+  else
+    puts("Spec: #{file} does not exist.")
+  end
+end
+
+watch("spec/.*/*_spec\.rb") do |match|
+  puts(match[0])
+  spec(match[0])
+end
+
+watch("lib/(.*/.*)\.rb") do |match|
+  puts(match[1])
+  spec("spec/#{match[1]}_spec.rb")
+end
+

data/Gemfile

@@ -0,0 +1,15 @@
+# Use `bundle install` in order to install these gems
+# Use `bundle exec rake` in order to run the specs using the bundle
+source "http://rubygems.org"
+
+gemspec
+
+gem 'rails'
+gem 'sqlite3-ruby', :require => 'sqlite3'
+gem 'mysql'
+gem 'activerecord-import'
+
+gem "rspec"
+gem "watchr"
+
+gem "perftools.rb"

data/Gemfile.lock

@@ -0,0 +1,105 @@
+PATH
+  remote: .
+  specs:
+    bullet (2.1.0)
+      uniform_notifier (~> 1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.11)
+      actionpack (= 3.0.11)
+      mail (~> 2.2.19)
+    actionpack (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activerecord-import (0.2.5)
+      activerecord (~> 3.0.0)
+    activeresource (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+    activesupport (3.0.11)
+    arel (2.0.10)
+    builder (2.1.2)
+    diff-lcs (1.1.3)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    json (1.6.3)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    mysql (2.8.1)
+    perftools.rb (0.5.6)
+    polyglot (0.3.3)
+    rack (1.2.4)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.11)
+      actionmailer (= 3.0.11)
+      actionpack (= 3.0.11)
+      activerecord (= 3.0.11)
+      activeresource (= 3.0.11)
+      activesupport (= 3.0.11)
+      bundler (~> 1.0)
+      railties (= 3.0.11)
+    railties (3.0.11)
+      actionpack (= 3.0.11)
+      activesupport (= 3.0.11)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.2.2)
+    rdoc (3.11)
+      json (~> 1.4)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    sqlite3-ruby (1.3.2)
+    thor (0.14.6)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+    uniform_notifier (1.0.1)
+    watchr (0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-import
+  bullet!
+  mysql
+  perftools.rb
+  rails
+  rspec
+  sqlite3-ruby
+  watchr

data/Hacking.textile

@@ -0,0 +1,69 @@
+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.
+
+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 response 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 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
+* 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.

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Richard Huang (flyerhzm@gmail.com)
+Copyright (c) 2009 - 2010 Richard Huang (flyerhzm@gmail.com)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.textile

@@ -4,19 +4,22 @@ The Bullet plugin/gem is designed to help you increase your application's perfor
 
 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.
 
-The Bullet plugin/gem now supports rails 2.1, 2.2, 2.3 and 3.0, tested in rails 2.1.2, 2.2.2, 2.3.2 and 3.0.0.beta.
+The Bullet plugin/gem now supports rails 2.1, 2.2, 2.3 and 3.0.
 
 ****************************************************************************
 
 h2. Install
 
-You can add Bullet to your Rails gem requirements:
-<pre><code>config.gem 'bullet', :source => 'http://gemcutter.org'</code></pre>
-
 You can install it as a gem:
 <pre><code>
-sudo gem install bullet --pre
+gem install bullet
 </code></pre>
+
+or add it into a Gemfile (Bundler):
+<pre><code>
+gem "bullet", :group => "development"
+</code></code>
+
 ****************************************************************************
 
 h2. Configuration
@@ -24,32 +27,30 @@ h2. Configuration
 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>
 config.after_initialize do
-  Bullet.enable = true 
+  Bullet.enable = true
   Bullet.alert = true
-  Bullet.bullet_logger = true  
+  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
 </code></pre>
 
-It is recommended to config growl notification as follows if your collaborators are not using MacOS
-<pre><code>
-  begin
-    require 'ruby-growl'
-    Bullet.growl = true
-  rescue MissingSourceFile
-  end
-</code></pre>
+The notifier of bullet is a wrap of "uniform_notifier":https://github.com/flyerhzm/uniform_notifier
 
-The code above will enable all five of the Bullet notification systems:
+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
 
 ****************************************************************************
@@ -90,10 +91,10 @@ These two lines are notifications that unused eager loadings have been encounter
 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>
+* Install the ruby-growl gem: <code>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.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 => '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.
 
@@ -105,6 +106,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*.
@@ -134,8 +146,7 @@ end
 
 after(:each)
   if Bullet.enable?
-    Bullet.growl_notification
-    Bullet.log_notification('Test: ')
+    Bullet.perform_out_of_channel_notifications
     Bullet.end_request
   end
 end
@@ -155,6 +166,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.
@@ -168,11 +180,11 @@ Bullet is designed to function as you browse through your application in develop
 1. setup test environment
 
 <pre><code>
-$ rails test
-$ cd test
-$ script/rails g scaffold post name:string 
-$ script/rails g scaffold comment name:string post_id:integer
-$ rake db:migrate
+$ rails new test_bullet
+$ cd test_bullet
+$ rails g scaffold post name:string
+$ rails g scaffold comment name:string post_id:integer
+$ bundle exec rake db:migrate
 </code></pre>
 
 2. change <code>app/model/post.rb</code> and <code>app/model/comment.rb</code>
@@ -187,7 +199,7 @@ class Comment < ActiveRecord::Base
 end
 </code></pre>
 
-3. go to <code>script/rails c</code> and execute
+3. go to <code>rails c</code> and execute
 
 <pre><code>
 post1 = Post.create(:name => 'first')
@@ -203,8 +215,8 @@ post2.comments.create(:name => 'fourth')
 <pre><code>
 <% @posts.each do |post| %>
   <tr>
-    <td><%=h post.name %></td>
-    <td><%= post.comments.collect(&:name) %></td>
+    <td><%= post.name %></td>
+    <td><%= post.comments.map(&: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>
@@ -215,7 +227,7 @@ post2.comments.create(:name => 'fourth')
 5. add bullet gem to <code>Gemfile</code>
 
 <pre><code>
-gem "bullet", "2.0.0.beta.2"
+gem "bullet"
 </code></pre>
 
 And run
@@ -239,7 +251,7 @@ end
 7. start server
 
 <pre><code>
-$ script/rails s
+$ rails s
 </code></pre>
 
 8. input http://localhost:3000/posts in browser, then you will see a popup alert box says
@@ -260,18 +272,18 @@ In the meanwhile, there's a log appended into <code>log/bullet.log</code> file
   Post => [:comments]
   Add to your finder: :include => [:comments]
 2010-03-07 14:12:18[INFO] N+1 Query method call stack
-  /home/flyerhzm/NetBeansProjects/test_bullet2/app/views/posts/index.html.erb:14:in `_render_template__600522146_80203160_0'
-  /home/flyerhzm/NetBeansProjects/test_bullet2/app/views/posts/index.html.erb:11:in `each'
-  /home/flyerhzm/NetBeansProjects/test_bullet2/app/views/posts/index.html.erb:11:in `_render_template__600522146_80203160_0'
-  /home/flyerhzm/NetBeansProjects/test_bullet2/app/controllers/posts_controller.rb:7:in `index'
+  /home/flyerhzm/Downloads/test_bullet/app/views/posts/index.html.erb:14:in `_render_template__600522146_80203160_0'
+  /home/flyerhzm/Downloads/test_bullet/app/views/posts/index.html.erb:11:in `each'
+  /home/flyerhzm/Downloads/test_bullet/app/views/posts/index.html.erb:11:in `_render_template__600522146_80203160_0'
+  /home/flyerhzm/Downloads/test_bullet/app/controllers/posts_controller.rb:7:in `index'
 </code></pre>
 
 The generated SQLs are
 
 <pre><code>
-  Post Load (1.0ms)   SELECT * FROM "posts" 
-  Comment Load (0.4ms)   SELECT * FROM "comments" WHERE ("comments".post_id = 1) 
-  Comment Load (0.3ms)   SELECT * FROM "comments" WHERE ("comments".post_id = 2) 
+  Post Load (1.0ms)   SELECT * FROM "posts"
+  Comment Load (0.4ms)   SELECT * FROM "comments" WHERE ("comments".post_id = 1)
+  Comment Load (0.3ms)   SELECT * FROM "comments" WHERE ("comments".post_id = 2)
 </code></pre>
 
 
@@ -284,8 +296,8 @@ The generated SQLs are
     respond_to do |format|
       format.html # index.html.erb
       format.xml  { render :xml => @posts }
-    end 
-  end 
+    end
+  end
 </code></pre>
 
 10. refresh http://localhost:3000/posts page, no alert box and no log appended.
@@ -293,8 +305,8 @@ The generated SQLs are
 The generated SQLs are
 
 <pre><code>
-  Post Load (0.5ms)   SELECT * FROM "posts" 
-  Comment Load (0.5ms)   SELECT "comments".* FROM "comments" WHERE ("comments".post_id IN (1,2)) 
+  Post Load (0.5ms)   SELECT * FROM "posts"
+  Comment Load (0.5ms)   SELECT "comments".* FROM "comments" WHERE ("comments".post_id IN (1,2))
 </code></pre>
 
 a N+1 query fixed. Cool!
@@ -308,14 +320,14 @@ a N+1 query fixed. Cool!
     respond_to do |format|
       format.html # index.html.erb
       format.xml  { render :xml => @posts }
-    end 
-  end 
+    end
+  end
 </code></pre>
 
 <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>
@@ -348,15 +360,15 @@ Remove from your finder: :include => [:comments]
     respond_to do |format|
       format.html # index.html.erb
       format.xml  { render :xml => @posts }
-    end 
-  end 
+    end
+  end
 </code></pre>
 
 <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>
@@ -381,4 +393,4 @@ In the meanwhile, there's a log appended into <code>log/bullet.log</code> file.
 ****************************************************************************
 
 
-Copyright (c) 2009 Richard Huang (flyerhzm@gmail.com), released under the MIT license
+Copyright (c) 2009 - 2011 Richard Huang (flyerhzm@gmail.com), released under the MIT license