bullet 4.4.0 → 4.5.0

data/lib/bullet.rb

@@ -30,18 +30,19 @@ module Bullet
   end
 
   class <<self
-    attr_accessor :enable
-    attr_reader :notification_collector
+    attr_writer :enable, :n_plus_one_query_enable, :unused_eager_loading_enable, :counter_cache_enable
+    attr_reader :notification_collector, :whitelist
 
     delegate :alert=, :console=, :growl=, :rails_logger=, :xmpp=, :airbrake=, :to => UniformNotifier
 
     DETECTORS = [ Bullet::Detector::NPlusOneQuery,
-                  Bullet::Detector::UnusedEagerAssociation,
-                  Bullet::Detector::Counter ]
+                  Bullet::Detector::UnusedEagerLoading,
+                  Bullet::Detector::CounterCache ]
 
     def enable=(enable)
-      @enable = enable
+      @enable = @n_plus_one_query_enable = @unused_eager_loading_enable = @counter_cache_enable = enable
       if enable?
+        reset_whitelist
         if mongoid?
           Bullet::Mongoid.enable
         end
@@ -53,7 +54,32 @@ module Bullet
     end
 
     def enable?
-      @enable == true
+      !!@enable
+    end
+
+    def n_plus_one_query_enable?
+      self.enable? && !!@n_plus_one_query_enable
+    end
+
+    def unused_eager_loading_enable?
+      self.enable? && !!@unused_eager_loading_enable
+    end
+
+    def counter_cache_enable?
+      self.enable? && !!@counter_cache_enable
+    end
+
+    def add_whitelist(options)
+      @whitelist[options[:type]][options[:class_name].classify] ||= []
+      @whitelist[options[:type]][options[:class_name].classify] << options[:association].to_s.tableize.to_sym
+    end
+
+    def get_whitelist_associations(type, class_name)
+      Array(@whitelist[type][class_name])
+    end
+
+    def reset_whitelist
+      @whitelist = {:n_plus_one_query => {}, :unused_eager_loading => {}, :counter_cache => {}}
     end
 
     def bullet_logger=(active)
@@ -82,7 +108,7 @@ module Bullet
     end
 
     def notification?
-      Bullet::Detector::UnusedEagerAssociation.check_unused_preload_associations
+      Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
       notification_collector.notifications_present?
     end
 
@@ -101,6 +127,15 @@ module Bullet
       end
     end
 
+    def warnings
+      notification_collector.collection.inject({}) do |warnings, notification|
+        warning_type = notification.class.to_s.split(':').last.tableize
+        warnings[warning_type] ||= []
+        warnings[warning_type] << notification
+        warnings
+      end
+    end
+
     private
       def for_each_active_notifier_with_notification
         UniformNotifier.active_notifiers.each do |notifier|

data/lib/bullet/active_record2.rb

@@ -12,11 +12,11 @@ module Bullet
 
             if records
               if records.size > 1
-                Bullet::Detector::Association.add_possible_objects(records)
-                Bullet::Detector::Counter.add_possible_objects(records)
+                Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
+                Bullet::Detector::CounterCache.add_possible_objects(records)
               elsif records.size == 1
-                Bullet::Detector::Association.add_impossible_object(records.first)
-                Bullet::Detector::Counter.add_impossible_object(records.first)
+                Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
+                Bullet::Detector::CounterCache.add_impossible_object(records.first)
               end
             end
 
@@ -35,7 +35,7 @@ module Bullet
           records.each do |record|
             Bullet::Detector::Association.add_object_associations(record, associations)
           end
-          Bullet::Detector::Association.add_eager_loadings(records, associations)
+          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
           origin_preload_associations(records, associations, preload_options={})
         end
       end
@@ -50,7 +50,7 @@ module Bullet
             Bullet::Detector::Association.add_object_associations(record, associations)
             Bullet::Detector::NPlusOneQuery.call_association(record, associations)
           end
-          Bullet::Detector::Association.add_eager_loadings(records, associations)
+          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
           records
         end
       end
@@ -94,7 +94,7 @@ module Bullet
           # avoid stack level too deep
           result = origin_load_target
           Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless caller.any? {|c| c.include?("load_target") }
