bullet 4.7.0 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04c7b4ccf13c0c17abfc2372d3d543f1195ba4ac
-  data.tar.gz: 71ab59fc2ebe3a2a51c77307f817b74aa5a4c601
+  metadata.gz: 4ebb362baca8a029544d754fed872a09f7033377
+  data.tar.gz: f12124695713d21526305a4c381160048cdc93d6
 SHA512:
-  metadata.gz: e5393d00b0a8f45977c7bd0695e55e12d57abd49f07fa22db185a2678a88d88c67596515a3ac97c7c077237d6c51832a3372caa3ecdcfb17d61bd41044e3b123
-  data.tar.gz: 25938fefe651d07838c8dc2f98785194ed2b48f7c6eb333be6b0029fd74a6fc8aeb3b85b7795cb5eed89d3d8d21d52b98b7ffea11ab1092551ad730748353dd8
+  metadata.gz: 7aac621e2ddb3931bb385017401121641027980ebddf0d82d1b43c9a71040a7c2eba3af2c4cb7862d69f9c31c99ac1e124f6a60bd9be6e8388199c187effc98f
+  data.tar.gz: 721e946c60ebc8de7bd6c609abb90a9fd29c5c4df2ac275b8bb607e64cffcd86887fa7fc0c82fdd86303faf77d251519b49314dc9af1032131af039b9fd5f868

data/.gitignore

@@ -11,3 +11,4 @@ benchmark_profile*
 /nbproject/private/
 coverage/
 .coveralls.yml
+Gemfile*.lock

data/.travis.yml

@@ -1,20 +1,20 @@
 language: ruby
 rvm:
-  - 2.0.0
+  - 2.1.0
 gemfile:
-  - Gemfile.rails-4.0.1
-  - Gemfile.rails-3.2.15
-  - Gemfile.rails-3.1.12
-  - Gemfile.rails-3.0.20
-  - Gemfile.mongoid-3.1.5
-  - Gemfile.mongoid-3.0.23
-  - Gemfile.mongoid-2.7.1
-  - Gemfile.mongoid-2.8.1
-  - Gemfile.mongoid-2.6.0
-  - Gemfile.mongoid-2.5.2
-  - Gemfile.mongoid-2.4.12
-env: DB=sqlite
-services: mongodb
-before_install:
-  - gem uninstall json
-  - gem install bundler
+  - Gemfile.rails-4.1
+  - Gemfile.rails-4.0
+  - Gemfile.rails-3.2
+  - Gemfile.rails-3.1
+  - Gemfile.rails-3.0
+  - Gemfile.mongoid-3.1
+  - Gemfile.mongoid-3.0
+  - Gemfile.mongoid-2.8
+  - Gemfile.mongoid-2.7
+  - Gemfile.mongoid-2.6
+  - Gemfile.mongoid-2.5
+  - Gemfile.mongoid-2.4
+env:
+  - DB=sqlite
+services:
+  - mongodb

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Next Release
 
+## 4.8.0 (02/16/2014)
+
+* Support rails 4.1.0.beta1
+* Update specs to be RSepc 3.0 compatible
+* Update latest minor version activerecord and mongoid on travis
+
+## 4.7.0 (11/03/2013)
+
+* Add coverall support
+* Add helper to profile code outside a request
+* Add activesupport dependency
+* Add Bullet.raise notification
+* Add Bullet.add_footer notification
+* Fix activerecord4 warnings in test code
+
 ## 4.6.0 (04/18/2013)
 
 * Fix Bullet::Rack to support sinatra

data/Gemfile

@@ -3,8 +3,10 @@ source "https://rubygems.org"
 gemspec
 
 gem 'rails', github: 'rails/rails'
-gem 'sqlite3'
-gem 'mysql2'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+gem 'mysql2', platforms: [:ruby]
+gem 'activerecord-jdbcmysql-adapter', platforms: [:jruby]
 gem 'activerecord-import'
 
 gem "rspec"
@@ -12,3 +14,8 @@ gem "guard"
 gem "guard-rspec"
 
 gem 'coveralls', require: false
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius-developer_tools'
+end

data/Gemfile.mongoid-2.4

@@ -0,0 +1,22 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.2.16'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+gem 'mysql2', platforms: [:ruby]
+gem 'activerecord-jdbcmysql-adapter', platforms: [:jruby]
+gem 'activerecord-import'
+gem 'mongoid', '~> 2.4.12'
+
+gem "rspec"
+gem "guard"
+gem "guard-rspec"
+
+gem 'coveralls', require: false
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius-developer_tools'
+end

