bullet 2.0.0.beta.2 → 2.0.1

data/Rakefile

@@ -1,34 +0,0 @@
-require 'rake'
-require 'rspec/core/rake_task'
-require 'rake/rdoctask'
-require 'jeweler'
-
-desc 'Default: run unit tests.'
-task :default => :spec
-
-desc 'Generate documentation for the sitemap plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Bullet'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-# FIXME: 'rake spec' will break the test, just run 'ruby spec/association_spec.rb'
-#desc "Run all specs in spec directory"
-#Rspec::Core::RakeTask.new(:spec) do |t|
-  #t.pattern = FileList['spec/**/*_spec.rb']
-#end
-
-Jeweler::Tasks.new do |gemspec|
-  gemspec.name = "bullet"
-  gemspec.summary = "A plugin to kill N+1 queries and unused eager loading"
-  gemspec.description = "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."
-  gemspec.email = "flyerhzm@gmail.com"
-  gemspec.homepage = "http://github.com/flyerhzm/bullet"
-  gemspec.authors = ["Richard Huang"]
-  gemspec.files.exclude '.gitignore'
-  gemspec.files.exclude 'log/*'
-end
-Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +0,0 @@
-2.0.0.beta.2

data/bullet.gemspec

@@ -1,67 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{bullet}
-  s.version = "2.0.0.beta.2"
-
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Richard Huang"]
-  s.date = %q{2010-03-07}
-  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 = [
-    "README.textile",
-     "README_for_rails2.textile"
-  ]
-  s.files = [
-    "MIT-LICENSE",
-     "README.textile",
-     "README_for_rails2.textile",
-     "Rakefile",
-     "VERSION",
-     "bullet.gemspec",
-     "lib/bullet.rb",
-     "lib/bullet/action_controller2.rb",
-     "lib/bullet/active_record2.rb",
-     "lib/bullet/active_record3.rb",
-     "lib/bullet/association.rb",
-     "lib/bullet/counter.rb",
-     "lib/bullet/logger.rb",
-     "lib/bullet/notification.rb",
-     "lib/bulletware.rb",
-     "rails/init.rb",
-     "spec/bullet/association_for_chris_spec.rb",
-     "spec/bullet/association_for_peschkaj_spec.rb",
-     "spec/bullet/association_spec.rb",
-     "spec/bullet/counter_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb",
-     "tasks/bullet_tasks.rake"
-  ]
-  s.homepage = %q{http://github.com/flyerhzm/bullet}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{A plugin to kill N+1 queries and unused eager loading}
-  s.test_files = [
-    "spec/spec_helper.rb",
-     "spec/bullet/counter_spec.rb",
-     "spec/bullet/association_spec.rb",
-     "spec/bullet/association_for_chris_spec.rb",
-     "spec/bullet/association_for_peschkaj_spec.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
-end
-

data/lib/bullet/association.rb

@@ -1,294 +0,0 @@
-module Bullet
-  class Association
-    class <<self
-      include Bullet::Notification
-
-      def start_request
-        @@checked = false
-      end
-
-      def end_request
-        clear
-      end
-      
-      def clear
-        @@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 notification?
-        check_unused_preload_associations unless @@checked
-        has_unpreload_associations? or has_unused_preload_associations?
-      end
-
-      def add_unpreload_associations(klazz, associations)
-        unpreload_associations[klazz] ||= []
-        unpreload_associations[klazz] << associations
-        unique(unpreload_associations[klazz])
-      end
-
-      def add_unused_preload_associations(klazz, associations)
-        unused_preload_associations[klazz] ||= []
-        unused_preload_associations[klazz] << associations
-        unique(unused_preload_associations[klazz])
-      end
-
-      def add_object_associations(object, associations)
-        object_associations[object] ||= []
-        object_associations[object] << associations
-        unique(object_associations[object])
-      end
-
-      def add_call_object_associations(object, associations)
-        call_object_associations[object] ||= []
-        call_object_associations[object] << associations
-        unique(call_object_associations[object])
-      end
-
-      def add_possible_objects(objects)
-        klazz = objects.is_a?(Array) ? objects.first.class : objects.class
-        possible_objects[klazz] ||= []
-        possible_objects[klazz] << objects
-        unique(possible_objects[klazz])
-      end
-
-      def add_impossible_object(object)
-        klazz = object.class
-        impossible_objects[klazz] ||= []
-        impossible_objects[klazz] << object
-        impossible_objects[klazz].uniq!
-      end
-
-      def add_eager_loadings(objects, associations)
-        objects = Array(objects)
-        eager_loadings[objects] ||= []
-        eager_loadings.each do |k, v|
-          unless (k & objects).empty?
-            if (k & objects) == k
-              eager_loadings[k] << associations
-              unique(eager_loadings[k])
-              break
-            else
-              eager_loadings.merge!({(k & objects) => (eager_loadings[k].dup << associations)})
-              unique(eager_loadings[(k & objects)])
-              eager_loadings.merge!({(k - objects) => eager_loadings[k]}) unless (k - objects).empty?
-              unique(eager_loadings[(k - objects)])
-              eager_loadings.delete(k)
-              objects = objects - k
-            end
-          end
-        end
-        unless objects.empty?
-          eager_loadings[objects] << associations
-          unique(eager_loadings[objects])
-        end
-      end
-
-      # 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)
-        add_call_object_associations(object, associations)
-        if unpreload_associations?(object, associations)
-          add_unpreload_associations(object.class, associations)
-          caller_in_project
-        end
-      end
-
-      # 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 check_unused_preload_associations
-        @@checked = true
-        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
-        # decide whether the object.associations is unpreloaded or not.
-        def unpreload_associations?(object, associations)
-          possible?(object) and !impossible?(object) and !association?(object, associations)
-        end
-
-        def possible?(object)
-          klazz = object.class
-          possible_objects[klazz] and possible_objects[klazz].include?(object)
-        end
-
-        def impossible?(object)
-          klazz = object.class
-          impossible_objects[klazz] and impossible_objects[klazz].include?(object)
-        end
-
-        # check if object => associations already exists in object_associations.
-        def association?(object, associations)
-          object_associations.each do |key, value|
-            if key == object
-              value.each do |v|
-                result = v.is_a?(Hash) ? v.has_key?(associations) : v == associations
-                return true if result
-              end
-            end
-          end
-          return false
-        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 console_title
-          title = []
-          title << unused_preload_messages.first.first unless unused_preload_messages.empty?
-          title << unpreload_messages.first.first unless unpreload_messages.empty?
-          title
-        end
-
-        def log_messages(path = nil)
-          messages = []
-          messages << unused_preload_messages(path)
-          messages << unpreload_messages(path)
-          messages << call_stack_messages
-          messages
-        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 call_stack_messages
-          callers.inject([]) do |messages, c|
-            messages << ['N+1 Query method call stack', c.collect {|line| "  #{line}"}].flatten
-          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 unique(array)
-          array.flatten!
-          array.uniq!
-        end
-
-        # unpreload_associations keep the class relationships 
-        # that the associations, belongs to the class, are used but not preloaded.
-        # e.g. { Post => [:comments] }
-        # so the unpreload_associations should be preloaded by find :include.
-        def unpreload_associations
-          @@unpreload_associations ||= {}
-        end
-        
-        # unused_preload_associations keep the class relationships 
-        # that the associations, belongs to the class, are preloaded but not used.
-        # e.g. { Post => [:comments] }
-        # so the unused_preload_associations should be removed from find :include.
-        def unused_preload_associations
-          @@unused_preload_associations ||= {}
-        end
-
-        # object_associations keep the object relationships 
-        # that the object has many associations.
-        # e.g. { <Post id:1> => [:comments] }
-        # the object_associations keep all associations that may be or may no be 
-        # unpreload associations or unused preload associations.
-        def object_associations
-          @@object_associations ||= {}
-        end
-
-        # call_object_assciations keep the object relationships
-        # that object.associations is called.
-        # e.g. { <Post id:1> => [:comments] }
-        # they are used to detect unused preload associations.
-        def call_object_associations
-          @@call_object_associations ||= {}
-        end
-
-        # possible_objects keep the class to object relationships
-        # that the objects may cause N+1 query.
-        # e.g. { Post => [<Post id:1>, <Post id:2>] }
-        def possible_objects
-          @@possible_objects ||= {}
-        end
-
-        # impossible_objects keep the class to objects relationships
-        # that the objects may not cause N+1 query.
-        # e.g. { Post => [<Post id:1>, <Post id:2>] }
-        # Notice: impossible_objects are not accurate,
-        # if find collection returns only one object, then the object is impossible object,
-        # impossible_objects are used to avoid treating 1+1 query to N+1 query.
-        def impossible_objects
-          @@impossible_objects ||= {}
-        end
-
-        # eager_loadings keep the object relationships
-        # that the associations are preloaded by find :include.
-        # e.g. { [<Post id:1>, <Post id:2>] => [:comments, :user] }
-        def eager_loadings
-          @@eager_loadings ||= {}
-        end
-
-        def caller_in_project
-          vender_root ||= File.join(Rails.root, 'vendor')
-          callers << caller.select {|c| c =~ /#{Rails.root}/}.reject {|c| c =~ /#{vender_root}/}
-          callers.uniq!
-        end
-
-        def callers
-          @@callers ||= []
-        end
-    end
-  end
-end

data/lib/bullet/counter.rb

@@ -1,101 +0,0 @@
-module Bullet
-  class Counter
-    class <<self
-      include Bullet::Notification
-
-      def start_request
-      end
-
-      def end_request
-        clear
-      end
-      
-      def clear
-        @@klazz_associations = nil
-        @@possible_objects = nil
-        @@impossible_objects = nil
-      end
-
-      def need_counter_caches?
-        !klazz_associations.empty?
-      end
-
-      def notification?
-        need_counter_caches?
-      end
-
-      def notification_response
-        response = []
-        if need_counter_caches?
-          response << counter_cache_messages.join("\n")
-        end
-        response
-      end
-
-      def console_title
-        title = ["Need Counter Cache"]
-      end
-
-      def log_messages(path = nil)
-        [counter_cache_messages(path)]
-      end
-      
-      def add_counter_cache(object, associations)
-        klazz = object.class
-        if (!possible_objects[klazz].nil? and possible_objects[klazz].include?(object)) and
-           (impossible_objects[klazz].nil? or !impossible_objects[klazz].include?(object))
-          klazz_associations[klazz] ||= []
-          klazz_associations[klazz] << associations
-          unique(klazz_associations[klazz])
-        end
-      end
-
-      def add_possible_objects(objects)
-        klazz = objects.first.class
-        possible_objects[klazz] ||= []
-        possible_objects[klazz] << objects
-        unique(possible_objects[klazz])
-      end
-
-      def add_impossible_object(object)
-        klazz = object.class
-        impossible_objects[klazz] ||= []
-        impossible_objects[klazz] << object
-        impossible_objects[klazz].uniq!
-      end
-      
-      private
-        def counter_cache_messages(path = nil)
-          messages = []
-          klazz_associations.each do |klazz, associations|
-            messages << [
-              "Need Counter Cache",
-              "  #{klazz} => [#{associations.map(&:inspect).join(', ')}]"
-            ]
-          end
-          messages
-        end
-        
-        def unique(array)
-          array.flatten!
-          array.uniq!
-        end
-
-        def call_stack_messages
-          []
-        end
-        
-        def klazz_associations
-          @@klazz_associations ||= {}
-        end
-
-        def possible_objects
-          @@possible_objects ||= {}
-        end
-
-        def impossible_objects
-          @@impossible_objects ||= {}
-        end
-    end
-  end
-end

data/lib/bullet/logger.rb

@@ -1,9 +0,0 @@
-module Bullet
-  class BulletLogger < Logger
-    LOG_FILE = File.join(Rails.root, 'log/bullet.log')
-
-    def format_message(severity, timestamp, progname, msg)
-      "#{timestamp.to_formatted_s(:db)}[#{severity}] #{msg}\n"
-    end
-  end
-end

data/lib/bulletware.rb

@@ -1,42 +0,0 @@
-class Bulletware
-  def initialize(app)
-    @app = app
-  end
-
-  def call(env)
-    return @app.call(env) unless Bullet.enable?
-
-    Bullet.start_request
-    status, headers, response = @app.call(env)
-    return [status, headers, response] if empty?(response)
-
-    if Bullet.notification?
-      if status == 200 and !response.body.frozen? and check_html?(headers, response)
-        response_body = response.body << Bullet.javascript_notification
-        headers['Content-Length'] = response_body.length.to_s
-      end
-
-      Bullet.growl_notification
-      Bullet.log_notification(env['PATH_INFO'])
-    end
-    response_body ||= response.body
-    Bullet.end_request
-    no_browser_cache(headers) if Bullet.disable_browser_cache
-    [status, headers, [response_body]]
-  end
-
-  # fix issue if response's body is a Proc
-  def empty?(response)
-    (response.is_a?(Array) && response.empty?) || !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
-  end
-
-  def no_browser_cache(headers)
-    headers["Cache-Control"] = "no-cache, no-store, max-age=0, must-revalidate"
-    headers["Pragma"] = "no-cache"
-    headers["Expires"] = "Wed, 09 Sep 2009 09:09:09 GMT"
-  end
-end

data/rails/init.rb

@@ -1 +0,0 @@
-require 'bullet'

data/spec/bullet/association_for_chris_spec.rb

@@ -1,96 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper'
-
-ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
-# This test is just used for http://github.com/flyerhzm/bullet/issues/#issue/14
-describe Bullet::Association do
-
-  describe "for chris" do
-    def setup_db
-      ActiveRecord::Schema.define(:version => 1) do
-        create_table :locations do |t|
-          t.column :name, :string
-        end
-
-        create_table :hotels do |t|
-          t.column :name, :string
-          t.column :location_id, :integer
-        end
-
-        create_table :deals do |t|
-          t.column :name, :string
-          t.column :hotel_id, :integer
-        end
-      end
-    end
-
-    def teardown_db
-      ActiveRecord::Base.connection.tables.each do |table|
-        ActiveRecord::Base.connection.drop_table(table)
-      end
-    end
-
-    class Location < ActiveRecord::Base
-      has_many :hotels
-    end
-  
-    class Hotel < ActiveRecord::Base
-      belongs_to :location
-      has_many :deals
-    end
-  
-    class Deal < ActiveRecord::Base
-      belongs_to :hotel
-      has_one :location, :through => :hotel
-    end
-
-    before(:all) do
-      setup_db
-    
-      location1 = Location.create(:name => "location1")
-      location2 = Location.create(:name => "location2")
-    
-      hotel1 = location1.hotels.create(:name => "hotel1")
-      hotel2 = location1.hotels.create(:name => "hotel2")
-      hotel3 = location2.hotels.create(:name => "hotel3")
-      hotel4 = location2.hotels.create(:name => "hotel4")
-    
-      deal1 = hotel1.deals.create(:name => "deal1")
-      deal2 = hotel2.deals.create(:name => "deal2")
-      deal3 = hotel3.deals.create(:name => "deal3")
-      deal4 = hotel4.deals.create(:name => "deal4")
-    end
-
-    after(:all) do
-      teardown_db
-    end
-
-    before(:each) do
-      Bullet::Association.start_request
-    end
-
-    after(:each) do
-      Bullet::Association.end_request
-    end
-  
-    it "should detect unpreload association from deal to hotel" do
-      Deal.all.each do |deal|
-        deal.hotel.location.name
-      end
-      Bullet::Association.should be_detecting_unpreloaded_association_for(Deal, :hotel)
-    end
-  
-    it "should detect unpreload association from hotel to location" do
-      Deal.includes(:hotel).each do |deal|
-        deal.hotel.location.name
-      end
-      Bullet::Association.should be_detecting_unpreloaded_association_for(Hotel, :location)
-    end
-  
-    it "should not detect unpreload association" do
-      Deal.includes({:hotel => :location}).each do |deal|
-        deal.hotel.location.name
-      end
-      Bullet::Association.should_not be_has_unused_preload_associations
-    end
-  end
-end