-          Bullet::Detector::Association.add_possible_objects(result)
+          Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
           result
         end
       end
@@ -103,7 +103,7 @@ module Bullet
         alias_method :origin_has_cached_counter?, :has_cached_counter?
         def has_cached_counter?
           result = origin_has_cached_counter?
-          Bullet::Detector::Counter.add_counter_cache(@owner, @reflection.name) unless result
+          Bullet::Detector::CounterCache.add_counter_cache(@owner, @reflection.name) unless result
           result
         end
       end
@@ -112,7 +112,7 @@ module Bullet
         alias_method :origin_has_cached_counter?, :has_cached_counter?
         def has_cached_counter?
           result = origin_has_cached_counter?
-          Bullet::Detector::Counter.add_counter_cache(@owner, @reflection.name) unless result
+          Bullet::Detector::CounterCache.add_counter_cache(@owner, @reflection.name) unless result
           result
         end
       end

data/lib/bullet/active_record3.rb

@@ -9,11 +9,11 @@ module Bullet
         def to_a
           records = origin_to_a
           if records.size > 1
-            Bullet::Detector::Association.add_possible_objects(records)
-            Bullet::Detector::Counter.add_possible_objects(records)
+            Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
+            Bullet::Detector::CounterCache.add_possible_objects(records)
           elsif records.size == 1
-            Bullet::Detector::Association.add_impossible_object(records.first)
-            Bullet::Detector::Counter.add_impossible_object(records.first)
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
+            Bullet::Detector::CounterCache.add_impossible_object(records.first)
           end
           records
         end
@@ -29,7 +29,7 @@ module Bullet
           records.each do |record|
             Bullet::Detector::Association.add_object_associations(record, associations)
           end
-          Bullet::Detector::Association.add_eager_loadings(records, associations)
+          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
           origin_preload_associations(records, associations, preload_options={})
         end
       end
@@ -44,7 +44,7 @@ module Bullet
             Bullet::Detector::Association.add_object_associations(record, associations)
             Bullet::Detector::NPlusOneQuery.call_association(record, associations)
           end
-          Bullet::Detector::Association.add_eager_loadings(records, associations)
+          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
           records
         end
       end
@@ -88,7 +88,7 @@ module Bullet
           # avoid stack level too deep
           result = origin_load_target
           Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name) unless caller.any? { |c| c.include?("load_target") }
-          Bullet::Detector::Association.add_possible_objects(result)
+          Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
           result
         end
       end
@@ -98,7 +98,7 @@ module Bullet
 
         def has_cached_counter?
           result = origin_has_cached_counter?
-          Bullet::Detector::Counter.add_counter_cache(@owner, @reflection.name) unless result
+          Bullet::Detector::CounterCache.add_counter_cache(@owner, @reflection.name) unless result
           result
         end
       end
@@ -107,7 +107,7 @@ module Bullet
         alias_method :origin_has_cached_counter?, :has_cached_counter?
         def has_cached_counter?
           result = origin_has_cached_counter?
-          Bullet::Detector::Counter.add_counter_cache(@owner, @reflection.name) unless result
+          Bullet::Detector::CounterCache.add_counter_cache(@owner, @reflection.name) unless result
           result
         end
       end

data/lib/bullet/active_record3x.rb

@@ -9,11 +9,11 @@ module Bullet
         def to_a
           records = origin_to_a
           if records.size > 1
-            Bullet::Detector::Association.add_possible_objects(records)
-            Bullet::Detector::Counter.add_possible_objects(records)
+            Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
+            Bullet::Detector::CounterCache.add_possible_objects(records)
           elsif records.size == 1
-            Bullet::Detector::Association.add_impossible_object(records.first)
-            Bullet::Detector::Counter.add_impossible_object(records.first)
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
+            Bullet::Detector::CounterCache.add_impossible_object(records.first)
           end
           records
         end
@@ -30,7 +30,7 @@ module Bullet
           records.each do |record|
             Bullet::Detector::Association.add_object_associations(record, associations)
           end
