brakefast 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8eb0828ea86e50b2c475a7d88359d907e350bc20
+  data.tar.gz: 40e8588718b3babe9075ae23d86deae3128090c0
+SHA512:
+  metadata.gz: c109fa8a8021c1f9b06d952f6edf71a9b860de7f4ed7c965050ae6fa3870f87908f99a72aac1852bd0540149ebcb55986b590faf59fded74ff2c8c51f37126a4
+  data.tar.gz: 0a193a1b9474c0a524030fbcbfcdcbfc1a8e76f684ff39ee155fbec1044ca95815d3ccbcb71ac3922898bfabcd6a5e5483156db04b8e79e9237c79e380a4c2c4

data/.gitignore

@@ -0,0 +1,14 @@
+log/**
+pkg/**
+.DS_Store
+lib/.DS_Store
+.*.swp
+coverage.data
+tags
+.bundle
+*.gem
+benchmark_profile*
+/nbproject/private/
+coverage/
+.coveralls.yml
+Gemfile*.lock

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format progress

data/.travis.yml

@@ -0,0 +1,48 @@
+sudo: false
+language: ruby
+rvm:
+  - 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-5.0
+  - Gemfile.mongoid-4.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
+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

@@ -0,0 +1,5 @@
+# Next Release
+
+## 0.0.1 (08/30/2015)
+
+* First release

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :all_after_pass => false, :all_on_start => false, :cli => "--color --format nested --fail-fast" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/Hacking.md

@@ -0,0 +1,74 @@
+# Bullet Overview for Developers
+
+This file aims to give developers a quick tour of the bullet internals, making
+it (hopefully) easier to extend or enhance the Bullet gem.
+
+## General Control Flow aka. 10000 Meter View
+
+When Rails is initialized, Bullet will extend ActiveRecord (and if you're using
+Rails 2.x ActiveController too) with the relevant modules and methods found
+in lib/bullet/active_recordX.rb and lib/bullet/action_controller2.rb. If you're
+running Rails 3, Bullet will integrate itself as a middleware into the Rack
+stack, so ActionController does not need to be extended.
+
+The ActiveRecord extensions will call methods in a given detector class, when
+certain methods are called.
+
+Detector classes contain all the logic to recognize
+a noteworthy event. If such an event is detected, an instance of the
+corresponding Notification class is created and stored in a Set instance in the
+main Bullet module (the 'notification collector').
+
+Notification instances contain the message that will be displayed, and will
+use a Presenter class to display their message to the user.
+
+So the flow of a request goes like this:
+1. Bullet.start_request is called, which resets all the detectors and empties
+   the notification collector
+2. The request is handled by Rails, and the installed ActiveRecord extensions
+   trigger Detector callbacks
+3. Detectors once called, will determine whether something noteworthy happend.
+   If yes, then a Notification is created and stored in the notification collector.
+4. Rails finishes handling the request
+5. For each notification in the collector, Bullet will iterate over each
+   Presenter and will try to generate an inline message that will be appended to
+   the generated response body.
+6. The response is returned to the client.
+7. Bullet will try to generate an out-of-channel message for each notification.
+8. Bullet calls end_request for each detector.
+9. Goto 1.
+
+## Adding Notification Types
+
+If you want to add more kinds of things that Bullet can detect, a little more
+work is needed than if you were just adding a Presenter, but the concepts are
+similar.
+
+* Add the class to the DETECTORS constant in the main Bullet module
+* Add (if needed) Rails monkey patches to Bullet.enable
+* Add an autoload directive to lib/bullet/detector.rb
+* Create a corresponding notification class in the Bullet::Notification namespace
+* Add an autoload directive to lib/bullet/notification.rb
+
+As a rule of thumb, you can assume that each Detector will have its own
+Notification class. If you follow the principle of Separation of Concerns I
+can't really think of an example where one would deviate from this rule.
+
+Since the detection of pathological associations is a bit hairy, I'd recommend
+having a look at the counter cache detector and associated notification to get
+a feel for what is needed to get off the ground.
+
+### Detectors
+
+The only things you'll need to consider when building your Detector class is
+that it will need to supply the .start_request, .end_request and .clear class
+methods.
+
+Simple implementations are provided by Bullet::Detector::Base for start_request
+and end_request, you will have to supply your own clear method.
+
+### Notifications
+
+For notifications you will want to supply a #title and #body instance method,
+and check to see if the #initialize and #full_notice methods in the
+Bullet::Notification::Base class fit your needs.

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,451 @@
+# Brakefast
+
+[![Gem Version](https://badge.fury.io/rb/brakefast.png)](http://badge.fury.io/rb/brakefast)
+[![Build Status](https://secure.travis-ci.org/flyerhzm/brakefast.png)](http://travis-ci.org/flyerhzm/brakefast)
+[![Coverage Status](https://coveralls.io/repos/flyerhzm/brakefast/badge.png?branch=master)](https://coveralls.io/r/flyerhzm/brakefast)
+<a href="https://codeclimate.com/github/flyerhzm/brakefast"><img src="https://codeclimate.com/github/flyerhzm/brakefast.png" /></a>
+[![Coderwall Endorse](http://api.coderwall.com/flyerhzm/endorsecount.png)](http://coderwall.com/flyerhzm)
+
+The Brakefast gem is designed to help you reduce your application's vulnerability. It will watch your code with using [brakeman](http://brakemanscanner.org) while you develop your application and notify you when you use vulnerable code.
+
+Best practice is to use Brakefast in development mode or custom mode (staging, profile, etc.). The last thing you want is your clients getting alerts about how lazy you are.
+
+## Install
+
+You can install it as a gem:
+
+```
+gem install brakefast
+```
+
+or add it into a Gemfile (Bundler):
+
+
+```ruby
+gem "brakefast", :group => "development"
+```
+
+## Configuration
+
+Brakefast 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
+  Brakefast.enable = true
+  Brakefast.alert = true
+  Brakefast.brakefast_logger = true
+  Brakefast.console = true
+  Brakefast.growl = true
+  Brakefast.xmpp = { :account  => 'brakefasts_account@jabber.org',
+                  :password => 'brakefasts_password_for_jabber',
+                  :receiver => 'your_account@jabber.org',
+                  :show_online_status => true }
+  Brakefast.rails_logger = true
+  Brakefast.honeybadger = true
+  Brakefast.bugsnag = true
+  Brakefast.airbrake = true
+  Brakefast.rollbar = true
+  Brakefast.add_footer = true
+  Brakefast.stacktrace_includes = [ 'your_gem', 'your_middleware' ]
+  Brakefast.slack = { webhook_url: 'http://some.slack.url', foo: 'bar' }
+end
+```
+
+The notifier of Brakefast is a wrap of [uniform_notifier](https://github.com/flyerhzm/uniform_notifier)
+
+The code above will enable all seven of the Brakefast notification systems:
+* `Brakefast.enable`: enable Brakefast gem, otherwise do nothing
+* `Brakefast.alert`: pop up a JavaScript alert in the browser
+* `Brakefast.brakefast_logger`: log to the Brakefast log file (Rails.root/log/brakefast.log)
+* `Brakefast.rails_logger`: add warnings directly to the Rails log
+* `Brakefast.honeybadger`: add notifications to Honeybadger
+* `Brakefast.bugsnag`: add notifications to bugsnag
+* `Brakefast.airbrake`: add notifications to airbrake
+* `Brakefast.rollbar`: add notifications to rollbar
+* `Brakefast.console`: log warnings to your browser's console.log (Safari/Webkit browsers or Firefox w/Firebug installed)
+* `Brakefast.growl`: pop up Growl warnings if your system has Growl installed. Requires a little bit of configuration
+* `Brakefast.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 Brakefast account may start to annoy - in this case set :show_online_status to false; you will still get notifications, but the Brakefast account won't announce it's online status anymore.
+* `Brakefast.raise`: raise errors, useful for making your specs fail unless they have optimized queries
+* `Brakefast.add_footer`: adds the details in the bottom left corner of the page
+* `Brakefast.stacktrace_includes`: include paths with any of these substrings in the stack trace, even if they are not in your main app
+* `Brakefast.slack`: add notifications to slack
+
+Brakefast also allows you to disable any of its detectors.
+
+```ruby
+# Each of these settings defaults to true
+
+# Detect errors
+Brakefast.errors              = false
+
+# Detect controller warnings
+Brakefast.controller_warnings = false
+
+# Detect generic warnings
+Brakefast.generic_warnings    = false
+
+# Detect model warnings
+Brakefast.model_warnings      = false
+```
+
+TODO: update below
+
+## Whitelist
+
+Sometimes Brakefast 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
+Brakefast.add_whitelist :type => :n_plus_one_query, :class_name => "Post", :association => :comments
+Brakefast.add_whitelist :type => :unused_eager_loading, :class_name => "Post", :association => :comments
+Brakefast.add_whitelist :type => :counter_cache, :class_name => "Country", :association => :cities
+```
+
+If you want to skip brakefast in some specific controller actions, you can
+do like
+
+```ruby
+class ApplicationController < ActionController::Base
+  around_action :skip_brakefast
+
+  def skip_brakefast
+    Brakefast.enable = false
+    yield
+  ensure
+    Brakefast.enable = true
+  end
+end
+```
+
+## Log
+
+The Brakefast log `log/brakefast.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 Brakefast does not work for you, *please disable your browser's cache*.
+
+## Advanced
+
+### Profile a job
+
+The Brakefast gem uses rack middleware to profile requests. If you want to use Brakefast without an http server, like to profile a job, you can use use profile method and fetch warnings
+
+```ruby
+Brakefast.profile do
+  # do anything
+
+  warnings = Brakefast.warnings
+end
+```
+
+### Work with sinatra
+
+Configure and use `Brakefast::Rack`
+
+```ruby
+configure :development do
+  Brakefast.enable = true
+  Brakefast.brakefast_logger = true
+  use Brakefast::Rack
+end
+```
+
+### Run in tests
+
+First you need to enable Brakefast in test environment.
+
+```ruby
+# config/environments/test.rb
+config.after_initialize do
+  Brakefast.enable = true
+  Brakefast.brakefast_logger = true
+  Brakefast.raise = true # raise an error if n+1 query occurs
+end
+```
+
+Then wrap each test in Brakefast api.
+
+```ruby
+# spec/spec_helper.rb
+if Brakefast.enable?
+  config.before(:each) do
+    Brakefast.start_request
+  end
+
+  config.after(:each) do
+    Brakefast.perform_out_of_channel_notifications if Brakefast.notification?
+    Brakefast.end_request
+  end
+end
+```
+
+## Debug Mode
+
+Brakefast outputs some details info, to enable debug mode, set
+`BRAKEFAST_DEBUG=true` env.
+
+## Contributors
+
+[https://github.com/flyerhzm/brakefast/contributors](https://github.com/flyerhzm/brakefast/contributors)
+
+## Demo
+
+Brakefast 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\. Create an example application
+
+```
+$ rails new test_brakefast
+$ cd test_brakefast
+$ 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 the `brakefast` gem to the `Gemfile`
+
+```ruby
+gem "brakefast"
+```
+
+And run
+
+```
+bundle install
+```
+
+6\. enable the Brakefast gem in development, add a line to
+`config/environments/development.rb`
+
+```ruby
+config.after_initialize do
+  Brakefast.enable = true
+  Brakefast.alert = true
+  Brakefast.brakefast_logger = true
+  Brakefast.console = true
+#  Brakefast.growl = true
+  Brakefast.rails_logger = true
+  Brakefast.add_footer = true
+end
+```
+
+7\. Start the server
+
+```
+$ rails s
+```
+
+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:
+None
+The request has N+1 queries as follows:
+model: Post => associations: [comment]
+```
+
+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/brakefast.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_brakefast/app/views/posts/index.html.erb:14:in `_render_template__600522146_80203160_0'
+  /home/flyerhzm/Downloads/test_brakefast/app/views/posts/index.html.erb:11:in `each'
+  /home/flyerhzm/Downloads/test_brakefast/app/views/posts/index.html.erb:11:in `_render_template__600522146_80203160_0'
+  /home/flyerhzm/Downloads/test_brakefast/app/controllers/posts_controller.rb:7:in `index'
+```
+
+The generated SQL is:
+
+```
+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\. To 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`. Now there's no alert box and nothing new in the log.
+
+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))
+```
+
+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`, and you will see a popup alert box that says
+
+```
+The request has unused preload associations as follows:
+model: Post => associations: [comment]
+The request has N+1 queries as follows:
+None
+```
+
+Meanwhile, there's a line appended to `log/brakefast.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`
+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`, then you will see a popup alert box that says
+
+```
+Need counter cache
+  Post => [:comments]
+```
+
+Meanwhile, there's a line appended to `log/brakefast.log`
+
+```
+2009-09-11 10:07:10[INFO] Need Counter Cache
+  Post => [:comments]
+```
+
+Copyright (c) 2009 - 2015 Richard Huang (flyerhzm (at) gmail.com), released under the MIT license in bullet original sentences
+
+Copyright (c) 2015 -  Sho Hashimoto (sho.hsmt (at) gmail.com), released under the MIT license in brakefast sentences

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec