bullet 4.14.8 → 4.14.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e402a50f9b2a4c75edafcf12bc2bdb32e3298860
-  data.tar.gz: 73102589e922894098fe54684ac483c8ef6b44b7
+  metadata.gz: 46631b5662b830f5e0c89e381ece4763ba55b2af
+  data.tar.gz: e636307ee2cea385fdd720a4757685f7de401a4b
 SHA512:
-  metadata.gz: 03191a02a885f763bbe24986fdad49f5f9e6d19f6f9a4501ff0c5915b1bb3eaf4cebde6b611be5c0a99982eef12ea32e1e3c51ad6a7a8d3029a1d38ea285d7c8
-  data.tar.gz: dffc316bd5cbacaee45d5ef161bfb63f159a24006d09baf7a5572cfed72a21f970a668c55799fceb2e48705625074fa257bdd0d608a5391c54a5e13e1b354577
+  metadata.gz: 2d5b60419c3f1676c8227db1102f9fac8c7085297aca02511b6e9822c8b14a19ed59c227a5ca2dee060b18295b633e4b3fbb246ee23afdd3c348b6f09468fa30
+  data.tar.gz: 6bfaf51d9ff6cebbc597fa9c6c97cc902b7cf6037f219a7d8bd72dbd09b530921174bea1aa4e9d5d29525107fee5ce9f782acd88d55668d1ab7d3ce11e9b707e

data/.travis.yml

@@ -1,3 +1,4 @@
+sudo: false
 language: ruby
 rvm:
   - 2.0
@@ -10,6 +11,7 @@ gemfile:
   - 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

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Next Release
 
+## 4.14.9
+
+* Support mongoid 5.0.0
+* Do not report association queries immediately after object creation to
+  require a preload
+* Detect `counter_cache` for `has_many :through` association
+
 ## 4.14.8
 
 * compatible with `composite_primary_keys` gem

data/Gemfile.mongoid-5.0

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 4.0.0'
+gem 'sqlite3', platforms: [:ruby]
+gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
+gem 'mongoid', '~> 5.0.0.beta', github: 'mongoid'
+
+gem "rspec"
+
+gem 'coveralls', require: false
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius-developer_tools'
+end

data/README.md

