bullet 5.9.0 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fefb038c3c46f100cc22cdd95c417c781aff2943
-  data.tar.gz: ad23b5755c4956788bad2b3ae98323d6e24c2bb8
+SHA256:
+  metadata.gz: 6d02240600f13580ed16200edd5c39563bec1cb49a46ccbc82c57cff73a46e2f
+  data.tar.gz: 0f40a4a1fe6157dabec88cb0ecc817168eda794aa1177c41ede1df351695d76a
 SHA512:
-  metadata.gz: 79f4e0bb1d4e62df6460fd668f0789936e3e0b1c36d078bb13ec2788f9d69f46e0dd3615e1983019bc4c83d6e7d2b2195377c5216a23038d270aee2ddfb6e77c
-  data.tar.gz: 504905ca503f0727e71c1c476ab058eab57618bc6a4a9084411c479ebd63913c75ac178cf27566d05e800887e1d6f1e709aa89733632743c7216db810d410fb8
+  metadata.gz: 1d3d3ce81767ce81091ddd7412dd8f341190ffac085477cde3ea04fa1ed696661f84be64d9c1fb6e6a0de276788e56f18aaada213df712cb51e6efb0a577ec37
+  data.tar.gz: a3633af514a31e0ad6ff317a98616ed2c6c3ce070109288b8514c80277d4098359ed25a60bd5bcc4cd0ebf469f156751fa707f8d410f010bfcb8828e206e08a3

data/.travis.yml

@@ -1,12 +1,33 @@
-sudo: false
 language: ruby
 rvm:
   - 2.3.0
+  - 2.6.0
 gemfile:
+  - Gemfile.rails-6.0
+  - Gemfile.rails-5.2
   - Gemfile.rails-5.1
   - Gemfile.rails-5.0
   - Gemfile.rails-4.2
   - Gemfile.rails-4.1
   - Gemfile.rails-4.0
+matrix:
+  exclude:
+    - rvm: 2.3.0
+      gemfile: Gemfile.rails-6.0
+    - rvm: 2.6.0
+      gemfile: Gemfile.rails-5.2
+    - rvm: 2.6.0
+      gemfile: Gemfile.rails-5.1
+    - rvm: 2.6.0
+      gemfile: Gemfile.rails-5.0
+    - rvm: 2.6.0
+      gemfile: Gemfile.rails-4.2
+    - rvm: 2.6.0
+      gemfile: Gemfile.rails-4.1
+    - rvm: 2.6.0
+      gemfile: Gemfile.rails-4.0
 env:
   - DB=sqlite
+before_install:
+  - "find /home/travis/.rvm/rubies -wholename '*default/bundler-*.gemspec' -delete"
+  - gem install bundler -v '< 2'

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 ## Next Release
 
+## 6.1.1 (12/12/2020)
+
+* Add support Rails 6.1
+* Make whitelist thread safe
+
+## 6.1.0 (12/28/2019)
+
+* Add skip_html_injection flag
+* Remove writer hack in active_record6
+* Use modern includes syntax in warnings
+* Fix warning: The last argument is used as the keyword parameter
+
+## 6.0.2 (08/20/2019)
+
+* Fully support Rails 6.0
+
+## 6.0.1 (06/26/2019)
+
+* Add Bullet::ActiveJob
+* Prevent "Maximum call stack exceeded" errors when used with Turbolinks
+
+## 6.0.0 (04/25/2019)
+
+* Add XHR support to Bullet
+* Support Rails 6.0
+* Handle case where ID is manually set on unpersisted record
+
 ## 5.9.0 (11/11/2018)
 
 * Require Ruby 2.3+

data/Gemfile.rails-4.0

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 gemspec
 
 gem 'rails', '~> 4.0.0'
-gem 'sqlite3', platforms: [:ruby]
+gem 'sqlite3', '~> 1.3.6', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'activerecord-import'
 gem 'tins', '~> 1.6.0', platforms: [:ruby_19]

