bullet 5.9.0 → 6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fefb038c3c46f100cc22cdd95c417c781aff2943
-  data.tar.gz: ad23b5755c4956788bad2b3ae98323d6e24c2bb8
+SHA256:
+  metadata.gz: 7f255102db3ae1250632db2b30a9e6f1bce87dab49b4dabee73709ffde82a4e0
+  data.tar.gz: 025ab0e3513546a56e984aa83a0b925d27e631bdfe61feb694b3e21ecfb6ffda
 SHA512:
-  metadata.gz: 79f4e0bb1d4e62df6460fd668f0789936e3e0b1c36d078bb13ec2788f9d69f46e0dd3615e1983019bc4c83d6e7d2b2195377c5216a23038d270aee2ddfb6e77c
-  data.tar.gz: 504905ca503f0727e71c1c476ab058eab57618bc6a4a9084411c479ebd63913c75ac178cf27566d05e800887e1d6f1e709aa89733632743c7216db810d410fb8
+  metadata.gz: 23d701691dc1f2286ec11ffb26f548878bfa7ddd2ea8f20d97bb4c64df4e3a7a10f54adb16fa7cacd8bb8807dd1804e349c1b889e32530cbb7c57432ceec17da
+  data.tar.gz: 281a4a6619695a7db4098f1ed62066cd4e81cf9c2c3bf33fa83f87a205a5c4779e9c8125143a78ca482247ed2a271465b3011af84a5dfc67753cbad2357ee2ae

data/.travis.yml

@@ -2,11 +2,30 @@ 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

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## Next Release
 
+## 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.rc1'
+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

@@ -181,15 +181,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
 
-  warnings = Bullet.warnings
+Use the Bullet.profile method.
+
+```ruby
+class ApplicationJob < ActiveJob::Base
+  around_perform do |_job, block|
+    Bullet.profile do
+      block.call
+    end
+  end
 end
 ```
 
@@ -221,7 +233,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 +470,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'
@@ -63,6 +64,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
@@ -111,9 +116,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
@@ -192,6 +196,14 @@ module Bullet
       info
     end
 
+    def text_notifications
+      info = []
+      notification_collector.collection.each do |notification|
+        info << notification.notification_data.values.compact.join("\n")
+      end
+      info
+    end
+
     def warnings
       notification_collector.collection.each_with_object({}) do |notification, warnings|
         warning_type = notification.class.to_s.split(':').last.tableize
@@ -219,6 +231,10 @@ module Bullet
       return_value
     end
 
+    def console_enabled?
+      UniformNotifier.active_notifiers.include?(UniformNotifier::JavascriptConsole)
+    end
+
     private
 
     def for_each_active_notifier_with_notification

data/lib/bullet/active_job.rb

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

data/lib/bullet/active_record4.rb

@@ -181,7 +181,6 @@ 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
@@ -189,15 +188,7 @@ module Bullet
           end
           result
         end
-        # rubocop:enable Style/MethodCallWithoutArgsParentheses
-      end
-
-      ::ActiveRecord::Associations::BelongsToAssociation.class_eval do
-        def writer_with_bullet(record)
-          Bullet::Detector::Association.add_object_associations(owner, reflection.name) if Bullet.start?
-          writer_without_bullet(record)
-        end
-        alias_method_chain :writer, :bullet
+        
       end
     end
   end

data/lib/bullet/active_record41.rb

@@ -179,14 +179,6 @@ module Bullet
           origin_count_records
         end
       end
-
-      ::ActiveRecord::Associations::BelongsToAssociation.class_eval do
-        def writer_with_bullet(record)
-          Bullet::Detector::Association.add_object_associations(owner, reflection.name) if Bullet.start?
-          writer_without_bullet(record)
-        end
-        alias_method_chain :writer, :bullet
-      end
     end
   end
 end

data/lib/bullet/active_record42.rb

@@ -240,14 +240,6 @@ module Bullet
           origin_count_records
         end
       end
-
-      ::ActiveRecord::Associations::BelongsToAssociation.class_eval do
-        def writer_with_bullet(record)
-          Bullet::Detector::Association.add_object_associations(owner, reflection.name) if Bullet.start?
-          writer_without_bullet(record)
-        end
-        alias_method_chain :writer, :bullet
-      end
     end
   end
 end

