bullet 5.7.5 → 6.1.4

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)
@@ -73,11 +69,11 @@ module Bullet
       protected
 
       def klazz_associations_str
-        "  #{@base_class} => [#{@associations.map(&:inspect).join(', '.freeze)}]"
+        "  #{@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}"
+        ".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

@@ -10,17 +10,24 @@ 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 && 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 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
+            response_body = append_to_html_body(response_body, Bullet.gather_inline_notifications)
+            response_body = append_to_html_body(response_body, xhr_script) if Bullet.add_footer && !Bullet.skip_http_headers
+            headers['Content-Length'] = response_body.bytesize.to_s
+          elsif !Bullet.skip_http_headers
+            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
@@ -31,20 +38,15 @@ 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)
       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,15 @@ module Bullet
     end
 
     def footer_note
-      "<div #{footer_div_attributes}>" + footer_close_button + 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)
+      # 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)
@@ -66,7 +76,7 @@ module Bullet
     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)
@@ -79,18 +89,34 @@ 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
+    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
+        style="font-weight: 600; padding: 2px 8px"
+      EOF
+    end
+
+    def footer_content_attributes
+      <<~EOF
+        style="padding: 8px; border-top: 1px solid #9b1c1c;"
+      EOF
+    end
+
+    def footer_console_message
+      if Bullet.console_enabled?
+        "<br/><span style='font-style: italic;'>See 'Uniform Notifier' in JS Console for Stacktrace</span>"
+      end
     end
 
-    def footer_close_button
-      "<span onclick='this.parentNode.remove()' style='position:absolute; right: 10px; top: 0px; font-weight: bold; color: #333;'>&times;</span>"
+    # 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

@@ -2,51 +2,60 @@
 
 module Bullet
   module StackTraceFilter
-    VENDOR_PATH = '/vendor'.freeze
+    VENDOR_PATH = '/vendor'
+    IS_RUBY_19 = Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
 
     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 |caller_path|
-        caller_path.include?(app_root) && !caller_path.include?(vendor_root) && !caller_path.include?(bundler_path) ||
-          Bullet.stacktrace_includes.any? do |include_pattern|
-            case include_pattern
-            when String
-              caller_path.include?(include_pattern)
-            when Regexp
-              caller_path =~ include_pattern
-            end
-          end
+      select_caller_locations do |location|
+        caller_path = location_as_path(location)
+        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
 
     def excluded_stacktrace_path?
       Bullet.stacktrace_excludes.any? do |exclude_pattern|
-        caller_in_project.any? do |location|
-          caller_path = location.absolute_path.to_s
-          case exclude_pattern
-          when String
-            caller_path.include?(exclude_pattern)
-          when Regexp
-            caller_path =~ exclude_pattern
-          end
-        end
+        caller_in_project.any? { |location| pattern_matches?(location, exclude_pattern) }
       end
     end
 
     private
 
-    def select_caller_locations
-      if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
-        caller.select do |caller_path|
-          yield caller_path
+    def pattern_matches?(location, pattern)
+      path = location_as_path(location)
+      case pattern
+      when Array
+        pattern_path = pattern.first
+        filter = pattern.last
+        return false unless pattern_matches?(location, pattern_path)
+
+        case filter
+        when Range
+          filter.include?(location.lineno)
+        when Integer
+          filter == location.lineno
+        when String
+          filter == location.base_label
         end
+      when String
+        path.include?(pattern)
+      when Regexp
+        path =~ pattern
+      end
+    end
+
+    def location_as_path(location)
+      IS_RUBY_19 ? location : location.absolute_path.to_s
+    end
+
+    def select_caller_locations
+      if IS_RUBY_19
+        caller.select { |caller_path| yield caller_path }
       else
-        caller_locations.select do |location|
-          caller_path = location.absolute_path.to_s
-          yield caller_path
-        end
+        caller_locations.select { |location| yield location }
       end
     end
   end

data/lib/bullet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bullet
-  VERSION = '5.7.5'.freeze
+  VERSION = '6.1.4'
 end

