bullet 5.7.0 → 6.0.0

data/lib/bullet/notification/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Notification
     class Base
@@ -11,11 +13,11 @@ module Bullet
       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
@@ -23,7 +25,11 @@ module Bullet
       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
@@ -36,11 +42,11 @@ 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
@@ -49,10 +55,10 @@ module Bullet
 
       def notification_data
         {
-          :user => whoami,
-          :url => url,
-          :title => title,
-          :body => body_with_caller,
+          user: whoami,
+          url: url,
+          title: title,
+          body: body_with_caller
         }
       end
 
@@ -66,13 +72,13 @@ module Bullet
 
       protected
 
-        def klazz_associations_str
-          "  #{@base_class} => [#{@associations.map(&:inspect).join(', '.freeze)}]"
-        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
+      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

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,15 +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,15 +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,17 +10,23 @@ 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)
-          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)
-          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
@@ -29,29 +37,32 @@ 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)
-      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_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)
@@ -63,7 +74,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)
@@ -77,17 +88,27 @@ 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
+        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;"
+      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>"
+      if Bullet.console_enabled?
+        "<span>See 'Uniform Notifier' in JS Console for Stacktrace</span>#{cancel_button}"
+      else
+        cancel_button
+      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/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

data/lib/bullet/registry/object.rb

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

data/lib/bullet/registry.rb

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

data/lib/bullet/stack_trace_filter.rb

@@ -1,35 +1,71 @@
+# frozen_string_literal: true
+
 module Bullet
   module StackTraceFilter
-    VENDOR_PATH = '/vendor'.freeze
+    VENDOR_PATH = '/vendor'
 
     def caller_in_project
-      app_root = rails? ? Rails.root.to_s : Dir.pwd
-      vendor_root = app_root + VENDOR_PATH
-      caller_locations.select do |location|
-        caller_path = location.absolute_path.to_s
-        caller_path.include?(app_root) && !caller_path.include?(vendor_root) ||
-          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
+      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?(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 |caller_path|
-          case exclude_pattern
-          when String
-            caller_path.include?(exclude_pattern)
-          when Regexp
-            caller_path =~ exclude_pattern
-          end
+        caller_in_project.any? { |location| pattern_matches?(location, exclude_pattern) }
+      end
+    end
+
+    private
+
+    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)
+      ruby_19? ? location : location.absolute_path.to_s
+    end
+
+    def select_caller_locations
+      if ruby_19?
+        caller.select do |caller_path|
+          yield caller_path
+        end
+      else
+        caller_locations.select do |location|
+          yield location
+        end
+      end
+    end
+
+    def ruby_19?
+      if @ruby_19.nil?
+        @ruby_19 = Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
       end
+      @ruby_19
     end
   end
 end

data/lib/bullet/version.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 
 module Bullet
-  VERSION = '5.7.0'.freeze
+  VERSION = '6.0.0'
 end

data/lib/bullet.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/module/delegation'
 require 'set'
 require 'uniform_notifier'
@@ -17,8 +19,8 @@ module Bullet
   autoload :Registry, 'bullet/registry'
   autoload :NotificationCollector, 'bullet/notification_collector'
 
-  BULLET_DEBUG = 'BULLET_DEBUG'.freeze
-  TRUE = 'true'.freeze
+  BULLET_DEBUG = 'BULLET_DEBUG'
+  TRUE = 'true'
 
   if defined? Rails::Railtie
     class BulletRailtie < Rails::Railtie
@@ -29,21 +31,21 @@ module Bullet
   end
 
   class << self
-    attr_writer :enable, :n_plus_one_query_enable, :unused_eager_loading_enable, :counter_cache_enable, :stacktrace_includes, :stacktrace_excludes
-    attr_reader :notification_collector, :whitelist
+    attr_writer :n_plus_one_query_enable, :unused_eager_loading_enable, :counter_cache_enable, :stacktrace_includes, :stacktrace_excludes
+    attr_reader :whitelist
     attr_accessor :add_footer, :orm_pathches_applied
 
     available_notifiers = UniformNotifier::AVAILABLE_NOTIFIERS.map { |notifier| "#{notifier}=" }
-    available_notifiers << { :to => UniformNotifier }
-    delegate *available_notifiers
+    available_notifiers << { to: UniformNotifier }
+    delegate(*available_notifiers)
 
     def raise=(should_raise)
       UniformNotifier.raise = (should_raise ? Notification::UnoptimizedQueryError : false)
     end
 
     DETECTORS = [Bullet::Detector::NPlusOneQuery,
-                  Bullet::Detector::UnusedEagerLoading,
-                  Bullet::Detector::CounterCache].freeze
+                 Bullet::Detector::UnusedEagerLoading,
+                 Bullet::Detector::CounterCache].freeze
 
     def enable=(enable)
       @enable = @n_plus_one_query_enable = @unused_eager_loading_enable = @counter_cache_enable = enable
@@ -61,16 +63,20 @@ 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?
-      self.enable? && !!@n_plus_one_query_enable
+      enable? && !!@n_plus_one_query_enable
     end
 
     def unused_eager_loading_enable?