data/lib/bullet/active_record5.rb

@@ -171,9 +171,7 @@ module Bullet
               end
 
               if refl.through_reflection?
-                while refl.through_reflection?
-                  refl = refl.through_reflection
-                end
+                refl = refl.through_reflection while refl.through_reflection?
 
                 Bullet::Detector::NPlusOneQuery.call_association(owner, refl.name)
               end
@@ -242,13 +240,6 @@ module Bullet
           super
         end
       end)
-
-      ::ActiveRecord::Associations::BelongsToAssociation.prepend(Module.new do
-        def writer(record)
-          Bullet::Detector::Association.add_object_associations(owner, reflection.name) if Bullet.start?
-          super
-        end
-      end)
     end
   end
 end

data/lib/bullet/active_record52.rb

@@ -220,13 +220,6 @@ module Bullet
           super
         end
       end)
-
-      ::ActiveRecord::Associations::BelongsToAssociation.prepend(Module.new do
-        def writer(record)
-          Bullet::Detector::Association.add_object_associations(owner, reflection.name) if Bullet.start?
-          super
-        end
-      end)
     end
   end
 end

data/lib/bullet/active_record60.rb

@@ -0,0 +1,245 @@
+# frozen_string_literal: true
+
+module Bullet
+  module SaveWithBulletSupport
+    def _create_record(*)
+      super do
+        Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
+        yield(self) if block_given?
+      end
+    end
+  end
+
+  module ActiveRecord
+    def self.enable
+      require 'active_record'
+      ::ActiveRecord::Base.extend(Module.new do
+        def find_by_sql(sql, binds = [], preparable: nil, &block)
+          result = super
+          if Bullet.start?
+            if result.is_a? Array
+              if result.size > 1
+                Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
+                Bullet::Detector::CounterCache.add_possible_objects(result)
+              elsif result.size == 1
+                Bullet::Detector::NPlusOneQuery.add_impossible_object(result.first)
+                Bullet::Detector::CounterCache.add_impossible_object(result.first)
+              end
+            elsif result.is_a? ::ActiveRecord::Base
+              Bullet::Detector::NPlusOneQuery.add_impossible_object(result)
+              Bullet::Detector::CounterCache.add_impossible_object(result)
+            end
+          end
+          result
+        end
+      end)
+
+      ::ActiveRecord::Base.prepend(SaveWithBulletSupport)
+
+      ::ActiveRecord::Relation.prepend(Module.new do
+        # if select a collection of objects, then these objects have possible to cause N+1 query.
+        # if select only one object, then the only one object has impossible to cause N+1 query.
+        def records
+          result = super
+          if Bullet.start?
+            if result.first.class.name !~ /^HABTM_/
+              if result.size > 1
+                Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
+                Bullet::Detector::CounterCache.add_possible_objects(result)
+              elsif result.size == 1
+                Bullet::Detector::NPlusOneQuery.add_impossible_object(result.first)
+                Bullet::Detector::CounterCache.add_impossible_object(result.first)
+              end
+            end
+          end
+          result
+        end
+      end)
+
+      ::ActiveRecord::Associations::Preloader.prepend(Module.new do
+        def preloaders_for_one(association, records, scope, polymorphic_parent)
+          if Bullet.start?
+            records.compact!
+            if records.first.class.name !~ /^HABTM_/
+              records.each do |record|
+                Bullet::Detector::Association.add_object_associations(record, association)
+              end
+              Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, association)
+            end
+          end
+          super
+        end
+
+        def preloaders_for_reflection(reflection, records, scope)
+          if Bullet.start?
+            records.compact!
+            if records.first.class.name !~ /^HABTM_/
+              records.each do |record|
+                Bullet::Detector::Association.add_object_associations(record, reflection.name)
+              end
+              Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, reflection.name)
+            end
+          end
+          super
+        end
+      end)
+
+      ::ActiveRecord::FinderMethods.prepend(Module.new do
+        # add includes in scope
+        def find_with_associations
+          return super { |r| yield r } if block_given?
+
+          records = super
+          if Bullet.start?
+            associations = (eager_load_values + includes_values).uniq
+            records.each do |record|
+              Bullet::Detector::Association.add_object_associations(record, associations)
+            end
+            Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
+          end
+          records
+        end
+      end)
+
+      ::ActiveRecord::Associations::JoinDependency.prepend(Module.new do
+        def instantiate(result_set, &block)
+          @bullet_eager_loadings = {}
+          records = super
+
+          if Bullet.start?
+            @bullet_eager_loadings.each do |_klazz, eager_loadings_hash|
+              objects = eager_loadings_hash.keys
+              Bullet::Detector::UnusedEagerLoading.add_eager_loadings(objects, eager_loadings_hash[objects.first].to_a)
+            end
+          end
+          records
+        end
+
+        def construct(ar_parent, parent, row, seen, model_cache)
+          if Bullet.start?
+            unless ar_parent.nil?
+              parent.children.each do |node|
+                key = aliases.column_alias(node, node.primary_key)
+                id = row[key]
+                next unless id.nil?
+
+                associations = node.reflection.name
+                Bullet::Detector::Association.add_object_associations(ar_parent, associations)
+                Bullet::Detector::NPlusOneQuery.call_association(ar_parent, associations)
+                @bullet_eager_loadings[ar_parent.class] ||= {}
+                @bullet_eager_loadings[ar_parent.class][ar_parent] ||= Set.new
+                @bullet_eager_loadings[ar_parent.class][ar_parent] << associations
+              end
+            end
+          end
+
+          super
+        end
+
+        # call join associations
+        def construct_model(record, node, row, model_cache, id)
+          result = super
+
+          if Bullet.start?
+            associations = node.reflection.name
+            Bullet::Detector::Association.add_object_associations(record, associations)
+            Bullet::Detector::NPlusOneQuery.call_association(record, associations)
+            @bullet_eager_loadings[record.class] ||= {}
+            @bullet_eager_loadings[record.class][record] ||= Set.new
+            @bullet_eager_loadings[record.class][record] << associations
+          end
+
+          result
+        end
+      end)
+
+      ::ActiveRecord::Associations::CollectionAssociation.prepend(Module.new do
+        def load_target
+          records = super
+
+          if Bullet.start?
+            if is_a? ::ActiveRecord::Associations::ThroughAssociation
+              Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.through_reflection.name)
+              association = owner.association reflection.through_reflection.name
+              Array(association.target).each do |through_record|
+                Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
+              end
+
+              if reflection.through_reflection != through_reflection
+                Bullet::Detector::NPlusOneQuery.call_association(owner, through_reflection.name)
+              end
+            end
+            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) unless @inversed
+            if records.first.class.name !~ /^HABTM_/
+              if records.size > 1
+                Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
+                Bullet::Detector::CounterCache.add_possible_objects(records)
+              elsif records.size == 1
+                Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
+                Bullet::Detector::CounterCache.add_impossible_object(records.first)
+              end
+            end
+          end
+          records
+        end
+
+        def empty?
+          if Bullet.start? && !reflection.has_cached_counter?
+            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+          end
+          super
+        end
+
+        def include?(object)
+          if Bullet.start?
+            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+          end
+          super
+        end
+      end)
+
+      ::ActiveRecord::Associations::SingularAssociation.prepend(Module.new do
+        # call has_one and belongs_to associations
+        def target
+          result = super()
+          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
+                Bullet::Detector::NPlusOneQuery.add_possible_objects(result) if result
+              end
+            end
+          end
+          result
+        end
+      end)
+
+      ::ActiveRecord::Associations::HasManyAssociation.prepend(Module.new do
+        def empty?
+          result = super
+          if Bullet.start? && !reflection.has_cached_counter?
+            Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
+          end
+          result
+        end
+
+        def count_records
+          result = reflection.has_cached_counter?
+          if Bullet.start? && !result && !is_a?(::ActiveRecord::Associations::ThroughAssociation)
+            Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
+          end
+          super
+        end
+      end)
+
+      ::ActiveRecord::Associations::BelongsToAssociation.prepend(Module.new do
+        def writer(record)
+          Bullet::Detector::Association.add_object_associations(owner, reflection.name) if Bullet.start?
+          super
+        end
+      end)
+    end
+  end
+end