data/lib/generators/bullet/install_generator.rb

@@ -3,24 +3,24 @@
 module Bullet
   module Generators
     class InstallGenerator < ::Rails::Generators::Base
-      desc <<-DESC
-Description:
-    Enable bullet in development/test for your application.
+      desc <<~DESC
+        Description:
+            Enable bullet in development/test for your application.
       DESC
 
       def enable_in_development
         environment(nil, env: 'development') do
-          <<-"FILE".strip
-
-  config.after_initialize do
-    Bullet.enable        = true
-    Bullet.alert         = true
-    Bullet.bullet_logger = true
-    Bullet.console       = true
-  # Bullet.growl         = true
-    Bullet.rails_logger  = true
-    Bullet.add_footer    = true
-  end
+          <<~FILE
+            config.after_initialize do
+              Bullet.enable        = true
+              Bullet.alert         = true
+              Bullet.bullet_logger = true
+              Bullet.console       = true
+            # Bullet.growl         = true
+              Bullet.rails_logger  = true
+              Bullet.add_footer    = true
+            end
+
           FILE
         end
 
@@ -28,20 +28,20 @@ Description:
       end
 
       def enable_in_test
-        if yes?('Would you like to enable bullet in test environment? (y/n)')
-          environment(nil, env: 'test') do
-            <<-"FILE".strip
-
-  config.after_initialize do
-    Bullet.enable        = true
-    Bullet.bullet_logger = true
-    Bullet.raise         = true # raise an error if n+1 query occurs
-  end
-            FILE
-          end
+        return unless yes?('Would you like to enable bullet in test environment? (y/n)')
 
-          say 'Enabled bullet in config/environments/test.rb'
+        environment(nil, env: 'test') do
+          <<~FILE
+            config.after_initialize do
+              Bullet.enable        = true
+              Bullet.bullet_logger = true
+              Bullet.raise         = true # raise an error if n+1 query occurs
+            end
+
+          FILE
         end
+
+        say 'Enabled bullet in config/environments/test.rb'
       end
     end
   end

data/perf/benchmark.rb

@@ -29,11 +29,11 @@ class User < ActiveRecord::Base
 end
 
 # create database bullet_benchmark;
-ActiveRecord::Base.establish_connection(adapter: 'mysql2', database: 'bullet_benchmark', server: '/tmp/mysql.socket', username: 'root')
+ActiveRecord::Base.establish_connection(
+  adapter: 'mysql2', database: 'bullet_benchmark', server: '/tmp/mysql.socket', username: 'root'
+)
 
-ActiveRecord::Base.connection.tables.each do |table|
-  ActiveRecord::Base.connection.drop_table(table)
-end
+ActiveRecord::Base.connection.tables.each { |table| ActiveRecord::Base.connection.drop_table(table) }
 
 ActiveRecord::Schema.define(version: 1) do
   create_table :posts do |t|
@@ -54,26 +54,20 @@ ActiveRecord::Schema.define(version: 1) do
 end
 
 users_size = 100
-posts_size = 1000
+posts_size = 1_000
 comments_size = 10_000
 users = []
-users_size.times do |i|
-  users << User.new(name: "user#{i}")
-end
+users_size.times { |i| users << User.new(name: "user#{i}") }
 User.import users
 users = User.all
 
 posts = []
-posts_size.times do |i|
-  posts << Post.new(title: "Title #{i}", body: "Body #{i}", user: users[i % 100])
-end
+posts_size.times { |i| posts << Post.new(title: "Title #{i}", body: "Body #{i}", user: users[i % 100]) }
 Post.import posts
 posts = Post.all
 
 comments = []
-comments_size.times do |i|
-  comments << Comment.new(body: "Comment #{i}", post: posts[i % 1000], user: users[i % 100])
-end
+comments_size.times { |i| comments << Comment.new(body: "Comment #{i}", post: posts[i % 1_000], user: users[i % 100]) }
 Comment.import comments
 
 puts 'Start benchmarking...'