bullet 5.9.0 → 7.0.4

data/lib/bullet.rb

@@ -14,15 +14,13 @@ module Bullet
   autoload :ActiveRecord, "bullet/#{active_record_version}" if active_record?
   autoload :Mongoid, "bullet/#{mongoid_version}" if mongoid?
   autoload :Rack, 'bullet/rack'
+  autoload :ActiveJob, 'bullet/active_job'
   autoload :Notification, 'bullet/notification'
   autoload :Detector, 'bullet/detector'
   autoload :Registry, 'bullet/registry'
   autoload :NotificationCollector, 'bullet/notification_collector'
 
-  BULLET_DEBUG = 'BULLET_DEBUG'
-  TRUE = 'true'
-
-  if defined? Rails::Railtie
+  if defined?(Rails::Railtie)
     class BulletRailtie < Rails::Railtie
       initializer 'bullet.configure_rails_initialization' do |app|
         app.middleware.use Bullet::Rack
@@ -31,28 +29,37 @@ module Bullet
   end
 
   class << self
-    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)
+    attr_writer :n_plus_one_query_enable,
+                :unused_eager_loading_enable,
+                :counter_cache_enable,
+                :stacktrace_includes,
+                :stacktrace_excludes,
+                :skip_html_injection
+    attr_reader :safelist
+    attr_accessor :add_footer, :orm_patches_applied, :skip_http_headers
+
+    available_notifiers =
+      UniformNotifier::AVAILABLE_NOTIFIERS.select { |notifier| notifier != :raise }.map { |notifier| "#{notifier}=" }
+    available_notifiers_options = { to: UniformNotifier }
+    delegate(*available_notifiers, **available_notifiers_options)
 
     def raise=(should_raise)
       UniformNotifier.raise = (should_raise ? Notification::UnoptimizedQueryError : false)
     end
 
-    DETECTORS = [Bullet::Detector::NPlusOneQuery,
-                 Bullet::Detector::UnusedEagerLoading,
-                 Bullet::Detector::CounterCache].freeze
+    DETECTORS = [
+      Bullet::Detector::NPlusOneQuery,
+      Bullet::Detector::UnusedEagerLoading,
+      Bullet::Detector::CounterCache
+    ].freeze
 
     def enable=(enable)
       @enable = @n_plus_one_query_enable = @unused_eager_loading_enable = @counter_cache_enable = enable
+
       if enable?
-        reset_whitelist
-        unless orm_pathches_applied
-          self.orm_pathches_applied = true
+        reset_safelist
+        unless orm_patches_applied
+          self.orm_patches_applied = true
           Bullet::Mongoid.enable if mongoid?
           Bullet::ActiveRecord.enable if active_record?
         end
@@ -63,6 +70,11 @@ module Bullet
       !!@enable
     end
 
+    # Rails.root might be nil if `railties` is a dependency on a project that does not use Rails
+    def app_root
+      @app_root ||= (defined?(::Rails.root) && !::Rails.root.nil? ? Rails.root.to_s : Dir.pwd).to_s
+    end
+
     def n_plus_one_query_enable?
       enable? && !!@n_plus_one_query_enable
     end
@@ -76,51 +88,50 @@ module Bullet
     end
 
     def stacktrace_includes
-      @stacktrace_includes || []
+      @stacktrace_includes ||= []
     end
 
     def stacktrace_excludes
-      @stacktrace_excludes || []
+      @stacktrace_excludes ||= []
     end
 
-    def add_whitelist(options)
-      reset_whitelist
-      @whitelist[options[:type]][options[:class_name]] ||= []
-      @whitelist[options[:type]][options[:class_name]] << options[:association].to_sym
+    def add_safelist(options)
+      reset_safelist
+      @safelist[options[:type]][options[:class_name]] ||= []
+      @safelist[options[:type]][options[:class_name]] << options[:association].to_sym
     end
 
-    def delete_whitelist(options)
-      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? }
+    def delete_safelist(options)
+      reset_safelist
+      @safelist[options[:type]][options[:class_name]] ||= []
+      @safelist[options[:type]][options[:class_name]].delete(options[:association].to_sym)
+      @safelist[options[:type]].delete_if { |_key, val| val.empty? }
     end
 
-    def get_whitelist_associations(type, class_name)
-      Array(@whitelist[type][class_name])
+    def get_safelist_associations(type, class_name)
+      Array.wrap(@safelist[type][class_name])
     end
 
-    def reset_whitelist
-      @whitelist ||= { n_plus_one_query: {}, unused_eager_loading: {}, counter_cache: {} }
+    def reset_safelist
+      @safelist ||= { n_plus_one_query: {}, unused_eager_loading: {}, counter_cache: {} }
     end
 
