bullet 6.0.0 → 6.1.2

data/lib/bullet/detector/association.rb

@@ -3,13 +3,16 @@
 module Bullet
   module Detector
     class Association < Base
-      class <<self
+      class << self
         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.bullet_primary_key_value
 
-          Bullet.debug('Detector::Association#add_object_associations', "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
 
@@ -18,7 +21,10 @@ module Bullet
           return if !Bullet.n_plus_one_query_enable? && !Bullet.unused_eager_loading_enable?
           return unless object.bullet_primary_key_value
 
-          Bullet.debug('Detector::Association#add_call_object_associations', "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
 
@@ -40,33 +46,33 @@ module Bullet
 
         private
 
-          # object_associations keep the object relationships
-          # that the object has many associations.
-          # e.g. { "Post:1" => [:comments] }
-          # the object_associations keep all associations that may be or may no be
-          # unpreload associations or unused preload associations.
+        # object_associations keep the object relationships
+        # that the object has many associations.
+        # 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
 
-          # 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.
+        # 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
 
-          # inversed_objects keeps object relationships
-          # that association is inversed.
-          # e.g. { "Comment:1" => ["post"] }
+        # inversed_objects keeps object relationships
+        # that association is inversed.
+        # e.g. { "Comment:1" => ["post"] }
         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] }
+        # 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

data/lib/bullet/detector/base.rb

@@ -2,7 +2,6 @@
 
 module Bullet
   module Detector
-    class Base
-    end
+    class Base; end
   end
 end

data/lib/bullet/detector/counter_cache.rb

@@ -3,16 +3,17 @@
 module Bullet
   module Detector
     class CounterCache < Base
-      class <<self
+      class << self
         def add_counter_cache(object, associations)
           return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
           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)
-            create_notification object.class.to_s, associations
-          end
+          Bullet.debug(
+            'Detector::CounterCache#add_counter_cache',
+            "object: #{object.bullet_key}, associations: #{associations}"
+          )
+          create_notification object.class.to_s, associations if conditions_met?(object, associations)
         end
 
         def add_possible_objects(object_or_objects)
@@ -22,7 +23,10 @@ module Bullet
           objects = Array(object_or_objects)
           return if objects.map(&:bullet_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
 

data/lib/bullet/detector/n_plus_one_query.rb

@@ -6,7 +6,7 @@ module Bullet
       extend Dependency
       extend StackTraceFilter
 
-      class <<self
+      class << self
         # executed when object.assocations is called.
         # first, it keeps this method call for object.association.
         # then, it checks if this associations call is unpreload.
@@ -19,7 +19,10 @@ module Bullet
 
           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}")
             create_notification caller_in_project, object.class.to_s, associations
@@ -33,7 +36,10 @@ module Bullet
           objects = Array(object_or_objects)
           return if objects.map(&:bullet_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
 
@@ -51,7 +57,10 @@ module Bullet
           return unless Bullet.n_plus_one_query_enable?
           return unless object.bullet_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
 
@@ -72,10 +81,11 @@ module Bullet
         def association?(object, associations)
           value = object_associations[object.bullet_key]
           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
+            # 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
 

data/lib/bullet/detector/unused_eager_loading.rb

@@ -6,7 +6,7 @@ module Bullet
       extend Dependency
       extend StackTraceFilter
 
-      class <<self
+      class << self
         # check if there are unused preload associations.
         #   get related_objects from eager_loadings associated with object and associations
         #   get call_object_association from associations of call_object_associations whose object is in related_objects
@@ -29,7 +29,10 @@ module Bullet
           return unless Bullet.unused_eager_loading_enable?
           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.debug(
+            'Detector::UnusedEagerLoading#add_eager_loadings',
+            "objects: #{objects.map(&:bullet_key).join(', ')}, associations: #{associations}"
+          )
           bullet_keys = objects.map(&:bullet_key)
 
           to_add = []

data/lib/bullet/mongoid4x.rb

@@ -37,9 +37,7 @@ module Bullet
 
         def eager_load(docs)
           associations = criteria.inclusions.map(&:name)
-          docs.each do |doc|
-            Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations)
-          end
+          docs.each { |doc| Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations) }
           Bullet::Detector::UnusedEagerLoading.add_eager_loadings(docs, associations)
           origin_eager_load(docs)
         end