@@ -36,6 +36,9 @@ or add it into a Gemfile (Bundler):
 gem "bullet", :group => "development"
 ```
 
+**Note**: make sure `bullet` gem is added after activerecord (rails) and
+mongoid.
+
 ## Configuration
 
 Bullet won't do ANYTHING unless you tell it to explicitly. Append to

data/lib/bullet.rb

@@ -16,6 +16,9 @@ module Bullet
   autoload :Registry, 'bullet/registry'
   autoload :NotificationCollector, 'bullet/notification_collector'
 
+  BULLET_DEBUG = 'BULLET_DEBUG'.freeze
+  TRUE = 'true'.freeze
+
   if defined? Rails::Railtie
     class BulletRailtie < Rails::Railtie
       initializer "bullet.configure_rails_initialization" do |app|
@@ -74,6 +77,7 @@ module Bullet
     end
 
     def add_whitelist(options)
+      reset_whitelist
       @whitelist[options[:type]][options[:class_name].classify] ||= []
       @whitelist[options[:type]][options[:class_name].classify] << options[:association].to_sym
     end
@@ -83,7 +87,11 @@ module Bullet
     end
 
     def reset_whitelist
-      @whitelist = {:n_plus_one_query => {}, :unused_eager_loading => {}, :counter_cache => {}}
+      @whitelist ||= {:n_plus_one_query => {}, :unused_eager_loading => {}, :counter_cache => {}}
+    end
+
+    def clear_whitelist
+      @whitelist = nil
     end
 
     def bullet_logger=(active)
@@ -98,7 +106,7 @@ module Bullet
     end
 
     def debug(title, message)
-      puts "[Bullet][#{title}] #{message}" if ENV['BULLET_DEBUG'] == 'true'
+      puts "[Bullet][#{title}] #{message}" if ENV[BULLET_DEBUG] == TRUE
     end
 
     def start_request
@@ -132,7 +140,7 @@ module Bullet
     end
 
     def start?
-      Thread.current[:bullet_start]
+      enable? && Thread.current[:bullet_start]
     end
 
     def notification_collector

data/lib/bullet/active_record3.rb

@@ -1,5 +1,7 @@
 module Bullet
   module ActiveRecord
+    LOAD_TARGET = 'load_target'.freeze
+
     def self.enable
       require 'active_record'
       ::ActiveRecord::Relation.class_eval do
@@ -138,7 +140,7 @@ module Bullet
           # avoid stack level too deep
           result = origin_load_target
           if Bullet.start?
-            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless caller.any? { |c| c.include?("load_target") }
+            Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless caller.any? { |c| c.include?(LOAD_TARGET) }
             Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
           end
           result
@@ -160,8 +162,8 @@ module Bullet
 
         def has_cached_counter?
           result = origin_has_cached_counter?
-          if Bullet.start?
-            Bullet::Detector::CounterCache.add_counter_cache(@owner, @reflection.name) unless result
+          if Bullet.start? && !result
+            Bullet::Detector::CounterCache.add_counter_cache(@owner, @reflection.name)
           end
           result
         end
@@ -171,8 +173,8 @@ module Bullet
         alias_method :origin_has_cached_counter?, :has_cached_counter?
         def has_cached_counter?
           result = origin_has_cached_counter?
-          if Bullet.start?
-            Bullet::Detector::CounterCache.add_counter_cache(@owner, @reflection.name) unless result
+          if Bullet.start? && !result
+            Bullet::Detector::CounterCache.add_counter_cache(@owner, @reflection.name)
           end
           result
         end

data/lib/bullet/active_record3x.rb

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

data/lib/bullet/active_record4.rb

@@ -21,6 +21,16 @@ module Bullet
         end
       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
+          end
+        end
+        alias_method_chain :save, :bullet
+      end
+
       ::ActiveRecord::Associations::Preloader.class_eval do
         # include query for one to many associations.
         # keep this eager loadings.
@@ -135,8 +145,8 @@ module Bullet
 
         def has_cached_counter?(reflection = reflection())
           result = origin_has_cached_counter?(reflection)
-          if Bullet.start?
-            Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name) unless result
+          if Bullet.start? && !result
+            Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
           end
           result
         end

data/lib/bullet/active_record41.rb

@@ -23,6 +23,16 @@ module Bullet
         end
       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
+          end
+        end
+        alias_method_chain :save, :bullet
+      end
+
       ::ActiveRecord::Associations::Preloader.class_eval do
         alias_method :origin_preloaders_on, :preloaders_on
 
@@ -138,8 +148,8 @@ module Bullet
 
         def has_cached_counter?(reflection = reflection())
           result = origin_has_cached_counter?(reflection)
-          if Bullet.start?
-            Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name) unless result
+          if Bullet.start? && !result
+            Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
           end
           result
         end

data/lib/bullet/active_record42.rb

@@ -21,6 +21,16 @@ module Bullet
         end
       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
+          end
+        end
+        alias_method_chain :save, :bullet
+      end
+
       ::ActiveRecord::Relation.class_eval do
         alias_method :origin_to_a, :to_a
         # if select a collection of objects, then these objects have possible to cause N+1 query.
@@ -182,10 +192,19 @@ module Bullet
         alias_method :origin_has_cached_counter?, :has_cached_counter?
         def has_cached_counter?(reflection = reflection())
           result = origin_has_cached_counter?(reflection)
-          if Bullet.start?
-            if !result && !Thread.current[:bullet_collection_empty]
-              Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
-            end
+          if Bullet.start? && !result && !Thread.current[:bullet_collection_empty]
+            Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
+          end
+          result
+        end
+      end
+
+      ::ActiveRecord::Associations::HasManyThroughAssociation.class_eval do
+        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)
           end
           result
         end

data/lib/bullet/dependency.rb

@@ -36,6 +36,8 @@ module Bullet
                                'mongoid3x'
                              elsif mongoid4x?
                                'mongoid4x'
+                             elsif mongoid5x?
+                               'mongoid5x'
                              end
                            end
     end
@@ -83,5 +85,9 @@ module Bullet
     def mongoid4x?
       mongoid? && ::Mongoid::VERSION =~ /\A4/
     end
+
+    def mongoid5x?
+      mongoid? && ::Mongoid::VERSION =~ /\A5/
+    end
   end
 end

data/lib/bullet/detector/n_plus_one_query.rb

@@ -70,7 +70,7 @@ module Bullet
               # associations == v comparision order is important here because
               # v variable might be a squeel node where :== method is redefined,
               # so it does not compare values at all and return unexpected results
-              result = v.is_a?(Hash) ? v.has_key?(associations) : associations == v
+              result = v.is_a?(Hash) ? v.key?(associations) : associations == v
               return true if result
             end
           end

data/lib/bullet/mongoid5x.rb

@@ -0,0 +1,56 @@
+module Bullet
+  module Mongoid
+    def self.enable
+      require 'mongoid'
+      ::Mongoid::Contextual::Mongo.class_eval do
+        alias_method :origin_first, :first
+        alias_method :origin_last, :last
+        alias_method :origin_each, :each
+        alias_method :origin_eager_load, :eager_load
+
+        def first
+          result = origin_first
+          Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+          result
+        end
+
+        def last
+          result = origin_last
+          Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+          result
+        end
+
+        def each(&block)
+          records = view.map{ |doc| ::Mongoid::Factory.from_db(klass, doc) }
+          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)
+        end
+
+        def eager_load(docs)
+          associations = criteria.inclusions.map(&:name)
+          docs.each do |doc|
+            Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations)
+          end
+          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(docs, associations)
+          origin_eager_load(docs)
+        end
+      end
+
+      ::Mongoid::Relations::Accessors.class_eval do
+        alias_method :origin_get_relation, :get_relation
+
+        def get_relation(name, metadata, object, reload = false)
+          result = origin_get_relation(name, metadata, object, reload)
+          if metadata.macro !~ /embed/
+            Bullet::Detector::NPlusOneQuery.call_association(self, name)
+          end
+          result
+        end
+      end
+    end
+  end
+end

data/lib/bullet/version.rb

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

data/spec/bullet_spec.rb

@@ -38,4 +38,51 @@ describe Bullet, focused: true do
       end
     end
   end
+
+  describe '#start?' do
+    context 'when bullet is disabled' do
+      before(:each) do
+        Bullet.enable = false
+      end
+
+      it 'should not be started' do
+        expect(Bullet).not_to be_start
+      end
+    end
+  end
+
+  describe '#debug' do
+    before(:each) do
+      $stdout = StringIO.new
+    end
+
+    after(:each) do
+      $stdout = STDOUT
+    end
+
+    context 'when debug is enabled' do
+      before(:each) do
+        ENV['BULLET_DEBUG'] = 'true'
+      end
+
+      after(:each) do
+        ENV['BULLET_DEBUG'] = 'false'
+      end
+
+      it 'should output debug information' do
+        Bullet.debug('debug_message', 'this is helpful information')
+
+        expect($stdout.string)
+          .to eq("[Bullet][debug_message] this is helpful information\n")
+      end
+    end
+
+    context 'when debug is disabled' do
+      it 'should output debug information' do
+        Bullet.debug('debug_message', 'this is helpful information')
+
+        expect($stdout.string).to be_empty
+      end
+    end
+  end
 end

data/spec/integration/active_record3/association_spec.rb

@@ -624,7 +624,7 @@ if !mongoid? && active_record3?
 
     context "whitelist n plus one query" do
       before { Bullet.add_whitelist :type => :n_plus_one_query, :class_name => "Post", :association => :comments }
-      after { Bullet.reset_whitelist }
+      after { Bullet.clear_whitelist }
 
       it "should not detect n plus one query" do
         Post.all.each do |post|
@@ -647,7 +647,7 @@ if !mongoid? && active_record3?
 
     context "whitelist unused eager loading" do
       before { Bullet.add_whitelist :type => :unused_eager_loading, :class_name => "Post", :association => :comments }
-      after { Bullet.reset_whitelist }
+      after { Bullet.clear_whitelist }
 
       it "should not detect unused eager loading" do
         Post.includes(:comments).map(&:name)

data/spec/integration/active_record4/association_spec.rb

@@ -560,6 +560,27 @@ if !mongoid? && active_record4?
     end
   end
 
+  describe Bullet::Detector::Association, "query immediately after creation" do
+    context "document => children" do
+      it 'should not detect non preload associations' do
+        document1 = Document.new
+        document1.children.build
+        document1.save
+
+        document2 = Document.new(parent: document1)
+        document2.save
+        document2.parent
+
+        document1.children.each.first
+
+        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
+    end
+  end
+
   describe Bullet::Detector::Association, "STI" do
     context "page => author" do
       it "should detect non preload associations" do
@@ -647,7 +668,7 @@ if !mongoid? && active_record4?
 
     context "whitelist n plus one query" do
       before { Bullet.add_whitelist :type => :n_plus_one_query, :class_name => "Post", :association => :comments }
-      after { Bullet.reset_whitelist }
+      after { Bullet.clear_whitelist }
 
       it "should not detect n plus one query" do
         Post.all.each do |post|
@@ -670,7 +691,7 @@ if !mongoid? && active_record4?
 
     context "whitelist unused eager loading" do
       before { Bullet.add_whitelist :type => :unused_eager_loading, :class_name => "Post", :association => :comments }
-      after { Bullet.reset_whitelist }
+      after { Bullet.clear_whitelist }
 
       it "should not detect unused eager loading" do
         Post.includes(:comments).map(&:name)

data/spec/integration/counter_cache_spec.rb

@@ -29,6 +29,13 @@ if !mongoid? && active_record?
       expect(Bullet.collected_counter_cache_notifications).to be_empty
     end
 
+    it "should need counter cache for has_many through" do
+      Client.all.each do |client|
+        client.firms.size
+      end
+      expect(Bullet.collected_counter_cache_notifications).not_to be_empty
+    end
+
     it "should not need counter cache with part of cities" do
       Country.all.each do |country|
         country.cities.where(:name => 'first').size
@@ -50,7 +57,7 @@ if !mongoid? && active_record?
 
     context "whitelist" do
       before { Bullet.add_whitelist :type => :counter_cache, :class_name => "Country", :association => :cities }
-      after { Bullet.reset_whitelist }
+      after { Bullet.clear_whitelist }
 
       it "should not detect counter cache" do
         Country.all.each do |country|

data/spec/spec_helper.rb

@@ -58,6 +58,7 @@ if active_record?
 
     config.before(:example) do
       Bullet.start_request
+      Bullet.enable = true
     end
 
     config.after(:example) do

data/spec/support/mongo_seed.rb

@@ -52,6 +52,19 @@ module Support
             }
           )
         end
+      elsif Mongoid::VERSION =~ /\A5/
+        Mongoid.configure do |config|
+          config.load_configuration(
+              clients: {
+                  default: {
+                      database: "bullet",
+                      hosts: [ "localhost:27017" ]
+                  }
+              }
+          )
+        end
+        # Increase the level from DEBUG in order to avoid excessive logging to the screen
+        Mongo::Logger.logger.level = Logger::WARN
       end
     end
 

data/test.sh

@@ -6,6 +6,7 @@ BUNDLE_GEMFILE=Gemfile.rails-4.0 bundle && BUNDLE_GEMFILE=Gemfile.rails-4.0 bund
 BUNDLE_GEMFILE=Gemfile.rails-3.2 bundle && BUNDLE_GEMFILE=Gemfile.rails-3.2 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.rails-3.1 bundle && BUNDLE_GEMFILE=Gemfile.rails-3.1 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.rails-3.0 bundle && BUNDLE_GEMFILE=Gemfile.rails-3.0 bundle exec rspec spec
+BUNDLE_GEMFILE=Gemfile.mongoid-5.0 bundle && BUNDLE_GEMFILE=Gemfile.mongoid-5.0 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.mongoid-4.0 bundle && BUNDLE_GEMFILE=Gemfile.mongoid-4.0 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.mongoid-3.1 bundle && BUNDLE_GEMFILE=Gemfile.mongoid-3.1 bundle exec rspec spec
 BUNDLE_GEMFILE=Gemfile.mongoid-3.0 bundle && BUNDLE_GEMFILE=Gemfile.mongoid-3.0 bundle exec rspec spec

data/update.sh

@@ -4,6 +4,7 @@ BUNDLE_GEMFILE=Gemfile.rails-4.0 bundle update
 BUNDLE_GEMFILE=Gemfile.rails-3.2 bundle update
 BUNDLE_GEMFILE=Gemfile.rails-3.1 bundle update
 BUNDLE_GEMFILE=Gemfile.rails-3.0 bundle update
+BUNDLE_GEMFILE=Gemfile.mongoid-5.0 bundle update
 BUNDLE_GEMFILE=Gemfile.mongoid-4.0 bundle update
 BUNDLE_GEMFILE=Gemfile.mongoid-3.1 bundle update
 BUNDLE_GEMFILE=Gemfile.mongoid-3.0 bundle update

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bullet
 version: !ruby/object:Gem::Version
-  version: 4.14.8
+  version: 4.14.9
 platform: ruby
 authors:
 - Richard Huang
@@ -59,6 +59,7 @@ files:
 - Gemfile.mongoid-3.0
 - Gemfile.mongoid-3.1
 - Gemfile.mongoid-4.0
+- Gemfile.mongoid-5.0
 - Gemfile.rails-3.0
 - Gemfile.rails-3.1
 - Gemfile.rails-3.2
@@ -89,6 +90,7 @@ files:
 - lib/bullet/mongoid2x.rb
 - lib/bullet/mongoid3x.rb
 - lib/bullet/mongoid4x.rb
+- lib/bullet/mongoid5x.rb
 - lib/bullet/notification.rb
 - lib/bullet/notification/base.rb
 - lib/bullet/notification/counter_cache.rb