data/lib/bullet/bullet_xhr.js

@@ -0,0 +1,69 @@
+(function() {
+  var oldOpen = window.XMLHttpRequest.prototype.open;
+  var oldSend = window.XMLHttpRequest.prototype.send;
+
+  /**
+   * Return early if we've already extended prototype. This prevents
+   * "maximum call stack exceeded" errors when used with Turbolinks.
+   * See https://github.com/flyerhzm/bullet/issues/454
+   */
+  if (isBulletInitiated()) return;
+
+  function isBulletInitiated() {
+    return oldOpen.name == 'bulletXHROpen' && oldSend.name == 'bulletXHRSend';
+  }
+  function bulletXHROpen(_, url) {
+    this._storedUrl = url;
+    return oldOpen.apply(this, arguments);
+  }
+  function bulletXHRSend() {
+    if (this.onload) {
+      this._storedOnload = this.onload;
+    }
+    this.addEventListener('load', bulletXHROnload);
+    return oldSend.apply(this, arguments);
+  }
+  function bulletXHROnload() {
+    if (
+      this._storedUrl.startsWith(
+        window.location.protocol + '//' + window.location.host
+      ) ||
+      !this._storedUrl.startsWith('http') // For relative paths
+    ) {
+      var bulletFooterText = this.getResponseHeader('X-bullet-footer-text');
+      if (bulletFooterText) {
+        setTimeout(() => {
+          var oldHtml = document
+            .getElementById('bullet-footer')
+            .innerHTML.split('<br>');
+          var header = oldHtml[0];
+          oldHtml = oldHtml.slice(1, oldHtml.length);
+          var newHtml = oldHtml.concat(JSON.parse(bulletFooterText));
+          newHtml = newHtml.slice(newHtml.length - 10, newHtml.length); // rotate through 10 most recent
+          document.getElementById(
+            'bullet-footer'
+          ).innerHTML = `${header}<br>${newHtml.join('<br>')}`;
+        }, 0);
+      }
+      var bulletConsoleText = this.getResponseHeader('X-bullet-console-text');
+      if (bulletConsoleText && typeof console !== 'undefined' && console.log) {
+        setTimeout(() => {
+          JSON.parse(bulletConsoleText).forEach(message => {
+            if (console.groupCollapsed && console.groupEnd) {
+              console.groupCollapsed('Uniform Notifier');
+              console.log(message);
+              console.groupEnd();
+            } else {
+              console.log(message);
+            }
+          });
+        }, 0);
+      }
+    }
+    if (this._storedOnload) {
+      return this._storedOnload.apply(this, arguments);
+    }
+  }
+  window.XMLHttpRequest.prototype.open = bulletXHROpen;
+  window.XMLHttpRequest.prototype.send = bulletXHRSend;
+})();

