bullet 5.7.0 → 6.0.0

data/lib/bullet/bullet_xhr.js

@@ -0,0 +1,58 @@
+(function() {
+  var oldOpen = window.XMLHttpRequest.prototype.open;
+  var oldSend = window.XMLHttpRequest.prototype.send;
+  function newOpen(method, url, async, user, password) {
+    this._storedUrl = url;
+    return oldOpen.apply(this, arguments);
+  }
+  function newSend(data) {
+    if (this.onload) {
+      this._storedOnload = this.onload;
+    }
+    this.onload = newOnload;
+    return oldSend.apply(this, arguments);
+  }
+  function newOnload() {
+    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 = newOpen;
+  window.XMLHttpRequest.prototype.send = newSend;
+})();

data/lib/bullet/dependency.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Dependency
     def mongoid?
@@ -8,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?
@@ -26,8 +24,10 @@ module Bullet
                                      'active_record5'
                                    elsif active_record52?
                                      'active_record52'
+                                   elsif active_record60?
+                                     'active_record60'
                                    else
-                                     raise "Bullet does not support active_record #{::ActiveRecord::VERSION} yet"
+                                     raise "Bullet does not support active_record #{::ActiveRecord::VERSION::STRING} yet"
                                    end
                                  end
     end
@@ -40,6 +40,8 @@ module Bullet
                                'mongoid5x'
                              elsif mongoid6x?
                                'mongoid6x'
+                             elsif mongoid7x?
+                               'mongoid7x'
                              else
                                raise "Bullet does not support mongoid #{::Mongoid::VERSION} yet"
                              end
@@ -54,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
@@ -78,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
@@ -89,5 +99,9 @@ module Bullet
     def mongoid6x?
       mongoid? && ::Mongoid::VERSION =~ /\A6/
     end
+
+    def mongoid7x?
+      mongoid? && ::Mongoid::VERSION =~ /\A7/
+    end
   end
 end

data/lib/bullet/detector/association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Detector
     class Association < Base
@@ -5,18 +7,18 @@ 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'.freeze, "object: #{object.bullet_key}, associations: #{associations}")
+          Bullet.debug('Detector::Association#add_object_associations', "object: #{object.bullet_key}, associations: #{associations}")
           object_associations.add(object.bullet_key, associations)
         end
 
         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'.freeze, "object: #{object.bullet_key}, associations: #{associations}")
+          Bullet.debug('Detector::Association#add_call_object_associations', "object: #{object.bullet_key}, associations: #{associations}")
           call_object_associations.add(object.bullet_key, associations)
         end
 
@@ -43,31 +45,31 @@ module Bullet
           # e.g. { "Post:1" => [:comments] }
           # the object_associations keep all associations that may be or may no be
           # unpreload associations or unused preload associations.
-          def object_associations
-            Thread.current[:bullet_object_associations]
-          end
+        def object_associations
+          Thread.current[:bullet_object_associations]
+        end
 
           # call_object_associations keep the object relationships
           # that object.associations is called.
           # e.g. { "Post:1" => [:comments] }
           # they are used to detect unused preload associations.
-          def call_object_associations
-            Thread.current[:bullet_call_object_associations]
-          end
+        def call_object_associations
+          Thread.current[:bullet_call_object_associations]
+        end
 
           # inversed_objects keeps object relationships
           # that association is inversed.
           # e.g. { "Comment:1" => ["post"] }
-          def inversed_objects
-            Thread.current[:bullet_inversed_objects]
-          end
+        def inversed_objects
+          Thread.current[:bullet_inversed_objects]
+        end
 
           # eager_loadings keep the object relationships
           # that the associations are preloaded by find :include.
           # e.g. { ["Post:1", "Post:2"] => [:comments, :user] }
-          def eager_loadings
-            Thread.current[:bullet_eager_loadings]
-          end
+        def eager_loadings
+          Thread.current[:bullet_eager_loadings]
+        end
       end
     end
   end

data/lib/bullet/detector/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Detector
     class Base

data/lib/bullet/detector/counter_cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Detector
     class CounterCache < Base
@@ -5,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)
@@ -16,8 +18,9 @@ module Bullet
         def add_possible_objects(object_or_objects)
           return unless Bullet.start?
           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 }
@@ -26,13 +29,13 @@ 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
         end
 
-        def conditions_met?(object, associations)
+        def conditions_met?(object, _associations)
           possible_objects.include?(object.bullet_key) && !impossible_objects.include?(object.bullet_key)
         end
 
@@ -46,14 +49,14 @@ module Bullet
 
         private
 
-          def create_notification(klazz, associations)
-            notify_associations = Array(associations) - Bullet.get_whitelist_associations(:counter_cache, klazz)
+        def create_notification(klazz, associations)
+          notify_associations = Array(associations) - Bullet.get_whitelist_associations(:counter_cache, klazz)
 
