bullet_instructure 4.0.5 → 4.14.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98a4fd498802478eaf995e91645dcd5fa4722103
-  data.tar.gz: 2c74f0ebd2ab028a4e0f9ae3a1a1eac4e45ff849
+  metadata.gz: 386728c2453beb337c1e0870abbfc8349caa5486
+  data.tar.gz: 59afaf0d90531cf32716444bdff369c03f94726d
 SHA512:
-  metadata.gz: f0b57d0a603bab53bdbe33f40afa8d8e30694200827f5cbebbc05cfed147e180823200278852171e5a6b7fcfe6b61e24d63cf7221dc93548501c790c462b3d4b
-  data.tar.gz: fcf37e95d84a32a773cbb7dd2685819f95990ed29767825c162d48527154a349119b085a66551c1321f43ff6d7a199e6ededb2072b92bb75f4999699924a269a
+  metadata.gz: 6b5cb202734160f6311a1a681d7028337fb70282e9ca0a910817d28d718641e4585f488d47f7b996cc1528a9c1ef34e4c9f9496c7f56877ab8403e1e354b7798
+  data.tar.gz: f1e29ce313199b9dc756807f420ef85a19023337640b2c4ac24758d84e90ad734f37d0a6f8f25fe15f6a1d1fb9f8507c84488f6081d7d78d17849bdfaf62f518

data/.travis.yml

@@ -1,12 +1,16 @@
 language: ruby
 rvm:
-  - 2.1.2
+  - 2.0
+  - 2.1
+  - 2.2
 gemfile:
+  - Gemfile.rails-4.2
   - Gemfile.rails-4.1
   - Gemfile.rails-4.0
   - Gemfile.rails-3.2
   - Gemfile.rails-3.1
   - Gemfile.rails-3.0
+  - Gemfile.mongoid-4.0
   - Gemfile.mongoid-3.1
   - Gemfile.mongoid-3.0
   - Gemfile.mongoid-2.8
@@ -18,3 +22,25 @@ env:
   - DB=sqlite
 services:
   - mongodb
+matrix:
+  exclude:
+    - rvm: 2.2
+      gemfile: Gemfile.rails-3.0
+    - rvm: 2.2
+      gemfile: Gemfile.rails-3.1
+    - rvm: 2.2
+      gemfile: Gemfile.rails-3.2
+    - rvm: 2.2
+      gemfile: Gemfile.mongoid-3.1
+    - rvm: 2.2
+      gemfile: Gemfile.mongoid-3.0
+    - rvm: 2.2
+      gemfile: Gemfile.mongoid-2.8
+    - rvm: 2.2
+      gemfile: Gemfile.mongoid-2.7
+    - rvm: 2.2
+      gemfile: Gemfile.mongoid-2.6
+    - rvm: 2.2
+      gemfile: Gemfile.mongoid-2.5
+    - rvm: 2.2
+      gemfile: Gemfile.mongoid-2.4

data/CHANGELOG.md

@@ -1,10 +1,52 @@
 # Next Release
 
-## 4.12.0 (not released yet)
+## 4.14.6
 