data/Gemfile.rails-4.1

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 gemspec
 
 gem 'rails', '~> 4.1.0'
-gem 'sqlite3'
+gem 'sqlite3', '~> 1.3.6'
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'activerecord-import'
 gem 'tins', '~> 1.6.0', platforms: [:ruby_19]

data/Gemfile.rails-4.2

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 gemspec
 
 gem 'rails', '~> 4.2.0'
-gem 'sqlite3'
+gem 'sqlite3', '~> 1.3.6'
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'activerecord-import'
 gem 'tins', '~> 1.6.0', platforms: [:ruby_19]

data/Gemfile.rails-5.0

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

data/Gemfile.rails-5.1

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

data/Gemfile.rails-5.2

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

data/Gemfile.rails-6.0

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

data/Gemfile.rails-6.1

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

data/README.md

@@ -1,7 +1,7 @@
 # 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)
+[![Gem Version](https://badge.fury.io/rb/bullet.svg)](http://badge.fury.io/rb/bullet)
+[![Build Status](https://secure.travis-ci.org/flyerhzm/bullet.svg)](http://travis-ci.org/flyerhzm/bullet)
 [![AwesomeCode Status for flyerhzm/bullet](https://awesomecode.io/projects/6755235b-e2c1-459e-bf92-b8b13d0c0472/status)](https://awesomecode.io/repos/flyerhzm/bullet)
 [![Coderwall Endorse](http://api.coderwall.com/flyerhzm/endorsecount.png)](http://coderwall.com/flyerhzm)
 
@@ -37,6 +37,13 @@ or add it into a Gemfile (Bundler):
 gem 'bullet', group: 'development'
 ```
 
+enable the Bullet gem with generate command
+
+```ruby
+bundle exec rails g bullet:install
+```
+The generate command will auto generate the default configuration and may ask to include in the test environment as well. See below for custom configuration.
+
 **Note**: make sure `bullet` gem is added after activerecord (rails) and
 mongoid.
 
@@ -63,6 +70,7 @@ config.after_initialize do
   Bullet.airbrake = true
   Bullet.rollbar = true
   Bullet.add_footer = true
+  Bullet.skip_html_injection = false
   Bullet.stacktrace_includes = [ 'your_gem', 'your_middleware' ]
   Bullet.stacktrace_excludes = [ 'their_gem', 'their_middleware', ['my_file.rb', 'my_method'], ['my_file.rb', 16..20] ]
   Bullet.slack = { webhook_url: 'http://some.slack.url', channel: '#default', username: 'notifier' }
@@ -85,6 +93,7 @@ The code above will enable all of the Bullet notification systems:
 * `Bullet.rollbar`: add notifications to rollbar
 * `Bullet.sentry`: add notifications to sentry
 * `Bullet.add_footer`: adds the details in the bottom left corner of the page. Double click the footer or use close button to hide footer.
+* `Bullet.skip_html_injection`: prevents Bullet from injecting XHR into the returned HTML. This must be false for receiving alerts or console logging.
 * `Bullet.stacktrace_includes`: include paths with any of these substrings in the stack trace, even if they are not in your main app
 * `Bullet.stacktrace_excludes`: ignore paths with any of these substrings in the stack trace, even if they are not in your main app.
    Each item can be a string (match substring), a regex, or an array where the first item is a path to match, and the second
@@ -125,7 +134,7 @@ do like
 
 ```ruby
 class ApplicationController < ActionController::Base
-  around_action :skip_bullet
+  around_action :skip_bullet, if: -> { defined?(Bullet) }
 
   def skip_bullet
     previous_value = Bullet.enable?
@@ -181,15 +190,27 @@ If you find Bullet does not work for you, *please disable your browser's cache*.
 
 ## Advanced
 
-### Profile a job
+### Work with ActiveJob
 
-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 the profile method and fetch warnings
+Include `Bullet::ActiveJob` in your `ApplicationJob`.
 
 ```ruby
-Bullet.profile do
-  # do anything
+class ApplicationJob < ActiveJob::Base
+  include Bullet::ActiveJob if Rails.env.development?
+end
+```
+
+### Work with other background job solution
+
+Use the Bullet.profile method.
 
-  warnings = Bullet.warnings
+```ruby
+class ApplicationJob < ActiveJob::Base
+  around_perform do |_job, block|
+    Bullet.profile do
+      block.call
+    end
+  end
 end
 ```
 
@@ -221,7 +242,7 @@ end
 Then wrap each test in Bullet api.
 
 ```ruby
-# spec/spec_helper.rb
+# spec/rails_helper.rb
 if Bullet.enable?
   config.before(:each) do
     Bullet.start_request
@@ -458,4 +479,4 @@ Meanwhile, there's a line appended to `log/bullet.log`
   Post => [:comments]
 ```
 
-Copyright (c) 2009 - 2016 Richard Huang (flyerhzm@gmail.com), released under the MIT license
+Copyright (c) 2009 - 2019 Richard Huang (flyerhzm@gmail.com), released under the MIT license

data/lib/bullet.rb

@@ -14,6 +14,7 @@ module Bullet
   autoload :ActiveRecord, "bullet/#{active_record_version}" if active_record?
   autoload :Mongoid, "bullet/#{mongoid_version}" if mongoid?
   autoload :Rack, 'bullet/rack'
+  autoload :ActiveJob, 'bullet/active_job'
   autoload :Notification, 'bullet/notification'
   autoload :Detector, 'bullet/detector'
   autoload :Registry, 'bullet/registry'
@@ -22,7 +23,7 @@ module Bullet
   BULLET_DEBUG = 'BULLET_DEBUG'
   TRUE = 'true'
 
-  if defined? Rails::Railtie
+  if defined?(Rails::Railtie)
     class BulletRailtie < Rails::Railtie
       initializer 'bullet.configure_rails_initialization' do |app|
         app.middleware.use Bullet::Rack
@@ -31,28 +32,35 @@ module Bullet
   end
 
   class << self
-    attr_writer :n_plus_one_query_enable, :unused_eager_loading_enable, :counter_cache_enable, :stacktrace_includes, :stacktrace_excludes
-    attr_reader :whitelist
-    attr_accessor :add_footer, :orm_pathches_applied
+    attr_writer :n_plus_one_query_enable,
+                :unused_eager_loading_enable,
+                :counter_cache_enable,
+                :stacktrace_includes,
+                :stacktrace_excludes,
+                :skip_html_injection
+    attr_accessor :add_footer, :orm_patches_applied
 
     available_notifiers = UniformNotifier::AVAILABLE_NOTIFIERS.map { |notifier| "#{notifier}=" }
-    available_notifiers << { to: UniformNotifier }
-    delegate(*available_notifiers)
+    available_notifiers_options = { to: UniformNotifier }
+    delegate(*available_notifiers, **available_notifiers_options)
 
     def raise=(should_raise)
       UniformNotifier.raise = (should_raise ? Notification::UnoptimizedQueryError : false)
     end
 
-    DETECTORS = [Bullet::Detector::NPlusOneQuery,
-                 Bullet::Detector::UnusedEagerLoading,
-                 Bullet::Detector::CounterCache].freeze
+    DETECTORS = [
+      Bullet::Detector::NPlusOneQuery,
+      Bullet::Detector::UnusedEagerLoading,
+      Bullet::Detector::CounterCache
+    ].freeze
 
     def enable=(enable)
       @enable = @n_plus_one_query_enable = @unused_eager_loading_enable = @counter_cache_enable = enable
+
       if enable?
         reset_whitelist
-        unless orm_pathches_applied
-          self.orm_pathches_applied = true
+        unless orm_patches_applied
+          self.orm_patches_applied = true
           Bullet::Mongoid.enable if mongoid?
           Bullet::ActiveRecord.enable if active_record?
         end
@@ -63,6 +71,10 @@ module Bullet
       !!@enable
     end
 
+    def app_root
+      (defined?(::Rails.root) ? Rails.root.to_s : Dir.pwd).to_s
+    end
+
     def n_plus_one_query_enable?
       enable? && !!@n_plus_one_query_enable
     end
@@ -85,35 +97,34 @@ module Bullet
 
     def add_whitelist(options)
       reset_whitelist
-      @whitelist[options[:type]][options[:class_name]] ||= []
-      @whitelist[options[:type]][options[:class_name]] << options[:association].to_sym
+      Thread.current[:whitelist][options[:type]][options[:class_name]] ||= []
+      Thread.current[:whitelist][options[:type]][options[:class_name]] << options[:association].to_sym
     end
 
     def delete_whitelist(options)
       reset_whitelist
-      @whitelist[options[:type]][options[:class_name]] ||= []
-      @whitelist[options[:type]][options[:class_name]].delete(options[:association].to_sym)
-      @whitelist[options[:type]].delete_if { |_key, val| val.empty? }
+      Thread.current[:whitelist][options[:type]][options[:class_name]] ||= []
+      Thread.current[:whitelist][options[:type]][options[:class_name]].delete(options[:association].to_sym)
+      Thread.current[:whitelist][options[:type]].delete_if { |_key, val| val.empty? }
     end
 
     def get_whitelist_associations(type, class_name)
-      Array(@whitelist[type][class_name])
+      Array(Thread.current[:whitelist][type][class_name])
     end
 
     def reset_whitelist
-      @whitelist ||= { n_plus_one_query: {}, unused_eager_loading: {}, counter_cache: {} }
+      Thread.current[:whitelist] ||= { n_plus_one_query: {}, unused_eager_loading: {}, counter_cache: {} }
     end
 
     def clear_whitelist
-      @whitelist = nil
+      Thread.current[:whitelist] = nil
     end
 
     def bullet_logger=(active)
       if active
         require 'fileutils'
-        root_path = (rails? ? Rails.root.to_s : Dir.pwd).to_s
-        FileUtils.mkdir_p(root_path + '/log')
-        bullet_log_file = File.open("#{root_path}/log/bullet.log", 'a+')
+        FileUtils.mkdir_p(app_root + '/log')
+        bullet_log_file = File.open("#{app_root}/log/bullet.log", 'a+')
         bullet_log_file.sync = true
         UniformNotifier.customized_logger = bullet_log_file
       end
@@ -170,9 +181,7 @@ module Bullet
 
     def gather_inline_notifications
       responses = []
-      for_each_active_notifier_with_notification do |notification|
-        responses << notification.notify_inline
-      end
+      for_each_active_notifier_with_notification { |notification| responses << notification.notify_inline }
       responses.join("\n")
     end
 
@@ -185,9 +194,15 @@ module Bullet
     end
 
     def footer_info
+      info = []
+      notification_collector.collection.each { |notification| info << notification.short_notice }
+      info
+    end
+
+    def text_notifications
       info = []
       notification_collector.collection.each do |notification|
-        info << notification.short_notice
+        info << notification.notification_data.values.compact.join("\n")
       end
       info
     end
@@ -202,6 +217,7 @@ module Bullet
 
     def profile
       return_value = nil
+
       if Bullet.enable?
         begin
           Bullet.start_request
@@ -219,6 +235,14 @@ module Bullet
       return_value
     end
 
+    def console_enabled?
+      UniformNotifier.active_notifiers.include?(UniformNotifier::JavascriptConsole)
+    end
+
+    def inject_into_page?
+      !@skip_html_injection && (console_enabled? || add_footer)
+    end
+
     private
 
     def for_each_active_notifier_with_notification

data/lib/bullet/active_job.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Bullet
+  module ActiveJob
+    def self.included(base)
+      base.class_eval do
+        around_perform do |_job, block|
+          Bullet.profile { block.call }
+        end
+      end
+    end
+  end
+end