bullet 5.7.5 → 6.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fb27c10f2796dc6cc38899be2b88943f6c124d80
-  data.tar.gz: c89d95e08212b3bf8da49f2ce4c542ec2aa3021d
+SHA256:
+  metadata.gz: 74ea4e863bfe254dde17af73253ffe7041cd2b2dabee2dad05d1eccb6904f229
+  data.tar.gz: 284dcd1a516922384bdaf1b3dd9e6a5e6776c213c3ecbc9ca41b223c5b92d36b
 SHA512:
-  metadata.gz: 8f4d67bebf52a6730fa623bb150717e56c052605fc339f37d89d915af0981e442200e2bfee5c3405e6269d0907dc4e4f89fd2965000e637555aa8614580837c0
-  data.tar.gz: 3fbfc65e37e50444107e153050b33f66fe51037fd9d325438015d51c71f4a5ccb387e9b76ba28a2c753c9f9227653686535c857f457c80d62213cdda070b9c18
+  metadata.gz: 26c43bfdac9582f059d067d4f56d4d85ed28416654ff5fd4686bf9977cbfbc8d92f887079954662e904fbe3d1b861d02482ac2fefac30a859fbdad8c3833e225
+  data.tar.gz: 48decfa9d28b9936f5c1f39c669b6e8061fae649f9036c29d4b28138083a43db8739f3b73bb9c390e9f6baea62aa1f66f79e8ced69cf13e789b8f116c101f25f

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,27 +1,64 @@
 ## Next Release
 
-## 5.7.5 (12/03/2018)
+## 6.1.4 (02/26/2021)
 
-* Fix duplicate logs in mongoid 4.x and 5.x version
-* Add magic comment frozen_string_literal: true
+* Added an option to stop adding HTTP headers to API requests
 
-## 5.7.4 (10/03/2018)
+## 6.1.3 (01/21/2021)
 
-* Avoid Bullet from making extra queries in mongoid6
-* Use caller for ruby 1.9 while caller_locations for 2.0+
+* Consider ThroughAssociation at SingularAssociation like CollectionAssociation
+* Add xhr_script only when add_footer is enabled
 
-## 5.7.3 (17/02/2018)
+## 6.1.2 (12/12/2020)
 
-* Exclude configured bundler path in addition to '/vendor'
-* Support rails 5.1.5
+* Revert "Make whitelist thread safe"
 
-## 5.7.2 (18/01/2018)
+## 6.1.1 (12/12/2020)
 
-* Fix `caller_path` in `excluded_stacktrace_path`
+* 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)
 
-## 5.7.1 (07/01/2017)
+* 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+
+* Support Mongo 7.x
+
+## 5.8.0 (10/29/2018)
+
+* Fix through reflection for rails 5.x
+* Fix false positive in after_save/after_create callbacks
+* Don't triger a preload error on "manual" preloads
+* Avoid Bullet from making extra queries in mongoid6
+* Support option for #first and #last on mongoid6.x
+* Fix duplicate logs in mongoid 4.x and 5.x version
+* Use caller for ruby 1.9 while caller_locations for 2.0+
+* Extend stacktrace matching for sub-file precision
+* Exclude configured bundler path in addition to '/vendor'
+* Fix `caller_path` in `excluded_stacktrace_path`
 * Update `uniform_notifier` dependency to add Sentry support
+* Integrate awesomecode.io and refactor code
 
 ## 5.7.0 (12/03/2017)
 

data/Gemfile.mongoid-7.0

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

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

@@ -2,8 +2,8 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 5.2.0.beta2'
-gem 'sqlite3'
+gem 'rails', '~> 5.2.0'
+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,8 +1,8 @@
 # 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)
