bullet 5.3.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed73722e74144833068cf4572e3624687a9db64b
-  data.tar.gz: e882a8f5c7e4bfbe1d37254e1255ed79fc3f3948
+  metadata.gz: 58f4f616944a1bfde9a34e4670788802f0ccd418
+  data.tar.gz: 61aabed03705063018b28e1505f0f0b693e1109b
 SHA512:
-  metadata.gz: a62b1a339dccad8b79e97971c8d7fc73f977eb9d0b1c19758f59259e85531116fb57a9ef51c90e013d6051a27616ec861380d0940f658102155a163f52eb1873
-  data.tar.gz: de637d2bb853c67a5e7f2b269f698b18b59a481f5988025407d094e0442df03de805bc3890945e49accba76d3ae3c7a62c4185a8fde8d584550eac251a281836
+  metadata.gz: 4be86c6d80b67bec48ee84d491b3b92cd19f9b9ea6d6d9d7d973848f93801edf0165f9a7f8f9309d7feee84ed2da1d6f39170161da2d0b01fe8debf7724d6dc9
+  data.tar.gz: b82c8e8207775a8e987e52fbbddb6d35350c591df288e1152ee2d55e8de9f257ca55f82bcac02c59807b3cffa76038c0373fc09ba42c36a45be059fc05fed7e8

data/CHANGELOG.md

@@ -1,11 +1,16 @@
 # Next Release
 
+## 5.4.0 (10/09/2016)
+
+* Support rails 5.1
+* Extract stack trace filtering into module
+
 ## 5.3.0 (15/08/2016)
 
 * Fix false alert on through association with join sql #301
-* Fix association.target in through_association can be singular #302
-* Support find_by_sql #303
-* Fix env REQUEST_URI
+* Fix association.target in `through_association` can be singular #302
+* Support `find_by_sql` #303
+* Fix env `REQUEST_URI`
 
 ## 5.2.0 (07/26/2016)
 

data/lib/bullet.rb

@@ -4,6 +4,7 @@ require 'uniform_notifier'
 require 'bullet/ext/object'
 require 'bullet/ext/string'
 require 'bullet/dependency'
+require 'bullet/stack_trace_filter'
 
 module Bullet
   extend Dependency

data/lib/bullet/dependency.rb

@@ -26,6 +26,8 @@ module Bullet
                                      'active_record42'
                                    elsif active_record50?
                                      'active_record5'
+                                   elsif active_record51?
+                                     'active_record5'
                                    end
                                  end
     end
@@ -84,8 +86,12 @@ module Bullet
       active_record5? && ::ActiveRecord::VERSION::MINOR == 0
     end
 
+    def active_record51?
+      active_record5? && ::ActiveRecord::VERSION::MINOR == 1
+    end
+
     def mongoid2x?
-      mongoid? && ::Mongoid::VERSION =~ /\A2\.[4-8]/
+      mongoid? && ::Mongoid::VERSION =~ /\A2\.[4-9]/
     end
 
     def mongoid3x?

data/lib/bullet/detector/n_plus_one_query.rb

@@ -2,6 +2,7 @@ module Bullet
   module Detector
     class NPlusOneQuery < Association
       extend Dependency
+      extend StackTraceFilter
 
       class <<self
         # executed when object.assocations is called.
@@ -87,21 +88,6 @@ module Bullet
               Bullet.notification_collector.add(notice)
             end
           end
-
-          def caller_in_project
-            app_root = rails? ? Rails.root.to_s : Dir.pwd
-            vendor_root = app_root + "/vendor"
-            caller.select do |c|
-              c.include?(app_root) && !c.include?(vendor_root) ||
-              Bullet.stacktrace_includes.any? { |include| c.include?(include) }
-            end
-          end
-
-          def excluded_stacktrace_path?
-            Bullet.stacktrace_excludes.any? do |excluded_path|
-              caller_in_project.any? { |c| c.include?(excluded_path) }
-            end
-          end
       end
     end
   end

data/lib/bullet/detector/unused_eager_loading.rb

@@ -1,6 +1,9 @@
 module Bullet
   module Detector
     class UnusedEagerLoading < Association
+      extend Dependency
+      extend StackTraceFilter
+
       class <<self
         # check if there are unused preload associations.
         #   get related_objects from eager_loadings associated with object and associations
@@ -15,7 +18,7 @@ module Bullet
             next if object_association_diff.empty?
 
             Bullet.debug("detect unused preload", "object: #{bullet_key}, associations: #{object_association_diff}")
