bullet 5.5.0 → 5.8.0

data/lib/bullet/detector/counter_cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Detector
     class CounterCache < Base
@@ -7,7 +9,7 @@ module Bullet
           return unless Bullet.counter_cache_enable?
           return unless object.primary_key_value
 
-          Bullet.debug("Detector::CounterCache#add_counter_cache", "object: #{object.bullet_key}, associations: #{associations}")
+          Bullet.debug('Detector::CounterCache#add_counter_cache', "object: #{object.bullet_key}, associations: #{associations}")
           if conditions_met?(object, associations)
             create_notification object.class.to_s, associations
           end
@@ -16,10 +18,11 @@ 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?
 
-          Bullet.debug("Detector::CounterCache#add_possible_objects", "objects: #{objects.map(&:bullet_key).join(', ')}")
+          Bullet.debug('Detector::CounterCache#add_possible_objects', "objects: #{objects.map(&:bullet_key).join(', ')}")
           objects.each { |object| possible_objects.add object.bullet_key }
         end
 
@@ -28,11 +31,11 @@ module Bullet
           return unless Bullet.counter_cache_enable?
           return unless object.primary_key_value
 
-          Bullet.debug("Detector::CounterCache#add_impossible_object", "object: #{object.bullet_key}")
+          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
 
@@ -45,14 +48,15 @@ module Bullet
         end
 
         private
-          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
+        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
+        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
@@ -11,13 +13,15 @@ module Bullet
         #   if it is, keeps this unpreload associations and caller.
         def call_association(object, associations)
           return unless Bullet.start?
+          return unless Bullet.n_plus_one_query_enable?
           return unless object.primary_key_value
           return if inversed_objects.include?(object.bullet_key, associations)
+
           add_call_object_associations(object, associations)
 
-          Bullet.debug("Detector::NPlusOneQuery#call_association", "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}")
+            Bullet.debug('detect n + 1 query', "object: #{object.bullet_key}, associations: #{associations}")
             create_notification caller_in_project, object.class.to_s, associations
           end
         end
@@ -25,10 +29,11 @@ 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?
 
-          Bullet.debug("Detector::NPlusOneQuery#add_possible_objects", "objects: #{objects.map(&:bullet_key).join(', ')}")
+          Bullet.debug('Detector::NPlusOneQuery#add_possible_objects', "objects: #{objects.map(&:bullet_key).join(', ')}")
           objects.each { |object| possible_objects.add object.bullet_key }
         end
 
@@ -37,7 +42,7 @@ module Bullet
           return unless Bullet.n_plus_one_query_enable?
           return unless object.primary_key_value
 
-          Bullet.debug("Detector::NPlusOneQuery#add_impossible_object", "object: #{object.bullet_key}")
+          Bullet.debug('Detector::NPlusOneQuery#add_impossible_object', "object: #{object.bullet_key}")
           impossible_objects.add object.bullet_key
         end
 
@@ -46,7 +51,7 @@ module Bullet
           return unless Bullet.n_plus_one_query_enable?
           return unless object.primary_key_value
 