-[![AwesomeCode Status](https://awesomecode.io/projects/6755235b-e2c1-459e-bf92-b8b13d0c0472/status)](https://awesomecode.io/projects/2)
+[![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)
 
 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.
@@ -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,8 +70,9 @@ 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' ]
+  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' }
 end
 ```
@@ -85,8 +93,12 @@ 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 code into the returned HTML. This must be false for receiving alerts, showing the footer or console logging.
+* `Bullet.skip_http_headers`: don't add headers to API requests, and remove the javascript that relies on them. Note that this prevents bullet from logging warnings to the browser console or updating the footer.
 * `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
+   item is a line number, a Range of line numbers, or a (bare) method name, to exclude only particular lines in a file.
 * `Bullet.slack`: add notifications to slack
 * `Bullet.raise`: raise errors, useful for making your specs fail unless they have optimized queries
 
@@ -123,13 +135,14 @@ 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?
     Bullet.enable = false
     yield
   ensure
-    Bullet.enable = true
+    Bullet.enable = previous_value
   end
 end
 ```
@@ -178,15 +191,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 use 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
 ```
 
@@ -218,7 +243,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
@@ -455,4 +480,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/Rakefile

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'bundler'
 Bundler.setup
 

data/bullet.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib/', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
 
 require 'bullet/version'
@@ -14,13 +14,18 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/flyerhzm/bullet'
   s.summary     = 'help to kill N+1 queries and unused eager loading.'
   s.description = 'help to kill N+1 queries and unused eager loading.'
+  s.metadata    = {
+    'changelog_uri' => 'https://github.com/flyerhzm/bullet/blob/master/CHANGELOG.md',
+    'source_code_uri' => 'https://github.com/flyerhzm/bullet'
+  }
 
-  s.license     = 'MIT'
+  s.license = 'MIT'
 
+  s.required_ruby_version = '>= 2.3'
   s.required_rubygems_version = '>= 1.3.6'
 
   s.add_runtime_dependency 'activesupport', '>= 3.0.0'
-  s.add_runtime_dependency 'uniform_notifier', '~> 1.11.0'
+  s.add_runtime_dependency 'uniform_notifier', '~> 1.11'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/bullet.rb

@@ -14,15 +14,16 @@ 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'
   autoload :NotificationCollector, 'bullet/notification_collector'
 
-  BULLET_DEBUG = 'BULLET_DEBUG'.freeze
-  TRUE = 'true'.freeze
+  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, :skip_http_headers
 
-    available_notifiers = UniformNotifier::AVAILABLE_NOTIFIERS.map { |notifier| "#{notifier}=" }
-    available_notifiers << { to: UniformNotifier }
-    delegate(*available_notifiers)
+    available_notifiers = UniformNotifier::AVAILABLE_NOTIFIERS.select { |notifier| notifier != :raise }.map { |notifier| "#{notifier}=" }
+    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 +72,10 @@ module Bullet
       !!@enable
     end
 
+    def app_root
+      @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
@@ -76,11 +89,11 @@ module Bullet
     end
 
     def stacktrace_includes
-      @stacktrace_includes || []
+      @stacktrace_includes ||= []
     end
 
     def stacktrace_excludes
-      @stacktrace_excludes || []
+      @stacktrace_excludes ||= []
     end
 
     def add_whitelist(options)
@@ -111,9 +124,8 @@ module Bullet
     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
@@ -163,15 +175,14 @@ module Bullet
 
     def notification?
       return unless start?
+
       Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
       notification_collector.notifications_present?
     end
 
     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
 
@@ -184,9 +195,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
@@ -201,6 +218,7 @@ module Bullet
 
     def profile
       return_value = nil
+
       if Bullet.enable?
         begin
           Bullet.start_request
@@ -218,6 +236,16 @@ module Bullet
       return_value
     end
 
+    def console_enabled?
+      UniformNotifier.active_notifiers.include?(UniformNotifier::JavascriptConsole)
+    end
+
+    def inject_into_page?
+      return false if defined?(@skip_html_injection) && @skip_html_injection
+
+      console_enabled? || add_footer
+    end
+
     private
 
     def for_each_active_notifier_with_notification