-          Bullet::Detector::Association.add_eager_loadings(records, associations)
+          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
         end
       end
 
@@ -44,7 +44,7 @@ module Bullet
             Bullet::Detector::Association.add_object_associations(record, associations)
             Bullet::Detector::NPlusOneQuery.call_association(record, associations)
           end
-          Bullet::Detector::Association.add_eager_loadings(records, associations)
+          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
           records
         end
       end
@@ -75,7 +75,7 @@ module Bullet
         def reader(force_reload = false)
           result = origin_reader(force_reload)
           Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
-          Bullet::Detector::Association.add_possible_objects(result)
+          Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
           result
         end
       end
@@ -85,7 +85,7 @@ module Bullet
 
         def has_cached_counter?(reflection = reflection)
           result = origin_has_cached_counter?(reflection)
-          Bullet::Detector::Counter.add_counter_cache(owner, reflection.name) unless result
+          Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name) unless result
           result
         end
       end

data/lib/bullet/active_record4.rb

@@ -9,11 +9,11 @@ module Bullet
         def to_a
           records = origin_to_a
           if records.size > 1
-            Bullet::Detector::Association.add_possible_objects(records)
-            Bullet::Detector::Counter.add_possible_objects(records)
+            Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
+            Bullet::Detector::CounterCache.add_possible_objects(records)
           elsif records.size == 1
-            Bullet::Detector::Association.add_impossible_object(records.first)
-            Bullet::Detector::Counter.add_impossible_object(records.first)
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
+            Bullet::Detector::CounterCache.add_impossible_object(records.first)
           end
           records
         end
@@ -30,7 +30,7 @@ module Bullet
           records.each do |record|
             Bullet::Detector::Association.add_object_associations(record, associations)
           end
-          Bullet::Detector::Association.add_eager_loadings(records, associations)
+          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
         end
       end
 
@@ -44,7 +44,7 @@ module Bullet
             Bullet::Detector::Association.add_object_associations(record, associations)
             Bullet::Detector::NPlusOneQuery.call_association(record, associations)
           end
-          Bullet::Detector::Association.add_eager_loadings(records, associations)
+          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
           records
         end
       end
@@ -75,7 +75,7 @@ module Bullet
         def reader(force_reload = false)
           result = origin_reader(force_reload)
           Bullet::Detector::NPlusOneQuery.call_association(@owner, @reflection.name)
-          Bullet::Detector::Association.add_possible_objects(result)
+          Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
           result
         end
       end
@@ -85,7 +85,7 @@ module Bullet
 
         def has_cached_counter?(reflection = reflection)
           result = origin_has_cached_counter?(reflection)
-          Bullet::Detector::Counter.add_counter_cache(owner, reflection.name) unless result
+          Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name) unless result
           result
         end
       end

data/lib/bullet/detector.rb

@@ -3,7 +3,7 @@ module Bullet
     autoload :Base, 'bullet/detector/base'
     autoload :Association, 'bullet/detector/association'
     autoload :NPlusOneQuery, 'bullet/detector/n_plus_one_query'
-    autoload :UnusedEagerAssociation, 'bullet/detector/unused_eager_association'
-    autoload :Counter, 'bullet/detector/counter'
+    autoload :UnusedEagerLoading, 'bullet/detector/unused_eager_loading'
+    autoload :CounterCache, 'bullet/detector/counter_cache'
   end
 end

data/lib/bullet/detector/association.rb

@@ -20,56 +20,15 @@ module Bullet
         end
 
         def add_object_associations(object, associations)
+          return if !Bullet.n_plus_one_query_enable? && !Bullet.unused_eager_loading_enable?
           object_associations.add(object.bullet_ar_key, associations) if object.id
         end
 
         def add_call_object_associations(object, associations)
+          return if !Bullet.n_plus_one_query_enable? && !Bullet.unused_eager_loading_enable?
           call_object_associations.add(object.bullet_ar_key, associations) if object.id
         end
 