data/lib/bullet/dependency.rb

@@ -10,10 +10,6 @@ module Bullet
       @active_record ||= defined? ::ActiveRecord
     end
 
-    def rails?
-      @rails ||= defined? ::Rails
-    end
-
     def active_record_version
       @active_record_version ||= begin
                                    if active_record40?
@@ -28,6 +24,8 @@ module Bullet
                                      'active_record5'
                                    elsif active_record52?
                                      'active_record52'
+                                   elsif active_record60?
+                                     'active_record60'
                                    else
                                      raise "Bullet does not support active_record #{::ActiveRecord::VERSION::STRING} yet"
                                    end
@@ -58,6 +56,10 @@ module Bullet
       active_record? && ::ActiveRecord::VERSION::MAJOR == 5
     end
 
+    def active_record6?
+      active_record? && ::ActiveRecord::VERSION::MAJOR == 6
+    end
+
     def active_record40?
       active_record4? && ::ActiveRecord::VERSION::MINOR == 0
     end
@@ -82,6 +84,10 @@ module Bullet
       active_record5? && ::ActiveRecord::VERSION::MINOR == 2
     end
 
+    def active_record60?
+      active_record6? && ::ActiveRecord::VERSION::MINOR == 0
+    end
+
     def mongoid4x?
       mongoid? && ::Mongoid::VERSION =~ /\A4/
     end

data/lib/bullet/detector/association.rb

@@ -7,7 +7,7 @@ module Bullet
         def add_object_associations(object, associations)
           return unless Bullet.start?
           return if !Bullet.n_plus_one_query_enable? && !Bullet.unused_eager_loading_enable?
