bullet 4.1.0 → 4.2.0

data/.gitignore

@@ -8,3 +8,5 @@ tags
 .bundle
 *.gem
 benchmark_profile*
+/nbproject/private/
+Gemfile*.lock

data/.travis.yml

@@ -3,8 +3,8 @@ rvm:
   - 1.9.3
 gemfile:
   - Gemfile
-  - Gemfile.rails-3.1.4
-  - Gemfile.rails-3.0.12
+  - Gemfile.rails-3.1.5
+  - Gemfile.rails-3.0.13
   - Gemfile.rails-2.3.14
 env: DB=sqlite
 before_install:

data/Gemfile

@@ -4,7 +4,7 @@ source "http://rubygems.org"
 
 gemspec
 
-gem 'rails', '3.2.3'
+gem 'rails', '3.2.5'
 gem 'sqlite3'
 gem 'mysql'
 gem 'activerecord-import'

data/{Gemfile.rails-3.0.12 → Gemfile.rails-3.0.13}

@@ -4,7 +4,7 @@ source "http://rubygems.org"
 
 gemspec
 
-gem 'rails', '3.0.12'
+gem 'rails', '3.0.13'
 gem 'sqlite3'
 gem 'mysql'
 gem 'activerecord-import'

data/{Gemfile.rails-3.1.4 → Gemfile.rails-3.1.5}

@@ -4,7 +4,7 @@ source "http://rubygems.org"
 
 gemspec
 
-gem 'rails', '3.1.4'
+gem 'rails', '3.1.5'
 gem 'sqlite3'
 gem 'mysql'
 gem 'activerecord-import'

data/Gemfile.rails-4-beta

@@ -0,0 +1,19 @@
+# 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', github: 'rails/rails'
+gem 'journey', github: 'rails/journey'
+gem 'activerecord-deprecated_finders', github: 'rails/activerecord-deprecated_finders'
+gem 'sqlite3'
+gem 'mysql'
+gem 'activerecord-import'
+gem 'mongoid', github: 'slbug/mongoid'
+
+gem "rspec"
+gem "guard"
+gem "guard-rspec"
+
+gem "perftools.rb"

data/README.textile

@@ -1,7 +1,9 @@
-h1. Bullet !https://gemnasium.com/flyerhzm/bullet.png?travis(Dependency Status)!:https://gemnasium.com/flyerhzm/bullet
+h1. Bullet
 
 !https://secure.travis-ci.org/flyerhzm/bullet.png!:http://travis-ci.org/flyerhzm/bullet
 
+!http://api.coderwall.com/flyerhzm/endorsecount.png!:http://coderwall.com/flyerhzm
+
 The Bullet gem 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.
@@ -10,6 +12,15 @@ The Bullet gem now supports **activerecord** 2.1, 2.2, 2.3, 3.0, 3.1, 3.2 and **
 
 ****************************************************************************
 
+h2. External Introduction
+
+* "http://railscasts.com/episodes/372-bullet":http://railscasts.com/episodes/372-bullet
+* "http://ruby5.envylabs.com/episodes/9-episode-8-september-8-2009":http://ruby5.envylabs.com/episodes/9-episode-8-september-8-2009
+* "http://railslab.newrelic.com/2009/10/23/episode-19-on-the-edge-part-1":http://railslab.newrelic.com/2009/10/23/episode-19-on-the-edge-part-1
+* "http://weblog.rubyonrails.org/2009/10/22/community-highlights":http://weblog.rubyonrails.org/2009/10/22/community-highlights
+
+****************************************************************************
+
 h2. Install
 
 You can install it as a gem:
@@ -39,17 +50,19 @@ config.after_initialize do
                   :receiver => 'your_account@jabber.org',
                   :show_online_status => true }
   Bullet.rails_logger = true
+  Bullet.airbrake = true
   Bullet.disable_browser_cache = true
 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 six of the Bullet notification systems:
+The code above will enable all seven of the Bullet notification systems:
 * <code>Bullet.enable</code>: enable Bullet 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.airbrake</code>: add notifications to airbrake
 * <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.
@@ -90,32 +103,9 @@ 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>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 => '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. Ruby 1.9 issue
+h2. Growl, XMPP/Jabber and Airbrake Support
 
-ruby-growl gem has an issue about md5 in ruby 1.9, if you use growl and ruby 1.9, check this gist http://gist.github.com/300184
-
-****************************************************************************
-
-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.
+see "https://github.com/flyerhzm/uniform_notifier":https://github.com/flyerhzm/uniform_notifier
 
 ****************************************************************************
 
@@ -158,14 +148,6 @@ Don't forget enabling bullet in test environment.
 
 ****************************************************************************
 
-h2. Links
-
-* "http://weblog.rubyonrails.org/2009/10/22/community-highlights":http://weblog.rubyonrails.org/2009/10/22/community-highlights
-* "http://ruby5.envylabs.com/episodes/9-episode-8-september-8-2009":http://ruby5.envylabs.com/episodes/9-episode-8-september-8-2009
-* "http://railslab.newrelic.com/2009/10/23/episode-19-on-the-edge-part-1":http://railslab.newrelic.com/2009/10/23/episode-19-on-the-edge-part-1
-
-****************************************************************************
-
 h2. Contributors
 
 "https://github.com/flyerhzm/bullet/contributors":https://github.com/flyerhzm/bullet/contributors

data/README_for_rails2.textile

@@ -1,5 +1,9 @@
 h1. Bullet
 
+!https://secure.travis-ci.org/flyerhzm/bullet.png!:http://travis-ci.org/flyerhzm/bullet
+
+!http://api.coderwall.com/flyerhzm/endorsecount.png!:http://coderwall.com/flyerhzm
+
 The Bullet plugin/gem 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.

data/bullet.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = ">= 1.3.6"
 
-  s.add_dependency "uniform_notifier", "~> 1.0.0"
+  s.add_dependency "uniform_notifier"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/bullet/action_controller2.rb

@@ -1,8 +1,10 @@
 module Bullet
   class ActionController
+    extend Dependency
+
     def self.enable
       require 'action_controller'
-      if Rails.version =~ /\A2.3/
+      if active_record23?
         ::ActionController::Dispatcher.middleware.use Bullet::Rack
         ::ActionController::Dispatcher.class_eval do
           class <<self
@@ -13,7 +15,7 @@ module Bullet
             end
           end
         end
-      elsif Rails.version =~ /\A2.[12]/
+      elsif active_record21? || active_record22?
         ::ActionController::Dispatcher.class_eval do
           alias_method :origin_reload_application, :reload_application
           def reload_application
@@ -29,8 +31,7 @@ module Bullet
             response = origin_process(request, response, method = :perform_action, *arguments)
 
             if Bullet.notification?
-              if response.headers["type"] && response.headers["type"].include?('text/html') &&
-                  response.body.include?("<html>") && response.body.include?("</html>")
+              if response.headers["type"] && response.headers["type"].include?('text/html') && response.body.include?("<html>")
                 response.body <<= Bullet.gather_inline_notifications
                 response.headers["Content-Length"] = response.body.length.to_s
               end

data/lib/bullet/dependency.rb

