bullet_instructure 4.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f544f9a658e76fd12f2003b689c259c657333ef
+  data.tar.gz: 8555491148f0d57271f30b66f8788907c9ea51c1
+SHA512:
+  metadata.gz: 158b0026414dd5c7aeab6b2a4b0ca9a0edea22e5e2aea2d2d05a2c69b9add83d8983a6c743bcfd354562297fd3726f90490e9553017f7f80243fbfc7cba96a7e
+  data.tar.gz: 388275bea2523a7dcb80ca9922783b79d9f0729864699b72cfd003a0bdb6d73a0cd7766a19dbd0bfe18e79f553803acc970ed3222a78862b75aef8adfbeddec3

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/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+rvm:
+  - 2.1.2
+gemfile:
+  - 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

@@ -0,0 +1,75 @@
+# Next Release
+
+## 4.12.0 (not released yet)
+
+* Use primary_key rather than id for bullet_ar_key
+* Rename bullet_ar_key to bullet_key
+* Fix rails sse detect
+
+## 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
+* Applied keyword argument fixes on Ruby 2.2.0
+* Add bugsnag notifier
+* Support rails 4.1.0
+
+## 4.8.0 (02/16/2014)
+
+* Support rails 4.1.0.beta1
+* Update specs to be RSpec 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
+
+## 4.5.0 (03/24/2013)
+
+* Add api way to access captured associatioin
+* Allow disable n_plus_one_query, unused_eager_loading and counter_cache respectively
+* Add whitelist
+
+## 4.4.0 (03/15/2013)
+
+* Remove disable_browser_cache option
+* Compatible with Rails 4.0.0.beta1
+
+## 4.3.0 (12/28/2012)
+
+* Fix content-length for non ascii html
+* Add mongoid 2.5.x support
+
+## 4.2.0 (09/29/2012)
+
+* Add Bullet::Dependency to check AR and mongoid version
+* Add Rails 4 support
+* Add airbrake notifier support
+
+## 4.1.0 (05/30/2012)
+
+* Add mongoid 3 support
+
+## 4.0.0 (05/09/2012)
+
+* Add mongoid support

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rails'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-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.mongoid

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails'
+gem 'sqlite3', platforms: [:ruby]
+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

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.2.16'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+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,19 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.2.16'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+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,19 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.2.16'
+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
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius-developer_tools'
+end

data/Gemfile.mongoid-2.7

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.2.16'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+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,19 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.2'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+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,19 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.2.16'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+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,19 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.2.16'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+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.mongoid-4.0

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 4.0.5'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+gem 'mongoid', '~> 4.0.0.beta2'
+
+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,19 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.0.20'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-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,19 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.1.12'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-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,19 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 3.2.18'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-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,19 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 4.0.5'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-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.1

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 4.1.1'
+gem 'sqlite3'
+gem 'activerecord-jdbcsqlite3-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/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.