-            if notify_associations.present?
-              notice = Bullet::Notification::CounterCache.new klazz, notify_associations
-              Bullet.notification_collector.add notice
-            end
+          if notify_associations.present?
+            notice = Bullet::Notification::CounterCache.new klazz, notify_associations
+            Bullet.notification_collector.add notice
           end
+        end
       end
     end
   end

data/lib/bullet/detector/n_plus_one_query.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Detector
     class NPlusOneQuery < Association
@@ -12,11 +14,12 @@ 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)
 
-          Bullet.debug('Detector::NPlusOneQuery#call_association'.freeze, "object: #{object.bullet_key}, associations: #{associations}")
+          Bullet.debug('Detector::NPlusOneQuery#call_association', "object: #{object.bullet_key}, associations: #{associations}")
           if !excluded_stacktrace_path? && conditions_met?(object, associations)
             Bullet.debug('detect n + 1 query', "object: #{object.bullet_key}, associations: #{associations}")
             create_notification caller_in_project, object.class.to_s, associations
@@ -26,28 +29,29 @@ module Bullet
         def add_possible_objects(object_or_objects)
           return unless Bullet.start?
           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'.freeze, "objects: #{objects.map(&:bullet_key).join(', '.freeze)}")
+          Bullet.debug('Detector::NPlusOneQuery#add_possible_objects', "objects: #{objects.map(&:bullet_key).join(', ')}")
           objects.each { |object| possible_objects.add object.bullet_key }
         end
 
         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'.freeze, "object: #{object.bullet_key}")
+          Bullet.debug('Detector::NPlusOneQuery#add_impossible_object', "object: #{object.bullet_key}")
           impossible_objects.add object.bullet_key
         end
 
         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'.freeze, "object: #{object.bullet_key}, association: #{association}")
+          Bullet.debug('Detector::NPlusOneQuery#add_inversed_object', "object: #{object.bullet_key}, association: #{association}")
           inversed_objects.add object.bullet_key, association
         end
 
@@ -67,14 +71,12 @@ module Bullet
         # check if object => associations already exists in object_associations.
         def association?(object, associations)
           value = object_associations[object.bullet_key]
-          if value
-            value.each do |v|
+          value&.each do |v|
               # associations == v comparison order is important here because
               # v variable might be a squeel node where :== method is redefined,
               # so it does not compare values at all and return unexpected results
-              result = v.is_a?(Hash) ? v.key?(associations) : associations == v
-              return true if result
-            end
+            result = v.is_a?(Hash) ? v.key?(associations) : associations == v
+            return true if result
           end
 
           false
@@ -82,14 +84,14 @@ module Bullet
 
         private
 
-          def create_notification(callers, klazz, associations)
-            notify_associations = Array(associations) - Bullet.get_whitelist_associations(:n_plus_one_query, klazz)
+        def create_notification(callers, klazz, associations)
+          notify_associations = Array(associations) - Bullet.get_whitelist_associations(:n_plus_one_query, klazz)
 
-            if notify_associations.present?
-              notice = Bullet::Notification::NPlusOneQuery.new(callers, klazz, notify_associations)
-              Bullet.notification_collector.add(notice)
-            end
+          if notify_associations.present?
+            notice = Bullet::Notification::NPlusOneQuery.new(callers, klazz, notify_associations)
+            Bullet.notification_collector.add(notice)
           end
+        end
       end
     end
   end

data/lib/bullet/detector/unused_eager_loading.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Detector
     class UnusedEagerLoading < Association
@@ -25,18 +27,20 @@ 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)
 
-          to_add, to_merge, to_delete = [], [], []
-          eager_loadings.each do |k, v|
+          to_add = []
+          to_merge = []
+          to_delete = []
+          eager_loadings.each do |k, _v|
             key_objects_overlap = k & bullet_keys
 
             next if key_objects_overlap.empty?
 
-            bullet_keys = bullet_keys - k
+            bullet_keys -= k
             if key_objects_overlap == k
               to_add << [k, associations]
             else
@@ -57,29 +61,30 @@ module Bullet
 
         private
 
-          def create_notification(callers, klazz, associations)
-            notify_associations = Array(associations) - Bullet.get_whitelist_associations(:unused_eager_loading, klazz)
+        def create_notification(callers, klazz, associations)
+          notify_associations = Array(associations) - Bullet.get_whitelist_associations(:unused_eager_loading, klazz)
 
-            if notify_associations.present?
-              notice = Bullet::Notification::UnusedEagerLoading.new(callers, klazz, notify_associations)
-              Bullet.notification_collector.add(notice)
-            end
+          if notify_associations.present?
+            notice = Bullet::Notification::UnusedEagerLoading.new(callers, klazz, notify_associations)
+            Bullet.notification_collector.add(notice)
           end
+        end
 