data/Gemfile.mongoid-2.5

@@ -0,0 +1,22 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.2.16'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+gem 'mysql2', platforms: [:ruby]
+gem 'activerecord-jdbcmysql-adapter', platforms: [:jruby]
+gem 'activerecord-import'
+gem 'mongoid', '~> 2.5.2'
+
+gem "rspec"
+gem "guard"
+gem "guard-rspec"
+
+gem 'coveralls', require: false
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius-developer_tools'
+end

data/Gemfile.mongoid-2.6

@@ -0,0 +1,22 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.2.16'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+gem 'mysql2', platforms: [:ruby]
+gem 'activerecord-jdbcmysql-adapter', platforms: [:jruby]
+gem 'activerecord-import'
+gem 'mongoid', '~> 2.6.0'
+
+gem "rspec"
+gem "guard"
+gem "guard-rspec"
+
+gem 'coveralls', require: false
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius-developer_tools'
+end

data/Gemfile.mongoid-2.7

@@ -0,0 +1,22 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.2.16'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+gem 'mysql2', platforms: [:ruby]
+gem 'activerecord-jdbcmysql-adapter', platforms: [:jruby]
+gem 'activerecord-import'
+gem 'mongoid', '~> 2.7.1'
+
+gem "rspec"
+gem "guard"
+gem "guard-rspec"
+
+gem 'coveralls', require: false
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius-developer_tools'
+end

data/Gemfile.mongoid-2.8

@@ -0,0 +1,22 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.2'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+gem 'mysql2', platforms: [:ruby]
+gem 'activerecord-jdbcmysql-adapter', platforms: [:jruby]
+gem 'activerecord-import'
+gem 'mongoid', '~> 2.8'
+
+gem "rspec"
+gem "guard"
+gem "guard-rspec"
+
+gem 'coveralls', require: false
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius-developer_tools'
+end

data/Gemfile.mongoid-3.0

@@ -0,0 +1,22 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.2.16'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+gem 'mysql2', platforms: [:ruby]
+gem 'activerecord-jdbcmysql-adapter', platforms: [:jruby]
+gem 'activerecord-import'
+gem 'mongoid', '~> 3.0.23'
+
+gem "rspec"
+gem "guard"
+gem "guard-rspec"
+
+gem 'coveralls', require: false
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius-developer_tools'
+end

data/Gemfile.mongoid-3.1

@@ -0,0 +1,22 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.2.16'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+gem 'mysql2', platforms: [:ruby]
+gem 'activerecord-jdbcmysql-adapter', platforms: [:jruby]
+gem 'activerecord-import'
+gem 'mongoid', '~> 3.1.6'
+
+gem "rspec"
+gem "guard"
+gem "guard-rspec"
+
+gem 'coveralls', require: false
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius-developer_tools'
+end

data/Gemfile.rails-3.0

@@ -0,0 +1,21 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.0.20'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+gem 'mysql2', platforms: [:ruby]
+gem 'activerecord-jdbcmysql-adapter', platforms: [:jruby]
+gem 'activerecord-import'
+
+gem "rspec"
+gem "guard"
+gem "guard-rspec"
+
+gem 'coveralls', require: false
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius-developer_tools'
+end

data/Gemfile.rails-3.1

@@ -0,0 +1,21 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.1.12'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+gem 'mysql2', platforms: [:ruby]
+gem 'activerecord-jdbcmysql-adapter', platforms: [:jruby]
+gem 'activerecord-import'
+
+gem "rspec"
+gem "guard"
+gem "guard-rspec"
+
+gem 'coveralls', require: false
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius-developer_tools'
+end

data/Gemfile.rails-3.2

@@ -0,0 +1,21 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.2.15'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+gem 'mysql2', platforms: [:ruby]
+gem 'activerecord-jdbcmysql-adapter', platforms: [:jruby]
+gem 'activerecord-import'
+
+gem "rspec"
+gem "guard"
+gem "guard-rspec"
+
+gem 'coveralls', require: false
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius-developer_tools'
+end

data/Gemfile.rails-4.0

@@ -0,0 +1,21 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 4.0.1'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+gem 'mysql2', platforms: [:ruby]
+gem 'activerecord-jdbcmysql-adapter', platforms: [:jruby]
+gem 'activerecord-import'
+
+gem "rspec"
+gem "guard"
+gem "guard-rspec"
+
+gem 'coveralls', require: false
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius-developer_tools'
+end