-          return unless object.primary_key_value
+          return unless object.bullet_primary_key_value
 
           Bullet.debug('Detector::Association#add_object_associations', "object: #{object.bullet_key}, associations: #{associations}")
           object_associations.add(object.bullet_key, associations)
@@ -16,7 +16,7 @@ module Bullet
         def add_call_object_associations(object, associations)
           return unless Bullet.start?
           return if !Bullet.n_plus_one_query_enable? && !Bullet.unused_eager_loading_enable?
-          return unless object.primary_key_value
+          return unless object.bullet_primary_key_value
 
           Bullet.debug('Detector::Association#add_call_object_associations', "object: #{object.bullet_key}, associations: #{associations}")
           call_object_associations.add(object.bullet_key, associations)

data/lib/bullet/detector/counter_cache.rb

@@ -7,7 +7,7 @@ module Bullet
         def add_counter_cache(object, associations)
           return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
-          return unless object.primary_key_value
+          return unless object.bullet_primary_key_value
 
           Bullet.debug('Detector::CounterCache#add_counter_cache', "object: #{object.bullet_key}, associations: #{associations}")
           if conditions_met?(object, associations)
@@ -20,7 +20,7 @@ module Bullet
           return unless Bullet.counter_cache_enable?
 
           objects = Array(object_or_objects)
-          return if objects.map(&:primary_key_value).compact.empty?
+          return if objects.map(&:bullet_primary_key_value).compact.empty?
 
           Bullet.debug('Detector::CounterCache#add_possible_objects', "objects: #{objects.map(&:bullet_key).join(', ')}")
           objects.each { |object| possible_objects.add object.bullet_key }
@@ -29,7 +29,7 @@ module Bullet
         def add_impossible_object(object)
           return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
-          return unless object.primary_key_value
+          return unless object.bullet_primary_key_value
 
           Bullet.debug('Detector::CounterCache#add_impossible_object', "object: #{object.bullet_key}")
           impossible_objects.add object.bullet_key

data/lib/bullet/detector/n_plus_one_query.rb

@@ -14,7 +14,7 @@ module Bullet
         def call_association(object, associations)
           return unless Bullet.start?
           return unless Bullet.n_plus_one_query_enable?
-          return unless object.primary_key_value
+          return unless object.bullet_primary_key_value
           return if inversed_objects.include?(object.bullet_key, associations)
 
           add_call_object_associations(object, associations)
@@ -31,7 +31,7 @@ module Bullet
           return unless Bullet.n_plus_one_query_enable?
 
           objects = Array(object_or_objects)
-          return if objects.map(&:primary_key_value).compact.empty?
+          return if objects.map(&:bullet_primary_key_value).compact.empty?
 
           Bullet.debug('Detector::NPlusOneQuery#add_possible_objects', "objects: #{objects.map(&:bullet_key).join(', ')}")
           objects.each { |object| possible_objects.add object.bullet_key }
@@ -40,7 +40,7 @@ module Bullet
         def add_impossible_object(object)
           return unless Bullet.start?
           return unless Bullet.n_plus_one_query_enable?
-          return unless object.primary_key_value
+          return unless object.bullet_primary_key_value
 
           Bullet.debug('Detector::NPlusOneQuery#add_impossible_object', "object: #{object.bullet_key}")
           impossible_objects.add object.bullet_key
@@ -49,7 +49,7 @@ module Bullet
         def add_inversed_object(object, association)
           return unless Bullet.start?
           return unless Bullet.n_plus_one_query_enable?
-          return unless object.primary_key_value
+          return unless object.bullet_primary_key_value
 
           Bullet.debug('Detector::NPlusOneQuery#add_inversed_object', "object: #{object.bullet_key}, association: #{association}")
           inversed_objects.add object.bullet_key, association

data/lib/bullet/detector/unused_eager_loading.rb

@@ -27,7 +27,7 @@ module Bullet
         def add_eager_loadings(objects, associations)
           return unless Bullet.start?
           return unless Bullet.unused_eager_loading_enable?
-          return if objects.map(&:primary_key_value).compact.empty?
+          return if objects.map(&:bullet_primary_key_value).compact.empty?
 
           Bullet.debug('Detector::UnusedEagerLoading#add_eager_loadings', "objects: #{objects.map(&:bullet_key).join(', ')}, associations: #{associations}")
           bullet_keys = objects.map(&:bullet_key)

