bullet 5.5.1 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '06945d7fd724e3e1f6355de32b078fac99e6366a'
-  data.tar.gz: ab28a1e628416d945ec40ad21b0ff3e8e4dd50ac
+  metadata.gz: 652f59b5a91224c16cace3931e368d0da02fa449
+  data.tar.gz: 9ef371969315cd308b194a9d230d1f19892a57e4
 SHA512:
-  metadata.gz: 33e0206bd7d7624e3ca311f48274708fcc8030a23ec77954007faaa6b2b14b1d4fd3a7f75c18a8150399565770dd19e252856c2cc94907c6abd3147488280bbf
-  data.tar.gz: cac678c258a0d278c92cbff1bb5e820d9ec71d628a55573588d3fb100a2ded60d28e496c7906632d438f367835d41b923aa98828028693183610840a22c5d114
+  metadata.gz: ed473ab951e1f168de703cf0615f203abc93e37ef896330d6f91c7b61d320cd0906e691e41245e13a11aa9e3aa3d059ea62b00b256fa96af0540c8ab35ebc2fb
+  data.tar.gz: f6c4456dfb56957b441fce1b56094baacc911186b59b48b43f22e41ad3bbed88c52aa16b4bc7247b7ca37a3c7d026bb45f5342ccc24b37bc47836cd63fb41a1c

data/.travis.yml

@@ -8,10 +8,5 @@ gemfile:
   - Gemfile.rails-4.2
   - Gemfile.rails-4.1
   - Gemfile.rails-4.0
-  - Gemfile.mongoid-6.0
-  - Gemfile.mongoid-5.0
-  - Gemfile.mongoid-4.0
 env:
   - DB=sqlite
-services:
-  - mongodb

data/CHANGELOG.md

@@ -1,10 +1,13 @@
 # Next Release
 
-## 5.5.1 (03/01/2016)
+## 5.6.0 (07/16/2017)
 
+* Migrate alias_method to Module#prepend
+* Add install generator
+* Stack trace filter
+* Fix rails 5.1 compatibility
 * Fix inverse_of for rails 5
 * Fix detect file attachment for rack #319
-* Fix `ActiveRecord::Associations::SingularAssociation#reader` usage for Rails 5.1
 
 ## 5.5.0 (12/30/2016)
 

data/Gemfile

@@ -1,8 +1,13 @@
 source 'https://rubygems.org'
 
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
+  "https://github.com/#{repo_name}.git"
+end
+
 gemspec
 
-gem 'rails', github: 'rails/rails'
+gem 'rails', github: 'rails'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'activerecord-import'

data/Gemfile.rails-5.0

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '5.0.0'
+gem 'rails', '~> 5.0.0'
 gem 'sqlite3'
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'activerecord-import'

data/Gemfile.rails-5.1

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '5.1.0.beta.1'
+gem 'rails', '~> 5.1.0'
 gem 'sqlite3'
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
 gem 'activerecord-import'

data/README.md

@@ -303,19 +303,10 @@ And run
 bundle install
 ```
 
-6\. enable the Bullet gem in development, add a line to
-`config/environments/development.rb`
+6\. enable the Bullet gem with generate command
 
-```ruby
-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
+```
+bundle exec rails g bullet:install
 ```
 
 7\. Start the server

data/lib/bullet/active_record5.rb

@@ -18,38 +18,34 @@ module Bullet
   module ActiveRecord
     def self.enable
       require 'active_record'
-      ::ActiveRecord::Base.class_eval do
-        class <<self
-          alias_method :origin_find_by_sql, :find_by_sql
-          def find_by_sql(sql, binds = [], preparable: nil, &block)
-            result = origin_find_by_sql(sql, binds, preparable: nil, &block)
-            if Bullet.start?
-              if result.is_a? Array
-                if result.size > 1
-                  Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
-                  Bullet::Detector::CounterCache.add_possible_objects(result)
-                elsif result.size == 1
-                  Bullet::Detector::NPlusOneQuery.add_impossible_object(result.first)
-                  Bullet::Detector::CounterCache.add_impossible_object(result.first)
-                end
-              elsif result.is_a? ::ActiveRecord::Base
-                Bullet::Detector::NPlusOneQuery.add_impossible_object(result)
-                Bullet::Detector::CounterCache.add_impossible_object(result)
+      ::ActiveRecord::Base.extend(Module.new {
+        def find_by_sql(sql, binds = [], preparable: nil, &block)
+          result = super
+          if Bullet.start?
+            if result.is_a? Array
+              if result.size > 1
+                Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
+                Bullet::Detector::CounterCache.add_possible_objects(result)
+              elsif result.size == 1
+                Bullet::Detector::NPlusOneQuery.add_impossible_object(result.first)
+                Bullet::Detector::CounterCache.add_impossible_object(result.first)
               end
+            elsif result.is_a? ::ActiveRecord::Base
+              Bullet::Detector::NPlusOneQuery.add_impossible_object(result)
+              Bullet::Detector::CounterCache.add_impossible_object(result)
             end
-            result
           end
+          result
         end
-      end
+      })
 
       ::ActiveRecord::Base.prepend(SaveWithBulletSupport)
 