-          def call_associations(bullet_key, associations)
-            all = Set.new
-            eager_loadings.similarly_associated(bullet_key, associations).each do |related_bullet_key|
-              coa = call_object_associations[related_bullet_key]
-              next if coa.nil?
-              all.merge coa
-            end
-            all.to_a
-          end
+        def call_associations(bullet_key, associations)
+          all = Set.new
+          eager_loadings.similarly_associated(bullet_key, associations).each do |related_bullet_key|
+            coa = call_object_associations[related_bullet_key]
+            next if coa.nil?
 
-          def diff_object_associations(bullet_key, associations)
-            potential_associations = associations - call_associations(bullet_key, associations)
-            potential_associations.reject { |a| a.is_a?(Hash) }
+            all.merge coa
           end
+          all.to_a
+        end
+
+        def diff_object_associations(bullet_key, associations)
+          potential_associations = associations - call_associations(bullet_key, associations)
+          potential_associations.reject { |a| a.is_a?(Hash) }
+        end
       end
     end
   end

data/lib/bullet/detector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Detector
     autoload :Base, 'bullet/detector/base'

data/lib/bullet/ext/object.rb

@@ -1,15 +1,19 @@
+# frozen_string_literal: true
+
 class Object
   def bullet_key
-    "#{self.class}:#{self.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| self.send primary_key }.join(','.freeze)
+      self.class.primary_keys.map { |primary_key| send primary_key }.join(',')
     elsif self.class.respond_to?(:primary_key) && self.class.primary_key
-      self.send self.class.primary_key
+      send self.class.primary_key
     else
-      self.id
+      id
     end
   end
 end

data/lib/bullet/ext/string.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 class String
   def bullet_class_name
-    self.sub(/:[^:]*?$/, ''.freeze)
+    sub(/:[^:]*?$/, '')
   end
 end

data/lib/bullet/mongoid4x.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Mongoid
     def self.enable
@@ -21,13 +23,16 @@ module Bullet
         end
 
         def each(&block)
-          records = query.map { |doc| ::Mongoid::Factory.from_db(klass, doc) }
+          return to_enum unless block_given?
+
+          records = []
+          origin_each { |record| records << record }
           if records.length > 1
             Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
           elsif records.size == 1
             Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
           end
-          origin_each(&block)
+          records.each(&block)
         end
 
         def eager_load(docs)

data/lib/bullet/mongoid5x.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Mongoid
     def self.enable
@@ -21,13 +23,16 @@ module Bullet
         end
 
         def each(&block)
-          records = view.map { |doc| ::Mongoid::Factory.from_db(klass, doc) }
+          return to_enum unless block_given?
+
+          records = []
+          origin_each { |record| records << record }
           if records.length > 1
             Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
           elsif records.size == 1
             Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
           end
-          origin_each(&block)
+          records.each(&block)
         end
 
         def eager_load(docs)

data/lib/bullet/mongoid6x.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Mongoid
     def self.enable
@@ -8,26 +10,29 @@ module Bullet
         alias_method :origin_each, :each
         alias_method :origin_eager_load, :eager_load
 
-        def first
-          result = origin_first
+        def first(opt = {})
+          result = origin_first(opt)
           Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
           result
         end
 
-        def last
-          result = origin_last
+        def last(opt = {})
+          result = origin_last(opt)
           Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
           result
         end
 
         def each(&block)
-          records = view.map { |doc| ::Mongoid::Factory.from_db(klass, doc) }
+          return to_enum unless block_given?
+
+          records = []
+          origin_each { |record| records << record }
           if records.length > 1
             Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
           elsif records.size == 1
             Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
           end
-          origin_each(&block)
+          records.each(&block)
         end
 
         def eager_load(docs)

data/lib/bullet/mongoid7x.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Bullet
+  module Mongoid
+    def self.enable
+      require 'mongoid'
+      ::Mongoid::Contextual::Mongo.class_eval do
+        alias_method :origin_first, :first
+        alias_method :origin_last, :last
+        alias_method :origin_each, :each
+        alias_method :origin_eager_load, :eager_load
+
+        def first(opts = {})
+          result = origin_first(opts)
+          Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+          result
+        end
+
+        def last(opts = {})
+          result = origin_last(opts)
+          Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+          result
+        end
+
+        def each(&block)
+          return to_enum unless block_given?
+
+          records = []
+          origin_each { |record| records << record }
+          if records.length > 1
+            Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
+          elsif records.size == 1
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
+          end
+          records.each(&block)
+        end
+
+        def eager_load(docs)
+          associations = criteria.inclusions.map(&:name)
+          docs.each do |doc|
+            Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations)
+          end
+          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(docs, associations)
+          origin_eager_load(docs)
+        end
+      end
+
+      ::Mongoid::Association::Accessors.class_eval do
+        alias_method :origin_get_relation, :get_relation
+
+        def get_relation(name, association, object, reload = false)
+          result = origin_get_relation(name, association, object, reload)
+          unless association.embedded?
+            Bullet::Detector::NPlusOneQuery.call_association(self, name)
+          end
+          result
+        end
+      end
+    end
+  end
+end