bullet 4.6.0 → 4.7.0

data/Gemfile.rails-4.0.1

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '4.0.1'
+gem 'sqlite3'
+gem 'mysql2'
+gem 'activerecord-import'
+
+gem "rspec"
+gem "guard"
+gem "guard-rspec"
+
+gem 'coveralls', require: false

data/Gemfile.rails-4.0.1.lock

@@ -0,0 +1,150 @@
+PATH
+  remote: .
+  specs:
+    bullet (4.7.0)
+      activesupport
+      uniform_notifier (>= 1.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.1)
+      actionpack (= 4.0.1)
+      mail (~> 2.5.4)
+    actionpack (4.0.1)
+      activesupport (= 4.0.1)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.1)
+      activesupport (= 4.0.1)
+      builder (~> 3.1.0)
+    activerecord (4.0.1)
+      activemodel (= 4.0.1)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.1)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activerecord-import (0.4.1)
+      activerecord (>= 3.0)
+    activesupport (4.0.1)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.1)
+    atomic (1.1.14)
+    builder (3.1.4)
+    coderay (1.0.9)
+    colorize (0.5.8)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    diff-lcs (1.2.4)
+    erubis (2.7.0)
+    ffi (1.9.0)
+    formatador (0.2.4)
+    guard (1.8.2)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (3.0.2)
+      guard (>= 1.8)
+      rspec (~> 2.13)
+    hike (1.2.3)
+    i18n (0.6.5)
+    listen (1.3.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.4)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.2)
+    mime-types (1.25)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    mysql2 (0.3.13)
+    polyglot (0.3.3)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.1)
+      actionmailer (= 4.0.1)
+      actionpack (= 4.0.1)
+      activerecord (= 4.0.1)
+      activesupport (= 4.0.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.1)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.1)
+      actionpack (= 4.0.1)
+      activesupport (= 4.0.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.1)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.4.6)
+    sprockets (2.10.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.8)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.38)
+    uniform_notifier (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-import
+  bullet!
+  coveralls
+  guard
+  guard-rspec
+  mysql2
+  rails (= 4.0.1)
+  rspec
+  sqlite3

data/README.md

@@ -1,6 +1,8 @@
 # Bullet
 
+[![Gem Version](https://badge.fury.io/rb/bullet.png)](http://badge.fury.io/rb/bullet)
 [![Build Status](https://secure.travis-ci.org/flyerhzm/bullet.png)](http://travis-ci.org/flyerhzm/bullet)
+[![Coverage Status](https://coveralls.io/repos/flyerhzm/bullet/badge.png?branch=master)](https://coveralls.io/r/flyerhzm/bullet)
 
 [![Coderwall Endorse](http://api.coderwall.com/flyerhzm/endorsecount.png)](http://coderwall.com/flyerhzm)
 
@@ -43,7 +45,7 @@ Bullet won't do ANYTHING unless you tell it to explicitly. Append to
 ```ruby
 config.after_initialize do
   Bullet.enable = true
-  Bullet.alert = true 
+  Bullet.alert = true
   Bullet.bullet_logger = true
   Bullet.console = true
   Bullet.growl = true
@@ -53,6 +55,7 @@ config.after_initialize do
                   :show_online_status => true }
   Bullet.rails_logger = true
   Bullet.airbrake = true
+  Bullet.add_footer = true
 end
 ```
 
@@ -67,6 +70,8 @@ The code above will enable all seven of the Bullet notification systems:
 * `Bullet.console`: log warnings to your browser's console.log (Safari/Webkit browsers or Firefox w/Firebug installed)
 * `Bullet.growl`: pop up Growl warnings if your system has Growl installed. Requires a little bit of configuration
 * `Bullet.xmpp`: 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.
+* `Bullet.raise`: raise errors, useful for making your specs fail unless they have optimized queries
+* `Bullet.add_footer`: adds the details in the bottom left corner of the page
 
 Bullet also allows you to disable n_plus_one_query, unused_eager_loading
 and counter_cache detectors respectively
@@ -131,20 +136,17 @@ see [https://github.com/flyerhzm/uniform_notifier](https://github.com/flyerhzm/u
 
 If you find bullet does not work for you, *please disable your browser's cache*.
 
-## Advance
+## Advanced
 
-The bullet gem use rack middleware for http request. If you want to bullet for without http server, such as job server. You can do like this:
+The bullet gem uses rack middleware to profile requests. If you want to use bullet without an http server, like to profile a job, you can do this:
 
 ```ruby
-Bullet.start_request if Bullet.enable?
-# run job
-if Bullet.enable? && Bullet.notification?
-  Bullet.perform_out_of_channel_notifications
+Bullet.profile do
+  # run job
 end
-Bullet.end_request if Bullet.enable?
 ```
 
-Or you want to use it in test mode
+Or to use it in test mode:
 
 ```ruby
 before(:each)
@@ -159,19 +161,16 @@ after(:each)
 end
 ```
 
-Don't forget enabling bullet in test environment.
+Don't forget to enable bullet in your test environment.
 
 ### API access
 
-after `end_request`, you can fetch warnings then do whatever you want
+after `profile`, you can fetch warnings then do whatever you want
 
 ```ruby
-Bullet.start_request if Bullet.enable?
-# run anything
-if Bullet.enable? && Bullet.notification?
-  Bullet.perform_out_of_channel_notifications
+Bullet.profile do
+  # run anything
 end
-Bullet.end_request if Bullet.enable?
 warnings = Bullet.warnings
 ```
 
@@ -253,6 +252,7 @@ config.after_initialize do
   Bullet.console = true
 #  Bullet.growl = true
   Bullet.rails_logger = true
+  Bullet.add_footer = true
 end
 ```
 

data/bullet.gemspec

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

data/lib/bullet.rb

@@ -1,3 +1,4 @@
+require "active_support/core_ext/module/delegation"
 require 'set'
 require 'uniform_notifier'
 require 'bullet/ext/object'
@@ -10,7 +11,6 @@ module Bullet
   autoload :ActiveRecord, "bullet/#{active_record_version}" if active_record?
   autoload :Mongoid, "bullet/#{mongoid_version}" if mongoid?
   autoload :Rack, 'bullet/rack'
-  autoload :BulletLogger, 'bullet/logger'
   autoload :Notification, 'bullet/notification'
   autoload :Detector, 'bullet/detector'
   autoload :Registry, 'bullet/registry'
@@ -24,12 +24,17 @@ module Bullet
     end
   end
 
-  class <<self
+  class << self
     attr_writer :enable, :n_plus_one_query_enable, :unused_eager_loading_enable, :counter_cache_enable
     attr_reader :notification_collector, :whitelist
+    attr_accessor :add_footer
 
     delegate :alert=, :console=, :growl=, :rails_logger=, :xmpp=, :airbrake=, :to => UniformNotifier
 
+    def raise=(should_raise)
+      UniformNotifier.raise=(should_raise ? Notification::UnoptimizedQueryError : false)
+    end
+
     DETECTORS = [ Bullet::Detector::NPlusOneQuery,
                   Bullet::Detector::UnusedEagerLoading,
                   Bullet::Detector::CounterCache ]
@@ -117,6 +122,14 @@ module Bullet
       end
     end
 
+    def footer_info
+      info = []
+      for_each_active_notifier_with_notification do |notification|
+        info << notification.short_notice
+      end
+      info
+    end
+
     def warnings
       notification_collector.collection.inject({}) do |warnings, notification|
         warning_type = notification.class.to_s.split(':').last.tableize
@@ -126,6 +139,17 @@ module Bullet
       end
     end
 
+    def profile
+      Bullet.start_request if Bullet.enable?
+
+      yield
+
+      if Bullet.enable? && Bullet.notification?
+        Bullet.perform_out_of_channel_notifications
+      end
+      Bullet.end_request if Bullet.enable?
+    end
+
     private
       def for_each_active_notifier_with_notification
         UniformNotifier.active_notifiers.each do |notifier|

data/lib/bullet/dependency.rb

@@ -1,21 +1,15 @@
 module Bullet
   module Dependency
     def mongoid?
-      @mongoid ||= begin
-                     require 'mongoid'
-                     mongoid_version.present?
-                   rescue LoadError
-                     false
-                   end
+      @mongoid ||= defined? ::Mongoid
     end
 
     def active_record?
-      @active_record ||= begin
-                           require 'active_record'
-                           true
-                         rescue LoadError
-                           false
-                         end
+      @active_record ||= defined? ::ActiveRecord
+    end
+
+    def rails?
+      @rails ||= defined? ::Rails
     end
 
     def active_record_version
@@ -36,16 +30,18 @@ module Bullet
                                'mongoid2x'
                              elsif mongoid3x?
                                'mongoid3x'
+                             elsif mongoid4x?
+                               'mongoid4x'
                              end
                            end
     end
 
     def active_record3?
-      ::ActiveRecord::VERSION::MAJOR == 3
+      active_record? && ::ActiveRecord::VERSION::MAJOR == 3
     end
 
     def active_record4?
-      ::ActiveRecord::VERSION::MAJOR == 4
+      active_record? && ::ActiveRecord::VERSION::MAJOR == 4
     end
 
     def active_record30?
@@ -61,20 +57,15 @@ module Bullet
     end
 
     def mongoid2x?
-      ::Mongoid::VERSION =~ /\A2\.[4|5]/
+      mongoid? && ::Mongoid::VERSION =~ /\A2\.[4-8]/
     end
 
     def mongoid3x?
-      ::Mongoid::VERSION =~ /\A3/
+      mongoid? && ::Mongoid::VERSION =~ /\A3/
     end
 
-    def rails?
-      @rails ||= begin
-                   require 'rails'
-                   true
-                 rescue LoadError
-                   false
-               end
+    def mongoid4x?
+      mongoid? && ::Mongoid::VERSION =~ /\A4/
     end
   end
 end

data/lib/bullet/mongoid4x.rb

@@ -0,0 +1,55 @@
+module Bullet
+  module Mongoid
+    def self.enable
+      require 'mongoid'
+      ::Mongoid::Contextual::Mongo.class_eval do
+        alias_method :origin_first, :first
+        alias_method :origin_last, :last
+        alias_method :origin_each, :each
+        alias_method :origin_eager_load, :eager_load
+
+        def first
+          result = origin_first
+          Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+          result
+        end
+
+        def last
+          result = origin_last
+          Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+          result
+        end
+
+        def each(&block)
+          records = query.map{ |doc| ::Mongoid::Factory.from_db(klass, doc) }
+          if records.length > 1
+            Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
+          elsif records.size == 1
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
+          end
+          origin_each(&block)
+        end
+
+        def eager_load(docs)
+          associations = criteria.inclusions.map(&:name)
+          docs.each do |doc|
+            Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations)
+          end
+          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(docs, associations)
+          origin_eager_load(docs)
+        end
+      end
+
+      ::Mongoid::Relations::Accessors.class_eval do
+        alias_method :origin_set_relation, :set_relation
+
+        def set_relation(name, relation)
+          if relation && relation.metadata.macro !~ /embed/
+            Bullet::Detector::NPlusOneQuery.call_association(self, name)
+          end
+          origin_set_relation(name, relation)
+        end
+      end
+    end
+  end
+end