bullet 6.0.2 → 6.1.4

data/lib/bullet/mongoid7x.rb

@@ -23,7 +23,7 @@ module Bullet
         end
 
         def each(&block)
-          return to_enum unless block_given?
+          return to_enum unless block
 
           records = []
           origin_each { |record| records << record }
@@ -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,15 +15,16 @@ 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
             response_body = append_to_html_body(response_body, Bullet.gather_inline_notifications)
-            response_body = append_to_html_body(response_body, xhr_script)
+            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
-          else
+          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
@@ -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
 

data/lib/bullet/stack_trace_filter.rb

@@ -3,13 +3,15 @@
 module Bullet
   module StackTraceFilter
     VENDOR_PATH = '/vendor'
+    IS_RUBY_19 = Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
 
     def caller_in_project
       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) ||
+        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
@@ -46,26 +48,15 @@ module Bullet
     end
 
     def location_as_path(location)
-      ruby_19? ? location : location.absolute_path.to_s
+      IS_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
+      if IS_RUBY_19
+        caller.select { |caller_path| yield caller_path }
       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')
+        caller_locations.select { |location| yield location }
       end
-      @ruby_19
     end
   end
 end

data/lib/bullet/version.rb

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

data/lib/generators/bullet/install_generator.rb

@@ -10,17 +10,17 @@ module Bullet
 
       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 @@ module Bullet
       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...'

data/spec/bullet/detector/counter_cache_spec.rb

@@ -12,15 +12,15 @@ module Bullet
 
       context '.add_counter_cache' do
         it 'should create notification if conditions met' do
-          expect(CounterCache).to receive(:conditions_met?).with(@post1, [:comments]).and_return(true)
-          expect(CounterCache).to receive(:create_notification).with('Post', [:comments])
-          CounterCache.add_counter_cache(@post1, [:comments])
+          expect(CounterCache).to receive(:conditions_met?).with(@post1, %i[comments]).and_return(true)
+          expect(CounterCache).to receive(:create_notification).with('Post', %i[comments])
+          CounterCache.add_counter_cache(@post1, %i[comments])
         end
 
         it 'should not create notification if conditions not met' do
-          expect(CounterCache).to receive(:conditions_met?).with(@post1, [:comments]).and_return(false)
+          expect(CounterCache).to receive(:conditions_met?).with(@post1, %i[comments]).and_return(false)
           expect(CounterCache).to receive(:create_notification).never
-          CounterCache.add_counter_cache(@post1, [:comments])
+          CounterCache.add_counter_cache(@post1, %i[comments])
         end
       end
 
@@ -47,7 +47,7 @@ module Bullet
           expect(CounterCache.conditions_met?(@post1, :associations)).to eq false
         end
 
-        it 'should be true when object is possible, and impossible' do
+        it 'should be false when object is possible, and impossible' do
           CounterCache.add_possible_objects(@post1)
           CounterCache.add_impossible_object(@post1)
           expect(CounterCache.conditions_met?(@post1, :associations)).to eq false

data/spec/bullet/detector/n_plus_one_query_spec.rb

@@ -76,8 +76,8 @@ module Bullet
       context '.call_association' do
         it 'should create notification if conditions met' do
           expect(NPlusOneQuery).to receive(:conditions_met?).with(@post, :association).and_return(true)
-          expect(NPlusOneQuery).to receive(:caller_in_project).and_return(['caller'])
-          expect(NPlusOneQuery).to receive(:create_notification).with(['caller'], 'Post', :association)
+          expect(NPlusOneQuery).to receive(:caller_in_project).and_return(%w[caller])
+          expect(NPlusOneQuery).to receive(:create_notification).with(%w[caller], 'Post', :association)
           NPlusOneQuery.call_association(@post, :association)
         end
 
@@ -149,7 +149,11 @@ module Bullet
 
             expect(NPlusOneQuery).to receive(:caller_locations).and_return([in_project, *included_gems, excluded_gem])
             expect(NPlusOneQuery).to receive(:conditions_met?).with(@post, :association).and_return(true)
-            expect(NPlusOneQuery).to receive(:create_notification).with([in_project, *included_gems], 'Post', :association)
+            expect(NPlusOneQuery).to receive(:create_notification).with(
+              [in_project, *included_gems],
+              'Post',
+              :association
+            )
             NPlusOneQuery.call_association(@post, :association)
           end
         end

data/spec/bullet/detector/unused_eager_loading_spec.rb

@@ -36,12 +36,14 @@ module Bullet
         it 'should return empty if associations exist in call_association' do
           UnusedEagerLoading.add_eager_loadings([@post], :association)
           UnusedEagerLoading.add_call_object_associations(@post, :association)
-          expect(UnusedEagerLoading.send(:diff_object_associations, @post.bullet_key, Set.new([:association]))).to be_empty
+          expect(
+            UnusedEagerLoading.send(:diff_object_associations, @post.bullet_key, Set.new([:association]))
+          ).to be_empty
         end
       end
 
       context '.check_unused_preload_associations' do
-        let(:paths) { ['/dir1', '/dir1/subdir'] }
+        let(:paths) { %w[/dir1 /dir1/subdir] }
         it 'should create notification if object_association_diff is not empty' do
           UnusedEagerLoading.add_object_associations(@post, :association)
           allow(UnusedEagerLoading).to receive(:caller_in_project).and_return(paths)
@@ -53,7 +55,9 @@ module Bullet
           UnusedEagerLoading.add_object_associations(@post, :association)
           UnusedEagerLoading.add_eager_loadings([@post], :association)
           UnusedEagerLoading.add_call_object_associations(@post, :association)
-          expect(UnusedEagerLoading.send(:diff_object_associations, @post.bullet_key, Set.new([:association]))).to be_empty
+          expect(
+            UnusedEagerLoading.send(:diff_object_associations, @post.bullet_key, Set.new([:association]))
+          ).to be_empty
           expect(UnusedEagerLoading).not_to receive(:create_notification).with('Post', [:association])
           UnusedEagerLoading.check_unused_preload_associations
         end
@@ -62,14 +66,23 @@ module Bullet
       context '.add_eager_loadings' do
         it 'should add objects, associations pair when eager_loadings are empty' do
           UnusedEagerLoading.add_eager_loadings([@post, @post2], :associations)
-          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include([@post.bullet_key, @post2.bullet_key], :associations)
+          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include(
+            [@post.bullet_key, @post2.bullet_key],
+            :associations
+          )
         end
 
         it 'should add objects, associations pair for existing eager_loadings' do
           UnusedEagerLoading.add_eager_loadings([@post, @post2], :association1)
           UnusedEagerLoading.add_eager_loadings([@post, @post2], :association2)
-          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include([@post.bullet_key, @post2.bullet_key], :association1)
-          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include([@post.bullet_key, @post2.bullet_key], :association2)
+          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include(
+            [@post.bullet_key, @post2.bullet_key],
+            :association1
+          )
+          expect(UnusedEagerLoading.send(:eager_loadings)).to be_include(
+            [@post.bullet_key, @post2.bullet_key],
+            :association2
+          )
         end
 
         it 'should merge objects, associations pair for existing eager_loadings' do