-    def clear_whitelist
-      @whitelist = nil
+    def clear_safelist
+      @safelist = nil
     end
 
     def bullet_logger=(active)
       if active
         require 'fileutils'
-        root_path = (rails? ? Rails.root.to_s : Dir.pwd).to_s
-        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
     end
 
     def debug(title, message)
-      puts "[Bullet][#{title}] #{message}" if ENV[BULLET_DEBUG] == TRUE
+      puts "[Bullet][#{title}] #{message}" if ENV['BULLET_DEBUG'] == 'true'
     end
 
     def start_request
@@ -170,9 +181,7 @@ module Bullet
 
     def gather_inline_notifications
       responses = []
-      for_each_active_notifier_with_notification do |notification|
-        responses << notification.notify_inline
-      end
+      for_each_active_notifier_with_notification { |notification| responses << notification.notify_inline }
       responses.join("\n")
     end
 
@@ -185,9 +194,15 @@ module Bullet
     end
 
     def footer_info
+      info = []
+      notification_collector.collection.each { |notification| info << notification.short_notice }
+      info
+    end
+
+    def text_notifications
       info = []
       notification_collector.collection.each do |notification|
-        info << notification.short_notice
+        info << notification.notification_data.values.compact.join("\n")
       end
       info
     end
@@ -202,6 +217,7 @@ module Bullet
 
     def profile
       return_value = nil
+
       if Bullet.enable?
         begin
           Bullet.start_request
@@ -219,6 +235,16 @@ module Bullet
       return_value
     end
 
+    def console_enabled?
+      UniformNotifier.active_notifiers.include?(UniformNotifier::JavascriptConsole)
+    end
+
+    def inject_into_page?
+      return false if defined?(@skip_html_injection) && @skip_html_injection
+
+      console_enabled? || add_footer
+    end
+
     private
 
     def for_each_active_notifier_with_notification

data/lib/generators/bullet/install_generator.rb

@@ -10,17 +10,16 @@ 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.rails_logger  = true
+              Bullet.add_footer    = true
+            end
+
           FILE
         end
 
@@ -28,20 +27,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,14 @@ 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 +57,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

@@ -39,7 +39,7 @@ module Bullet
 
         it 'should be false if object, association pair is not existed' do
           NPlusOneQuery.add_object_associations(@post, :association1)
-          expect(NPlusOneQuery.association?(@post, :associatio2)).to eq false
+          expect(NPlusOneQuery.association?(@post, :association2)).to eq false
         end
       end
 
@@ -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

@@ -19,7 +19,9 @@ module Bullet
         it 'should get call associations if object and association are both in eager_loadings and call_object_associations' do
           UnusedEagerLoading.add_eager_loadings([@post], :association)
           UnusedEagerLoading.add_call_object_associations(@post, :association)
-          expect(UnusedEagerLoading.send(:call_associations, @post.bullet_key, Set.new([:association]))).to eq([:association])
+          expect(UnusedEagerLoading.send(:call_associations, @post.bullet_key, Set.new([:association]))).to eq(
+            [:association]
+          )
         end
 
         it 'should not get call associations if not exist in call_object_associations' do
@@ -30,18 +32,22 @@ module Bullet
 
       context '.diff_object_associations' do
         it 'should return associations not exist in call_association' do
-          expect(UnusedEagerLoading.send(:diff_object_associations, @post.bullet_key, Set.new([:association]))).to eq([:association])
+          expect(UnusedEagerLoading.send(:diff_object_associations, @post.bullet_key, Set.new([:association]))).to eq(
+            [:association]
+          )
         end
 
         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 +59,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 +70,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

data/spec/bullet/ext/object_spec.rb

@@ -10,30 +10,35 @@ describe Object do
     end
 
     if mongoid?
-      it 'should return class with namesapce and id composition' do
+      it 'should return class with namespace and id composition' do
         post = Mongoid::Post.first
         expect(post.bullet_key).to eq("Mongoid::Post:#{post.id}")
       end
     end
   end
 
-  context 'primary_key_value' do
+  context 'bullet_primary_key_value' do
     it 'should return id' do
       post = Post.first
-      expect(post.primary_key_value).to eq(post.id)
+      expect(post.bullet_primary_key_value).to eq(post.id)
     end
 
     it 'should return primary key value' do
       post = Post.first
       Post.primary_key = 'name'
-      expect(post.primary_key_value).to eq(post.name)
+      expect(post.bullet_primary_key_value).to eq(post.name)
       Post.primary_key = 'id'
     end
 
     it 'should return value for multiple primary keys' do
       post = Post.first
       allow(Post).to receive(:primary_keys).and_return(%i[category_id writer_id])
