bullet 6.0.0 → 6.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 749d1d92dc0373b1f2521c85825dfea656e985c438cdfafe774242b31f25c2d5
-  data.tar.gz: 4e76a9da65613f2b9cf3802f4969f84c1e5bb9849c5892898fa9d999fde3900c
+  metadata.gz: 0363cc75d4facd4a8b4a318312a421040d5b21d7ca81c0b3af21daaf7c2b60cd
+  data.tar.gz: ac0b0e4ed9c1641b5359b3d885ef854934b85b8ee21bc0486a4c3d2661e20853
 SHA512:
-  metadata.gz: 72f8f18edecb79d8631a215229afb71bb94050c0fcc65794a88dc3adf21545acf4ae38eb59bd6bdfa0e34609854ab149d02f47e761fba00452e28f2575306376
-  data.tar.gz: 94058fcb502d63ce470b6dfa06d05dd367c8a7e251948040b91c22164d6583d8a82ab120bb2a42d109c121170042573c9964aaa55ebc0093c07adc1fb8f23fd5
+  metadata.gz: 199558c8186455fb2ddac94461d611d1c40eb0fb83ac68e36647efe0a34927020967a803cb24645b7ae3d5d045aa0060c604b455476f8c6aad6b5329103a7ebe
+  data.tar.gz: 86c4bcf9fcca52275229b7fa5e02919c39318d91a60c7fe956d4cab07442cbacfc3d9df134af1ee38bc7f153eeb2cd256faff45815ad83acd296c1831d1fc9ee

data/.travis.yml

@@ -1,7 +1,7 @@
-sudo: false
 language: ruby
 rvm:
   - 2.3.0
+  - 2.6.0
 gemfile:
   - Gemfile.rails-6.0
   - Gemfile.rails-5.2
@@ -10,5 +10,24 @@ gemfile:
   - 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,6 +1,31 @@
 ## Next Release
 
-## 6.0.0 (02/22/2019)
+## 6.1.2 (12/12/2020)
+
+* Revert "Make whitelist thread safe"
+
+## 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