-        def add_possible_objects(object_or_objects)
-          return unless object_or_objects
-          if object_or_objects.is_a? Array
-            object_or_objects.each { |object| possible_objects.add object.bullet_ar_key }
-          else
-            possible_objects.add object_or_objects.bullet_ar_key if object_or_objects.id
-          end
-        end
-
-        def add_impossible_object(object)
-          impossible_objects.add object.bullet_ar_key if object.id
-        end
-
-        def add_eager_loadings(objects, associations)
-          bullet_ar_keys = objects.map(&:bullet_ar_key)
-
-          to_add = nil
-          to_merge, to_delete = [], []
-          eager_loadings.each do |k, v|
-            key_objects_overlap = k & bullet_ar_keys
-
-            next if key_objects_overlap.empty?
-
-            if key_objects_overlap == k
-              to_add = [k, associations]
-              break
-            else
-              to_merge << [key_objects_overlap, ( eager_loadings[k].dup  << associations )]
-
-              keys_without_objects = k - bullet_ar_keys
-              to_merge << [keys_without_objects, eager_loadings[k]]
-              to_delete << k
-              bullet_ar_keys = bullet_ar_keys - k
-            end
-          end
-
-          eager_loadings.add *to_add if to_add
-          to_merge.each { |k,val| eager_loadings.merge k, val }
-          to_delete.each { |k| eager_loadings.delete k }
-
-          eager_loadings.add bullet_ar_keys, associations unless bullet_ar_keys.empty?
-        end
-
         private
           # object_associations keep the object relationships
           # that the object has many associations.

data/lib/bullet/detector/{counter.rb → counter_cache.rb}

@@ -1,6 +1,6 @@
 module Bullet
   module Detector
-    class Counter < Base
+    class CounterCache < Base
       class <<self
         def clear
           @@possible_objects = nil
@@ -8,12 +8,16 @@ module Bullet
         end
 
         def add_counter_cache(object, associations)
+          return unless Bullet.counter_cache_enable?
+
           if conditions_met?(object.bullet_ar_key, associations)
             create_notification object.class.to_s, associations
           end
         end
 
         def add_possible_objects(object_or_objects)
+          return unless Bullet.counter_cache_enable?
+
           if object_or_objects.is_a? Array
             object_or_objects.each { |object| possible_objects.add object.bullet_ar_key }
           else
@@ -22,13 +26,19 @@ module Bullet
         end
 
         def add_impossible_object(object)
+          return unless Bullet.counter_cache_enable?
+
           impossible_objects.add object.bullet_ar_key
         end
 
         private
           def create_notification(klazz, associations)
-             notice = Bullet::Notification::CounterCache.new klazz, associations
-             Bullet.notification_collector.add notice
+            notify_associations = Array(associations) - Bullet.get_whitelist_associations(:counter_cache, klazz)
+
+            if notify_associations.present?
+              notice = Bullet::Notification::CounterCache.new klazz, notify_associations
+              Bullet.notification_collector.add notice
+            end
           end
 
           def possible_objects

data/lib/bullet/detector/n_plus_one_query.rb

@@ -15,10 +15,29 @@ module Bullet
           end
         end
 
+        def add_possible_objects(object_or_objects)
+          return unless Bullet.n_plus_one_query_enable?
+          return if object_or_objects.blank?
+          if object_or_objects.is_a? Array
+            object_or_objects.each { |object| possible_objects.add object.bullet_ar_key }
+          else
+            possible_objects.add object_or_objects.bullet_ar_key if object_or_objects.id
+          end
+        end
+
+        def add_impossible_object(object)
+          return unless Bullet.n_plus_one_query_enable?
+          impossible_objects.add object.bullet_ar_key if object.id
+        end
+
         private
           def create_notification(callers, klazz, associations)
-            notice = Bullet::Notification::NPlusOneQuery.new(callers, klazz, associations)
-            Bullet.notification_collector.add(notice)
+            notify_associations = Array(associations) - Bullet.get_whitelist_associations(:n_plus_one_query, klazz)
+
+            if notify_associations.present?
+              notice = Bullet::Notification::NPlusOneQuery.new(callers, klazz, notify_associations)
+              Bullet.notification_collector.add(notice)
+            end
           end
 
           # decide whether the object.associations is unpreloaded or not.