flyerhzm-bullet 1.4.0 → 1.4.1

data/README.textile

@@ -9,6 +9,7 @@ Best practice is to use Bullet in development mode or custom mode (staging, prof
 h2. Thanks
 
 flipsasser added Growl, console.log and Rails.log support, very awesome. And he improved README.
+rainux add group style console.log.
 
 ****************************************************************************
 
@@ -97,6 +98,22 @@ To get Growl support up-and-running for Bullet, follow the steps below:
 
 ****************************************************************************
 
+h2. Advance
+
+The bullet plugin use rack middleware for http request. If you want to bullet for without http server, such as job server. You can do like this:
+
+<pre><code>
+Bullet::Association.start_request if Bullet.enable?
+# run job
+if Bullet.enable?
+  Bullet::Association.growl_notification
+  Bullet::Association.log_notificatioin('JobServer: ')
+  Bullet::Association.end_request
+end
+</code></pre>
+
+****************************************************************************
+
 h2. Step by step example
 
 Bullet is designed to function as you browse through your application in development. It will alert you whenever it encounters N+1 queries or unused eager loading.

data/Rakefile

@@ -17,7 +17,7 @@ end
 
 desc "Run all specs in spec directory"
 Spec::Rake::SpecTask.new(:spec) do |t|
-  t.spec_files = FileList['spec/spec_helper.rb', 'spec/**/*_spec.rb']
+  t.spec_files = FileList['spec/**/*_spec.rb']
 end
 
 Jeweler::Tasks.new do |gemspec|

data/VERSION

@@ -1 +1 @@
-1.4.0
+1.4.1

data/bullet.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bullet}
-  s.version = "1.4.0"
+  s.version = "1.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
-  s.date = %q{2009-09-03}
+  s.date = %q{2009-09-09}
   s.description = %q{The Bullet plugin is designed to help you increase your application's performance by reducing the number of queries it makes. It will watch your queries while you develop your application and notify you when you should add eager loading (N+1 queries) or when you're using eager loading that isn't necessary.}
   s.email = %q{flyerhzm@gmail.com}
   s.extra_rdoc_files = [
@@ -24,10 +24,12 @@ Gem::Specification.new do |s|
      "lib/bullet.rb",
      "lib/bullet/active_record.rb",
      "lib/bullet/association.rb",
+     "lib/bullet/counter.rb",
      "lib/bullet/logger.rb",
      "lib/bulletware.rb",
      "rails/init.rb",
      "spec/bullet_association_spec.rb",
+     "spec/bullet_counter_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "tasks/bullet_tasks.rake"
@@ -39,6 +41,7 @@ Gem::Specification.new do |s|
   s.summary = %q{A plugin to kill N+1 queries and unused eager loading}
   s.test_files = [
     "spec/bullet_association_spec.rb",
+     "spec/bullet_counter_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/lib/bullet.rb

@@ -1,3 +1,5 @@
+require 'bulletware'
+
 module Bullet
   @@enable = nil
 

data/lib/bullet/active_record.rb

@@ -62,6 +62,15 @@ module Bullet
           origin_load_target
         end
       end
+      
+      ::ActiveRecord::Associations::HasManyAssociation.class_eval do
+        alias_method :origin_has_cached_counter?, :has_cached_counter?
+        def has_cached_counter?
+          result = origin_has_cached_counter?
+          Bullet::Counter.add_counter_cache(@owner, @reflection.name) unless result
+          result
+        end
+      end
     end
   end
 end

data/lib/bullet/association.rb

@@ -11,33 +11,13 @@ module Bullet
       @@growl_password = nil
       @@rails_logger = nil
 
-      def start_request
-        # puts "start request"
-      end
-
-      def end_request
-        # puts "end request"
-        @@object_associations = nil
-        @@unpreload_associations = nil
-        @@unused_preload_associations = nil
-        @@callers = nil
-        @@possible_objects = nil
-        @@impossible_objects = nil
-        @@call_object_associations = nil
-        @@eager_loadings = nil
-      end
-
+      ###################################################
+      # Configurations
+      ###################################################
       def alert=(alert)
         @@alert = alert
       end
 
-      def bullet_logger=(bullet_logger)
-        if @@bullet_logger = bullet_logger
-          @@logger_file = File.open(Bullet::BulletLogger::LOG_FILE, 'a+')
-          @@logger = Bullet::BulletLogger.new(@@logger_file)
-        end
-      end
-
       def console=(console)
         @@console = console
       end
@@ -59,32 +39,44 @@ module Bullet
         @@growl_password = growl_password
       end
 
+      def bullet_logger=(bullet_logger)
+        if @@bullet_logger = bullet_logger
+          @@logger_file = File.open(Bullet::BulletLogger::LOG_FILE, 'a+')
+          @@logger = Bullet::BulletLogger.new(@@logger_file)
+        end
+      end
+
       def rails_logger=(rails_logger)
         @@rails_logger = rails_logger
       end
 
-      def check_unused_preload_associations
-        object_associations.each do |object, association|
-          related_objects = eager_loadings.select {|key, value| key.include?(object) and value == association}.collect(&:first).flatten
-          call_object_association = related_objects.collect { |related_object| call_object_associations[related_object] }.compact.flatten.uniq
-          diff_object_association = (association - call_object_association).reject {|a| a.is_a? Hash}
-          add_unused_preload_associations(object.class, diff_object_association) unless diff_object_association.empty?
-        end
+      #####################################################
+      # login control interface
+      #####################################################
+      def start_request
+        # puts "start request"
       end
-      
+
+      def end_request
+        # puts "end request"
+        @@object_associations = nil
+        @@unpreload_associations = nil
+        @@unused_preload_associations = nil
+        @@callers = nil
+        @@possible_objects = nil
+        @@impossible_objects = nil
+        @@call_object_associations = nil
+        @@eager_loadings = nil
+      end
+
       def has_bad_assocations?
         check_unused_preload_associations
         has_unpreload_associations? or has_unused_preload_associations?
       end
 
-      def has_unused_preload_associations?
-        !unused_preload_associations.empty?
-      end
-      
-      def has_unpreload_associations?
-        !unpreload_associations.empty?
-      end
-
+      ######################################################
+      # Notifications
+      ######################################################
       def javascript_notification
         str = ''
         if @@alert || @@console
@@ -94,11 +86,30 @@ module Bullet
           str << wrap_js_association("alert(#{response.join("\n").inspect});")
         end
         if @@console
-          str << wrap_js_association("if (typeof(console) != 'undefined' && console.log) console.log(#{response.join("\n").inspect});")
+          title = []
+          title << unused_preload_messages.first.first unless unused_preload_messages.empty?
+          title << unpreload_messages.first.first unless unpreload_messages.empty?
+          code = <<-CODE
+            if (typeof(console) !== 'undefined') {
+
+              if (console.groupCollapsed && console.groupEnd && console.log) {
+
+                console.groupCollapsed(#{title.join(', ').inspect});
+                console.log(#{response.join("\n").inspect});
+                console.log(#{call_stack_messages.join("\n").inspect});
+                console.groupEnd();
+
+              } else if (console.log) {
+
+                console.log(#{response.join("\n").inspect});
+              }
+            }
+          CODE
+          str << wrap_js_association(code)
         end
         str
       end
-      
+
       def growl_notification
         if @@growl
           response = notification_response
@@ -113,77 +124,21 @@ module Bullet
       def log_notificatioin(path)
         if (@@bullet_logger || @@rails_logger) && (!unpreload_associations.empty? || !unused_preload_associations.empty?)
           Rails.logger.warn '' if @@rails_logger
-          unused_preload_associations.each do |klazz, associations|
-            log = ["Unused eager loadings: #{path}", klazz_associations_str(klazz, associations), "  Remove from your finder: #{associations_str(associations)}"].join("\n")
-            @@logger.info(log) if @@bullet_logger
-            Rails.logger.warn(log) if @@rails_logger
+          unused_preload_messages(path).each do |message|
+            @@logger.info(message.join("\n")) if @@bullet_logger
+            Rails.logger.warn(message.join("\n")) if @@rails_logger
+          end
+          unpreload_messages(path).each do |message|
+            @@logger.info(message.join("\n")) if @@bullet_logger
+            Rails.logger.warn(message.join("\n")) if @@rails_logger
           end
-          unpreload_associations.each do |klazz, associations|
-            log = ["N+1 Query in #{path}", klazz_associations_str(klazz, associations), "  Add to your finder: #{associations_str(associations)}"].join("\n")
-            @@logger.info(log) if @@bullet_logger
-            Rails.logger.warn(log) if @@rails_logger
-          end  
-          callers.each do |c|
-            log = ["N+1 Query method call stack", c.map{|line| "  #{line}"}].flatten.join("\n")
-            @@logger.info(log) if @@bullet_logger
-            Rails.logger.warn(log) if @@rails_logger
+          call_stack_messages.each do |message|
+            @@logger.info(message.join("\n")) if @@bullet_logger
+            Rails.logger.warn(message.join("\n")) if @@rails_logger
           end
           @@logger_file.flush if @@bullet_logger
         end
       end
-      
-      def klazz_associations_str(klazz, associations)
-        "  #{klazz} => [#{associations.map(&:inspect).join(', ')}]"
-      end
-      
-      def associations_str(associations)
-        ":include => #{associations.map{|a| a.to_sym unless a.is_a? Hash}.inspect}"
-      end
-
-      def notification_response
-        response = []
-        if has_unused_preload_associations?
-          response.push("Unused eager loadings detected:\n")
-          response.push(*@@unused_preload_associations.to_a.collect{|klazz, associations| klazz_associations_str(klazz, associations)}.join("\n"))
-        end
-        if has_unpreload_associations?
-          response.push("#{"\n" unless response.empty?}N+1 queries detected:\n")
-          response.push(*@@unpreload_associations.to_a.collect{|klazz, associations| "  #{klazz} => [#{associations.map(&:inspect).join(', ')}]"}.join("\n"))
-        end
-        response
-      end
-
-      def wrap_js_association(message)
-        str = ''
-        str << "<script type=\"text/javascript\">/*<![CDATA[*/"
-        str << message
-        str << "/*]]>*/</script>\n"
-      end
-
-      def has_klazz_association(klazz)
-        !klazz_associations[klazz].nil? and klazz_associations.keys.include?(klazz)
-      end
-      
-      def define_association(klazz, associations)
-        # puts "define association, #{klazz} => #{associations.inspect}"
-        add_klazz_associations(klazz, associations)
-      end
-
-      def call_association(object, associations)
-        # puts "call association, #{object} => #{associations.inspect}"
-        add_call_object_associations(object, associations)
-        if unpreload_associations?(object, associations)
-          add_unpreload_associations(object.class, associations)
-          caller_in_project
-        end
-      end
-      
-      def unpreload_associations?(object, associations)
-        klazz = object.class
-        (!possible_objects[klazz].nil? and possible_objects[klazz].include?(object)) and 
-        (impossible_objects[klazz].nil? or !impossible_objects[klazz].include?(object)) and 
-        (object_associations[object].nil? or !object_associations[object].include?(associations))
-      end
 
       def add_unpreload_associations(klazz, associations)
         # puts "add unpreload associations, #{klazz} => #{associations.inspect}"
@@ -191,7 +146,7 @@ module Bullet
         unpreload_associations[klazz] << associations
         unique(unpreload_associations[klazz])
       end
-      
+
       def add_unused_preload_associations(klazz, associations)
         # puts "add unused preload associations, #{klazz} => #{associations.inspect}"
         unused_preload_associations[klazz] ||= []
@@ -206,6 +161,9 @@ module Bullet
         unique(object_associations[object])
       end
 
+      ###################################################
+      # interface for active record
+      ###################################################
       def add_call_object_associations(object, associations)
         # puts "add call object associations, #{object} => #{associations.inspect}"
         call_object_associations[object] ||= []
@@ -228,7 +186,7 @@ module Bullet
         impossible_objects[klazz] << object
         impossible_objects[klazz].uniq!
       end
-      
+
       def add_klazz_associations(klazz, associations)
         # puts "define associations, #{klazz} => #{associations.inspect}"
         klazz_associations[klazz] ||= []
@@ -243,28 +201,127 @@ module Bullet
         eager_loadings[objects] << associations
         unique(eager_loadings[objects])
       end
+
+      def define_association(klazz, associations)
+        # puts "define association, #{klazz} => #{associations.inspect}"
+        add_klazz_associations(klazz, associations)
+      end
+
+      def call_association(object, associations)
+        # puts "call association, #{object} => #{associations.inspect}"
+        add_call_object_associations(object, associations)
+        if unpreload_associations?(object, associations)
+          add_unpreload_associations(object.class, associations)
+          caller_in_project
+        end
+      end
+
+      ############################################
+      # for rspec
+      ############################################
+      def check_unused_preload_associations
+        object_associations.each do |object, association|
+          related_objects = eager_loadings.select {|key, value| key.include?(object) and value == association}.collect(&:first).flatten
+          call_object_association = related_objects.collect { |related_object| call_object_associations[related_object] }.compact.flatten.uniq
+          diff_object_association = (association - call_object_association).reject {|a| a.is_a? Hash}
+          add_unused_preload_associations(object.class, diff_object_association) unless diff_object_association.empty?
+        end
+      end
+
+      def has_unused_preload_associations?
+        !unused_preload_associations.empty?
+      end
+
+      def has_unpreload_associations?
+        !unpreload_associations.empty?
+      end
+
+
+      private
+      def unpreload_associations?(object, associations)
+        klazz = object.class
+        (!possible_objects[klazz].nil? and possible_objects[klazz].include?(object)) and
+        (impossible_objects[klazz].nil? or !impossible_objects[klazz].include?(object)) and
+        (object_associations[object].nil? or !object_associations[object].include?(associations))
+      end
+
+      def notification_response
+        response = []
+        if has_unused_preload_associations?
+          response << unused_preload_messages.join("\n")
+        end
+        if has_unpreload_associations?
+          response << unpreload_messages.join("\n")
+        end
+        response
+      end
+
+      def unused_preload_messages(path = nil)
+        messages = []
+        unused_preload_associations.each do |klazz, associations|
+          messages << [
+            "Unused Eager Loading #{path ? "in #{path}" : 'detected'}",
+            klazz_associations_str(klazz, associations),
+            "  Remove from your finder: #{associations_str(associations)}"
+          ]
+        end
+        messages
+      end
+
+      def unpreload_messages(path = nil)
+        messages = []
+        unpreload_associations.each do |klazz, associations|
+          messages << [
+            "N+1 Query #{path ? "in #{path}" : 'detected'}",
+            klazz_associations_str(klazz, associations),
+            "  Add to your finder: #{associations_str(associations)}"
+          ]
+        end
+        messages
+      end
+
+      def klazz_associations_str(klazz, associations)
+        "  #{klazz} => [#{associations.map(&:inspect).join(', ')}]"
+      end
+
+      def associations_str(associations)
+        ":include => #{associations.map{|a| a.to_sym unless a.is_a? Hash}.inspect}"
+      end
+
+      def wrap_js_association(message)
+        str = ''
+        str << "<script type=\"text/javascript\">/*<![CDATA[*/"
+        str << message
+        str << "/*]]>*/</script>\n"
+      end
+
+      def call_stack_messages
+        callers.inject([]) do |messages, c|
+          messages << ['N+1 Query method call stack', c.collect {|line| "  #{line}"}].flatten
+        end
+      end
       
       def unique(array)
         array.flatten!
         array.uniq!
       end
-      
+
       def unpreload_associations
         @@unpreload_associations ||= {}
       end
-      
+
       def unused_preload_associations
         @@unused_preload_associations ||= {}
       end
-      
+
       def object_associations
         @@object_associations ||= {}
       end
-      
+
       def call_object_associations
         @@call_object_associations ||= {}
       end
-      
+
       def possible_objects
         @@possible_objects ||= {}
       end
@@ -272,7 +329,7 @@ module Bullet
       def impossible_objects
         @@impossible_objects ||= {}
       end
-      
+
       def klazz_associations
         @@klazz_associations ||= {}
       end
@@ -280,13 +337,13 @@ module Bullet
       def eager_loadings
         @@eager_loadings ||= {}
       end
-      
+
       VENDOR_ROOT = File.join(RAILS_ROOT, 'vendor')
       def caller_in_project
         callers << caller.select {|c| c =~ /#{RAILS_ROOT}/}.reject {|c| c =~ /#{VENDOR_ROOT}/}
         callers.uniq!
       end
-      
+
       def callers
         @@callers ||= []
       end

data/lib/bullet/counter.rb

@@ -0,0 +1,29 @@
+module Bullet
+  class Counter
+    class <<self
+      def start_request
+
+      end
+
+      def end_request
+        @@klazz_associations = nil
+      end
+
+      def need_counter_caches?
+        !klazz_associations.empty?
+      end
+      
+      def add_counter_cache(object, associations)
+        klazz = object.class
+        klazz_associations[klazz] ||= []
+        klazz_associations[klazz] << associations
+        klazz_associations[klazz].flatten!
+        klazz_associations[klazz].uniq!
+      end
+      
+      def klazz_associations
+        @@klazz_associations ||= {}
+      end
+    end
+  end
+end

data/spec/bullet_association_spec.rb

@@ -1,3 +1,5 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
 ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :dbfile => ':memory:')
 
 describe Bullet::Association, 'has_many' do

data/spec/bullet_counter_spec.rb

@@ -0,0 +1,124 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :dbfile => ':memory:')
+
+describe Bullet::Counter do
+  def setup_db
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :countries do |t|
+        t.string :name
+      end
+
+      create_table :cities do |t|
+        t.string :name
+        t.integer :country_id
+      end
+    end
+  end
+
+  def teardown_db
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+
+  class Country < ActiveRecord::Base
+    has_many :cities
+  end
+
+  class City < ActiveRecord::Base
+    belongs_to :country
+  end
+
+  before(:all) do
+    setup_db
+
+    country1 = Country.create(:name => 'first')
+    country2 = Country.create(:name => 'second')
+    
+    country1.cities.create(:name => 'first')
+    country1.cities.create(:name => 'second')
+    country2.cities.create(:name => 'third')
+    country2.cities.create(:name => 'fourth')
+  end
+
+  after(:all) do
+    teardown_db
+  end
+
+  before(:each) do
+    Bullet::Counter.start_request
+  end
+  
+  after(:each) do
+    Bullet::Counter.end_request
+  end
+
+  it "should need counter cache with count" do
+    Country.all.each do |country|
+      country.cities.size
+    end
+    Bullet::Counter.should be_need_counter_caches
+  end
+end
+
+describe Bullet::Counter do
+  def setup_db
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :people do |t|
+        t.string :name
+        t.integer :pets_count
+      end
+
+      create_table :pets do |t|
+        t.string :name
+        t.integer :person_id
+      end
+    end
+  end
+
+  def teardown_db
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+
+  class Person < ActiveRecord::Base
+    has_many :pets
+  end
+
+  class Pet < ActiveRecord::Base
+    belongs_to :person, :counter_cache => true
+  end
+
+  before(:all) do
+    setup_db
+
+    person1 = Person.create(:name => 'first')
+    person2 = Person.create(:name => 'second')
+    
+    person1.pets.create(:name => 'first')
+    person1.pets.create(:name => 'second')
+    person2.pets.create(:name => 'third')
+    person2.pets.create(:name => 'fourth')
+  end
+
+  after(:all) do
+    teardown_db
+  end
+
+  before(:each) do
+    Bullet::Counter.start_request
+  end
+  
+  after(:each) do
+    Bullet::Counter.end_request
+  end
+
+  it "should need counter cache with count" do
+    Person.all.each do |person|
+      person.pets.size
+    end
+    Bullet::Counter.should_not be_need_counter_caches
+  end
+end

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ RAILS_ROOT = File.expand_path(__FILE__).split('/')[0..-3].join('/') unless defin
 require File.expand_path(File.join(File.dirname(__FILE__), '../lib/bullet/logger'))
 require File.expand_path(File.join(File.dirname(__FILE__), '../lib/bullet/active_record'))
 require File.expand_path(File.join(File.dirname(__FILE__), '../lib/bullet/association'))
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/bullet/counter'))
 require File.expand_path(File.join(File.dirname(__FILE__), '../lib/bullet'))
 require File.expand_path(File.join(File.dirname(__FILE__), '../lib/bulletware'))
 Bullet.enable = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: flyerhzm-bullet
 version: !ruby/object:Gem::Version 
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors: 
 - Richard Huang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-03 00:00:00 -07:00
+date: 2009-09-09 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -30,10 +30,12 @@ files:
 - lib/bullet.rb
 - lib/bullet/active_record.rb
 - lib/bullet/association.rb
+- lib/bullet/counter.rb
 - lib/bullet/logger.rb
 - lib/bulletware.rb
 - rails/init.rb
 - spec/bullet_association_spec.rb
+- spec/bullet_counter_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - tasks/bullet_tasks.rake
@@ -65,4 +67,5 @@ specification_version: 3
 summary: A plugin to kill N+1 queries and unused eager loading
 test_files: 
 - spec/bullet_association_spec.rb
+- spec/bullet_counter_spec.rb
 - spec/spec_helper.rb