bullet 5.7.5 → 5.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb27c10f2796dc6cc38899be2b88943f6c124d80
-  data.tar.gz: c89d95e08212b3bf8da49f2ce4c542ec2aa3021d
+  metadata.gz: b32f7ec78bd32da2e77680a04a02aefb3cd6615f
+  data.tar.gz: d946cc0ded11f343b047bb16145cc72c703d15c9
 SHA512:
-  metadata.gz: 8f4d67bebf52a6730fa623bb150717e56c052605fc339f37d89d915af0981e442200e2bfee5c3405e6269d0907dc4e4f89fd2965000e637555aa8614580837c0
-  data.tar.gz: 3fbfc65e37e50444107e153050b33f66fe51037fd9d325438015d51c71f4a5ccb387e9b76ba28a2c753c9f9227653686535c857f457c80d62213cdda070b9c18
+  metadata.gz: 9c27d586ccdee749e304f57df64c7c17cc77ea88689d5e60b4ae53d19cf25447fe9758fc8c968ca0016a1bb8c5068af1cefd6a76bf07725bcb7c0ffc099ca345
+  data.tar.gz: a864ff44451a06069e812bab6b41826cef78ceed6e25949fd630a0399271d7fb3b25e2b43b619ea74956f7ec58c5886045e5766f7ec9efb8e5f2f2e0c197acac

data/CHANGELOG.md

@@ -1,21 +1,27 @@
 ## Next Release
 
-## 5.7.5 (12/03/2018)
+## 5.7.6 (08/15/2018)
+
+* Extend stacktrace matching for sub-file precision
+* Fix false positive in after_save/_create callbacks
+* Don't triger a preload error on "manual" preloads
+
+## 5.7.5 (03/12/2018)
 
 * Fix duplicate logs in mongoid 4.x and 5.x version
 * Add magic comment frozen_string_literal: true
 
-## 5.7.4 (10/03/2018)
+## 5.7.4 (03/10/2018)
 
 * Avoid Bullet from making extra queries in mongoid6
 * Use caller for ruby 1.9 while caller_locations for 2.0+
 
-## 5.7.3 (17/02/2018)
+## 5.7.3 (02/17/2018)
 
 * Exclude configured bundler path in addition to '/vendor'
 * Support rails 5.1.5
 
-## 5.7.2 (18/01/2018)
+## 5.7.2 (01/18/2018)
 
 * Fix `caller_path` in `excluded_stacktrace_path`
 

data/README.md

@@ -64,7 +64,7 @@ config.after_initialize do
   Bullet.rollbar = true
   Bullet.add_footer = true
   Bullet.stacktrace_includes = [ 'your_gem', 'your_middleware' ]
-  Bullet.stacktrace_excludes = [ 'their_gem', 'their_middleware' ]
+  Bullet.stacktrace_excludes = [ 'their_gem', 'their_middleware', ['my_file.rb', 'my_method'], ['my_file.rb', 16..20] ]
   Bullet.slack = { webhook_url: 'http://some.slack.url', channel: '#default', username: 'notifier' }
 end
 ```
@@ -87,6 +87,8 @@ The code above will enable all of the Bullet notification systems:
 * `Bullet.add_footer`: adds the details in the bottom left corner of the page. Double click the footer or use close button to hide footer.
 * `Bullet.stacktrace_includes`: include paths with any of these substrings in the stack trace, even if they are not in your main app
 * `Bullet.stacktrace_excludes`: ignore paths with any of these substrings in the stack trace, even if they are not in your main app.
+   Each item can be a string (match substring), a regex, or an array where the first item is a path to match, and the second
+   item is a line number, a Range of line numbers, or a (bare) method name, to exclude only particular lines in a file.
 * `Bullet.slack`: add notifications to slack
 * `Bullet.raise`: raise errors, useful for making your specs fail unless they have optimized queries
 
@@ -126,10 +128,11 @@ class ApplicationController < ActionController::Base
   around_action :skip_bullet
 
   def skip_bullet
+    previous_value = Bullet.enabled?
     Bullet.enable = false
     yield
   ensure
-    Bullet.enable = true
+    Bullet.enable = previous_value
   end
 end
 ```