@@ -0,0 +1,87 @@
+module Bullet
+  module Dependency
+    def mongoid?
+      @mongoid ||= begin
+                     require 'mongoid'
+                     true
+                   rescue LoadError
+                     false
+                   end
+    end
+
+    def active_record?
+      @active_record ||= begin
+                           require 'active_record'
+                           true
+                         rescue LoadError
+                           false
+                         end
+    end
+
+    def active_record_version
+      @active_record_version ||= begin
+                                   if active_record2?
+                                     'active_record2'
+                                   elsif active_record30?
+                                     'active_record3'
+                                   elsif active_record31? || active_record32? || active_record4?
+                                     'active_record31'
+                                   end
+                                 end
+    end
+
+    def mongoid_version
+      @mongoid_version ||= begin
+                             if mongoid24?
+                               'mongoid24'
+                             elsif mongoid3?
+                               'mongoid3'
+                             end
+                           end
+    end
+
+    def active_record2?
+      ::ActiveRecord::VERSION::MAJOR == 2
+    end
+
+    def active_record23?
+      active_record2? && ::ActiveRecord::VERSION::MINOR == 3
+    end
+
+    def active_record22?
+      active_record2? && ::ActiveRecord::VERSION::MINOR == 2
+    end
+
+    def active_record21?
+      active_record2? && ::ActiveRecord::VERSION::MINOR == 1
+    end
+
+    def active_record3?
+      ::ActiveRecord::VERSION::MAJOR == 3
+    end
+
+    def active_record4?
+      ::ActiveRecord::VERSION::MAJOR == 4
+    end
+
+    def active_record30?
+      active_record3? && ::ActiveRecord::VERSION::MINOR == 0
+    end
+
+    def active_record31?
+      active_record3? && ::ActiveRecord::VERSION::MINOR == 1
+    end
+
+    def active_record32?
+      active_record3? && ::ActiveRecord::VERSION::MINOR == 2
+    end
+
+    def mongoid24?
+      ::Mongoid::VERSION =~ /\A2\.4/
+    end
+
+    def mongoid3?
+      ::Mongoid::VERSION =~ /\A3/
+    end
+  end
+end

data/lib/bullet/mongoid24.rb

@@ -11,13 +11,13 @@ module Bullet
 
         def first
           result = origin_first
-          Bullet::Detector::Association.add_impossible_object(result)
+          Bullet::Detector::Association.add_impossible_object(result) if result
           result
         end
 
         def last
           result = origin_last
-          Bullet::Detector::Association.add_impossible_object(result)
+          Bullet::Detector::Association.add_impossible_object(result) if result
           result
         end
 
@@ -45,7 +45,9 @@ module Bullet
         alias_method :origin_set_relation, :set_relation
 
         def set_relation(name, relation)
-          Bullet::Detector::NPlusOneQuery.call_association(self, name)
+          if relation && relation.metadata.macro !~ /embed/
+            Bullet::Detector::NPlusOneQuery.call_association(self, name)
+          end
           origin_set_relation(name, relation)
         end
       end

data/lib/bullet/mongoid3.rb

@@ -10,13 +10,13 @@ module Bullet
 
         def first
           result = origin_first
-          Bullet::Detector::Association.add_impossible_object(result)
+          Bullet::Detector::Association.add_impossible_object(result) if result
           result
         end
 
         def last
           result = origin_last
-          Bullet::Detector::Association.add_impossible_object(result)
+          Bullet::Detector::Association.add_impossible_object(result) if result
           result
         end
 
@@ -44,7 +44,9 @@ module Bullet
         alias_method :origin_set_relation, :set_relation
 
         def set_relation(name, relation)
-          Bullet::Detector::NPlusOneQuery.call_association(self, name)
+          if relation && relation.metadata.macro !~ /embed/
+            Bullet::Detector::NPlusOneQuery.call_association(self, name)
+          end
           origin_set_relation(name, relation)
         end
       end

data/lib/bullet/notification/base.rb

@@ -19,7 +19,12 @@ module Bullet
       end
 
       def whoami
-        "user: " << `whoami`.chomp
+        user = `whoami`
+        if user
+          "user: #{user.chomp}"
+        else
+          ""
+        end
       end
 
       def body_with_caller

data/lib/bullet/rack.rb

@@ -9,7 +9,7 @@ module Bullet
 
       Bullet.start_request
       status, headers, response = @app.call(env)
-      return [status, headers, response] if empty?(response)
+      return [status, headers, response] if file?(headers) || empty?(response)
 
       response_body = nil
       if Bullet.notification?
