bullet 5.5.0 → 6.1.5

data/lib/bullet/mongoid5x.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Mongoid
     def self.enable
@@ -21,20 +23,21 @@ module Bullet
         end
 
         def each(&block)
-          records = view.map{ |doc| ::Mongoid::Factory.from_db(klass, doc) }
+          return to_enum unless block
+
+          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)
           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
@@ -45,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Mongoid
     def self.enable
@@ -8,33 +10,34 @@ 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
+
+          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)
           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
@@ -45,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

@@ -0,0 +1,57 @@
+# 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
+
+          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 { |doc| Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations) }
+          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)
+          Bullet::Detector::NPlusOneQuery.call_association(self, name) unless association.embedded?
+          result
+        end
+      end
+    end
+  end
+end

data/lib/bullet/notification/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Notification
     class Base
@@ -6,29 +8,34 @@ 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 "")
-        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
@@ -36,24 +43,19 @@ 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
 
       def eql?(other)
@@ -65,13 +67,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 }.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
@@ -8,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
@@ -16,15 +18,14 @@ module Bullet
       end
 
       def notification_data
-        super.merge(
-          :backtrace => []
-        )
+        super.merge(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
@@ -8,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
@@ -16,15 +18,14 @@ module Bullet
       end
 
       def notification_data
-        super.merge(
-            :backtrace => []
-        )
+        super.merge(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'
@@ -5,6 +7,7 @@ module Bullet
     autoload :NPlusOneQuery, 'bullet/notification/n_plus_one_query'
     autoload :CounterCache, 'bullet/notification/counter_cache'
 
-    class UnoptimizedQueryError < StandardError; end
+    class UnoptimizedQueryError < StandardError
+    end
   end
 end

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,26 @@ 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 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)
+            if Bullet.add_footer && !Bullet.skip_http_headers
+              response_body = append_to_html_body(response_body, xhr_script)
+            end
+            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
@@ -29,65 +40,85 @@ 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
+      content = content.html_safe if content.respond_to?(:html_safe)
+      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>"
+      "<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)
-      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)
       if response.respond_to?(:body)
         Array === response.body ? response.body.first : response.body
-      else
+      elsif response.respond_to?(:first)
         response.first
       end
     end
 
     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/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,33 +1,63 @@
+# frozen_string_literal: true
+require "bundler"
+
 module Bullet
   module StackTraceFilter
-    VENDOR_PATH = "/vendor"
+    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
-      caller.select do |caller_path|
-        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)
+      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 { |location| yield location }
       end
     end
   end

data/lib/bullet/version.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Bullet
-  VERSION = "5.5.0"
+  VERSION = '6.1.5'
 end