data/lib/bullet/ext/object.rb

@@ -2,10 +2,12 @@
 
 class Object
   def bullet_key
-    "#{self.class}:#{primary_key_value}"
+    "#{self.class}:#{bullet_primary_key_value}"
   end
 
-  def primary_key_value
+  def bullet_primary_key_value
+    return if respond_to?(:persisted?) && !persisted?
+
     if self.class.respond_to?(:primary_keys) && self.class.primary_keys
       self.class.primary_keys.map { |primary_key| send primary_key }.join(',')
     elsif self.class.respond_to?(:primary_key) && self.class.primary_key

data/lib/bullet/rack.rb

@@ -16,12 +16,17 @@ module Bullet
 
       response_body = nil
       if Bullet.notification?
-        if !file?(headers) && !sse?(headers) && !empty?(response) &&
-           status == 200 && html_request?(headers, response)
-          response_body = response_body(response)
-          response_body = append_to_html_body(response_body, footer_note) if Bullet.add_footer
-          response_body = append_to_html_body(response_body, Bullet.gather_inline_notifications)
-          headers['Content-Length'] = response_body.bytesize.to_s
+        if !file?(headers) && !sse?(headers) && !empty?(response) && status == 200
+          if html_request?(headers, response)
+            response_body = response_body(response)
+            response_body = append_to_html_body(response_body, footer_note) if Bullet.add_footer
+            response_body = append_to_html_body(response_body, Bullet.gather_inline_notifications)
+            response_body = append_to_html_body(response_body, xhr_script)
+            headers['Content-Length'] = response_body.bytesize.to_s
+          else
+            set_header(headers, 'X-bullet-footer-text', Bullet.footer_info.uniq) if Bullet.add_footer
+            set_header(headers, 'X-bullet-console-text', Bullet.text_notifications) if Bullet.console_enabled?
+          end
         end
         Bullet.perform_out_of_channel_notifications(env)
       end
@@ -32,16 +37,10 @@ module Bullet
 
     # fix issue if response's body is a Proc
     def empty?(response)
-      # response may be ["Not Found"], ["Move Permanently"], etc.
-      if rails?
-        (response.is_a?(Array) && response.size <= 1) ||
-          !response.respond_to?(:body) ||
-          !response_body(response).respond_to?(:empty?) ||
-          response_body(response).empty?
-      else
-        body = response_body(response)
-        body.nil? || body.empty?
-      end
+      # response may be ["Not Found"], ["Move Permanently"], etc, but
+      # those should not happen if the status is 200
+      body = response_body(response)
+      body.nil? || body.empty?
     end
 
     def append_to_html_body(response_body, content)
@@ -55,7 +54,15 @@ module Bullet
     end
 
     def footer_note
-      "<div #{footer_div_attributes}>" + footer_close_button + Bullet.footer_info.uniq.join('<br>') + '</div>'
+      "<div #{footer_div_attributes}>" + footer_header + '<br>' + Bullet.footer_info.uniq.join('<br>') + '</div>'
+    end
+
+    def set_header(headers, header_name, header_array)
+      # Many proxy applications such as Nginx and AWS ELB limit
+      # the size a header to 8KB, so truncate the list of reports to
+      # be under that limit
+      header_array.pop while header_array.to_json.length > 8 * 1024
+      headers[header_name] = header_array.to_json
     end
 
     def file?(headers)
@@ -82,7 +89,7 @@ module Bullet
 
     def footer_div_attributes
       <<~EOF
-        data-is-bullet-footer ondblclick="this.parentNode.removeChild(this);" style="position: fixed; bottom: 0pt; left: 0pt; cursor: pointer; border-style: solid; border-color: rgb(153, 153, 153);
+        id="bullet-footer" data-is-bullet-footer ondblclick="this.parentNode.removeChild(this);" style="position: fixed; bottom: 0pt; left: 0pt; cursor: pointer; border-style: solid; border-color: rgb(153, 153, 153);
          -moz-border-top-colors: none; -moz-border-right-colors: none; -moz-border-bottom-colors: none;
          -moz-border-left-colors: none; -moz-border-image: none; border-width: 2pt 2pt 0px 0px;
          padding: 3px 5px; border-radius: 0pt 10pt 0pt 0px; background: none repeat scroll 0% 0% rgba(200, 200, 200, 0.8);