-* Use primary_key rather than id for bullet_ar_key
+* Fix false positive with `belongs_to` -> `belongs_to` for active\_record 4.2
+* Activate active\_record hacks only when Bullet already start
+
+## 4.14.5
+
+* Don't execute query when running `to_sql`
+* Send backtrace to `uniform_notifier`
+* Fix sse response check
+* Dynamically delegate available notifiers to UniformNotifier
+
+## 4.14.4
+
+* Fix false N + 1 warnings on Rails 4.2
+
+## 4.14.3
+
+* Fix false positive on create
+
+## 4.14.2
+
+* Hotfix nil object when `add_impossible_object`
+
+## 4.14.1
+
+* Fix `has_one` then `has_many` associations in rails 4.2
+* Append js and dom to html body in proper position
+
+## 4.14.0 (10/03/2014)
+
+* Support rails 4.2
+* Polish notification output
+* Fix warning: `*' interpreted as argument prefix
+
+## 4.13.0 (07/19/2014)
+
+* Support include? call on ar associations
+
+## 4.12.0 (07/13/2014)
+
+* 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)
 

data/Gemfile.mongoid

@@ -8,7 +8,5 @@ gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'mongoid', github: 'mongoid/mongoid'
 
 gem "rspec"
-gem "guard"
-gem "guard-rspec"
 
 gem 'coveralls', require: false

data/Gemfile.mongoid-2.4

@@ -2,14 +2,12 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 3.2.16'
+gem 'rails', '~> 3.2.0'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
-gem 'mongoid', '~> 2.4.12'
+gem 'mongoid', '~> 2.4.0'
 
 gem "rspec"
-gem "guard"
-gem "guard-rspec"
 
 gem 'coveralls', require: false
 

data/Gemfile.mongoid-2.5

@@ -2,14 +2,12 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 3.2.16'
+gem 'rails', '~> 3.2.0'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
-gem 'mongoid', '~> 2.5.2'
+gem 'mongoid', '~> 2.5.0'
 
 gem "rspec"
-gem "guard"
-gem "guard-rspec"
 
 gem 'coveralls', require: false
 

data/Gemfile.mongoid-2.6

@@ -2,14 +2,12 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 3.2.16'
+gem 'rails', '~> 3.2.0'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'mongoid', '~> 2.6.0'
 
 gem "rspec"
-gem "guard"
-gem "guard-rspec"
 
 gem 'coveralls', require: false
 

data/Gemfile.mongoid-2.7

@@ -2,14 +2,12 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 3.2.16'
+gem 'rails', '~> 3.2.0'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
-gem 'mongoid', '~> 2.7.1'
+gem 'mongoid', '~> 2.7.0'
 
 gem "rspec"
-gem "guard"
-gem "guard-rspec"
 
 gem 'coveralls', require: false
 

data/Gemfile.mongoid-2.8

@@ -2,14 +2,12 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 3.2'
+gem 'rails', '~> 3.2.0'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
-gem 'mongoid', '~> 2.8'
+gem 'mongoid', '~> 2.8.0'
 
 gem "rspec"
-gem "guard"
-gem "guard-rspec"
 
 gem 'coveralls', require: false
 

data/Gemfile.mongoid-3.0

@@ -2,14 +2,12 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 3.2.16'
+gem 'rails', '~> 3.2.0'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
-gem 'mongoid', '~> 3.0.23'
+gem 'mongoid', '~> 3.0.0'
 
 gem "rspec"
-gem "guard"
-gem "guard-rspec"
 
 gem 'coveralls', require: false
 

data/Gemfile.mongoid-3.1

@@ -2,14 +2,12 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 3.2.16'
+gem 'rails', '~> 3.2.0'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
-gem 'mongoid', '~> 3.1.6'
+gem 'mongoid', '~> 3.1.0'
 
 gem "rspec"
-gem "guard"
-gem "guard-rspec"
 
 gem 'coveralls', require: false
 

data/Gemfile.mongoid-4.0

@@ -2,14 +2,12 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 4.0.5'
+gem 'rails', '~> 4.0.0'
 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"
-gem "guard-rspec"
 
 gem 'coveralls', require: false
 

data/Gemfile.rails-3.0

@@ -2,14 +2,12 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 3.0.20'
+gem 'rails', '~> 3.0.0'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'activerecord-import'
 
 gem "rspec"
-gem "guard"
-gem "guard-rspec"
 
 gem 'coveralls', require: false
 

data/Gemfile.rails-3.1

@@ -2,14 +2,12 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 3.1.12'
+gem 'rails', '~> 3.1.0'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'activerecord-import'
 
 gem "rspec"
-gem "guard"
-gem "guard-rspec"
 
 gem 'coveralls', require: false
 

data/Gemfile.rails-3.2

@@ -2,14 +2,12 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 3.2.18'
+gem 'rails', '~> 3.2.0'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'activerecord-import'
 
 gem "rspec"
-gem "guard"
-gem "guard-rspec"
 
 gem 'coveralls', require: false
 

data/Gemfile.rails-4.0

@@ -2,14 +2,12 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 4.0.5'
+gem 'rails', '~> 4.0.0'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'activerecord-import'
 
 gem "rspec"
-gem "guard"
-gem "guard-rspec"
 
 gem 'coveralls', require: false
 

data/Gemfile.rails-4.1

@@ -2,14 +2,12 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 4.1.1'
+gem 'rails', '~> 4.1.0'
 gem 'sqlite3'
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'activerecord-import'
 
 gem "rspec"
-gem "guard"
-gem "guard-rspec"
 
 gem 'coveralls', require: false
 

data/Gemfile.rails-4.2

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

data/README.md

@@ -12,7 +12,7 @@ Best practice is to use Bullet in development mode or custom mode (staging, prof
 
 Bullet gem now supports **activerecord** >= 3.0 and **mongoid** >= 2.4.1.
 
-If you use activercord 2.x, please use bullet <= 4.5.0
+If you use activerecord 2.x, please use bullet <= 4.5.0
 
 ## External Introduction
 
@@ -53,42 +53,55 @@ config.after_initialize do
                   :receiver => 'your_account@jabber.org',
                   :show_online_status => true }
   Bullet.rails_logger = true
+  Bullet.honeybadger = true
   Bullet.bugsnag = true
   Bullet.airbrake = true
+  Bullet.rollbar = true
   Bullet.add_footer = true
   Bullet.stacktrace_includes = [ 'your_gem', 'your_middleware' ]
+  Bullet.slack = { webhook_url: 'http://some.slack.url', foo: 'bar' }
 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
 * `Bullet.alert`: pop up a JavaScript alert in the browser
 * `Bullet.bullet_logger`: log to the Bullet log file (Rails.root/log/bullet.log)
 * `Bullet.rails_logger`: add warnings directly to the Rails log
+* `Bullet.honeybadger`: add notifications to Honeybadger
+* `Bullet.bugsnag`: add notifications to bugsnag
 * `Bullet.airbrake`: add notifications to airbrake
+* `Bullet.rollbar`: add notifications to rollbar
 * `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.slack`: add notifications to slack
 
-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,24 +149,25 @@ 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
   # do anything
+
+  warnings = Bullet.warnings
 end
-warnings = Bullet.warnings
 ```
 
 ### Work with sinatra
 
-Configure and use bullet rack
+Configure and use `Bullet::Rack`
 
 ```ruby
 configure :development do
@@ -165,7 +179,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,7 +190,7 @@ config.after_initialize do
 end
 ```
 
-Then wrap each test in bullet api.
+Then wrap each test in Bullet api.
 
 ```ruby
 # spec/spec_helper.rb
@@ -194,18 +208,18 @@ 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
@@ -215,7 +229,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
@@ -227,7 +241,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')
@@ -238,7 +252,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| %>
@@ -252,7 +266,7 @@ post2.comments.create(:name => 'fourth')
 <% end %>
 ```
 
-5\. add bullet gem to `Gemfile`
+5\. Add the `bullet` gem to the `Gemfile`
 
 ```ruby
 gem "bullet"
@@ -264,7 +278,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
@@ -279,13 +293,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:
@@ -294,7 +308,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
 
@@ -309,7 +323,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"
@@ -317,8 +331,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
@@ -331,18 +344,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`
 
@@ -368,7 +381,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:
@@ -377,14 +390,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
@@ -410,19 +423,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
+Copyright (c) 2009 - 2015 Richard Huang (flyerhzm@gmail.com), released under the MIT license