-      self.enable? && !!@unused_eager_loading_enable
+      enable? && !!@unused_eager_loading_enable
     end
 
     def counter_cache_enable?
-      self.enable? && !!@counter_cache_enable
+      enable? && !!@counter_cache_enable
     end
 
     def stacktrace_includes
@@ -91,7 +97,7 @@ module Bullet
       reset_whitelist
       @whitelist[options[:type]][options[:class_name]] ||= []
       @whitelist[options[:type]][options[:class_name]].delete(options[:association].to_sym)
-      @whitelist[options[:type]].delete_if { |key, val| val.empty? }
+      @whitelist[options[:type]].delete_if { |_key, val| val.empty? }
     end
 
     def get_whitelist_associations(type, class_name)
@@ -99,7 +105,7 @@ module Bullet
     end
 
     def reset_whitelist
-      @whitelist ||= { :n_plus_one_query => {}, :unused_eager_loading => {}, :counter_cache => {} }
+      @whitelist ||= { n_plus_one_query: {}, unused_eager_loading: {}, counter_cache: {} }
     end
 
     def clear_whitelist
@@ -109,9 +115,8 @@ module Bullet
     def bullet_logger=(active)
       if active
         require 'fileutils'
-        root_path = "#{rails? ? Rails.root.to_s : Dir.pwd}"
-        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
@@ -161,6 +166,7 @@ module Bullet
 
     def notification?
       return unless start?
+
       Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
       notification_collector.notifications_present?
     end
@@ -189,12 +195,19 @@ 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.inject({}) do |warnings, notification|
+      notification_collector.collection.each_with_object({}) do |notification, warnings|
         warning_type = notification.class.to_s.split(':').last.tableize
         warnings[warning_type] ||= []
         warnings[warning_type] << notification
-        warnings
       end
     end
 
@@ -217,25 +230,29 @@ module Bullet
       return_value
     end
 
+    def console_enabled?
+      UniformNotifier.active_notifiers.include?(UniformNotifier::JavascriptConsole)
+    end
+
     private
 
-      def for_each_active_notifier_with_notification
-        UniformNotifier.active_notifiers.each do |notifier|
-          notification_collector.collection.each do |notification|
-            notification.notifier = notifier
-            yield notification
-          end
+    def for_each_active_notifier_with_notification
+      UniformNotifier.active_notifiers.each do |notifier|
+        notification_collector.collection.each do |notification|
+          notification.notifier = notifier
+          yield notification
         end
       end
+    end
 
-      def build_request_uri(env)
-        return "#{env['REQUEST_METHOD']} #{env['REQUEST_URI']}" if env['REQUEST_URI']
+    def build_request_uri(env)
+      return "#{env['REQUEST_METHOD']} #{env['REQUEST_URI']}" if env['REQUEST_URI']
 
-        if env['QUERY_STRING'].present?
-          "#{env['REQUEST_METHOD']} #{env['PATH_INFO']}?#{env['QUERY_STRING']}"
-        else
-          "#{env['REQUEST_METHOD']} #{env['PATH_INFO']}"
-        end
+      if env['QUERY_STRING'].present?
+        "#{env['REQUEST_METHOD']} #{env['PATH_INFO']}?#{env['QUERY_STRING']}"
+      else
+        "#{env['REQUEST_METHOD']} #{env['PATH_INFO']}"
       end
+    end
   end
 end

data/lib/generators/bullet/install_generator.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 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

data/perf/benchmark.rb

@@ -1,4 +1,6 @@
-$: << 'lib'
+# frozen_string_literal: true
+
+$LOAD_PATH << 'lib'
 require 'benchmark'
 require 'rails'
 require 'active_record'
@@ -27,13 +29,13 @@ 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::Schema.define(:version => 1) do
+ActiveRecord::Schema.define(version: 1) do
   create_table :posts do |t|
     t.column :title, :string
     t.column :body, :string
@@ -56,21 +58,21 @@ posts_size = 1000
 comments_size = 10_000
 users = []
 users_size.times do |i|
-  users << User.new(:name => "user#{i}")
+  users << User.new(name: "user#{i}")
 end
 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])
+  posts << Post.new(title: "Title #{i}", body: "Body #{i}", user: users[i % 100])
 end
 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])
+  comments << Comment.new(body: "Comment #{i}", post: posts[i % 1000], user: users[i % 100])
 end
 Comment.import comments
 
@@ -82,7 +84,7 @@ Benchmark.bm(70) do |bm|
   bm.report("Querying & Iterating #{posts_size} Posts with #{comments_size} Comments and #{users_size} Users") do
     10.times do
       Bullet.start_request
-      Post.select('SQL_NO_CACHE *').includes(:user, :comments => :user).each do |p|
+      Post.select('SQL_NO_CACHE *').includes(:user, comments: :user).each do |p|
         p.title
         p.user.name
         p.comments.each do |c|

data/rails/init.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'bullet'

data/spec/bullet/detector/association_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Bullet