bullet 5.4.3 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db91b963b462abea2bcc844e823be6844b6e9619
-  data.tar.gz: 53743afe0b49e9cb886ab14f1fd486c1545aa9fb
+  metadata.gz: 652f59b5a91224c16cace3931e368d0da02fa449
+  data.tar.gz: 9ef371969315cd308b194a9d230d1f19892a57e4
 SHA512:
-  metadata.gz: 3b5d3790ae95fd828af2bd4ce1c4b964ec906e1d2caf8a4220e9757f8e0a192af2078a1a2f4e2704b3700eed8f43f4fcb1d0e7638a3a47aa81dfeaf42f535384
-  data.tar.gz: 048266edcde0343713b05d3b726ecb318340c9d2e382877b1e697549b185f164933ba3761c10b2b2f991c1d9638b1f5a119e6bb8738f4da6034b6ed949e2a565
+  metadata.gz: ed473ab951e1f168de703cf0615f203abc93e37ef896330d6f91c7b61d320cd0906e691e41245e13a11aa9e3aa3d059ea62b00b256fa96af0540c8ab35ebc2fb
+  data.tar.gz: f6c4456dfb56957b441fce1b56094baacc911186b59b48b43f22e41ad3bbed88c52aa16b4bc7247b7ca37a3c7d026bb45f5342ccc24b37bc47836cd63fb41a1c

data/.gitignore

@@ -12,3 +12,4 @@ benchmark_profile*
 coverage/
 .coveralls.yml
 Gemfile*.lock
+.idea/

data/.travis.yml

@@ -1,107 +1,12 @@
 sudo: false
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0
-  - 2.1
-  - 2.2
   - 2.3.0
 gemfile:
+  - Gemfile.rails-5.1
   - Gemfile.rails-5.0
   - Gemfile.rails-4.2
   - Gemfile.rails-4.1
   - Gemfile.rails-4.0
-  - Gemfile.rails-3.2
-  - Gemfile.rails-3.1
-  - Gemfile.rails-3.0
-  - Gemfile.mongoid-5.0
-  - Gemfile.mongoid-4.0
-  - Gemfile.mongoid-3.1
-  - Gemfile.mongoid-3.0
-  - Gemfile.mongoid-2.8
-  - Gemfile.mongoid-2.7
-  - Gemfile.mongoid-2.6
-  - Gemfile.mongoid-2.5
-  - Gemfile.mongoid-2.4
 env:
   - DB=sqlite
-services:
-  - mongodb
-matrix:
-  exclude:
-    - rvm: 1.9.3
-      gemfile: Gemfile.rails-4.0
-    - rvm: 1.9.3
-      gemfile: Gemfile.rails-4.1
-    - rvm: 1.9.3
-      gemfile: Gemfile.rails-4.2
-    - rvm: 1.9.3
-      gemfile: Gemfile.rails-5.0
-    - rvm: 1.9.3
-      gemfile: Gemfile.mongoid-2.4
-    - rvm: 1.9.3
-      gemfile: Gemfile.mongoid-2.5
-    - rvm: 1.9.3
-      gemfile: Gemfile.mongoid-2.6
-    - rvm: 1.9.3
-      gemfile: Gemfile.mongoid-2.7
-    - rvm: 1.9.3
-      gemfile: Gemfile.mongoid-2.8
-    - rvm: 1.9.3
-      gemfile: Gemfile.mongoid-3.0
-    - rvm: 1.9.3
-      gemfile: Gemfile.mongoid-3.1
-    - rvm: 1.9.3
-      gemfile: Gemfile.mongoid-4.0
-    - rvm: 1.9.3
-      gemfile: Gemfile.mongoid-5.0
-    - rvm: 2.0
-      gemfile: Gemfile.rails-3.0
-    - rvm: 2.0
-      gemfile: Gemfile.rails-5.0
-    - rvm: 2.1
-      gemfile: Gemfile.rails-3.0
-    - rvm: 2.1
-      gemfile: Gemfile.rails-5.0
-    - rvm: 2.2
-      gemfile: Gemfile.rails-3.0
-    - rvm: 2.2
-      gemfile: Gemfile.rails-3.1
-    - rvm: 2.2
-      gemfile: Gemfile.rails-3.2
-    - rvm: 2.2
-      gemfile: Gemfile.rails-5.0
-    - rvm: 2.2
-      gemfile: Gemfile.mongoid-3.1
-    - rvm: 2.2
-      gemfile: Gemfile.mongoid-3.0
-    - rvm: 2.2
-      gemfile: Gemfile.mongoid-2.8
-    - rvm: 2.2
-      gemfile: Gemfile.mongoid-2.7
-    - rvm: 2.2
-      gemfile: Gemfile.mongoid-2.6
-    - rvm: 2.2
-      gemfile: Gemfile.mongoid-2.5
-    - rvm: 2.2
-      gemfile: Gemfile.mongoid-2.4
-    - rvm: 2.3.0
-      gemfile: Gemfile.rails-3.0
-    - rvm: 2.3.0
-      gemfile: Gemfile.rails-3.1
-    - rvm: 2.3.0
-      gemfile: Gemfile.rails-3.2
-    - rvm: 2.3.0
-      gemfile: Gemfile.mongoid-3.1
-    - rvm: 2.3.0
-      gemfile: Gemfile.mongoid-3.0
-    - rvm: 2.3.0
-      gemfile: Gemfile.mongoid-2.8
-    - rvm: 2.3.0
-      gemfile: Gemfile.mongoid-2.7
-    - rvm: 2.3.0
-      gemfile: Gemfile.mongoid-2.6
-    - rvm: 2.3.0
-      gemfile: Gemfile.mongoid-2.5
-    - rvm: 2.3.0
-      gemfile: Gemfile.mongoid-2.4

data/CHANGELOG.md

@@ -1,17 +1,23 @@
 # Next Release
 
-## 5.4.3
+## 5.6.0 (07/16/2017)
 
-* Fix "false alert" in rails 5 #239
-
-## 5.4.2
+* 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 "display http request method" #311
-
-## 5.4.1
+## 5.5.0 (12/30/2016)
 
 * Display http request method #311
+* Add close button to footer
 * Raise an error if bullet does not support AR or Mongoid
+* Avoid double backtrace
+* Fix false alert on counter cache when associations are already loaded #288
+* Fix "false alert" in rails 5 #239
+* Do not support ActiveRecord 3.x and Mongoid 3.x / 4.x anymore
 
 ## 5.4.0 (10/09/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.mongoid-5.0

@@ -5,7 +5,7 @@ gemspec
 gem 'rails', '~> 4.0.0'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
-gem 'mongoid', '~> 5.0.0'
+gem 'mongoid', '~> 5.1.0'
 
 gem "rspec"
 

data/{Gemfile.mongoid-2.4 → Gemfile.mongoid-6.0}

@@ -2,10 +2,10 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 3.2.0'
+gem 'rails', '~> 5.0.0'
 gem 'sqlite3', platforms: [:ruby]
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
-gem 'mongoid', '~> 2.4.0'
+gem 'mongoid', '~> 6.0.0'
 
 gem "rspec"
 

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.mongoid-2.5 → Gemfile.rails-5.1}

@@ -2,10 +2,10 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 3.2.0'
-gem 'sqlite3', platforms: [:ruby]
+gem 'rails', '~> 5.1.0'
+gem 'sqlite3'
 gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
-gem 'mongoid', '~> 2.5.0'
+gem 'activerecord-import'
 
 gem "rspec"
 

data/Hacking.md

@@ -28,7 +28,7 @@ So the flow of a request goes like this:
    the notification collector
 2. The request is handled by Rails, and the installed ActiveRecord extensions
    trigger Detector callbacks
-3. Detectors once called, will determine whether something noteworthy happend.
+3. Detectors once called, will determine whether something noteworthy happened.
    If yes, then a Notification is created and stored in the notification collector.
 4. Rails finishes handling the request
 5. For each notification in the collector, Bullet will iterate over each

data/README.md

@@ -9,10 +9,12 @@ The Bullet gem is designed to help you increase your application's performance b
 
 Best practice is to use Bullet in development mode or custom mode (staging, profile, etc.). The last thing you want is your clients getting alerts about how lazy you are.
 
-Bullet gem now supports **activerecord** >= 3.0 and **mongoid** >= 2.4.1.
+Bullet gem now supports **activerecord** >= 4.0 and **mongoid** >= 4.0.
 
 If you use activerecord 2.x, please use bullet <= 4.5.0
 
+If you use activerecord 3.x, please use bullet < 5.5.0
+
 ## External Introduction
 
 * [http://railscasts.com/episodes/372-bullet](http://railscasts.com/episodes/372-bullet)
@@ -32,7 +34,7 @@ or add it into a Gemfile (Bundler):
 
 
 ```ruby
-gem "bullet", :group => "development"
+gem 'bullet', group: 'development'
 ```
 
 **Note**: make sure `bullet` gem is added after activerecord (rails) and
@@ -68,23 +70,24 @@ end
 
 The notifier of Bullet is a wrap of [uniform_notifier](https://github.com/flyerhzm/uniform_notifier)
 
-The code above will enable all seven of the Bullet notification systems:
+The code above will enable all of the Bullet notification systems:
 * `Bullet.enable`: enable Bullet gem, otherwise do nothing
 * `Bullet.alert`: pop up a JavaScript alert in the browser
 * `Bullet.bullet_logger`: log to the Bullet log file (Rails.root/log/bullet.log)
+* `Bullet.console`: log warnings to your browser's console.log (Safari/Webkit browsers or Firefox w/Firebug installed)
+* `Bullet.growl`: pop up Growl warnings if your system has Growl installed. Requires a little bit of configuration
+* `Bullet.xmpp`: send XMPP/Jabber notifications to the receiver indicated. Note that the code will currently not handle the adding of contacts, so you will need to make both accounts indicated know each other manually before you will receive any notifications. If you restart the development server frequently, the 'coming online' sound for the Bullet account may start to annoy - in this case set :show_online_status to false; you will still get notifications, but the Bullet account won't announce it's online status anymore.
 * `Bullet.rails_logger`: add warnings directly to the Rails log
 * `Bullet.honeybadger`: add notifications to Honeybadger
 * `Bullet.bugsnag`: add notifications to bugsnag
 * `Bullet.airbrake`: add notifications to airbrake
 * `Bullet.rollbar`: add notifications to rollbar
-* `Bullet.console`: log warnings to your browser's console.log (Safari/Webkit browsers or Firefox w/Firebug installed)
-* `Bullet.growl`: pop up Growl warnings if your system has Growl installed. Requires a little bit of configuration
-* `Bullet.xmpp`: send XMPP/Jabber notifications to the receiver indicated. Note that the code will currently not handle the adding of contacts, so you will need to make both accounts indicated know each other manually before you will receive any notifications. If you restart the development server frequently, the 'coming online' sound for the Bullet account may start to annoy - in this case set :show_online_status to false; you will still get notifications, but the Bullet account won't announce it's online status anymore.
-* `Bullet.raise`: raise errors, useful for making your specs fail unless they have optimized queries
-* `Bullet.add_footer`: adds the details in the bottom left corner of the page
+* `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.
 * `Bullet.slack`: add notifications to slack
+* `Bullet.raise`: raise errors, useful for making your specs fail unless they have optimized queries
+
 
 Bullet also allows you to disable any of its detectors.
 
@@ -300,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_record4.rb

@@ -152,7 +152,7 @@ module Bullet
       ::ActiveRecord::Associations::HasManyAssociation.class_eval do
         alias_method :origin_empty?, :empty?
         def empty?
-          if Bullet.start? && !has_cached_counter?(@reflection)
+          if Bullet.start? && !loaded? && !has_cached_counter?(@reflection)
             Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
           end
           origin_empty?
@@ -162,7 +162,7 @@ module Bullet
       ::ActiveRecord::Associations::HasAndBelongsToManyAssociation.class_eval do
         alias_method :origin_empty?, :empty?
         def empty?
-          if Bullet.start?
+          if Bullet.start? && !loaded?
             Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
           end
           origin_empty?

data/lib/bullet/active_record41.rb

@@ -176,14 +176,13 @@ module Bullet
       end
 
       ::ActiveRecord::Associations::HasManyAssociation.class_eval do
-        alias_method :origin_has_cached_counter?, :has_cached_counter?
-
-        def has_cached_counter?(reflection = reflection())
-          result = origin_has_cached_counter?(reflection)
+        alias_method :origin_count_records, :count_records
+        def count_records
+          result = has_cached_counter?
           if Bullet.start? && !result
-            Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
+            Bullet::Detector::CounterCache.add_counter_cache(@owner, @reflection.name)
           end
-          result
+          origin_count_records
         end
       end
     end

data/lib/bullet/active_record42.rb

@@ -230,33 +230,20 @@ module Bullet
       ::ActiveRecord::Associations::HasManyAssociation.class_eval do
         alias_method :origin_many_empty?, :empty?
         def empty?
-          Thread.current[:bullet_collection_empty] = true
           result = origin_many_empty?
-          Thread.current[:bullet_collection_empty] = nil
           if Bullet.start? && !has_cached_counter?(@reflection)
             Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
           end
           result
         end
 
-        alias_method :origin_has_cached_counter?, :has_cached_counter?
-        def has_cached_counter?(reflection = reflection())
-          result = origin_has_cached_counter?(reflection)
-          if Bullet.start? && !result && !Thread.current[:bullet_collection_empty]
-            Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
+        alias_method :origin_count_records, :count_records
+        def count_records
+          result = has_cached_counter?
+          if Bullet.start? && !result
+            Bullet::Detector::CounterCache.add_counter_cache(@owner, @reflection.name)
           end
-          result
-        end
-      end
-
-      ::ActiveRecord::Associations::HasManyThroughAssociation.class_eval do
-        alias_method :origin_hmt_has_cached_counter?, :has_cached_counter?
-        def has_cached_counter?(reflection = reflection())
-          result = origin_hmt_has_cached_counter?(reflection)
-          if Bullet.start? && !result && !Thread.current[:bullet_collection_empty]
-            Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
-          end
-          result
+          origin_count_records
         end
       end
     end

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)
-            result = origin_find_by_sql(sql, binds, preparable: nil)
-            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 = origin_reader(force_reload)
+        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