bullet 4.10.0 → 4.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3badf3b077a980eaa5aff1923f4e73d702f5b91
-  data.tar.gz: f62fd9855dca76718f1abd484052e8b9ec841088
+  metadata.gz: b201e99b1db5ea0ae016eb415b8bdcb2141a0321
+  data.tar.gz: 072c423687b8482273549f30c2538edec5c3c03f
 SHA512:
-  metadata.gz: cd79339a18313dd651739d819f59d33ceee240ec595ff53a49b27133010d8a83e9274292907ccd99bd9b894b7d975c54e4a65b49f0907b08f0b70a4a994dc9e1
-  data.tar.gz: 3dbb60cf0426b5cfb0d1fc5ac1bed620d139aafbf798eae0a7ebe94915a8b17fcc0a745b587313007a2922826f0b396f4be290dc353832f0c5e2618bedb29c50
+  metadata.gz: 624bfcc8a8f2044699d19e598729cba0bf858e054002b435a31cce643d1bc3834139dad14ea510ef573a31059ce13f4b5c1dd892404645cca8d77e47264db794
+  data.tar.gz: ffaf8125f6797fd85b42be44f645e835796d623bc8b656662b8bd7387ac3b92882d4f2daaf2c50c04aced38113d7c96fbd8b3bdf631bd532c0a02663e221e1d1

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Next Release
 
+## 4.12.0
+
+* Fix false n+1 queries caused by inversed objects.
+* Replace .id with .primary_key_value
+* Rename bullet_ar_key to bullet_key
+* Fix rails sse detect
+* Fix bullet using in test environment
+* Memoize whoami
+
+## 4.11.0 (06/24/2014)
+
+* Support empty? call on ar associations
+* Skip detecting if object is a new record
+
+## 4.10.0 (06/06/2014)
+
+* Handle join query smarter
+* Support mongoid 4.0
+* Thread safe
+* Add debug mode
+
 ## 4.9.0 (04/30/2014)
 
 * Add Bullet.stacktrace_includes option

data/Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
 
@@ -7,9 +7,9 @@ gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'activerecord-import'
 
-gem "rspec"
-gem "guard"
-gem "guard-rspec"
+gem 'rspec'
+gem 'guard'
+gem 'guard-rspec'
 
 gem 'coveralls', require: false
 

data/Gemfile.mongoid-4.0

@@ -5,7 +5,7 @@ gemspec
 gem 'rails', '~> 4.0.5'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
-gem 'mongoid', '~> 4.0.0.beta2'
+gem 'mongoid', '~> 4.0.0'
 
 gem "rspec"
 gem "guard"

data/Gemfile.rails-3.2

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 3.2.18'
+gem 'rails', '~> 3.2.19'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'activerecord-import'

data/Gemfile.rails-4.0

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 4.0.5'
+gem 'rails', '~> 4.0.8'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'activerecord-import'

data/Gemfile.rails-4.1

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 4.1.1'
+gem 'rails', '~> 4.1.4'
 gem 'sqlite3'
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'activerecord-import'

data/README.md

@@ -60,7 +60,7 @@ config.after_initialize do
 end
 ```
 
-The notifier of bullet is a wrap of [uniform_notifier](https://github.com/flyerhzm/uniform_notifier)
+The notifier of Bullet is a wrap of [uniform_notifier](https://github.com/flyerhzm/uniform_notifier)
 
 The code above will enable all seven of the Bullet notification systems:
 * `Bullet.enable`: enable Bullet gem, otherwise do nothing
@@ -70,25 +70,31 @@ The code above will enable all seven of the Bullet notification systems:
 * `Bullet.airbrake`: add notifications to airbrake
 * `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.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.stacktrace_includes`: include paths with any of these substrings in the stack trace, even if they are not in your main app
 
-Bullet also allows you to disable n_plus_one_query, unused_eager_loading
-and counter_cache detectors respectively.
+Bullet also allows you to disable any of its detectors.
 
 ```ruby