-          Bullet.debug("Detector::NPlusOneQuery#add_inversed_object", "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
 
@@ -66,28 +71,27 @@ 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|
-              # associations == v comparision order is important here because
+          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
         end
 
         private
-          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
+        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
+        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
@@ -17,7 +19,7 @@ module Bullet
             object_association_diff = diff_object_associations bullet_key, associations
             next if object_association_diff.empty?
 
-            Bullet.debug("detect unused preload", "object: #{bullet_key}, associations: #{object_association_diff}")
+            Bullet.debug('detect unused preload', "object: #{bullet_key}, associations: #{object_association_diff}")
             create_notification(caller_in_project, bullet_key.bullet_class_name, object_association_diff)
           end
         end
@@ -27,20 +29,22 @@ module Bullet
           return unless Bullet.unused_eager_loading_enable?
           return if objects.map(&:primary_key_value).compact.empty?
 
-          Bullet.debug("Detector::UnusedEagerLoading#add_eager_loadings", "objects: #{objects.map(&:bullet_key).join(', ')}, associations: #{associations}")
+          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
-              to_merge << [key_objects_overlap, ( eager_loadings[k].dup  << associations )]
+              to_merge << [key_objects_overlap, (eager_loadings[k].dup << associations)]
 
               keys_without_objects = k - key_objects_overlap
               to_merge << [keys_without_objects, eager_loadings[k]]
@@ -56,29 +60,31 @@ module Bullet
         end
 
         private
-          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
-          end
+        def create_notification(callers, klazz, associations)
+          notify_associations = Array(associations) - Bullet.get_whitelist_associations(:unused_eager_loading, klazz)
 
-          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
+          if notify_associations.present?
+            notice = Bullet::Notification::UnusedEagerLoading.new(callers, klazz, notify_associations)
+            Bullet.notification_collector.add(notice)
           end
+        end
 
-          def diff_object_associations(bullet_key, associations)
-            potential_associations = associations - call_associations(bullet_key, associations)
-            potential_associations.reject { |a| a.is_a?(Hash) }
+        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 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,17 @@
+# frozen_string_literal: true
+
 class Object
   def bullet_key
-    "#{self.class}:#{self.primary_key_value}"
+    "#{self.class}:#{primary_key_value}"
   end
 
   def primary_key_value
     if self.class.respond_to?(:primary_keys) && self.class.primary_keys
-      self.class.primary_keys.map { |primary_key| self.send primary_key }.join(',')
+      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(/:[^:]*?$/, "")
+    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/notification/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Notification
     class Base
@@ -6,28 +8,32 @@ module Bullet
 
       def initialize(base_class, association_or_associations, path = nil)
         @base_class = base_class
-        @associations = association_or_associations.is_a?(Array) ?  association_or_associations : [association_or_associations]
+        @associations = association_or_associations.is_a?(Array) ? association_or_associations : [association_or_associations]
         @path = path
       end
 
       def title
-        raise NoMethodError.new("no method title defined")
+        raise NoMethodError, 'no method title defined'
       end
 
       def body
-        raise NoMethodError.new("no method body defined")
+        raise NoMethodError, 'no method body defined'
       end
 
       def call_stack_messages
-        ""
+        ''
       end
 
       def whoami
-        @user ||= ENV['USER'].presence || (`whoami`.chomp rescue "")
+        @user ||= ENV['USER'].presence || (begin
+                                             `whoami`.chomp
+                                           rescue StandardError
+                                             ''
+                                           end)
         if @user.present?
           "user: #{@user}"
         else
-          ""
+          ''
         end
       end
 
@@ -36,23 +42,23 @@ module Bullet
       end
 
       def notify_inline
-        self.notifier.inline_notify(notification_data)
+        notifier.inline_notify(notification_data)
       end
 
       def notify_out_of_channel
-        self.notifier.out_of_channel_notify(notification_data)
+        notifier.out_of_channel_notify(notification_data)
       end
 
       def short_notice
-        [whoami.presence, url, title, body].compact.join("  ")
+        [whoami.presence, url, title, body].compact.join('  ')
       end
 
       def notification_data
         {
-          :user => whoami,
-          :url => url,
-          :title => title,
-          :body => body_with_caller,
+          user: whoami,
+          url: url,
+          title: title,
+          body: body_with_caller
         }
       end
 
@@ -65,13 +71,14 @@ module Bullet
       end
 
       protected
-        def klazz_associations_str
-          "  #{@base_class} => [#{@associations.map(&:inspect).join(', ')}]"
-        end
 
-        def associations_str
-          ":includes => #{@associations.map{ |a| a.to_s.to_sym unless a.is_a? Hash }.inspect}"
-        end
+      def klazz_associations_str
+        "  #{@base_class} => [#{@associations.map(&:inspect).join(', ')}]"
+      end
+
+      def associations_str
+        ":includes => #{@associations.map { |a| a.to_s.to_sym unless a.is_a? Hash }.inspect}"
+      end
     end
   end
 end

data/lib/bullet/notification/counter_cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Notification
     class CounterCache < Base
@@ -6,7 +8,7 @@ module Bullet
       end
 
       def title
-        "Need Counter Cache"
+        'Need Counter Cache'
       end
     end
   end

data/lib/bullet/notification/n_plus_one_query.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Notification
     class NPlusOneQuery < Base
@@ -17,14 +19,15 @@ module Bullet
 
       def notification_data
         super.merge(
-          :backtrace => []
+          backtrace: []
         )
       end
 
       protected
-        def call_stack_messages
-          (['Call stack'] + @callers).join( "\n  " )
-        end
+
+      def call_stack_messages
+        (['Call stack'] + @callers).join("\n  ")
+      end
     end
   end
 end

data/lib/bullet/notification/unused_eager_loading.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Notification
     class UnusedEagerLoading < Base
@@ -17,14 +19,15 @@ module Bullet
 
       def notification_data
         super.merge(
-            :backtrace => []
+          backtrace: []
         )
       end
 
       protected
-        def call_stack_messages
-          (['Call stack'] + @callers).join( "\n  " )
-        end
+
+      def call_stack_messages
+        (['Call stack'] + @callers).join("\n  ")
+      end
     end
   end
 end

data/lib/bullet/notification.rb

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

data/lib/bullet/notification_collector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Bullet
@@ -21,4 +23,3 @@ module Bullet
     end
   end
 end
-

data/lib/bullet/rack.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   class Rack
     include Dependency
@@ -8,16 +10,17 @@ module Bullet
 
     def call(env)
       return @app.call(env) unless Bullet.enable?
+
       Bullet.start_request
       status, headers, response = @app.call(env)
 
       response_body = nil
       if Bullet.notification?
         if !file?(headers) && !sse?(headers) && !empty?(response) &&
-            status == 200 && !response_body(response).frozen? && html_request?(headers, response)
+           status == 200 && html_request?(headers, response)
           response_body = response_body(response)
-          append_to_html_body(response_body, footer_note) if Bullet.add_footer
-          append_to_html_body(response_body, Bullet.gather_inline_notifications)
+          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
         end
         Bullet.perform_out_of_channel_notifications(env)
@@ -42,28 +45,29 @@ module Bullet
     end
 
     def append_to_html_body(response_body, content)
-      if response_body.include?('</body>')
-        position = response_body.rindex('</body>')
-        response_body.insert(position, content)
+      body = response_body.dup
+      if body.include?('</body>')
+        position = body.rindex('</body>')
+        body.insert(position, content)
       else
-        response_body << content
+        body << content
       end
     end
 
     def footer_note
-      "<div #{footer_div_attributes}>" + footer_close_button + Bullet.footer_info.uniq.join("<br>") + "</div>"
+      "<div #{footer_div_attributes}>" + footer_close_button + Bullet.footer_info.uniq.join('<br>') + '</div>'
     end
 
     def file?(headers)
-      headers["Content-Transfer-Encoding"] == "binary"
+      headers['Content-Transfer-Encoding'] == 'binary' || headers['Content-Disposition']
     end
 
     def sse?(headers)
-      headers["Content-Type"] == "text/event-stream"
+      headers['Content-Type'] == 'text/event-stream'
     end
 
     def html_request?(headers, response)
-      headers['Content-Type'] && headers['Content-Type'].include?('text/html') && response_body(response).include?("<html")
+      headers['Content-Type']&.include?('text/html') && response_body(response).include?('<html')
     end
 
     def response_body(response)
@@ -77,13 +81,13 @@ module Bullet
     private
 
     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);
- -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);
- color: rgb(119, 119, 119); font-size: 16px; font-family: 'Arial', sans-serif; z-index:9999;"
-EOF
+      <<~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);
+         -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);
+         color: rgb(119, 119, 119); font-size: 16px; font-family: 'Arial', sans-serif; z-index:9999;"
+      EOF
     end
 
     def footer_close_button

data/lib/bullet/registry/association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Registry
     class Association < Base

data/lib/bullet/registry/base.rb

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