@@ -50,9 +48,7 @@ module Bullet
 
         def get_relation(name, metadata, object, reload = false)
           result = origin_get_relation(name, metadata, object, reload)
-          if metadata.macro !~ /embed/
-            Bullet::Detector::NPlusOneQuery.call_association(self, name)
-          end
+          Bullet::Detector::NPlusOneQuery.call_association(self, name) if metadata.macro !~ /embed/
           result
         end
       end

data/lib/bullet/mongoid5x.rb

@@ -37,9 +37,7 @@ module Bullet
 
         def eager_load(docs)
           associations = criteria.inclusions.map(&:name)
-          docs.each do |doc|
-            Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations)
-          end
+          docs.each { |doc| Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations) }
           Bullet::Detector::UnusedEagerLoading.add_eager_loadings(docs, associations)
           origin_eager_load(docs)
         end
@@ -50,9 +48,7 @@ module Bullet
 
         def get_relation(name, metadata, object, reload = false)
           result = origin_get_relation(name, metadata, object, reload)
-          if metadata.macro !~ /embed/
-            Bullet::Detector::NPlusOneQuery.call_association(self, name)
-          end
+          Bullet::Detector::NPlusOneQuery.call_association(self, name) if metadata.macro !~ /embed/
           result
         end
       end

data/lib/bullet/mongoid6x.rb

@@ -37,9 +37,7 @@ module Bullet
 
         def eager_load(docs)
           associations = criteria.inclusions.map(&:name)
-          docs.each do |doc|
-            Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations)
-          end
+          docs.each { |doc| Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations) }
           Bullet::Detector::UnusedEagerLoading.add_eager_loadings(docs, associations)
           origin_eager_load(docs)
         end
@@ -50,9 +48,7 @@ module Bullet
 
         def get_relation(name, metadata, object, reload = false)
           result = origin_get_relation(name, metadata, object, reload)
-          if metadata.macro !~ /embed/
-            Bullet::Detector::NPlusOneQuery.call_association(self, name)
-          end
+          Bullet::Detector::NPlusOneQuery.call_association(self, name) if metadata.macro !~ /embed/
           result
         end
       end

data/lib/bullet/mongoid7x.rb

@@ -37,9 +37,7 @@ module Bullet
 
         def eager_load(docs)
           associations = criteria.inclusions.map(&:name)
-          docs.each do |doc|
-            Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations)
-          end
+          docs.each { |doc| Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations) }
           Bullet::Detector::UnusedEagerLoading.add_eager_loadings(docs, associations)
           origin_eager_load(docs)
         end
@@ -50,9 +48,7 @@ module Bullet
 
         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
+          Bullet::Detector::NPlusOneQuery.call_association(self, name) unless association.embedded?
           result
         end
       end

data/lib/bullet/notification/base.rb

@@ -8,7 +8,8 @@ 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
 
@@ -25,16 +26,16 @@ module Bullet
       end
 
       def whoami
-        @user ||= ENV['USER'].presence || (begin
-                                             `whoami`.chomp
-                                           rescue StandardError
-                                             ''
-                                           end)
-        if @user.present?
-          "user: #{@user}"
-        else
-          ''
-        end
+        @user ||=
+          ENV['USER'].presence ||
+            (
+              begin
+                `whoami`.chomp
+              rescue StandardError
+                ''
+              end
+            )
+        @user.present? ? "user: #{@user}" : ''
       end
 
       def body_with_caller
@@ -54,12 +55,7 @@ module Bullet
       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
 
       def eql?(other)
