bullet 5.7.4 → 5.8.0

data/lib/bullet/mongoid5x.rb

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

data/lib/bullet/mongoid6x.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Mongoid
     def self.enable
@@ -8,20 +10,21 @@ 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)
           return to_enum unless block_given?
+
           records = []
           origin_each { |record| records << record }
           if records.length > 1

data/lib/bullet/notification/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   module Notification
     class Base
@@ -71,7 +73,7 @@ module Bullet
       protected
 
       def klazz_associations_str
-        "  #{@base_class} => [#{@associations.map(&:inspect).join(', '.freeze)}]"
+        "  #{@base_class} => [#{@associations.map(&:inspect).join(', ')}]"
       end
 
       def associations_str

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

data/lib/bullet/notification/unused_eager_loading.rb

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

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

data/lib/bullet/rack.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
   class Rack
     include Dependency
@@ -8,16 +10,17 @@ 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)
+           status == 200 && 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)
+          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
         end
         Bullet.perform_out_of_channel_notifications(env)
@@ -42,11 +45,12 @@ module Bullet
     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
 
@@ -63,7 +67,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,13 +81,13 @@ 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
+        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_close_button

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,51 +1,72 @@
+# 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
       bundler_path = Bundler.bundle_path.to_s
-      select_caller_locations do |caller_path|
+      select_caller_locations do |location|
+        caller_path = location_as_path(location)
         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
+          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 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 Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
+      if ruby_19?
         caller.select do |caller_path|
           yield caller_path
         end
       else
         caller_locations.select do |location|
-          caller_path = location.absolute_path.to_s
-          yield caller_path
+          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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bullet
-  VERSION = '5.7.4'.freeze
+  VERSION = '5.8.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
@@ -161,6 +163,7 @@ module Bullet
 
     def notification?
       return unless start?
+
       Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
       notification_collector.notifications_present?
     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,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH << 'lib'
 require 'benchmark'
 require 'rails'

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

data/spec/bullet/detector/base_spec.rb

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

data/spec/bullet/detector/counter_cache_spec.rb

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

data/spec/bullet/detector/n_plus_one_query_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Bullet
@@ -99,6 +101,29 @@ module Bullet
             expect(NPlusOneQuery).to_not receive(:create_notification)
             NPlusOneQuery.call_association(@post, :association)
           end
+
+          # just a sanity spec to make sure the following spec works correctly
+          it "should create notification when stacktrace contains methods that aren't in the exclude list" do
+            method = NPlusOneQuery.method(:excluded_stacktrace_path?).source_location
+            in_project = OpenStruct.new(absolute_path: File.join(Dir.pwd, 'abc', 'abc.rb'))
+            excluded_path = OpenStruct.new(absolute_path: method.first, lineno: method.last)
+
+            expect(NPlusOneQuery).to receive(:caller_locations).at_least(1).and_return([in_project, excluded_path])
+            expect(NPlusOneQuery).to receive(:conditions_met?).and_return(true)
+            expect(NPlusOneQuery).to receive(:create_notification)
+            NPlusOneQuery.call_association(@post, :association)
+          end
+
+          it 'should not create notification when stacktrace contains methods that are in the exclude list' do
+            method = NPlusOneQuery.method(:excluded_stacktrace_path?).source_location
+            Bullet.stacktrace_excludes = [method]
+            in_project = OpenStruct.new(absolute_path: File.join(Dir.pwd, 'abc', 'abc.rb'))
+            excluded_path = OpenStruct.new(absolute_path: method.first, lineno: method.last)
+
+            expect(NPlusOneQuery).to receive(:caller_locations).and_return([in_project, excluded_path])
+            expect(NPlusOneQuery).to_not receive(:create_notification)
+            NPlusOneQuery.call_association(@post, :association)
+          end
         end
       end
 

data/spec/bullet/detector/unused_eager_loading_spec.rb

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

data/spec/bullet/ext/object_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Object do

data/spec/bullet/ext/string_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe String do