@@ -28,14 +28,16 @@ module Bullet
     def empty?(response)
       # response may be ["Not Found"], ["Move Permanently"], etc.
       (response.is_a?(Array) && response.size <= 1) ||
-      !response.body.is_a?(String) || response.body.empty?
+        !response.respond_to?(:body) || response.body.empty?
+    end
+
+    # if send file?
+    def file?(headers)
+      headers["Content-Transfer-Encoding"] == "binary"
     end
 
     def html_request?(headers, response)
-      headers['Content-Type'] &&
-        headers['Content-Type'].include?('text/html') &&
-        response.body.include?("<html>") &&
-        response.body.include?("</html>")
+      headers['Content-Type'] && headers['Content-Type'].include?('text/html') && response.body.include?("<html")
     end
 
     def no_browser_cache(headers)

data/lib/bullet/version.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
 module Bullet
-  VERSION = "4.1.0"
+  VERSION = "4.2.0"
 end
-

data/lib/bullet.rb

@@ -2,24 +2,17 @@ require 'set'
 require 'uniform_notifier'
 require 'bullet/ext/object'
 require 'bullet/ext/string'
+require 'bullet/dependency'
 
 module Bullet
-  if Rails.version =~ /\A3\.0/
-    autoload :ActiveRecord, 'bullet/active_record3'
-  elsif Rails.version =~ /\A3\.[12]/
-    autoload :ActiveRecord, 'bullet/active_record31'
-  else
-    autoload :ActiveRecord, 'bullet/active_record2'
-    autoload :ActionController, 'bullet/action_controller2'
+  extend Dependency
+
+  if active_record?
+    autoload :ActiveRecord, "bullet/#{active_record_version}"
+    autoload :ActionController, 'bullet/action_controller2' if active_record2?
   end
-  begin
-    require 'mongoid'
-    if Mongoid::VERSION =~ /\A2\.4/
-      autoload :Mongoid, 'bullet/mongoid24'
-    elsif Mongoid::VERSION =~ /\A3/
-      autoload :Mongoid, 'bullet/mongoid3'
-    end
-  rescue LoadError
+  if mongoid?
+    autoload :Mongoid, "bullet/#{mongoid_version}"
   end
   autoload :Rack, 'bullet/rack'
   autoload :BulletLogger, 'bullet/logger'
@@ -40,7 +33,7 @@ module Bullet
     attr_accessor :enable, :disable_browser_cache
     attr_reader :notification_collector
 
