bullet 2.2.0 → 2.3.0

data/lib/bullet/detector/n_plus_one_query.rb

@@ -1,38 +1,57 @@
 module Bullet
   module Detector
     class NPlusOneQuery < Association
-      # executed when object.assocations is called.
-      # first, it keeps this method call for object.association.
-      # then, it checks if this associations call is unpreload.
-      #   if it is, keeps this unpreload associations and caller.
-      def self.call_association(object, associations)
-        @@checked = true
-        add_call_object_associations(object, associations)
-
-        if conditions_met?(object, associations)
-          caller_in_project
-          create_notification object.class, associations
+      class <<self
+        # executed when object.assocations is called.
+        # first, it keeps this method call for object.association.
+        # then, it checks if this associations call is unpreload.
+        #   if it is, keeps this unpreload associations and caller.
+        def call_association(object, associations)
+          @@checked = true
+          add_call_object_associations(object, associations)
+
+          if conditions_met?(object.ar_key, associations)
+            create_notification caller_in_project, object.class.to_s, associations
+          end
         end
-      end
 
-      private
-      def self.create_notification(klazz, associations)
-        notice = Bullet::Notification::NPlusOneQuery.new( callers, klazz, associations )
-        Bullet.notification_collector.add( notice )
-      end
+        private
+          def create_notification(callers, klazz, associations)
+            notice = Bullet::Notification::NPlusOneQuery.new(callers, klazz, associations)
+            Bullet.notification_collector.add(notice)
+          end
 
-      # decide whether the object.associations is unpreloaded or not.
-      def self.conditions_met?(object, associations)
-        possible?(object) and 
-        !impossible?(object) and 
-        !association?(object, associations)
-      end
+          # decide whether the object.associations is unpreloaded or not.
+          def conditions_met?(object_ar_key, associations)
+            possible?(object_ar_key) && !impossible?(object_ar_key) && !association?(object_ar_key, associations)
+          end
+
+          def caller_in_project
+            rails_root = Rails.root.to_s
+            vendor_root = rails_root + "/vendor"
+            caller.select { |c| c.include?(rails_root) && !c.include?(vendor_root) }
+          end
+
+          def possible?(object_ar_key)
+            possible_objects.include? object_ar_key
+          end
+
+          def impossible?(object_ar_key)
+            impossible_objects.include? object_ar_key
+          end
+
+          # check if object => associations already exists in object_associations.
+          def association?(object_ar_key, associations)
+            value = object_associations[object_ar_key]
+            if value
+              value.each do |v|
+                result = v.is_a?(Hash) ? v.has_key?(associations) : v == associations
+                return true if result
+              end
+            end
 
-      def self.caller_in_project
-        vender_root ||= File.join(Rails.root, 'vendor')
-        callers << caller.select { |c| c =~ /#{Rails.root}/ }.
-                          reject { |c| c =~ /#{vender_root}/ }
-        callers.uniq!
+            return false
+          end
       end
     end
   end

data/lib/bullet/detector/unused_eager_association.rb

@@ -1,40 +1,41 @@
 module Bullet
   module Detector
     class UnusedEagerAssociation < Association
-      # check if there are unused preload associations.
-      # for each object => association
-      #   get related_objects from eager_loadings associated with object and associations
-      #   get call_object_association from associations of call_object_associations whose object is in related_objects 
-      #   if association not in call_object_association, then the object => association - call_object_association is ununsed preload assocations
-      def self.check_unused_preload_associations
-        @@checked = true
-        object_associations.each do |object, association|
-          object_association_diff = diff_object_association object, association
-          next if object_association_diff.empty?
+      class <<self
+        # check if there are unused preload associations.
+        #   get related_objects from eager_loadings associated with object and associations
+        #   get call_object_association from associations of call_object_associations whose object is in related_objects
+        #   if association not in call_object_association, then the object => association - call_object_association is ununsed preload assocations
+        def check_unused_preload_associations
+          @@checked = true
+          object_associations.each do |object_ar_key, association|
+            object_association_diff = diff_object_association object_ar_key, association
+            next if object_association_diff.empty?
 
-          create_notification object.class, object_association_diff
+            create_notification object_ar_key.split(":").first, object_association_diff
+          end
         end
-      end
-      
-      protected
-      def self.create_notification(klazz, associations)
-        notice = Bullet::Notification::UnusedEagerLoading.new( klazz, associations )
-        Bullet.notification_collector.add( notice )
-      end
 
-      def self.call_object_association( object, association )
-        all = Set.new
-        eager_loadings.similarly_associated( object, association ).each do |related_object|
-            coa = call_object_associations[related_object]
-            next if coa.nil?
-            all.merge coa
-        end
-        all.to_a
-      end
+        private
+          def create_notification(klazz, associations)
+            notice = Bullet::Notification::UnusedEagerLoading.new(klazz, associations)
+            Bullet.notification_collector.add(notice)
+          end
+
+          def call_associations(object_ar_key, association)
+            all = Set.new
+            eager_loadings.similarly_associated(object_ar_key, association).each do |related_object_ar_key|
+              coa = call_object_associations[related_object_ar_key]
+              next if coa.nil?
+              all.merge coa
+            end
+            all.to_a
+          end
 
-      def self.diff_object_association( object, association )
-        potential_objects = association - call_object_association( object, association )
-        potential_objects.reject {|a| a.is_a?( Hash ) }
+          def diff_object_association(object_ar_key, association)
+            potential_objects = association - call_associations(object_ar_key, association)
+            potential_objects.reject { |a| a.is_a?(Hash) }
+          end
       end
     end
   end

data/lib/bullet/notification/base.rb

@@ -4,18 +4,20 @@ module Bullet
       attr_accessor :notifier, :url
       attr_reader :base_class, :associations, :path
 
-      def initialize( base_class, associations, path = nil )
+      def initialize(base_class, association_or_associations, path = nil)
         @base_class = base_class
-        @associations = associations.is_a?( Array ) ? associations : [ associations ]
+        @associations = association_or_associations.is_a?(Array) ?  association_or_associations : [association_or_associations]
         @path = path
       end
 
       def title
+        raise NoMethodError.new("no method title defined")
       end
 
       def body
+        raise NoMethodError.new("no method body defined")
       end
-      
+
       def whoami
         "user: " << `whoami`.chomp
       end
@@ -33,14 +35,14 @@ module Bullet
       end
 
       def notify_inline
-        self.notifier.inline_notify( self.full_notice )
+        self.notifier.inline_notify(self.full_notice)
       end
 
       def notify_out_of_channel
-        self.notifier.out_of_channel_notify( self.full_notice )
+        self.notifier.out_of_channel_notify(self.full_notice)
       end
 
-      def eql?( other )
+      def eql?(other)
         klazz_associations_str == other.klazz_associations_str
       end
 
@@ -49,13 +51,13 @@ module Bullet
       end
 
       protected
-      def klazz_associations_str
-        "  #{@base_class} => [#{@associations.map(&:inspect).join(', ')}]"
-      end
+        def klazz_associations_str
+          "  #{@base_class} => [#{@associations.map(&:inspect).join(', ')}]"
+        end
 
-      def associations_str
-        ":include => #{@associations.map{|a| a.to_s.to_sym unless a.is_a? Hash}.inspect}"
-      end
+        def associations_str
+          ":include => #{@associations.map{ |a| a.to_s.to_sym unless a.is_a? Hash }.inspect}"
+        end
     end
   end
 end

data/lib/bullet/notification/n_plus_one_query.rb

@@ -1,8 +1,8 @@
 module Bullet
   module Notification
     class NPlusOneQuery < Base
-      def initialize( callers, base_class, associations, path = nil )
-        super( base_class, associations, path )
+      def initialize(callers, base_class, associations, path = nil)
+        super(base_class, associations, path)
 
         @callers = callers
       end
@@ -10,7 +10,7 @@ module Bullet
       def body_with_caller
         "#{body}\n#{call_stack_messages}"
       end
-      
+
       def body
         "#{klazz_associations_str}\n  Add to your finder: #{associations_str}"
       end
@@ -20,13 +20,9 @@ module Bullet
       end
 
       protected
-      def call_stack_messages
-        @callers.collect do |c|
-          [ 'N+1 Query method call stack', 
-            c.collect {|line| "  #{line}"} ].flatten
-        end.join( "\n" )
-      end
-
+        def call_stack_messages
+          @callers.unshift('N+1 Query method call stack').join( "\n  " )
+        end
     end
   end
 end

data/lib/bullet/notification/unused_eager_loading.rb

@@ -6,9 +6,8 @@ module Bullet
       end
 
       def title
-        "Unused Eager Loading #{@path ? "in #{@path}" : 'detected'}" 
+        "Unused Eager Loading #{@path ? "in #{@path}" : 'detected'}"
       end
-
     end
   end
 end

data/lib/bullet/notification_collector.rb

@@ -12,14 +12,13 @@ module Bullet
       @collection = Set.new
     end
 
-    def add( value )
+    def add(value)
       @collection << value
     end
 
     def notifications_present?
       !@collection.empty?
     end
-
   end
 end
 

data/lib/bullet/rack.rb

@@ -13,7 +13,7 @@ module Bullet
 
       response_body = nil
       if Bullet.notification?
-        if status == 200 and !response.body.frozen? and check_html?(headers, response)
+        if status == 200 && !response.body.frozen? && html_request?(headers, response)
           response_body = response.body << Bullet.gather_inline_notifications
           headers['Content-Length'] = response_body.length.to_s
         end
@@ -31,8 +31,11 @@ module Bullet
       !response.body.is_a?(String) || response.body.empty?
     end
 
-    def check_html?(headers, response)
-      headers['Content-Type'] and headers['Content-Type'].include? 'text/html' and response.body =~ %r{<html.*</html>}m
+    def html_request?(headers, response)
+      headers['Content-Type'] &&
+        headers['Content-Type'].include?('text/html') &&
+        response.body.include?("<html>") &&
+        response.body.include?("</html>")
     end
 
     def no_browser_cache(headers)

data/lib/bullet/registry/association.rb

@@ -1,14 +1,12 @@
 module Bullet
   module Registry
     class Association < Base
-      def merge( base, associations )
-        @registry.merge!( { base => associations } )
+      def merge(base, associations)
+        @registry.merge!(base => associations)
       end
 
-      def similarly_associated( base, associations )
-        @registry.select do |key, value|
-          key.include?( base ) and value == associations
-        end.collect( &:first ).flatten
+      def similarly_associated(base, associations)
+        @registry.select { |key, value| key.include?(base) && value == associations }.collect(&:first).flatten
       end
     end
   end

data/lib/bullet/registry/base.rb

@@ -11,19 +11,19 @@ module Bullet
         @registry[key]
       end
 
-      def each( &block )
-        @registry.each( &block )
+      def each(&block)
+        @registry.each(&block)
       end
 
-      def delete( base )
-        @registry.delete( base )
+      def delete(base)
+        @registry.delete(base)
       end
 
-      def select( *args, &block )
-        @registry.select( *args, &block )
+      def select(*args, &block)
+        @registry.select(*args, &block)
       end
 
-      def add( key, value )
+      def add(key, value)
         @registry[key] ||= Set.new
         if value.is_a? Array
           @registry[key] += value
@@ -32,6 +32,9 @@ module Bullet
         end
       end
 
+      def include?(key, value)
+        @registry[key] && @registry[key].include?(value)
+      end
     end
   end
 end

data/lib/bullet/registry/object.rb

@@ -1,14 +1,14 @@
 module Bullet
   module Registry
     class Object < Base
-      def add( object_or_objects )
-        klazz = object_or_objects.is_a?( Array ) ? object_or_objects.first.class :
-                                                   object_or_objects.class
-        super( klazz, object_or_objects )
+      def add(object_ar_key)
+        klazz = object_ar_key.split(":").first
+        super(klazz, object_ar_key)
       end
 
-      def contains?( object )
-        @registry[object.class] and @registry[object.class].include?( object )
+      def include?(object_ar_key)
+        klazz = object_ar_key.split(":").first
+        super(klazz, object_ar_key)
       end
     end
   end

data/lib/bullet/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 module Bullet
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end
 

data/lib/bullet.rb

@@ -1,10 +1,16 @@
 require 'set'
 require 'uniform_notifier'
 
+class Object
+  def ar_key
+    "#{self.class}:#{self.id}"
+  end
+end
+
 module Bullet
-  if Rails.version =~ /^3\.0/
+  if Rails.version =~ /\A3\.0/
     autoload :ActiveRecord, 'bullet/active_record3'
-  elsif Rails.version =~ /^3\.[12]/
+  elsif Rails.version =~ /\A3\.[12]/
     autoload :ActiveRecord, 'bullet/active_record31'
   else
     autoload :ActiveRecord, 'bullet/active_record2'
@@ -39,7 +45,7 @@ module Bullet
       @enable = enable
       if enable?
         Bullet::ActiveRecord.enable
-        if Rails.version =~ /^2./
+        if Rails.version =~ /\A2./
           Bullet::ActionController.enable
         end
       end
@@ -51,7 +57,7 @@ module Bullet
 
     def bullet_logger=(active)
       if active
-        bullet_log_file = File.open( 'log/bullet.log', 'a+' )
+        bullet_log_file = File.open('log/bullet.log', 'a+')
         bullet_log_file.sync
         UniformNotifier.customized_logger = bullet_log_file
       end
@@ -59,15 +65,15 @@ module Bullet
 
     def start_request
       notification_collector.reset
-      DETECTORS.each {|bullet| bullet.start_request}
+      DETECTORS.each { |bullet| bullet.start_request }
     end
 
     def end_request
-      DETECTORS.each {|bullet| bullet.end_request}
+      DETECTORS.each { |bullet| bullet.end_request }
     end
 
     def clear
-      DETECTORS.each {|bullet| bullet.clear}
+      DETECTORS.each { |bullet| bullet.clear }
     end
 
     def notification_collector
@@ -104,5 +110,4 @@ module Bullet
         end
       end
   end
-
 end

data/perf/benchmark.rb

@@ -83,16 +83,18 @@ PerfTools::CpuProfiler.start(ARGV[0]|| "benchmark_profile") if defined? PerfTool
 
 Benchmark.bm(70) do |bm|
   bm.report("Querying & Iterating #{posts_size} Posts with #{comments_size} Comments and #{users_size} Users") do
-    Bullet.start_request
-    Post.select("SQL_NO_CACHE *").includes(:user, :comments => :user).each do |p|
-      p.title
-      p.user.name
-      p.comments.each do |c|
-        c.body
-        c.user.name
+    10.times do
+      Bullet.start_request
+      Post.select("SQL_NO_CACHE *").includes(:user, :comments => :user).each do |p|
+        p.title
+        p.user.name
+        p.comments.each do |c|
+          c.body
+          c.user.name
+        end
       end
+      Bullet.end_request
     end
-    Bullet.end_request
   end
 end
 
@@ -100,7 +102,23 @@ PerfTools::CpuProfiler.stop if defined? PerfTools
 puts "End benchmarking..."
 
 
-# 2.0.1
-#                                                                             user     system      total        real
-# Querying & Iterating 100 Posts with 10000 Comments and 100 Users        2.290000   0.050000   2.340000 (  2.366174)
-
+# Run benchmark with bundler
+#
+#     bundle exec ruby perf/benchmark.rb
+#
+# bullet 2.3.0 with rails 3.2.2
+#                                                                              user     system      total        real
+# Querying & Iterating 1000 Posts with 10000 Comments and 100 Users       16.460000   0.190000  16.650000 ( 16.968246)
+#
+# bullet 2.3.0 with rails 3.1.4
+#                                                                              user     system      total        real
+# Querying & Iterating 1000 Posts with 10000 Comments and 100 Users       14.600000   0.130000  14.730000 ( 14.937590)
+#
+# bullet 2.3.0 with rails 3.0.12
+#                                                                              user     system      total        real
+# Querying & Iterating 1000 Posts with 10000 Comments and 100 Users       26.120000   0.430000  26.550000 ( 27.179304)
+#
+#
+# bullet 2.2.1 with rails 3.0.12
+#                                                                              user     system      total        real
+# Querying & Iterating 1000 Posts with 10000 Comments and 100 Users       29.970000   0.270000  30.240000 ( 30.452083)

data/spec/bullet/detector/association_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+module Bullet
+  module Detector
+    describe Association do
+      before :all do
+        @post1 = Post.first
+        @post2 = Post.last
+      end
+      before(:each) { Association.clear }
+
+      context ".start_request" do
+        it "should set @@checked to false" do
+          Association.start_request
+          Association.class_variable_get(:@@checked).should be_false
+        end
+      end
+
+      context ".clear" do
+        it "should clear all class variables" do
+          Association.clear
+          Association.class_variable_get(:@@object_associations).should be_nil
+          Association.class_variable_get(:@@possible_objects).should be_nil
+          Association.class_variable_get(:@@impossible_objects).should be_nil
+          Association.class_variable_get(:@@call_object_associations).should be_nil
+          Association.class_variable_get(:@@eager_loadings).should be_nil
+        end
+      end
+
+      context ".add_object_association" do
+        it "should add object, associations pair" do
+          Association.add_object_associations(@post1, :associations)
+          Association.send(:object_associations).should be_include(@post1.ar_key, :associations)
+        end
+      end
+
+      context ".add_call_object_associations" do
+        it "should add call object, associations pair" do
+          Association.add_call_object_associations(@post1, :associations)
+          Association.send(:call_object_associations).should be_include(@post1.ar_key, :associations)
+        end
+      end
+
+      context ".add_possible_objects" do
+        it "should add possible objects" do
+          Association.add_possible_objects([@post1, @post2])
+          Association.send(:possible_objects).should be_include(@post1.ar_key)
+          Association.send(:possible_objects).should be_include(@post2.ar_key)
+        end
+      end
+
+      context ".add_impossible_object" do
+        it "should add impossible object" do
+          Association.add_impossible_object(@post1)
+          Association.send(:impossible_objects).should be_include(@post1.ar_key)
+        end
+      end
+
+      context ".add_eager_loadings" do
+        it "should add objects, associations pair when eager_loadings are empty" do
+          Association.add_eager_loadings([@post1, @post2], :associations)
+          Association.send(:eager_loadings).should be_include([@post1.ar_key, @post2.ar_key], :associations)
+        end
+
+        it "should add objects, associations pair for existing eager_loadings" do
+          Association.add_eager_loadings([@post1, @post2], :association1)
+          Association.add_eager_loadings([@post1, @post2], :association2)
+          Association.send(:eager_loadings).should be_include([@post1.ar_key, @post2.ar_key], :association1)
+          Association.send(:eager_loadings).should be_include([@post1.ar_key, @post2.ar_key], :association2)
+        end
+
+        it "should merge objects, associations pair for existing eager_loadings" do
+          Association.add_eager_loadings(@post1, :association1)
+          Association.add_eager_loadings([@post1, @post2], :association2)
+          Association.send(:eager_loadings).should be_include([@post1.ar_key], :association1)
+          Association.send(:eager_loadings).should be_include([@post1.ar_key], :association2)
+          Association.send(:eager_loadings).should be_include([@post1.ar_key, @post2.ar_key], :association2)
+        end
+
+        it "should delete objects, associations pair for existing eager_loadings" do
+          Association.add_eager_loadings([@post1, @post2], :association1)
+          Association.add_eager_loadings(@post1, :association2)
+          Association.send(:eager_loadings).should be_include([@post1.ar_key], :association1)
+          Association.send(:eager_loadings).should be_include([@post1.ar_key], :association2)
+          Association.send(:eager_loadings).should be_include([@post2.ar_key], :association1)
+        end
+      end
+    end
+  end
+end

data/spec/bullet/detector/base_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+module Bullet
+  module Detector
+    describe Base do
+      context ".end_request" do
+        it "should call clear" do
+          Base.should_receive(:clear)
+          Base.end_request
+        end
+      end
+    end
+  end
+end