data/spec/bullet/notification/base_spec.rb

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

data/spec/bullet/notification/counter_cache_spec.rb

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

data/spec/bullet/notification/n_plus_one_query_spec.rb

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

data/spec/bullet/notification/unused_eager_loading_spec.rb

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

data/spec/bullet/notification_collector_spec.rb

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

data/spec/bullet/rack_spec.rb

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

data/spec/bullet/registry/association_spec.rb

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

data/spec/bullet/registry/base_spec.rb

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

data/spec/bullet/registry/object_spec.rb

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

data/spec/bullet_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Bullet, focused: true do

data/spec/integration/active_record/association_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 if active_record?
@@ -224,7 +226,7 @@ if active_record?
     context 'post => comment' do
       it 'should detect unused preload with post => comments' do
         Post.includes(:comments).each do |post|
-          post.comments.first.name if post.comments.first
+          post.comments.first&.name
         end
         Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
         expect(Bullet::Detector::Association).not_to be_unused_preload_associations_for(Post, :comments)
@@ -354,6 +356,28 @@ if active_record?
 
         expect(Bullet::Detector::Association).to be_completely_preloading_associations
       end
+
+      it 'should not detect newly assigned object in an after_save' do
+        new_post = Post.new(category: Category.first)
+
+        new_post.trigger_after_save = true
+        new_post.save!
+        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+        expect(Bullet::Detector::Association).to be_completely_preloading_associations
+      end
+
+      it 'should not detect "manual" preload' do
+        comment = Comment.all.to_a.first
+        post = Post.find(comment.post_id)
+        # "manually" preload with out-of-band data
+        comment.post = post
+        # loading it should not trigger anything
+        comment.post
+
+        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+        expect(Bullet::Detector::Association).to be_completely_preloading_associations
+      end
     end
 
     context 'comment => post => category' do
@@ -526,6 +550,44 @@ if active_record?
         expect(Bullet::Detector::Association).to be_completely_preloading_associations
       end
     end
+
+    context 'firm => clients => groups' do
+      it 'should detect non preload associations' do
+        Firm.all.each do |firm|
+          firm.groups.map(&:name)
+        end
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+        expect(Bullet::Detector::Association).to be_detecting_unpreloaded_association_for(Firm, :groups)
+      end
+
+      it 'should detect preload associations' do
+        Firm.includes(:groups).each do |firm|
+          firm.groups.map(&:name)
+        end
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+        expect(Bullet::Detector::Association).to be_completely_preloading_associations
+      end
+
+      it 'should not detect preload associations' do
+        Firm.all.map(&:name)
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+        expect(Bullet::Detector::Association).not_to be_has_unused_preload_associations
+
+        expect(Bullet::Detector::Association).to be_completely_preloading_associations
+      end
+
+      it 'should detect unused preload associations' do
+        Firm.includes(:groups).map(&:name)
+        Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
+        expect(Bullet::Detector::Association).to be_unused_preload_associations_for(Firm, :groups)
+
+        expect(Bullet::Detector::Association).to be_completely_preloading_associations
+      end
+    end
   end
 
   describe Bullet::Detector::Association, 'has_one' do

data/spec/integration/counter_cache_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 if !mongoid? && active_record?

data/spec/integration/mongoid/association_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 if mongoid?

data/spec/models/address.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Address < ActiveRecord::Base
   belongs_to :company
 end

data/spec/models/author.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Author < ActiveRecord::Base
   has_many :documents
 end

data/spec/models/base_user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class BaseUser < ActiveRecord::Base
   has_many :comments
   has_many :posts

data/spec/models/category.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Category < ActiveRecord::Base
   has_many :posts, inverse_of: :category
   has_many :entries

data/spec/models/city.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class City < ActiveRecord::Base
   belongs_to :country
 end

data/spec/models/client.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 class Client < ActiveRecord::Base
+  belongs_to :group
+
   has_many :relationships
   has_many :firms, through: :relationships
 end