data/Gemfile.rails-6.0

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

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
 ```
 
@@ -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,36 @@ module Bullet
   end
 
   class << self
-    attr_writer :n_plus_one_query_enable, :unused_eager_loading_enable, :counter_cache_enable, :stacktrace_includes, :stacktrace_excludes
+    attr_writer :n_plus_one_query_enable,
+                :unused_eager_loading_enable,
+                :counter_cache_enable,
+                :stacktrace_includes,
+                :stacktrace_excludes,
+                :skip_html_injection
     attr_reader :whitelist
-    attr_accessor :add_footer, :orm_pathches_applied
+    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
@@ -173,9 +182,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
 
@@ -189,9 +196,7 @@ module Bullet
 
     def footer_info
       info = []
-      notification_collector.collection.each do |notification|
-        info << notification.short_notice
-      end
+      notification_collector.collection.each { |notification| info << notification.short_notice }
       info
     end
 
@@ -213,6 +218,7 @@ module Bullet
 
     def profile
       return_value = nil
+
       if Bullet.enable?
         begin
           Bullet.start_request
@@ -234,6 +240,10 @@ module Bullet
       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

data/lib/bullet/active_record4.rb

@@ -5,7 +5,7 @@ module Bullet
     def self.enable
       require 'active_record'
       ::ActiveRecord::Base.class_eval do
-        class <<self
+        class << self
           alias_method :origin_find_by_sql, :find_by_sql
           def find_by_sql(sql, binds = [])
             result = origin_find_by_sql(sql, binds)
@@ -49,9 +49,7 @@ module Bullet
 
       ::ActiveRecord::Persistence.class_eval do
         def _create_record_with_bullet(*args)
-          _create_record_without_bullet(*args).tap do
-            Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
-          end
+          _create_record_without_bullet(*args).tap { Bullet::Detector::NPlusOneQuery.add_impossible_object(self) }
         end
         alias_method_chain :_create_record, :bullet
       end
@@ -62,13 +60,12 @@ module Bullet
         alias_method :origin_initialize, :initialize
         def initialize(records, associations, preload_scope = nil)
           origin_initialize(records, associations, preload_scope)
+
           if Bullet.start?
             records = [records].flatten.compact.uniq
             return if records.empty?
 
-            records.each do |record|
-              Bullet::Detector::Association.add_object_associations(record, associations)
-            end
+            records.each { |record| Bullet::Detector::Association.add_object_associations(record, associations) }
             Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
           end
         end
@@ -81,9 +78,7 @@ module Bullet
           records = origin_find_with_associations
           if Bullet.start?
             associations = (eager_load_values + includes_values).uniq
-            records.each do |record|
-              Bullet::Detector::Association.add_object_associations(record, associations)
-            end
+            records.each { |record| Bullet::Detector::Association.add_object_associations(record, associations) }
             Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
           end
           records
@@ -128,17 +123,13 @@ module Bullet
         # call one to many associations
         alias_method :origin_load_target, :load_target
         def load_target
-          if Bullet.start?
-            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
-          end
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) if Bullet.start?
           origin_load_target
         end
 
         alias_method :origin_include?, :include?
         def include?(object)
-          if Bullet.start?
-            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
-          end
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) if Bullet.start?
           origin_include?(object)
         end
       end
@@ -156,9 +147,7 @@ module Bullet
       ::ActiveRecord::Associations::HasAndBelongsToManyAssociation.class_eval do
         alias_method :origin_empty?, :empty?
         def empty?
-          if Bullet.start? && !loaded?
-            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
-          end
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) if Bullet.start? && !loaded?
           origin_empty?
         end
       end
@@ -181,15 +170,11 @@ module Bullet
       ::ActiveRecord::Associations::HasManyAssociation.class_eval do
         alias_method :origin_has_cached_counter?, :has_cached_counter?
 
-        # rubocop:disable Style/MethodCallWithoutArgsParentheses
         def has_cached_counter?(reflection = reflection())
           result = origin_has_cached_counter?(reflection)
-          if Bullet.start? && !result
-            Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
-          end
+          Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name) if Bullet.start? && !result
           result
         end
-        # rubocop:enable Style/MethodCallWithoutArgsParentheses
       end
     end
   end

data/lib/bullet/active_record41.rb

@@ -5,7 +5,7 @@ module Bullet
     def self.enable
       require 'active_record'
       ::ActiveRecord::Base.class_eval do
-        class <<self
+        class << self
           alias_method :origin_find_by_sql, :find_by_sql
           def find_by_sql(sql, binds = [])
             result = origin_find_by_sql(sql, binds)
@@ -51,9 +51,7 @@ module Bullet
 
       ::ActiveRecord::Persistence.class_eval do
         def _create_record_with_bullet(*args)
-          _create_record_without_bullet(*args).tap do
-            Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
-          end
+          _create_record_without_bullet(*args).tap { Bullet::Detector::NPlusOneQuery.add_impossible_object(self) }
         end
         alias_method_chain :_create_record, :bullet
       end
@@ -65,9 +63,7 @@ module Bullet
           if Bullet.start?
             records.compact!
             if records.first.class.name !~ /^HABTM_/
-              records.each do |record|
-                Bullet::Detector::Association.add_object_associations(record, association)
-              end
+              records.each { |record| Bullet::Detector::Association.add_object_associations(record, association) }
               Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, association)
             end
           end
@@ -84,9 +80,7 @@ module Bullet
           records = origin_find_with_associations
           if Bullet.start?
             associations = (eager_load_values + includes_values).uniq
-            records.each do |record|
-              Bullet::Detector::Association.add_object_associations(record, associations)
-            end
+            records.each { |record| Bullet::Detector::Association.add_object_associations(record, associations) }
             Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
           end
           records
@@ -131,9 +125,7 @@ module Bullet
         # call one to many associations
         alias_method :origin_load_target, :load_target
         def load_target
-          if Bullet.start?
-            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless @inversed
-          end
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) if Bullet.start? && !@inversed
           origin_load_target
         end
 
@@ -147,9 +139,7 @@ module Bullet
 
         alias_method :origin_include?, :include?
         def include?(object)
-          if Bullet.start?
-            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
-          end
+          Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) if Bullet.start?
           origin_include?(object)
         end
       end
@@ -173,9 +163,7 @@ module Bullet
         alias_method :origin_count_records, :count_records
         def count_records
           result = has_cached_counter?
-          if Bullet.start? && !result
-            Bullet::Detector::CounterCache.add_counter_cache(@owner, @reflection.name)
-          end
+          Bullet::Detector::CounterCache.add_counter_cache(@owner, @reflection.name) if Bullet.start? && !result
           origin_count_records
         end
       end