@@ -90,8 +97,18 @@ module Bullet
       EOF
     end
 
-    def footer_close_button
-      "<span onclick='this.parentNode.remove()' style='position:absolute; right: 10px; top: 0px; font-weight: bold; color: #333;'>&times;</span>"
+    def footer_header
+      cancel_button = "<span onclick='this.parentNode.remove()' style='position:absolute; right: 10px; top: 0px; font-weight: bold; color: #333;'>&times;</span>"
+      if Bullet.console_enabled?
+        "<span>See 'Uniform Notifier' in JS Console for Stacktrace</span>#{cancel_button}"
+      else
+        cancel_button
+      end
+    end
+
+    # Make footer work for XHR requests by appending data to the footer
+    def xhr_script
+      "<script type='text/javascript'>#{File.read("#{__dir__}/bullet_xhr.js")}</script>"
     end
   end
 end

data/lib/bullet/stack_trace_filter.rb

@@ -5,12 +5,11 @@ module Bullet
     VENDOR_PATH = '/vendor'
 
     def caller_in_project
-      app_root = rails? ? Rails.root.to_s : Dir.pwd
-      vendor_root = app_root + VENDOR_PATH
+      vendor_root = Bullet.app_root + VENDOR_PATH
       bundler_path = Bundler.bundle_path.to_s
       select_caller_locations do |location|
         caller_path = location_as_path(location)
-        caller_path.include?(app_root) && !caller_path.include?(vendor_root) && !caller_path.include?(bundler_path) ||
+        caller_path.include?(Bullet.app_root) && !caller_path.include?(vendor_root) && !caller_path.include?(bundler_path) ||
           Bullet.stacktrace_includes.any? { |include_pattern| pattern_matches?(location, include_pattern) }
       end
     end

data/lib/bullet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bullet
-  VERSION = '5.9.0'
+  VERSION = '6.0.1'
 end

data/spec/bullet/ext/object_spec.rb

@@ -17,23 +17,28 @@ describe Object do
     end
   end
 
-  context 'primary_key_value' do
+  context 'bullet_primary_key_value' do
     it 'should return id' do
       post = Post.first
-      expect(post.primary_key_value).to eq(post.id)
+      expect(post.bullet_primary_key_value).to eq(post.id)
     end
 
     it 'should return primary key value' do
       post = Post.first
       Post.primary_key = 'name'
-      expect(post.primary_key_value).to eq(post.name)
+      expect(post.bullet_primary_key_value).to eq(post.name)
       Post.primary_key = 'id'
     end
 
     it 'should return value for multiple primary keys' do
       post = Post.first
       allow(Post).to receive(:primary_keys).and_return(%i[category_id writer_id])
-      expect(post.primary_key_value).to eq("#{post.category_id},#{post.writer_id}")
+      expect(post.bullet_primary_key_value).to eq("#{post.category_id},#{post.writer_id}")
+    end
+
+    it 'it should return nil for unpersisted records' do
+      post = Post.new(id: 123)
+      expect(post.bullet_primary_key_value).to be_nil
     end
   end
 end

data/spec/bullet/rack_spec.rb

@@ -45,9 +45,9 @@ module Bullet
         expect(middleware).not_to be_empty(response)
       end
 
-      it 'should be true if response is not found' do
+      it 'should be false if response is not found' do
         response = ['Not Found']
-        expect(middleware).to be_empty(response)
+        expect(middleware).not_to be_empty(response)
       end
 
       it 'should be true if response body is empty' do
@@ -68,6 +68,7 @@ module Bullet
         it 'should change response body if notification is active' do
           expect(Bullet).to receive(:notification?).and_return(true)
           expect(Bullet).to receive(:gather_inline_notifications).and_return('<bullet></bullet>')
+          expect(middleware).to receive(:xhr_script).and_return('')
           expect(Bullet).to receive(:perform_out_of_channel_notifications)
           status, headers, response = middleware.call('Content-Type' => 'text/html')
           expect(headers['Content-Length']).to eq('56')