-    delegate :alert=, :console=, :growl=, :rails_logger=, :xmpp=, :to => UniformNotifier
+    delegate :alert=, :console=, :growl=, :rails_logger=, :xmpp=, :airbrake=, :to => UniformNotifier
 
     DETECTORS = [ Bullet::Detector::NPlusOneQuery,
                   Bullet::Detector::UnusedEagerAssociation,
@@ -49,18 +42,12 @@ module Bullet
     def enable=(enable)
       @enable = enable
       if enable?
-        begin
-          require 'mongoid'
+        if mongoid?
           Bullet::Mongoid.enable
-        rescue LoadError
         end
-        begin
-          require 'active_record'
+        if active_record?
           Bullet::ActiveRecord.enable
-          if Rails.version =~ /\A2./
-            Bullet::ActionController.enable
-          end
-        rescue LoadError
+          Bullet::ActionController.enable if active_record2?
         end
       end
     end
@@ -72,7 +59,7 @@ module Bullet
     def bullet_logger=(active)
       if active
         bullet_log_file = File.open('log/bullet.log', 'a+')
-        bullet_log_file.sync
+        bullet_log_file.sync = true
         UniformNotifier.customized_logger = bullet_log_file
       end
     end

data/spec/bullet/ext/object_spec.rb

@@ -7,14 +7,11 @@ describe Object do
       post.bullet_ar_key.should == "Post:#{post.id}"
     end
 
-    begin
-      require 'mongoid'
-
+    if mongoid?
       it "should return class with namesapce and id composition" do
         post = Mongoid::Post.first
         post.bullet_ar_key.should == "Mongoid::Post:#{post.id}"
       end
-    rescue LoadError
     end
   end
 end

data/spec/bullet/rack_spec.rb

@@ -22,6 +22,12 @@ module Bullet
         middleware.should be_html_request(headers, response)
       end
 
+      it "should be true if Content-Type is text/html and http body contains html tag with attributes" do
+        headers = {"Content-Type" => "text/html"}
+        response = stub(:body => "<html attr='hello'><head></head><body></body></html>")
+        middleware.should be_html_request(headers, response)
+      end
+
       it "should be false if there is no Content-Type header" do
         headers = {}
         response = stub(:body => "<html><head></head><body></body></html>")

data/spec/integration/association_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-if Rails.version.to_i > 2
+if active_record3?
   describe Bullet::Detector::Association, 'has_many' do
     before(:each) do
       Bullet.clear

data/spec/integration/counter_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-if Rails.version.to_i > 2
+if active_record3?
   describe Bullet::Detector::Counter do
     before(:each) do
       Bullet.start_request

data/spec/integration/mongoid/association_spec.rb

@@ -1,7 +1,6 @@
-begin
-  require 'mongoid'
-  require 'spec_helper'
+require 'spec_helper'
 
+if mongoid?
   describe Bullet::Detector::Association do
     before(:each) do
       Bullet.clear
@@ -12,6 +11,20 @@ begin
       Mongoid::IdentityMap.clear
     end
 
+    context 'embeds_many' do
+      context "posts => users" do
+        it "should detect nothing" do
+          Mongoid::Post.all.each do |post|
+            post.users.map(&:name)
+          end
+          Bullet::Detector::UnusedEagerAssociation.check_unused_preload_associations
+          Bullet::Detector::Association.should_not be_has_unused_preload_associations
+
+          Bullet::Detector::Association.should be_completely_preloading_associations
+        end
+      end
+    end
+
     context 'has_many' do
       context "posts => comments" do
         it "should detect non preload posts => comments" do
@@ -249,5 +262,4 @@ begin
       end
     end
   end
-rescue LoadError
 end

data/spec/integration/rails2/association_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-if Rails.version.to_i == 2
+if active_record2?
   describe Bullet::Detector::Association, 'has_many' do
     before(:each) do
       Bullet.clear

data/spec/integration/rails2/counter_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-if Rails.version.to_i > 2
+if active_record2?
   describe Bullet::Detector::Counter do
     before(:each) do
       Bullet.start_request
@@ -31,7 +31,7 @@ if Rails.version.to_i > 2
 
     it "should not need counter cache with part of cities" do
       Country.all.each do |country|
-        country.cities.where(:name => 'first').size
+        country.cities.find(:all, :conditions => {:name => 'first'}).size
       end
       Bullet.collected_counter_cache_notifications.should be_empty
     end

data/spec/models/mongoid/post.rb

@@ -4,5 +4,7 @@ class Mongoid::Post
   has_many :comments, :class_name => "Mongoid::Comment"
   belongs_to :category, :class_name => "Mongoid::Category"
 
+  embeds_many :users, :class_name => "Mongoid::User"
+
   scope :preload_comments, lambda { includes(:comments) }
 end

data/spec/models/mongoid/user.rb

@@ -0,0 +1,3 @@
+class Mongoid::User
+  include Mongoid::Document
+end

data/spec/models/post.rb

@@ -1,9 +1,11 @@
 class Post < ActiveRecord::Base
+  extend Bullet::Dependency
+
   belongs_to :category
   belongs_to :writer
   has_many :comments
 
-  if Rails.version.to_i == 2
+  if active_record2?
     named_scope :preload_comments, lambda { {:include => :comments} }
     named_scope :in_category_name, lambda { |name|
       {:conditions => ['categories.name = ?', name], :include => :category}