-Bullet.n_plus_one_query_enable = false
+# Each of these settings defaults to true
+
+# Detect N+1 queries
+Bullet.n_plus_one_query_enable     = false
+
+# Detect eager-loaded associations which are not used
 Bullet.unused_eager_loading_enable = false
-Bullet.counter_cache_enable = false
+
+# Detect unnecessary COUNT queries which could be avoided
+# with a counter_cache
+Bullet.counter_cache_enable        = false
 ```
 
 ## Whitelist
 
-Sometimes bullet may notify n plus one query, unused eager loading or
-counter cache you don't care about or they occur in the third party gems
-that you can't fix, you can add whitelist to bullet
+Sometimes Bullet may notify you of query problems you don't care to fix, or
+which come from outside your code. You can whitelist these to ignore them:
 
 ```ruby
 Bullet.add_whitelist :type => :n_plus_one_query, :class_name => "Post", :association => :comments
@@ -136,13 +142,13 @@ see [https://github.com/flyerhzm/uniform_notifier](https://github.com/flyerhzm/u
 
 ## Important
 
-If you find bullet does not work for you, *please disable your browser's cache*.
+If you find Bullet does not work for you, *please disable your browser's cache*.
 
 ## Advanced
 
 ### 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
+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
@@ -153,7 +159,7 @@ warnings = Bullet.warnings
 
 ### Work with sinatra
 
-Configure and use bullet rack
+Configure and use `Bullet::Rack`
 
 ```ruby
 configure :development do
@@ -165,7 +171,7 @@ end
 
 ### Run in tests
 
-First you need to enable bullet in test environment.
+First you need to enable Bullet in test environment.
 
 ```ruby
 # config/environments/test.rb
@@ -176,34 +182,36 @@ config.after_initialize do
 end
 ```
 
-Then wrap each test in bullet api.
+Then wrap each test in Bullet api.
 
 ```ruby
 # spec/spec_helper.rb
-config.before(:each) do
-  Bullet.start_request if Bullet.enable?
-end
+if Bullet.enable?
+  config.before(:each) do
+    Bullet.start_request
+  end
 
-config.after(:each) do
-  Bullet.perform_out_of_channel_notifications if Bullet.enable? && Bullet.notification?
-  Bullet.end_request if Bullet.enable?
+  config.after(:each) do
+    Bullet.perform_out_of_channel_notifications if Bullet.notification?
+    Bullet.end_request
+  end
 end
 ```
 
 ## Debug Mode
 
-Bullet outputs some details info, to enable debug mode, set DEBUG=true
-env.
+Bullet outputs some details info, to enable debug mode, set
+`BULLET_DEBUG=true` env.
 
 ## Contributors
 
 [https://github.com/flyerhzm/bullet/contributors](https://github.com/flyerhzm/bullet/contributors)
 
-## Step by step example
+## Demo
 
-Bullet is designed to function as you browse through your application in development. It will alert you whenever it encounters N+1 queries or unused eager loading.
+Bullet is designed to function as you browse through your application in development. To see it in action, follow these steps to create, detect, and fix example query problems.
 
-1\. setup test environment
+1\. Create an example application
 
 ```
 $ rails new test_bullet
@@ -213,7 +221,7 @@ $ rails g scaffold comment name:string post_id:integer
 $ bundle exec rake db:migrate
 ```
 
-2\. change `app/model/post.rb` and `app/model/comment.rb`
+2\. Change `app/model/post.rb` and `app/model/comment.rb`
 
 ```ruby
 class Post < ActiveRecord::Base
@@ -225,7 +233,7 @@ class Comment < ActiveRecord::Base
 end
 ```
 
-3\. go to `rails c` and execute
+3\. Go to `rails c` and execute
 
 ```ruby
 post1 = Post.create(:name => 'first')
@@ -236,7 +244,7 @@ post2.comments.create(:name => 'third')
 post2.comments.create(:name => 'fourth')
 ```
 
-4\. change the `app/views/posts/index.html.erb` to produce a N+1 query
+4\. Change the `app/views/posts/index.html.erb` to produce a N+1 query
 
 ```
 <% @posts.each do |post| %>
@@ -250,7 +258,7 @@ post2.comments.create(:name => 'fourth')
 <% end %>
 ```
 
-5\. add bullet gem to `Gemfile`
+5\. Add the `bullet` gem to the `Gemfile`
 
 ```ruby
 gem "bullet"
@@ -262,7 +270,7 @@ And run
 bundle install
 ```
 
-6\. enable the bullet gem in development, add a line to
+6\. enable the Bullet gem in development, add a line to
 `config/environments/development.rb`
 
 ```ruby
@@ -277,13 +285,13 @@ config.after_initialize do
 end
 ```
 
-7\. start server
+7\. Start the server
 
 ```
 $ rails s
 ```
 
-8\. input http://localhost:3000/posts in browser, then you will see a popup alert box says
+8\. Visit `http://localhost:3000/posts` in browser, and you will see a popup alert box that says
 
 ```
 The request has unused preload associations as follows:
@@ -292,7 +300,7 @@ The request has N+1 queries as follows:
 model: Post => associations: [comment]
 ```
 
-which means there is a N+1 query from post object to comments associations.
+which means there is a N+1 query from the Post object to its Comment association.
 
 In the meanwhile, there's a log appended into `log/bullet.log` file
 
@@ -307,7 +315,7 @@ In the meanwhile, there's a log appended into `log/bullet.log` file
   /home/flyerhzm/Downloads/test_bullet/app/controllers/posts_controller.rb:7:in `index'
 ```
 
-The generated SQLs are
+The generated SQL is:
 
 ```
 Post Load (1.0ms)   SELECT * FROM "posts"
@@ -315,8 +323,7 @@ Comment Load (0.4ms)   SELECT * FROM "comments" WHERE ("comments".post_id = 1)
 Comment Load (0.3ms)   SELECT * FROM "comments" WHERE ("comments".post_id = 2)
 ```
 
-
-9\. fix the N+1 query, change `app/controllers/posts_controller.rb` file
+9\. To fix the N+1 query, change `app/controllers/posts_controller.rb` file
 
 ```ruby
 def index
@@ -329,18 +336,18 @@ def index
 end
 ```
 
-10\. refresh http://localhost:3000/posts page, no alert box and no log appended.
+10\. Refresh `http://localhost:3000/posts`. Now there's no alert box and nothing new in the log.
 
-The generated SQLs are
+The generated SQL is:
 
 ```
 Post Load (0.5ms)   SELECT * FROM "posts"
 Comment Load (0.5ms)   SELECT "comments".* FROM "comments" WHERE ("comments".post_id IN (1,2))
 ```
 
-a N+1 query fixed. Cool!
+N+1 query fixed. Cool!
 
-11\. now simulate unused eager loading. Change
+11\. Now simulate unused eager loading. Change
 `app/controllers/posts_controller.rb` and
 `app/views/posts/index.html.erb`
 
@@ -366,7 +373,7 @@ end
 <% end %>
 ```
 
-12\. refresh http://localhost:3000/posts page, then you will see a popup alert box says
+12\. Refresh `http://localhost:3000/posts`, and you will see a popup alert box that says
 
 ```
 The request has unused preload associations as follows:
@@ -375,14 +382,14 @@ The request has N+1 queries as follows:
 None
 ```
 
-In the meanwhile, there's a log appended into `log/bullet.log` file
+Meanwhile, there's a line appended to `log/bullet.log`
 
 ```
 2009-08-25 21:13:22[INFO] Unused preload associations: PATH_INFO: /posts;    model: Post => associations: [comments]·
 Remove from your finder: :include => [:comments]
 ```
 
-13\. simulate counter_cache. Change `app/controllers/posts_controller.rb`
+13\. Simulate counter_cache. Change `app/controllers/posts_controller.rb`
 and `app/views/posts/index.html.erb`
 
 ```ruby
@@ -408,19 +415,18 @@ end
 <% end %>
 ```
 
-14\. refresh http://localhost:3000/posts page, then you will see a popup alert box says
+14\. Refresh `http://localhost:3000/posts`, then you will see a popup alert box that says
 
 ```
 Need counter cache
   Post => [:comments]
 ```
 
-In the meanwhile, there's a log appended into `log/bullet.log` file.
+Meanwhile, there's a line appended to `log/bullet.log`
 
 ```
 2009-09-11 10:07:10[INFO] Need Counter Cache
   Post => [:comments]
 ```
 
-
 Copyright (c) 2009 - 2014 Richard Huang (flyerhzm@gmail.com), released under the MIT license

data/bullet.gemspec

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

data/lib/bullet/active_record3.rb

@@ -97,6 +97,12 @@ module Bullet
           Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
           origin_last(*args)
         end
+
+        alias_method :origin_empty?, :empty?
+        def empty?
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          origin_empty?
+        end
       end
 
       ::ActiveRecord::Associations::AssociationProxy.class_eval do
@@ -113,7 +119,7 @@ module Bullet
         alias_method :origin_set_inverse_instance, :set_inverse_instance
         def set_inverse_instance(record, instance)
           if record && we_can_set_the_inverse_on_this?(record)
-            Bullet::Detector::NPlusOneQuery.add_impossible_object(record)
+            Bullet::Detector::NPlusOneQuery.add_inversed_object(record, @reflection.inverse_of.name)
           end
           origin_set_inverse_instance(record, instance)
         end

data/lib/bullet/active_record3x.rb

@@ -85,6 +85,12 @@ module Bullet
           Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
           origin_load_target
         end
+
+        alias_method :origin_empty?, :empty?
+        def empty?
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          origin_empty?
+        end
       end
 
       ::ActiveRecord::Associations::SingularAssociation.class_eval do
@@ -102,7 +108,7 @@ module Bullet
         alias_method :origin_set_inverse_instance, :set_inverse_instance
         def set_inverse_instance(record)
           if record && invertible_for?(record)
-            Bullet::Detector::NPlusOneQuery.add_impossible_object(record)
+            Bullet::Detector::NPlusOneQuery.add_inversed_object(record, inverse_reflection_for(record).name)
           end
           origin_set_inverse_instance(record)
         end

data/lib/bullet/active_record4.rb

@@ -85,6 +85,12 @@ module Bullet
           Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
           origin_load_target
         end
+
+        alias_method :origin_empty?, :empty?
+        def empty?
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          origin_empty?
+        end
       end
 
       ::ActiveRecord::Associations::SingularAssociation.class_eval do
@@ -92,22 +98,12 @@ module Bullet
         alias_method :origin_reader, :reader
         def reader(force_reload = false)
           result = origin_reader(force_reload)
-          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless @inversed
           Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
           result
         end
       end
 
-      ::ActiveRecord::Associations::Association.class_eval do
-        alias_method :origin_set_inverse_instance, :set_inverse_instance
-        def set_inverse_instance(record)
-          if record && invertible_for?(record)
-            Bullet::Detector::NPlusOneQuery.add_impossible_object(record)
-          end
-          origin_set_inverse_instance(record)
-        end
-      end
-
       ::ActiveRecord::Associations::HasManyAssociation.class_eval do
         alias_method :origin_has_cached_counter?, :has_cached_counter?
 

data/lib/bullet/active_record41.rb

@@ -27,6 +27,7 @@ module Bullet
         def preloaders_on(association, records, scope)
           if records.first.class.name !~ /^HABTM_/
             records.each do |record|
+              next unless record
               Bullet::Detector::Association.add_object_associations(record, association)
             end
             Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, association)