-      ::ActiveRecord::Relation.class_eval do
-        alias_method :origin_records, :records
+      ::ActiveRecord::Relation.prepend(Module.new {
         # if select a collection of objects, then these objects have possible to cause N+1 query.
         # if select only one object, then the only one object has impossible to cause N+1 query.
         def records
-          result = origin_records
+          result = super
           if Bullet.start?
             if result.first.class.name !~ /^HABTM_/
               if result.size > 1
@@ -63,11 +59,9 @@ module Bullet
           end
           result
         end
-      end
-
-      ::ActiveRecord::Associations::Preloader.class_eval do
-        alias_method :origin_preloaders_for_one, :preloaders_for_one
+      })
 
+      ::ActiveRecord::Associations::Preloader.prepend(Module.new {
         def preloaders_for_one(association, records, scope)
           if Bullet.start?
             records.compact!
@@ -78,16 +72,15 @@ module Bullet
               Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, association)
             end
           end
-          origin_preloaders_for_one(association, records, scope)
+          super
         end
-      end
+      })
 
-      ::ActiveRecord::FinderMethods.class_eval do
+      ::ActiveRecord::FinderMethods.prepend(Module.new {
         # add includes in scope
-        alias_method :origin_find_with_associations, :find_with_associations
         def find_with_associations
-          return origin_find_with_associations { |r| yield r } if block_given?
-          records = origin_find_with_associations
+          return super { |r| yield r } if block_given?
+          records = super
           if Bullet.start?
             associations = (eager_load_values + includes_values).uniq
             records.each do |record|
@@ -97,16 +90,12 @@ module Bullet
           end
           records
         end
-      end
-
-      ::ActiveRecord::Associations::JoinDependency.class_eval do
-        alias_method :origin_instantiate, :instantiate
-        alias_method :origin_construct, :construct
-        alias_method :origin_construct_model, :construct_model
+      })
 
+      ::ActiveRecord::Associations::JoinDependency.prepend(Module.new {
         def instantiate(result_set, aliases)
           @bullet_eager_loadings = {}
-          records = origin_instantiate(result_set, aliases)
+          records = super
 
           if Bullet.start?
             @bullet_eager_loadings.each do |klazz, eager_loadings_hash|
@@ -135,12 +124,12 @@ module Bullet
             end
           end
 
-          origin_construct(ar_parent, parent, row, rs, seen, model_cache, aliases)
+          super
         end
 
         # call join associations
         def construct_model(record, node, row, model_cache, id, aliases)
-          result = origin_construct_model(record, node, row, model_cache, id, aliases)
+          result = super
 
           if Bullet.start?
             associations = node.reflection.name
@@ -153,13 +142,11 @@ module Bullet
 
           result
         end
-      end
+      })
 
-      ::ActiveRecord::Associations::CollectionAssociation.class_eval do
-        # call one to many associations
-        alias_method :origin_load_target, :load_target
+      ::ActiveRecord::Associations::CollectionAssociation.prepend(Module.new {
         def load_target
-          records = origin_load_target
+          records = super
 
           if Bullet.start?
             if self.is_a? ::ActiveRecord::Associations::ThroughAssociation
@@ -183,28 +170,25 @@ module Bullet
           records
         end
 
-        alias_method :origin_empty?, :empty?
         def empty?
           if Bullet.start? && !reflection.has_cached_counter?
             Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
           end
-          origin_empty?
+          super
         end
 
-        alias_method :origin_include?, :include?
         def include?(object)
           if Bullet.start?
             Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
           end
-          origin_include?(object)
+          super
         end
-      end
+      })
 
-      ::ActiveRecord::Associations::SingularAssociation.class_eval do
+      ::ActiveRecord::Associations::SingularAssociation.prepend(Module.new {
         # call has_one and belongs_to associations
-        alias_method :origin_reader, :reader
-        def reader(force_reload = false)
-          result = force_reload ? force_reload_reader : origin_reader
+        def target
+          result = super()
           if Bullet.start?
             if owner.class.name !~ /^HABTM_/ && !@inversed
               Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
@@ -217,27 +201,25 @@ module Bullet
           end
           result
         end
-      end
+      })
 
-      ::ActiveRecord::Associations::HasManyAssociation.class_eval do
-        alias_method :origin_many_empty?, :empty?
+      ::ActiveRecord::Associations::HasManyAssociation.prepend(Module.new {
         def empty?
-          result = origin_many_empty?
+          result = super
           if Bullet.start? && !reflection.has_cached_counter?
             Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
           end
           result
         end
 
-        alias_method :origin_count_records, :count_records
         def count_records
           result = reflection.has_cached_counter?
           if Bullet.start? && !result && !self.is_a?(::ActiveRecord::Associations::ThroughAssociation)
             Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
           end
-          origin_count_records
+          super
         end
-      end
+      })
     end
   end
 end

data/lib/bullet/detector/association.rb

@@ -7,7 +7,7 @@ module Bullet
           return if !Bullet.n_plus_one_query_enable? && !Bullet.unused_eager_loading_enable?
           return unless object.primary_key_value
 
-          Bullet.debug("Detector::Association#add_object_associations", "object: #{object.bullet_key}, associations: #{associations}")
+          Bullet.debug("Detector::Association#add_object_associations".freeze, "object: #{object.bullet_key}, associations: #{associations}")
           object_associations.add(object.bullet_key, associations)
         end
 
@@ -16,7 +16,7 @@ module Bullet
           return if !Bullet.n_plus_one_query_enable? && !Bullet.unused_eager_loading_enable?
           return unless object.primary_key_value
 
-          Bullet.debug("Detector::Association#add_call_object_associations", "object: #{object.bullet_key}, associations: #{associations}")
+          Bullet.debug("Detector::Association#add_call_object_associations".freeze, "object: #{object.bullet_key}, associations: #{associations}")
           call_object_associations.add(object.bullet_key, associations)
         end
 

data/lib/bullet/detector/n_plus_one_query.rb

@@ -16,7 +16,7 @@ module Bullet
           return if inversed_objects.include?(object.bullet_key, associations)
           add_call_object_associations(object, associations)
 
-          Bullet.debug("Detector::NPlusOneQuery#call_association", "object: #{object.bullet_key}, associations: #{associations}")
+          Bullet.debug("Detector::NPlusOneQuery#call_association".freeze, "object: #{object.bullet_key}, associations: #{associations}")
           if !excluded_stacktrace_path? && conditions_met?(object, associations)
             Bullet.debug("detect n + 1 query", "object: #{object.bullet_key}, associations: #{associations}")
             create_notification caller_in_project, object.class.to_s, associations
@@ -29,7 +29,7 @@ module Bullet
           objects = Array(object_or_objects)
           return if objects.map(&:primary_key_value).compact.empty?
 
-          Bullet.debug("Detector::NPlusOneQuery#add_possible_objects", "objects: #{objects.map(&:bullet_key).join(', ')}")
+          Bullet.debug("Detector::NPlusOneQuery#add_possible_objects".freeze, "objects: #{objects.map(&:bullet_key).join(', '.freeze)}")
           objects.each { |object| possible_objects.add object.bullet_key }
         end
 
@@ -38,7 +38,7 @@ module Bullet
           return unless Bullet.n_plus_one_query_enable?
           return unless object.primary_key_value
 
-          Bullet.debug("Detector::NPlusOneQuery#add_impossible_object", "object: #{object.bullet_key}")
+          Bullet.debug("Detector::NPlusOneQuery#add_impossible_object".freeze, "object: #{object.bullet_key}")
           impossible_objects.add object.bullet_key
         end
 
@@ -47,7 +47,7 @@ module Bullet
           return unless Bullet.n_plus_one_query_enable?
           return unless object.primary_key_value
 
-          Bullet.debug("Detector::NPlusOneQuery#add_inversed_object", "object: #{object.bullet_key}, association: #{association}")
+          Bullet.debug("Detector::NPlusOneQuery#add_inversed_object".freeze, "object: #{object.bullet_key}, association: #{association}")
           inversed_objects.add object.bullet_key, association
         end
 

data/lib/bullet/ext/object.rb

@@ -5,7 +5,7 @@ class Object
 
   def primary_key_value
     if self.class.respond_to?(:primary_keys) && self.class.primary_keys
-      self.class.primary_keys.map { |primary_key| self.send primary_key }.join(',')
+      self.class.primary_keys.map { |primary_key| self.send primary_key }.join(','.freeze)
     elsif self.class.respond_to?(:primary_key) && self.class.primary_key
       self.send self.class.primary_key
     else

data/lib/bullet/ext/string.rb

@@ -1,5 +1,5 @@
 class String
   def bullet_class_name
-    self.sub(/:[^:]*?$/, "")
+    self.sub(/:[^:]*?$/, "".freeze)
   end
 end

data/lib/bullet/notification/base.rb

@@ -66,7 +66,7 @@ module Bullet
 
       protected
         def klazz_associations_str
-          "  #{@base_class} => [#{@associations.map(&:inspect).join(', ')}]"
+          "  #{@base_class} => [#{@associations.map(&:inspect).join(', '.freeze)}]"
         end
 
         def associations_str

data/lib/bullet/stack_trace_filter.rb

@@ -5,7 +5,8 @@ module Bullet
     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_locations.select do |location|
+        caller_path = location.absolute_path
         caller_path.include?(app_root) && !caller_path.include?(vendor_root) ||
           Bullet.stacktrace_includes.any? do |include_pattern|
           case include_pattern

data/lib/bullet/version.rb

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

data/lib/generators/bullet/install_generator.rb

@@ -0,0 +1,46 @@
+module Bullet
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc <<-DESC
+Description:
+    Enable bullet in development/test for your application.
+      DESC
+
+      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
+        end
+
+        say "Enabled bullet in config/environments/development.rb"
+      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
+
+          say "Enabled bullet in config/environments/test.rb"
+        end
+      end
+    end
+  end
+end

data/spec/bullet/detector/n_plus_one_query_spec.rb

@@ -91,11 +91,11 @@ module Bullet
           after { Bullet.stacktrace_excludes = nil }
 
           it "should not create notification when stacktrace contains paths that are in the exclude list" do
-            in_project = File.join(Dir.pwd, 'abc', 'abc.rb')
-            included_path = '/ghi/ghi.rb'
-            excluded_path = '/def/def.rb'
+            in_project = OpenStruct.new(:absolute_path => File.join(Dir.pwd, 'abc', 'abc.rb'))
+            included_path = OpenStruct.new(:absolute_path => '/ghi/ghi.rb')
+            excluded_path = OpenStruct.new(:absolute_path => '/def/def.rb')
 
-            expect(NPlusOneQuery).to receive(:caller).and_return([in_project, included_path, excluded_path])
+            expect(NPlusOneQuery).to receive(:caller_locations).and_return([in_project, included_path, excluded_path])
             expect(NPlusOneQuery).to_not receive(:create_notification)
             NPlusOneQuery.call_association(@post, :association)
           end
@@ -104,10 +104,10 @@ module Bullet
 
       context ".caller_in_project" do
         it "should include only paths that are in the project" do
-          in_project = File.join(Dir.pwd, 'abc', 'abc.rb')
-          not_in_project = '/def/def.rb'
+          in_project = OpenStruct.new(:absolute_path => File.join(Dir.pwd, 'abc', 'abc.rb'))
+          not_in_project = OpenStruct.new(:absolute_path => '/def/def.rb')
 
-          expect(NPlusOneQuery).to receive(:caller).and_return([in_project, not_in_project])
+          expect(NPlusOneQuery).to receive(:caller_locations).and_return([in_project, not_in_project])
           expect(NPlusOneQuery).to receive(:conditions_met?).with(@post, :association).and_return(true)
           expect(NPlusOneQuery).to receive(:create_notification).with([in_project], "Post", :association)
           NPlusOneQuery.call_association(@post, :association)
@@ -118,11 +118,11 @@ module Bullet
           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_gems = ['/def/def.rb', 'xyz/xyz.rb']
-            excluded_gem = '/ghi/ghi.rb'
+            in_project = OpenStruct.new(:absolute_path => File.join(Dir.pwd, 'abc', 'abc.rb'))
+            included_gems = [OpenStruct.new(:absolute_path => '/def/def.rb'), OpenStruct.new(:absolute_path => 'xyz/xyz.rb')]
+            excluded_gem = OpenStruct.new(:absolute_path => '/ghi/ghi.rb')
 
-            expect(NPlusOneQuery).to receive(:caller).and_return([in_project, *included_gems, excluded_gem])
+            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)
             NPlusOneQuery.call_association(@post, :association)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet
 version: !ruby/object:Gem::Version
-  version: 5.5.1
+  version: 5.6.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2017-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -95,6 +95,7 @@ files:
 - lib/bullet/registry/object.rb
 - lib/bullet/stack_trace_filter.rb
 - lib/bullet/version.rb
+- lib/generators/bullet/install_generator.rb
 - perf/benchmark.rb
 - rails/init.rb
 - spec/bullet/detector/association_spec.rb
@@ -177,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: help to kill N+1 queries and unused eager loading.