-            create_notification bullet_key.bullet_class_name, object_association_diff
+            create_notification(caller_in_project, bullet_key.bullet_class_name, object_association_diff)
           end
         end
 
@@ -53,11 +56,11 @@ module Bullet
         end
 
         private
-          def create_notification(klazz, associations)
+          def create_notification(callers, klazz, associations)
             notify_associations = Array(associations) - Bullet.get_whitelist_associations(:unused_eager_loading, klazz)
 
             if notify_associations.present?
-              notice = Bullet::Notification::UnusedEagerLoading.new(klazz, notify_associations)
+              notice = Bullet::Notification::UnusedEagerLoading.new(callers, klazz, notify_associations)
               Bullet.notification_collector.add(notice)
             end
           end

data/lib/bullet/notification/unused_eager_loading.rb

@@ -1,6 +1,18 @@
 module Bullet
   module Notification
     class UnusedEagerLoading < Base
+      def initialize(callers, base_class, associations, path = nil)
+        super(base_class, associations, path)
+
+        @callers = callers
+      end
+
+      def notification_data
+        super.merge(
+          :backtrace => @callers
+        )
+      end
+
       def body
         "#{klazz_associations_str}\n  Remove from your finder: #{associations_str}"
       end

data/lib/bullet/rack.rb

@@ -80,8 +80,8 @@ module Bullet
 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: 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: 18px; font-family: 'Arial', sans-serif; z-index:9999;"
+ 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
   end

data/lib/bullet/stack_trace_filter.rb

@@ -0,0 +1,34 @@
+module Bullet
+  module StackTraceFilter
+    VENDOR_PATH = "/vendor"
+
+    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
+      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
+        end
+      end
+    end
+  end
+end

data/lib/bullet/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Bullet
-  VERSION = "5.3.0"
+  VERSION = "5.4.0"
 end

data/spec/bullet/detector/n_plus_one_query_spec.rb

@@ -87,7 +87,7 @@ module Bullet
         end
 
         context "stacktrace_excludes" do
-          before { Bullet.stacktrace_excludes = [ 'def' ] }
+          before { Bullet.stacktrace_excludes = [ /def/ ] }
           after { Bullet.stacktrace_excludes = nil }
 
           it "should not create notification when stacktrace contains paths that are in the exclude list" do
@@ -114,17 +114,17 @@ module Bullet
         end
 
         context "stacktrace_includes" do
-          before { Bullet.stacktrace_includes = [ 'def' ] }
+          before { Bullet.stacktrace_includes = [ 'def', /xyz/ ] }
           after { Bullet.stacktrace_includes = nil }
 
           it "should include paths that are in the stacktrace_include list" do
             in_project = File.join(Dir.pwd, 'abc', 'abc.rb')
-            included_gem = '/def/def.rb'
+            included_gems = ['/def/def.rb', 'xyz/xyz.rb']
             excluded_gem = '/ghi/ghi.rb'
 
-            expect(NPlusOneQuery).to receive(:caller).and_return([in_project, included_gem, excluded_gem])
+            expect(NPlusOneQuery).to receive(:caller).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_gem], "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

@@ -39,9 +39,11 @@ module Bullet
       end
 
       context ".check_unused_preload_associations" do
+        let(:paths) { ["/dir1", "/dir1/subdir"] }
         it "should create notification if object_association_diff is not empty" do
           UnusedEagerLoading.add_object_associations(@post, :association)
-          expect(UnusedEagerLoading).to receive(:create_notification).with("Post", [:association])
+          allow(UnusedEagerLoading).to receive(:caller_in_project).and_return(paths)
+          expect(UnusedEagerLoading).to receive(:create_notification).with(paths, "Post", [:association])
           UnusedEagerLoading.check_unused_preload_associations
         end
 

data/spec/bullet/notification/unused_eager_loading_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module Bullet
   module Notification
     describe UnusedEagerLoading do
-      subject { UnusedEagerLoading.new(Post, [:comments, :votes], "path") }
+      subject { UnusedEagerLoading.new([""], Post, [:comments, :votes], "path") }
 
       it { expect(subject.body).to eq("  Post => [:comments, :votes]\n  Remove from your finder: :includes => [:comments, :votes]") }
       it { expect(subject.title).to eq("Unused Eager Loading in path") }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.4.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-15 00:00:00.000000000 Z
+date: 2016-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -104,6 +104,7 @@ files:
 - lib/bullet/registry/association.rb
 - lib/bullet/registry/base.rb
 - lib/bullet/registry/object.rb
+- lib/bullet/stack_trace_filter.rb
 - lib/bullet/version.rb
 - perf/benchmark.rb
 - rails/init.rb