@@ -86,6 +87,12 @@ module Bullet
           Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless @inversed
           origin_load_target
         end
+
+        alias_method :origin_empty?, :empty?
+        def empty?
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+          origin_empty?
+        end
       end
 
       ::ActiveRecord::Associations::SingularAssociation.class_eval do

data/lib/bullet/detector/association.rb

@@ -5,17 +5,19 @@ module Bullet
         def add_object_associations(object, associations)
           return unless Bullet.start?
           return if !Bullet.n_plus_one_query_enable? && !Bullet.unused_eager_loading_enable?
+          return unless object.primary_key_value
 
-          Bullet.debug("Detector::Association#add_object_associations", "object: #{object.bullet_ar_key}, associations: #{associations}")
-          object_associations.add(object.bullet_ar_key, associations)
+          Bullet.debug("Detector::Association#add_object_associations", "object: #{object.bullet_key}, associations: #{associations}")
+          object_associations.add(object.bullet_key, associations)
         end
 
         def add_call_object_associations(object, associations)
           return unless Bullet.start?
           return if !Bullet.n_plus_one_query_enable? && !Bullet.unused_eager_loading_enable?
+          return unless object.primary_key_value
 
-          Bullet.debug("Detector::Association#add_call_object_associations", "object: #{object.bullet_ar_key}, associations: #{associations}")
-          call_object_associations.add(object.bullet_ar_key, associations)
+          Bullet.debug("Detector::Association#add_call_object_associations", "object: #{object.bullet_key}, associations: #{associations}")
+          call_object_associations.add(object.bullet_key, associations)
         end
 
         private
@@ -46,13 +48,19 @@ module Bullet
           # impossible_objects keep the class to objects relationships
           # that the objects may not cause N+1 query.
           # e.g. { Post => ["Post:1", "Post:2"] }
-          # Notice: impossible_objects are not accurate,
           # if find collection returns only one object, then the object is impossible object,
           # impossible_objects are used to avoid treating 1+1 query to N+1 query.
           def impossible_objects
             Thread.current[:bullet_impossible_objects]
           end
 
+          # inversed_objects keeps object relationships
+          # that association is inversed.
+          # e.g. { "Comment:1" => ["post"] }
+          def inversed_objects
+            Thread.current[:bullet_inversed_objects]
+          end
+
           # eager_loadings keep the object relationships
           # that the associations are preloaded by find :include.
           # e.g. { ["Post:1", "Post:2"] => [:comments, :user] }

data/lib/bullet/detector/counter_cache.rb

@@ -5,9 +5,10 @@ module Bullet
         def add_counter_cache(object, associations)
           return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
+          return unless object.primary_key_value
 
-          Bullet.debug("Detector::CounterCache#add_counter_cache", "object: #{object.bullet_ar_key}, associations: #{associations}")
-          if conditions_met?(object.bullet_ar_key, associations)
+          Bullet.debug("Detector::CounterCache#add_counter_cache", "object: #{object.bullet_key}, associations: #{associations}")
+          if conditions_met?(object.bullet_key, associations)
             create_notification object.class.to_s, associations
           end
         end
@@ -15,18 +16,20 @@ module Bullet
         def add_possible_objects(object_or_objects)
           return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
-
           objects = Array(object_or_objects)
-          Bullet.debug("Detector::CounterCache#add_possible_objects", "objects: #{objects.map(&:bullet_ar_key).join(', ')}")
-          objects.each { |object| possible_objects.add object.bullet_ar_key }
+          return if objects.map(&:primary_key_value).compact.empty?
+
+          Bullet.debug("Detector::CounterCache#add_possible_objects", "objects: #{objects.map(&:bullet_key).join(', ')}")
+          objects.each { |object| possible_objects.add object.bullet_key }
         end
 
         def add_impossible_object(object)
           return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
+          return unless object.primary_key_value
 
-          Bullet.debug("Detector::CounterCache#add_impossible_object", "object: #{object.bullet_ar_key}")
-          impossible_objects.add object.bullet_ar_key
+          Bullet.debug("Detector::CounterCache#add_impossible_object", "object: #{object.bullet_key}")
+          impossible_objects.add object.bullet_key
         end
 
         private
@@ -47,8 +50,8 @@ module Bullet
             Thread.current[:bullet_counter_impossible_objects]
           end
 
-          def conditions_met?(bullet_ar_key, associations)
-            possible_objects.include?(bullet_ar_key) && !impossible_objects.include?(bullet_ar_key)
+          def conditions_met?(bullet_key, associations)
+            possible_objects.include?(bullet_key) && !impossible_objects.include?(bullet_key)
           end
       end
     end