data/{Gemfile.rails-3.0.20 → Gemfile.rails-4.1}

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '3.0.20'
+gem 'rails', '4.1.0.beta1'
 gem 'sqlite3'
 gem 'mysql2'
 gem 'activerecord-import'

data/README.md

@@ -3,14 +3,14 @@
 [![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)
-
+<a href="https://codeclimate.com/github/flyerhzm/bullet"><img src="https://codeclimate.com/github/flyerhzm/bullet.png" /></a>
 [![Coderwall Endorse](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.
 
-Bullet gem now supports **activerecord** 3.0, 3.1, 3.2, 4.0 and **mongoid** >= 2.4.1.
+Bullet gem now supports **activerecord** >= 3.0 and **mongoid** >= 2.4.1.
 
 If you use activercord 2.x, please use bullet <= 4.5.0
 
@@ -27,7 +27,6 @@ You can install it as a gem:
 
 ```
 gem install bullet
-
 ```
 
 or add it into a Gemfile (Bundler):
@@ -138,40 +137,42 @@ If you find bullet does not work for you, *please disable your browser's cache*.
 
 ## Advanced
 
-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:
+### Profile a job
+
+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 use use profile method and fetch warnings
 
 ```ruby
 Bullet.profile do
-  # run job
+  # do anything
 end
+warnings = Bullet.warnings
 ```
 
-Or to use it in test mode:
+### Run in tests
 
-```ruby
-before(:each)
-  Bullet.start_request if Bullet.enable?
-end
+First you need to enable bullet in test environment.
 
-after(:each)
-  if Bullet.enable? && Bullet.notification?
-    Bullet.perform_out_of_channel_notifications
-  end
-  Bullet.end_request if Bullet.enable?
+```ruby
+# config/environments/test.rb
+config.after_initialize do
+  Bullet.enable = true
+  Bullet.bullet_logger = true
+  Bullet.raise = true # raise an error if n+1 query occurs
 end
 ```
 
-Don't forget to enable bullet in your test environment.
-
-### API access
-
-after `profile`, you can fetch warnings then do whatever you want
+Then wrap each test in bullet api.
 
 ```ruby
-Bullet.profile do
-  # run anything
+# spec/spec_helper.rb
+before(:each) do
+  Bullet.start_request if Bullet.enable?
+end
+
+after(:each) do
+  Bullet.perform_out_of_channel_notifications if Bullet.enable? && Bullet.notification?
+  Bullet.end_request if Bullet.enable?
 end
-warnings = Bullet.warnings
 ```
 
 ## Contributors
@@ -402,4 +403,4 @@ In the meanwhile, there's a log appended into `log/bullet.log` file.
 ```
 
 
-Copyright (c) 2009 - 2013 Richard Huang (flyerhzm@gmail.com), released under the MIT license
+Copyright (c) 2009 - 2014 Richard Huang (flyerhzm@gmail.com), released under the MIT license

data/Rakefile

@@ -3,7 +3,6 @@ require "bundler"
 Bundler.setup
 
 require "rake"
-require "rdoc/task"
 require "rspec"
 require "rspec/core/rake_task"
 
@@ -35,11 +34,19 @@ RSpec::Core::RakeTask.new('spec:progress') do |spec|
   spec.pattern = "spec/**/*_spec.rb"
 end
 
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.title = "bullet #{Bullet::VERSION}"
-  rdoc.rdoc_files.include("README*")
-  rdoc.rdoc_files.include("lib/**/*.rb")
+
+begin
+  require 'rdoc/task'
+
+  desc "Generate documentation for the plugin."
+  Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = "rdoc"
+    rdoc.title = "bullet #{Bullet::VERSION}"
+    rdoc.rdoc_files.include("README*")
+    rdoc.rdoc_files.include("lib/**/*.rb")
+  end
+rescue LoadError
+  puts 'RDocTask is not supported for this platform'
 end
 
 task :default => :spec

data/bullet.gemspec

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

data/lib/bullet/active_record41.rb

@@ -0,0 +1,97 @@
+module Bullet
+  module ActiveRecord
+    def self.enable
+      require 'active_record'
+      ::ActiveRecord::Relation.class_eval do
+        alias_method :origin_to_a, :to_a
+        # if select a collection of objects, then these objects have possible to cause N+1 query.
+        # if select only one object, then the only one object has impossible to cause N+1 query.
+        def to_a
+          records = origin_to_a
+          if records.first.class.name !~ /^HABTM_/
+            if records.size > 1
+              Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
+              Bullet::Detector::CounterCache.add_possible_objects(records)
+            elsif records.size == 1
+              Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
+              Bullet::Detector::CounterCache.add_impossible_object(records.first)
+            end
+          end
+          records
+        end
+      end
+
+      ::ActiveRecord::Associations::Preloader.class_eval do
+        alias_method :origin_preloaders_on, :preloaders_on
+
+        def preloaders_on(association, records, scope)
+          if records.first.class.name !~ /^HABTM_/
+            records.each do |record|
+              Bullet::Detector::Association.add_object_associations(record, association)
+            end
+            Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, association)
+          end
+          origin_preloaders_on(association, records, scope)
+        end
+      end
+
+      ::ActiveRecord::FinderMethods.class_eval do
+        # add includes in scope
+        alias_method :origin_find_with_associations, :find_with_associations
+        def find_with_associations
+          records = origin_find_with_associations
+          associations = (eager_load_values + includes_values).uniq
+          records.each do |record|
+            Bullet::Detector::Association.add_object_associations(record, associations)
+            Bullet::Detector::NPlusOneQuery.call_association(record, associations)
+          end
+          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
+          records
+        end
+      end
+
+      ::ActiveRecord::Associations::JoinDependency.class_eval do
+        alias_method :origin_construct_model, :construct_model
+        # call join associations
+        def construct_model(record, node, row, model_cache, id, aliases)
+          associations = node.reflection.name
+          Bullet::Detector::Association.add_object_associations(record, associations)
+          Bullet::Detector::NPlusOneQuery.call_association(record, associations)
+          origin_construct_model(record, node, row, model_cache, id, aliases)
+        end
+      end
+
+      ::ActiveRecord::Associations::CollectionAssociation.class_eval do
+        # call one to many associations
+        alias_method :origin_load_target, :load_target
+        def load_target
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless @inversed
+          origin_load_target
+        end
+      end
+
+      ::ActiveRecord::Associations::SingularAssociation.class_eval do
+        # call has_one and belongs_to associations
+        alias_method :origin_reader, :reader
+        def reader(force_reload = false)
+          result = origin_reader(force_reload)
+          if @owner.class.name !~ /^HABTM_/
+            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless @inversed
+            Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
+          end
+          result
+        end
+      end
+
+      ::ActiveRecord::Associations::HasManyAssociation.class_eval do
+        alias_method :origin_has_cached_counter?, :has_cached_counter?
+
+        def has_cached_counter?(reflection = reflection)
+          result = origin_has_cached_counter?(reflection)
+          Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name) unless result
+          result
+        end
+      end
+    end
+  end
+end

data/lib/bullet/dependency.rb

@@ -18,8 +18,10 @@ module Bullet
                                      'active_record3'
                                    elsif active_record31? || active_record32?
                                      'active_record3x'
-                                   elsif active_record4?
+                                   elsif active_record40?
                                      'active_record4'
+                                   elsif active_record41?
+                                     'active_record41'
                                    end
                                  end
     end
@@ -56,6 +58,14 @@ module Bullet
       active_record3? && ::ActiveRecord::VERSION::MINOR == 2
     end
 
+    def active_record40?
+      active_record4? && ::ActiveRecord::VERSION::MINOR == 0
+    end
+
+    def active_record41?
+      active_record4? && ::ActiveRecord::VERSION::MINOR == 1
+    end
+
     def mongoid2x?
       mongoid? && ::Mongoid::VERSION =~ /\A2\.[4-8]/
     end

data/lib/bullet/mongoid4x.rb

@@ -44,7 +44,7 @@ module Bullet
         alias_method :origin_set_relation, :set_relation
 
         def set_relation(name, relation)
-          if relation && relation.metadata.macro !~ /embed/
+          if relation && relation.relation_metadata.macro !~ /embed/
             Bullet::Detector::NPlusOneQuery.call_association(self, name)
           end
           origin_set_relation(name, relation)

data/lib/bullet/registry/base.rb

@@ -33,7 +33,7 @@ module Bullet
       end
 
       def include?(key, value)
-        @registry[key] && @registry[key].include?(value)
+        !@registry[key].nil? && @registry[key].include?(value)
       end
     end
   end

data/lib/bullet/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Bullet
-  VERSION = "4.7.0"
+  VERSION = "4.8.0"
 end

data/lib/bullet.rb

@@ -66,7 +66,7 @@ module Bullet
 
     def add_whitelist(options)
       @whitelist[options[:type]][options[:class_name].classify] ||= []
-      @whitelist[options[:type]][options[:class_name].classify] << options[:association].to_s.tableize.to_sym
+      @whitelist[options[:type]][options[:class_name].classify] << options[:association]
     end
 
     def get_whitelist_associations(type, class_name)