bullet_instructure 4.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 - 2010 Richard Huang (flyerhzm@gmail.com)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,428 @@
+# 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)
+<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 and **mongoid** >= 2.4.1.
+
+If you use activercord 2.x, please use bullet <= 4.5.0
+
+## 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)
+
+## Install
+
+You can install it as a gem:
+
+```
+gem install bullet
+```
+
+or add it into a Gemfile (Bundler):
+
+
+```ruby
+gem "bullet", :group => "development"
+```
+
+## Configuration
+
+Bullet won't do ANYTHING unless you tell it to explicitly. Append to
+`config/environments/development.rb` initializer with the following code:
+
+```ruby
+config.after_initialize do
+  Bullet.enable = true
+  Bullet.alert = true
+  Bullet.bullet_logger = true
+  Bullet.console = true
+  Bullet.growl = true
+  Bullet.xmpp = { :account  => 'bullets_account@jabber.org',
+                  :password => 'bullets_password_for_jabber',
+                  :receiver => 'your_account@jabber.org',
+                  :show_online_status => true }
+  Bullet.rails_logger = true
+  Bullet.bugsnag = true
+  Bullet.airbrake = true
+  Bullet.add_footer = true
+  Bullet.stacktrace_includes = [ 'your_gem', 'your_middleware' ]
+end
+```
+
+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.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.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.
+
+```ruby
+Bullet.n_plus_one_query_enable = false
+Bullet.unused_eager_loading_enable = false
+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
+
+```ruby
+Bullet.add_whitelist :type => :n_plus_one_query, :class_name => "Post", :association => :comments
+Bullet.add_whitelist :type => :unused_eager_loading, :class_name => "Post", :association => :comments
+Bullet.add_whitelist :type => :counter_cache, :class_name => "Country", :association => :cities
+```
+
+## Log
+
+The Bullet log `log/bullet.log` will look something like this:
+
+* N+1 Query:
+
+```
+2009-08-25 20:40:17[INFO] N+1 Query: PATH_INFO: /posts;    model: Post => associations: [comments]·
+Add to your finder: :include => [:comments]
+2009-08-25 20:40:17[INFO] N+1 Query: method call stack:·
+/Users/richard/Downloads/test/app/views/posts/index.html.erb:11:in `_run_erb_app47views47posts47index46html46erb'
+/Users/richard/Downloads/test/app/views/posts/index.html.erb:8:in `each'
+/Users/richard/Downloads/test/app/views/posts/index.html.erb:8:in `_run_erb_app47views47posts47index46html46erb'
+/Users/richard/Downloads/test/app/controllers/posts_controller.rb:7:in `index'
+```
+
+The first two lines are notifications that N+1 queries have been encountered. The remaining lines are stack traces so you can find exactly where the queries were invoked in your code, and fix them.
+
+* Unused eager loading:
+
+```
+2009-08-25 20:53:56[INFO] Unused eager loadings: PATH_INFO: /posts;    model: Post => associations: [comments]·
+Remove from your finder: :include => [:comments]
+```
+
+These two lines are notifications that unused eager loadings have been encountered.
+
+* Need counter cache:
+
+```
+2009-09-11 09:46:50[INFO] Need Counter Cache
+  Post => [:comments]
+```
+
+## Growl, XMPP/Jabber and Airbrake Support
+
+see [https://github.com/flyerhzm/uniform_notifier](https://github.com/flyerhzm/uniform_notifier)
+
+## Important
+
+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
+
+```ruby
+Bullet.profile do
+  # do anything
+end
+warnings = Bullet.warnings
+```
+
+### Work with sinatra
+
+Configure and use bullet rack
+
+```ruby
+configure :development do
+  Bullet.enable = true
+  Bullet.bullet_logger = true
+  use Bullet::Rack
+end
+```
+
+### Run in tests
+
+First you need to enable bullet in test environment.
+
+```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
+```
+
+Then wrap each test in bullet api.
+
+```ruby
+# spec/spec_helper.rb
+if Bullet.enable?
+  config.before(:each) do
+    Bullet.start_request
+  end
+
+  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.
+
+## Contributors
+
+[https://github.com/flyerhzm/bullet/contributors](https://github.com/flyerhzm/bullet/contributors)
+
+## Step by step example
+
+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.
+
+1\. setup test environment
+
+```
+$ rails new test_bullet
+$ cd test_bullet
+$ rails g scaffold post name:string
+$ 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`
+
+```ruby
+class Post < ActiveRecord::Base
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+end
+```
+
+3\. go to `rails c` and execute
+
+```ruby
+post1 = Post.create(:name => 'first')
+post2 = Post.create(:name => 'second')
+post1.comments.create(:name => 'first')
+post1.comments.create(:name => 'second')
+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
+
+```
+<% @posts.each do |post| %>
+  <tr>
+    <td><%= post.name %></td>
+    <td><%= post.comments.map(&:name) %></td>
+    <td><%= link_to 'Show', post %></td>
+    <td><%= link_to 'Edit', edit_post_path(post) %></td>
+    <td><%= link_to 'Destroy', post, :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<% end %>
+```
+
+5\. add bullet gem to `Gemfile`
+
+```ruby
+gem "bullet"
+```
+
+And run
+
+```
+bundle install
+```
+
+6\. enable the bullet gem in development, add a line to
+`config/environments/development.rb`
+
+```ruby
+config.after_initialize do
+  Bullet.enable = true
+  Bullet.alert = true
+  Bullet.bullet_logger = true
+  Bullet.console = true
+#  Bullet.growl = true
+  Bullet.rails_logger = true
+  Bullet.add_footer = true
+end
+```
+
+7\. start server
+
+```
+$ rails s
+```
+
+8\. input http://localhost:3000/posts in browser, then you will see a popup alert box says
+
+```
+The request has unused preload associations as follows:
+None
+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.
+
+In the meanwhile, there's a log appended into `log/bullet.log` file
+
+```
+2010-03-07 14:12:18[INFO] N+1 Query in /posts
+  Post => [:comments]
+  Add to your finder: :include => [:comments]
+2010-03-07 14:12:18[INFO] N+1 Query method call stack
+  /home/flyerhzm/Downloads/test_bullet/app/views/posts/index.html.erb:14:in `_render_template__600522146_80203160_0'
+  /home/flyerhzm/Downloads/test_bullet/app/views/posts/index.html.erb:11:in `each'
+  /home/flyerhzm/Downloads/test_bullet/app/views/posts/index.html.erb:11:in `_render_template__600522146_80203160_0'
+  /home/flyerhzm/Downloads/test_bullet/app/controllers/posts_controller.rb:7:in `index'
+```
+
+The generated SQLs are
+
+```
+Post Load (1.0ms)   SELECT * FROM "posts"
+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
+
+```ruby
+def index
+  @posts = Post.includes(:comments)
+
+  respond_to do |format|
+    format.html # index.html.erb
+    format.xml  { render :xml => @posts }
+  end
+end
+```
+
+10\. refresh http://localhost:3000/posts page, no alert box and no log appended.
+
+The generated SQLs are
+
+```
+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!
+
+11\. now simulate unused eager loading. Change
+`app/controllers/posts_controller.rb` and
+`app/views/posts/index.html.erb`
+
+```ruby
+def index
+  @posts = Post.includes(:comments)
+
+  respond_to do |format|
+    format.html # index.html.erb
+    format.xml  { render :xml => @posts }
+  end
+end
+```
+
+```
+<% @posts.each do |post| %>
+  <tr>
+    <td><%= post.name %></td>
+    <td><%= link_to 'Show', post %></td>
+    <td><%= link_to 'Edit', edit_post_path(post) %></td>
+    <td><%= link_to 'Destroy', post, :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<% end %>
+```
+
+12\. refresh http://localhost:3000/posts page, then you will see a popup alert box says
+
+```
+The request has unused preload associations as follows:
+model: Post => associations: [comment]
+The request has N+1 queries as follows:
+None
+```
+
+In the meanwhile, there's a log appended into `log/bullet.log` file
+
+```
+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`
+and `app/views/posts/index.html.erb`
+
+```ruby
+def index
+  @posts = Post.all
+
+  respond_to do |format|
+    format.html # index.html.erb
+    format.xml  { render :xml => @posts }
+  end
+end
+```
+
+```
+<% @posts.each do |post| %>
+  <tr>
+    <td><%= post.name %></td>
+    <td><%= post.comments.size %></td>
+    <td><%= link_to 'Show', post %></td>
+    <td><%= link_to 'Edit', edit_post_path(post) %></td>
+    <td><%= link_to 'Destroy', post, :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<% end %>
+```
+
+14\. refresh http://localhost:3000/posts page, then you will see a popup alert box says
+
+```
+Need counter cache
+  Post => [:comments]
+```
+
+In the meanwhile, there's a log appended into `log/bullet.log` file.
+
+```
+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/Rakefile

@@ -0,0 +1,52 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "bundler"
+Bundler.setup
+
+require "rake"
+require "rspec"
+require "rspec/core/rake_task"
+
+require "bullet/version"
+
+task :build do
+  system "gem build bullet_instructure.gemspec"
+end
+
+task :install => :build do
+  system "sudo gem install bullet_instructure-#{Bullet::VERSION}.gem"
+end
+
+task :release => :build do
+  puts "Tagging #{Bullet::VERSION}..."
+  system "git tag -a #{Bullet::VERSION} -m 'Tagging #{Bullet::VERSION}'"
+  puts "Pushing to Github..."
+  system "git push --tags"
+  puts "Pushing to rubygems.org..."
+  system "gem push bullet-#{Bullet::VERSION}.gem"
+end
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+RSpec::Core::RakeTask.new('spec:progress') do |spec|
+  spec.rspec_opts = %w(--format progress)
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+
+begin
+  require 'rdoc/task'
+
+  desc "Generate documentation for the plugin."
+  Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = "rdoc"
+    rdoc.title = "bullet_instructure #{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