@@ -77,7 +73,7 @@ module Bullet
       end
 
       def associations_str
-        ":includes => #{@associations.map { |a| a.to_s.to_sym unless a.is_a? Hash }.inspect}"
+        ".includes(#{@associations.map { |a| a.to_s.to_sym }.inspect})"
       end
     end
   end

data/lib/bullet/notification/n_plus_one_query.rb

@@ -10,7 +10,7 @@ module Bullet
       end
 
       def body
-        "#{klazz_associations_str}\n  Add to your finder: #{associations_str}"
+        "#{klazz_associations_str}\n  Add to your query: #{associations_str}"
       end
 
       def title
@@ -18,9 +18,7 @@ module Bullet
       end
 
       def notification_data
-        super.merge(
-          backtrace: []
-        )
+        super.merge(backtrace: [])
       end
 
       protected

data/lib/bullet/notification/unused_eager_loading.rb

@@ -10,7 +10,7 @@ module Bullet
       end
 
       def body
-        "#{klazz_associations_str}\n  Remove from your finder: #{associations_str}"
+        "#{klazz_associations_str}\n  Remove from your query: #{associations_str}"
       end
 
       def title
@@ -18,9 +18,7 @@ module Bullet
       end
 
       def notification_data
-        super.merge(
-          backtrace: []
-        )
+        super.merge(backtrace: [])
       end
 
       protected

data/lib/bullet/rack.rb

@@ -15,8 +15,9 @@ module Bullet
       status, headers, response = @app.call(env)
 
       response_body = nil
+
       if Bullet.notification?
-        if !file?(headers) && !sse?(headers) && !empty?(response) && status == 200
+        if Bullet.inject_into_page? && !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
@@ -45,6 +46,7 @@ module Bullet
 
     def append_to_html_body(response_body, content)
       body = response_body.dup
+      content = content.html_safe if content.respond_to?(:html_safe)
       if body.include?('</body>')
         position = body.rindex('</body>')
         body.insert(position, content)
@@ -54,7 +56,7 @@ module Bullet
     end
 
     def footer_note
-      "<div #{footer_div_attributes}>" + footer_header + '<br>' + Bullet.footer_info.uniq.join('<br>') + '</div>'
+      "<details #{details_attributes}><summary #{summary_attributes}>Bullet Warnings</summary><div #{footer_content_attributes}>#{Bullet.footer_info.uniq.join('<br>')}#{footer_console_message}</div></details>"
     end
 
     def set_header(headers, header_name, header_array)
@@ -87,22 +89,28 @@ module Bullet
 
     private
 
-    def footer_div_attributes
+    def details_attributes
+      <<~EOF
+        id="bullet-footer" data-is-bullet-footer
+        style="cursor: pointer; position: fixed; left: 0px; bottom: 0px; z-index: 9999; background: #fdf2f2; color: #9b1c1c; font-size: 12px; border-radius: 0px 8px 0px 0px; border: 1px solid #9b1c1c;"
+      EOF
+    end
+
+    def summary_attributes
       <<~EOF
-        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);
-         color: rgb(119, 119, 119); font-size: 16px; font-family: 'Arial', sans-serif; z-index:9999;"
+        style="font-weight: 600; padding: 2px 8px"
       EOF
     end
 
-    def footer_header
-      cancel_button = "<span onclick='this.parentNode.remove()' style='position:absolute; right: 10px; top: 0px; font-weight: bold; color: #333;'>&times;</span>"
+    def footer_content_attributes
+      <<~EOF
+        style="padding: 8px; border-top: 1px solid #9b1c1c;"
+      EOF
+    end
+
+    def footer_console_message
       if Bullet.console_enabled?
-        "<span>See 'Uniform Notifier' in JS Console for Stacktrace</span>#{cancel_button}"
-      else
-        cancel_button
+        "<br/><span style='font-style: italic;'>See 'Uniform Notifier' in JS Console for Stacktrace</span>"
       end
     end