@@ -180,7 +183,7 @@ If you find Bullet does not work for you, *please disable your browser's cache*.
 
 ### Profile a job
 
-The Bullet gem uses rack middleware to profile requests. If you want to use Bullet without an http server, like to profile a job, you can use use profile method and fetch warnings
+The Bullet gem uses rack middleware to profile requests. If you want to use Bullet without an http server, like to profile a job, you can use the profile method and fetch warnings
 
 ```ruby
 Bullet.profile do

data/Rakefile

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'bundler'
 Bundler.setup
 

data/bullet.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib/', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
 
 require 'bullet/version'

data/lib/bullet/active_record4.rb

@@ -48,21 +48,12 @@ module Bullet
       end
 
       ::ActiveRecord::Persistence.class_eval do
-        def save_with_bullet(*args, &proc)
-          was_new_record = new_record?
-          save_without_bullet(*args, &proc).tap do |result|
-            Bullet::Detector::NPlusOneQuery.add_impossible_object(self) if result && was_new_record
+        def _create_record_with_bullet(*args)
+          _create_record_without_bullet(*args).tap do
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
           end
         end
-        alias_method_chain :save, :bullet
-
-        def save_with_bullet!(*args, &proc)
-          was_new_record = new_record?
-          save_without_bullet!(*args, &proc).tap do |result|
-            Bullet::Detector::NPlusOneQuery.add_impossible_object(self) if result && was_new_record
-          end
-        end
-        alias_method_chain :save!, :bullet
+        alias_method_chain :_create_record, :bullet
       end
 
       ::ActiveRecord::Associations::Preloader.class_eval do
@@ -199,6 +190,14 @@ module Bullet
         end
         # rubocop:enable Style/MethodCallWithoutArgsParentheses
       end
+
+      ::ActiveRecord::Associations::BelongsToAssociation.class_eval do
+        def writer_with_bullet(record)
+          Bullet::Detector::Association.add_object_associations(owner, reflection.name) if Bullet.start?
+          writer_without_bullet(record)
+        end
+        alias_method_chain :writer, :bullet
+      end
     end
   end
 end

data/lib/bullet/active_record41.rb

@@ -50,21 +50,12 @@ module Bullet
       end
 
       ::ActiveRecord::Persistence.class_eval do
-        def save_with_bullet(*args, &proc)
-          was_new_record = new_record?
-          save_without_bullet(*args, &proc).tap do |result|
-            Bullet::Detector::NPlusOneQuery.add_impossible_object(self) if result && was_new_record
+        def _create_record_with_bullet(*args)
+          _create_record_without_bullet(*args).tap do
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
           end
         end
-        alias_method_chain :save, :bullet
-
-        def save_with_bullet!(*args, &proc)
-          was_new_record = new_record?
-          save_without_bullet!(*args, &proc).tap do |result|
-            Bullet::Detector::NPlusOneQuery.add_impossible_object(self) if result && was_new_record
-          end
-        end
-        alias_method_chain :save!, :bullet
+        alias_method_chain :_create_record, :bullet
       end
 
       ::ActiveRecord::Associations::Preloader.class_eval do
@@ -187,6 +178,14 @@ module Bullet
           origin_count_records
         end
       end
+
+      ::ActiveRecord::Associations::BelongsToAssociation.class_eval do
+        def writer_with_bullet(record)
+          Bullet::Detector::Association.add_object_associations(owner, reflection.name) if Bullet.start?
+          writer_without_bullet(record)
+        end
+        alias_method_chain :writer, :bullet
+      end
     end
   end
 end

data/lib/bullet/active_record42.rb

@@ -44,21 +44,12 @@ module Bullet
       end
 
       ::ActiveRecord::Persistence.class_eval do
-        def save_with_bullet(*args, &proc)
-          was_new_record = new_record?
-          save_without_bullet(*args, &proc).tap do |result|
-            Bullet::Detector::NPlusOneQuery.add_impossible_object(self) if result && was_new_record
+        def _create_record_with_bullet(*args)
+          _create_record_without_bullet(*args).tap do
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
           end
         end
-        alias_method_chain :save, :bullet
-
-        def save_with_bullet!(*args, &proc)
-          was_new_record = new_record?
-          save_without_bullet!(*args, &proc).tap do |result|
-            Bullet::Detector::NPlusOneQuery.add_impossible_object(self) if result && was_new_record
-          end
-        end
-        alias_method_chain :save!, :bullet
+        alias_method_chain :_create_record, :bullet
       end
 
       ::ActiveRecord::Relation.class_eval do
@@ -247,6 +238,14 @@ module Bullet
           origin_count_records
         end
       end
+
+      ::ActiveRecord::Associations::BelongsToAssociation.class_eval do
+        def writer_with_bullet(record)
+          Bullet::Detector::Association.add_object_associations(owner, reflection.name) if Bullet.start?
+          writer_without_bullet(record)
+        end
+        alias_method_chain :writer, :bullet
+      end
     end
   end
 end

data/lib/bullet/active_record5.rb

@@ -2,17 +2,10 @@
 
 module Bullet
   module SaveWithBulletSupport
-    def save(*args)
-      was_new_record = new_record?
-      super(*args).tap do |result|
-        Bullet::Detector::NPlusOneQuery.add_impossible_object(self) if result && was_new_record
-      end
-    end
-
-    def save!(*args)
-      was_new_record = new_record?
-      super(*args).tap do |result|
-        Bullet::Detector::NPlusOneQuery.add_impossible_object(self) if result && was_new_record
+    def _create_record(*)
+      super do
+        Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
+        yield(self) if block_given?
       end
     end
   end
@@ -238,6 +231,13 @@ module Bullet
           super
         end
       end)
+
+      ::ActiveRecord::Associations::BelongsToAssociation.prepend(Module.new do
+        def writer(record)
+          Bullet::Detector::Association.add_object_associations(owner, reflection.name) if Bullet.start?
+          super
+        end
+      end)
     end
   end
 end

data/lib/bullet/active_record52.rb

@@ -2,17 +2,10 @@
 
 module Bullet
   module SaveWithBulletSupport
-    def save(*args)
-      was_new_record = new_record?
-      super(*args).tap do |result|
-        Bullet::Detector::NPlusOneQuery.add_impossible_object(self) if result && was_new_record
-      end
-    end
-
-    def save!(*args)
-      was_new_record = new_record?
-      super(*args).tap do |result|
-        Bullet::Detector::NPlusOneQuery.add_impossible_object(self) if result && was_new_record
+    def _create_record(*)
+      super do
+        Bullet::Detector::NPlusOneQuery.add_impossible_object(self)
+        yield(self) if block_given?
       end
     end
   end
@@ -221,6 +214,13 @@ module Bullet
           super
         end
       end)
+
+      ::ActiveRecord::Associations::BelongsToAssociation.prepend(Module.new do
+        def writer(record)
+          Bullet::Detector::Association.add_object_associations(owner, reflection.name) if Bullet.start?
+          super
+        end
+      end)
     end
   end
 end

data/lib/bullet/dependency.rb

@@ -29,7 +29,7 @@ module Bullet
                                    elsif active_record52?
                                      'active_record52'
                                    else
-                                     raise "Bullet does not support active_record #{::ActiveRecord::VERSION} yet"
+                                     raise "Bullet does not support active_record #{::ActiveRecord::VERSION::STRING} yet"
                                    end
                                  end
     end

data/lib/bullet/stack_trace_filter.rb

@@ -8,46 +8,65 @@ module Bullet
       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,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bullet
-  VERSION = '5.7.5'.freeze
+  VERSION = '5.7.6'.freeze
 end

data/spec/bullet/detector/n_plus_one_query_spec.rb

@@ -101,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/integration/active_record/association_spec.rb

@@ -356,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

data/spec/models/post.rb

@@ -14,4 +14,19 @@ class Post < ActiveRecord::Base
   def link=(*)
     comments.new
   end
+
+  # see association_spec.rb 'should not detect newly assigned object in an after_save'
+  attr_accessor :trigger_after_save
+  after_save do
+    next unless trigger_after_save
+
+    temp_comment = Comment.new(post: self)
+    # this triggers self to be "possible", even though it's
+    # not saved yet
+    temp_comment.post
+
+    # category should NOT whine about not being pre-loaded, because
+    # it's obviously attached to a new object
+    category
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet
 version: !ruby/object:Gem::Version
-  version: 5.7.5
+  version: 5.7.6
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2018-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport