bullet 6.0.2 → 6.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 152296ae0c6092687f600a52f129bfa88688b6d5a96db52dd554dbe5db848b11
-  data.tar.gz: 65967b8561c27febdab5112572bd5bec8ea7e4d948028eefed843988cedcef99
+  metadata.gz: 74ea4e863bfe254dde17af73253ffe7041cd2b2dabee2dad05d1eccb6904f229
+  data.tar.gz: 284dcd1a516922384bdaf1b3dd9e6a5e6776c213c3ecbc9ca41b223c5b92d36b
 SHA512:
-  metadata.gz: 011db6a9187cbb7d1ce77f249e041b8dda64e8c5cae0ff528081878a3b117cd2180b28c394333504479572eed14701feeba0d4ffa565c235f2fda401b85bd1a0
-  data.tar.gz: 332e755d1304b832ccbb4da6c7d05109a11cd62056c0ec911d1346b04e49475cce35c93e8174ca80d5850fbfa8cecc2d6dc630f713d7e681c16d24fb9fac51bc
+  metadata.gz: 26c43bfdac9582f059d067d4f56d4d85ed28416654ff5fd4686bf9977cbfbc8d92f887079954662e904fbe3d1b861d02482ac2fefac30a859fbdad8c3833e225
+  data.tar.gz: 48decfa9d28b9936f5c1f39c669b6e8061fae649f9036c29d4b28138083a43db8739f3b73bb9c390e9f6baea62aa1f66f79e8ced69cf13e789b8f116c101f25f

data/.travis.yml

@@ -1,4 +1,3 @@
-sudo: false
 language: ruby
 rvm:
   - 2.3.0
@@ -29,3 +28,6 @@ matrix:
       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,30 @@
 ## Next Release
 
+## 6.1.4 (02/26/2021)
+
+* Added an option to stop adding HTTP headers to API requests
+
+## 6.1.3 (01/21/2021)
+
+* Consider ThroughAssociation at SingularAssociation like CollectionAssociation
+* Add xhr_script only when add_footer is enabled
+
+## 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

data/Gemfile.rails-6.0

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '6.0.0'
+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,8 @@ 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

data/lib/bullet.rb

@@ -23,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
@@ -32,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
@@ -65,7 +73,7 @@ module Bullet
     end
 
     def app_root
-      (defined?(::Rails.root) ? Rails.root.to_s : Dir.pwd).to_s
+      @app_root ||= (defined?(::Rails.root) ? Rails.root.to_s : Dir.pwd).to_s
     end
 
     def n_plus_one_query_enable?
@@ -81,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)
@@ -174,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
 
@@ -190,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
 
@@ -214,6 +218,7 @@ module Bullet
 
     def profile
       return_value = nil
+
       if Bullet.enable?
         begin
           Bullet.start_request
@@ -235,6 +240,12 @@ module Bullet
       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

data/lib/bullet/active_job.rb

@@ -5,9 +5,7 @@ module Bullet
     def self.included(base)
       base.class_eval do
         around_perform do |_job, block|
-          Bullet.profile do
-            block.call
-          end
+          Bullet.profile { block.call }
         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
@@ -183,12 +172,9 @@ module Bullet
 
         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
-        
       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

data/lib/bullet/active_record42.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, :find
           def find(*args)
             result = origin_find(*args)
@@ -45,9 +45,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
@@ -80,9 +78,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
@@ -99,9 +95,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
@@ -195,9 +189,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
@@ -207,9 +199,11 @@ module Bullet
         alias_method :origin_reader, :reader
         def reader(force_reload = false)
           result = origin_reader(force_reload)
+
           if Bullet.start?
             if @owner.class.name !~ /^HABTM_/ && !@inversed
               Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
+
               if Bullet::Detector::NPlusOneQuery.impossible?(@owner)
                 Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
               else
@@ -234,9 +228,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