-      expect(post.primary_key_value).to eq("#{post.category_id},#{post.writer_id}")
+      expect(post.bullet_primary_key_value).to eq("#{post.category_id},#{post.writer_id}")
+    end
+
+    it 'it should return nil for unpersisted records' do
+      post = Post.new(id: 123)
+      expect(post.bullet_primary_key_value).to be_nil
     end
   end
 end

data/spec/bullet/notification/base_spec.rb

@@ -26,9 +26,7 @@ module Bullet
         end
 
         it 'should leverage ENV parameter' do
-          temp_env_variable('USER', 'bogus') do
-            expect(subject.whoami).to eq('user: bogus')
-          end
+          temp_env_variable('USER', 'bogus') { expect(subject.whoami).to eq('user: bogus') }
         end
 
         it 'should return blank if no user available' do
@@ -76,8 +74,8 @@ module Bullet
         it 'should send full_notice to notifier' do
           notifier = double
           allow(subject).to receive(:notifier).and_return(notifier)
-          allow(subject).to receive(:notification_data).and_return(foo: :bar)
-          expect(notifier).to receive(:inline_notify).with(foo: :bar)
+          allow(subject).to receive(:notification_data).and_return({ foo: :bar })
+          expect(notifier).to receive(:inline_notify).with({ foo: :bar })
           subject.notify_inline
         end
       end
@@ -86,8 +84,8 @@ module Bullet
         it 'should send full_out_of_channel to notifier' do
           notifier = double
           allow(subject).to receive(:notifier).and_return(notifier)
-          allow(subject).to receive(:notification_data).and_return(foo: :bar)
-          expect(notifier).to receive(:out_of_channel_notify).with(foo: :bar)
+          allow(subject).to receive(:notification_data).and_return({ foo: :bar })
+          expect(notifier).to receive(:out_of_channel_notify).with({ foo: :bar })
           subject.notify_out_of_channel
         end
       end

data/spec/bullet/notification/n_plus_one_query_spec.rb

@@ -7,9 +7,22 @@ module Bullet
     describe NPlusOneQuery do
       subject { NPlusOneQuery.new([%w[caller1 caller2]], Post, %i[comments votes], 'path') }
 
-      it { expect(subject.body_with_caller).to eq("  Post => [:comments, :votes]\n  Add to your finder: :includes => [:comments, :votes]\nCall stack\n  caller1\n  caller2\n") }
-      it { expect([subject.body_with_caller, subject.body_with_caller]).to eq(["  Post => [:comments, :votes]\n  Add to your finder: :includes => [:comments, :votes]\nCall stack\n  caller1\n  caller2\n", "  Post => [:comments, :votes]\n  Add to your finder: :includes => [:comments, :votes]\nCall stack\n  caller1\n  caller2\n"]) }
-      it { expect(subject.body).to eq("  Post => [:comments, :votes]\n  Add to your finder: :includes => [:comments, :votes]") }
+      it do
+        expect(subject.body_with_caller).to eq(
+          "  Post => [:comments, :votes]\n  Add to your query: .includes([:comments, :votes])\nCall stack\n  caller1\n  caller2\n"
+        )
+      end
+      it do
+        expect([subject.body_with_caller, subject.body_with_caller]).to eq(
+          [
+            "  Post => [:comments, :votes]\n  Add to your query: .includes([:comments, :votes])\nCall stack\n  caller1\n  caller2\n",
+            "  Post => [:comments, :votes]\n  Add to your query: .includes([:comments, :votes])\nCall stack\n  caller1\n  caller2\n"
+          ]
+        )
+      end
+      it do
+        expect(subject.body).to eq("  Post => [:comments, :votes]\n  Add to your query: .includes([:comments, :votes])")
+      end
       it { expect(subject.title).to eq('USE eager loading in path') }
     end
   end

data/spec/bullet/notification/unused_eager_loading_spec.rb

@@ -7,7 +7,11 @@ module Bullet
     describe UnusedEagerLoading do
       subject { UnusedEagerLoading.new([''], Post, %i[comments votes], 'path') }
 
-      it { expect(subject.body).to eq("  Post => [:comments, :votes]\n  Remove from your finder: :includes => [:comments, :votes]") }
+      it do
+        expect(subject.body).to eq(
+          "  Post => [:comments, :votes]\n  Remove from your query: .includes([:comments, :votes])"
+        )
+      end
       it { expect(subject.title).to eq('AVOID eager loading in path') }
     end
   end