@@ -81,7 +82,7 @@ module Bullet
           expect(Bullet).to receive(:notification?).and_return(true)
           expect(Bullet).to receive(:gather_inline_notifications).and_return('<bullet></bullet>')
           status, headers, response = middleware.call('Content-Type' => 'text/html')
-          expect(headers['Content-Length']).to eq('58')
+          expect(headers['Content-Length']).to eq((58 + middleware.send(:xhr_script).length).to_s)
         end
       end
 
@@ -95,6 +96,14 @@ module Bullet
       end
     end
 
+    context '#set_header' do
+      it 'should truncate headers to under 8kb' do
+        long_header = ['a' * 1024] * 10
+        expected_res = (['a' * 1024] * 7).to_json
+        expect(middleware.set_header({}, 'Dummy-Header', long_header)).to eq(expected_res)
+      end
+    end
+
     describe '#response_body' do
       let(:response) { double }
       let(:body_string) { '<html><body>My Body</body></html>' }

data/spec/integration/active_record/association_spec.rb

@@ -246,7 +246,7 @@ if active_record?
         category = Category.first
         category.draft_post.destroy!
         post = category.draft_post
-        post.update_attributes!(link: true)
+        post.update!(link: true)
         Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
         expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
 
@@ -331,7 +331,7 @@ if active_record?
         expect(Bullet::Detector::Association).to be_completely_preloading_associations
       end
 
-      it 'should dtect preload with comment => post' do
+      it 'should detect preload with comment => post' do
         Comment.includes(:post).each do |comment|
           comment.post.name
         end
@@ -362,22 +362,11 @@ if active_record?
 
         new_post.trigger_after_save = true
         new_post.save!
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
         expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
 
         expect(Bullet::Detector::Association).to be_completely_preloading_associations
       end
-
-      it 'should not detect "manual" preload' do
-        comment = Comment.all.to_a.first
-        post = Post.find(comment.post_id)
-        # "manually" preload with out-of-band data
-        comment.post = post
-        # loading it should not trigger anything
-        comment.post
-
-        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
-        expect(Bullet::Detector::Association).to be_completely_preloading_associations
-      end
     end
 
     context 'comment => post => category' do

data/spec/integration/counter_cache_spec.rb

@@ -38,7 +38,7 @@ if !mongoid? && active_record?
       expect(Bullet.collected_counter_cache_notifications).to be_empty
     end
 
-    if active_record5?
+    if active_record5? || active_record6?
       it 'should not need counter cache for has_many through' do
         Client.all.each do |client|
           client.firms.size

data/test.sh

@@ -1,5 +1,6 @@
 #bundle update rails && bundle exec rspec spec
 #BUNDLE_GEMFILE=Gemfile.mongoid bundle update mongoid && BUNDLE_GEMFILE=Gemfile.mongoid bundle exec rspec spec
+BUNDLE_GEMFILE=Gemfile.rails-6.0 bundle && BUNDLE_GEMFILE=Gemfile.rails-6.0 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.rails-5.2 bundle && BUNDLE_GEMFILE=Gemfile.rails-5.2 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.rails-5.1 bundle && BUNDLE_GEMFILE=Gemfile.rails-5.1 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.rails-5.0 bundle && BUNDLE_GEMFILE=Gemfile.rails-5.0 bundle exec rspec spec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet
 version: !ruby/object:Gem::Version
-  version: 5.9.0
+  version: 6.0.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-11 00:00:00.000000000 Z
+date: 2019-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -61,6 +61,7 @@ files:
 - Gemfile.rails-5.0
 - Gemfile.rails-5.1
 - Gemfile.rails-5.2
+- Gemfile.rails-6.0
 - Guardfile
 - Hacking.md
 - MIT-LICENSE
@@ -68,11 +69,14 @@ files:
 - Rakefile
 - bullet.gemspec
 - lib/bullet.rb
+- lib/bullet/active_job.rb
 - lib/bullet/active_record4.rb
 - lib/bullet/active_record41.rb
 - lib/bullet/active_record42.rb
 - lib/bullet/active_record5.rb
 - lib/bullet/active_record52.rb
+- lib/bullet/active_record60.rb
+- lib/bullet/bullet_xhr.js
 - lib/bullet/dependency.rb
 - lib/bullet/detector.rb
 - lib/bullet/detector/association.rb
@@ -184,8 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: help to kill N+1 queries and unused eager loading.