bullet 2.0.0.beta.2 → 2.1.0

data/lib/bullet/registry/base.rb

@@ -0,0 +1,37 @@
+module Bullet
+  module Registry
+    class Base
+      attr_reader :registry
+
+      def initialize
+        @registry = {}
+      end
+
+      def [](key)
+        @registry[key]
+      end
+
+      def each( &block )
+        @registry.each( &block )
+      end
+
+      def delete( base )
+        @registry.delete( base )
+      end
+
+      def select( *args, &block )
+        @registry.select( *args, &block )
+      end
+
+      def add( key, value )
+        @registry[key] ||= Set.new
+        if value.is_a? Array
+          @registry[key] += value
+        else
+          @registry[key] << value
+        end
+      end
+
+    end
+  end
+end

data/lib/bullet/registry/object.rb

@@ -0,0 +1,15 @@
+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 )
+      end
+
+      def contains?( object )
+        @registry[object.class] and @registry[object.class].include?( object )
+      end
+    end
+  end
+end

data/lib/bullet/registry.rb

@@ -0,0 +1,7 @@
+module Bullet
+  module Registry
+    autoload :Base, 'bullet/registry/base'
+    autoload :Object, 'bullet/registry/object'
+    autoload :Association, 'bullet/registry/association'
+  end
+end

data/lib/bullet/version.rb

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

data/lib/bullet.rb

@@ -1,31 +1,46 @@
-require 'bulletware'
+require 'set'
+require 'uniform_notifier'
 
 module Bullet
-  if Rails.version =~ /^3.0/
+  if Rails.version =~ /^3\.0/
     autoload :ActiveRecord, 'bullet/active_record3'
+  elsif Rails.version =~ /^3\.1/
+    autoload :ActiveRecord, 'bullet/active_record31'
   else
     autoload :ActiveRecord, 'bullet/active_record2'
     autoload :ActionController, 'bullet/action_controller2'
   end
-  autoload :Association, 'bullet/association'
-  autoload :Counter, 'bullet/counter'
+  autoload :Rack, 'bullet/rack'
   autoload :BulletLogger, 'bullet/logger'
   autoload :Notification, 'bullet/notification'
+  autoload :Detector, 'bullet/detector'
+  autoload :Registry, 'bullet/registry'
+  autoload :NotificationCollector, 'bullet/notification_collector'
+
+  if defined? Rails::Railtie
+    class BulletRailtie < Rails::Railtie
+      initializer "bullet.configure_rails_initialization" do |app|
+        app.middleware.use Bullet::Rack
+      end
+    end
+  end
 
   class <<self
-    attr_accessor :enable, :alert, :console, :growl, :growl_password, :rails_logger, :bullet_logger, :logger, :logger_file, :disable_browser_cache
+    attr_accessor :enable, :disable_browser_cache
+    attr_reader :notification_collector
+
+    delegate :alert=, :console=, :growl=, :rails_logger=, :xmpp=, :to => UniformNotifier
+
+    DETECTORS = [ Bullet::Detector::NPlusOneQuery,
+                  Bullet::Detector::UnusedEagerAssociation,
+                  Bullet::Detector::Counter ]
 
     def enable=(enable)
       @enable = enable
-      if enable? 
+      if enable?
         Bullet::ActiveRecord.enable
-        if Rails.version =~ /^3.0/
-          require 'action_controller/metal'
-          ::ActionController::Metal.middleware_stack.use Bulletware
-        elsif Rails.version =~/^2.3/
+        if Rails.version =~ /^2./
           Bullet::ActionController.enable
-          require 'action_controller/dispatcher'
-          ::ActionController::Dispatcher.middleware.use Bulletware
         end
       end
     end
@@ -34,54 +49,60 @@ module Bullet
       @enable == true
     end
 
-    def growl=(growl)
-      if growl
-        begin
-          require 'ruby-growl'
-          growl = Growl.new('localhost', 'ruby-growl', ['Bullet Notification'], nil, @growl_password)
-          growl.notify('Bullet Notification', 'Bullet Notification', 'Bullet Growl notifications have been turned on')
-        rescue MissingSourceFile
-          raise NotificationError.new('You must install the ruby-growl gem to use Growl notifications: `sudo gem install ruby-growl`')
-        end
-      end
-      @growl = growl
-    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)
+    def bullet_logger=(active)
+      if active
+        bullet_log_file = File.open( 'log/bullet.log', 'a+' )
+        bullet_log_file.sync
+        UniformNotifier.customized_logger = bullet_log_file
       end
     end
 
-    BULLETS = [Bullet::Association, Bullet::Counter]
-
     def start_request
-      BULLETS.each {|bullet| bullet.start_request}
+      notification_collector.reset
+      DETECTORS.each {|bullet| bullet.start_request}
     end
 
     def end_request
-      BULLETS.each {|bullet| bullet.end_request}
+      DETECTORS.each {|bullet| bullet.end_request}
     end
-    
+
     def clear
-      BULLETS.each {|bullet| bullet.clear}
+      DETECTORS.each {|bullet| bullet.clear}
     end
 
-    def notification?
-      BULLETS.any? {|bullet| bullet.notification?}
+    def notification_collector
+      @notification_collector ||= Bullet::NotificationCollector.new
     end
 
-    def javascript_notification
-      BULLETS.collect {|bullet| bullet.javascript_notification if bullet.notification?}.join("\n")
+    def notification?
+      Bullet::Detector::UnusedEagerAssociation.check_unused_preload_associations
+      notification_collector.notifications_present?
     end
 
-    def growl_notification
-      BULLETS.each {|bullet| bullet.growl_notification if bullet.notification?}
+    def gather_inline_notifications
+      responses = []
+      for_each_active_notifier_with_notification do |notification|
+        responses << notification.notify_inline
+      end
+      responses.join( "\n" )
     end
 
-    def log_notification(path)
-      BULLETS.each {|bullet| bullet.log_notification(path) if bullet.notification?}
+    def perform_out_of_channel_notifications(env = {})
+      for_each_active_notifier_with_notification do |notification|
+        notification.url = [env['HTTP_HOST'], env['REQUEST_URI']].compact.join
+        notification.notify_out_of_channel
+      end
     end
+
+    private
+      def for_each_active_notifier_with_notification
+        UniformNotifier.active_notifiers.each do |notifier|
+          notification_collector.collection.each do |notification|
+            notification.notifier = notifier
+            yield notification
+          end
+        end
+      end
   end
+
 end

data/perf/benchmark.rb

@@ -0,0 +1,106 @@
+$: << 'lib'
+require 'benchmark'
+require 'rails'
+require 'active_record'
+require 'activerecord-import'
+require 'bullet'
+
+begin
+  require 'perftools'
+rescue LoadError
+  puts "Could not load perftools.rb, profiling won't be possible"
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :user
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :post
+end
+
+class User < ActiveRecord::Base
+  has_many :posts
+  has_many :comments
+end
+
+# create database bullet_benchmark;
+ActiveRecord::Base.establish_connection(:adapter => 'mysql', :database => 'bullet_benchmark', :server => '/tmp/mysql.socket', :username => 'root')
+
+ActiveRecord::Base.connection.tables.each do |table|
+  ActiveRecord::Base.connection.drop_table(table)
+end
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :posts do |t|
+    t.column :title, :string
+    t.column :body, :string
+    t.column :user_id, :integer
+  end
+
+  create_table :comments do |t|
+    t.column :body, :string
+    t.column :post_id, :integer
+    t.column :user_id, :integer
+  end
+
+  create_table :users do |t|
+    t.column :name, :string
+  end
+end
+
+users_size = 100
+posts_size = 1000
+comments_size = 10000
+users = []
+users_size.times do |i|
+  users << User.new(:name => "user#{i}")
+end
+User.import users
+users = User.all
+
+posts = []
+posts_size.times do |i|
+  posts << Post.new(:title => "Title #{i}", :body => "Body #{i}", :user => users[i%100])
+end
+Post.import posts
+posts = Post.all
+
+comments = []
+comments_size.times do |i|
+  comments << Comment.new(:body => "Comment #{i}", :post => posts[i%1000], :user => users[i%100])
+end
+Comment.import comments
+
+puts "Start benchmarking..."
+
+
+Bullet.enable = true
+
+PerfTools::CpuProfiler.start(ARGV[0]|| "benchmark_profile") if defined? PerfTools
+
+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
+      end
+    end
+    Bullet.end_request
+  end
+end
+
+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)
+

data/spec/bullet/association_for_chris_spec.rb

@@ -2,7 +2,7 @@ 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 Bullet::Detector::Association do
 
   describe "for chris" do
     def setup_db
@@ -65,32 +65,32 @@ describe Bullet::Association do
     end
 
     before(:each) do
-      Bullet::Association.start_request
+      Bullet.start_request
     end
 
     after(:each) do
-      Bullet::Association.end_request
+      Bullet.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)
+      Bullet::Detector::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)
+      Bullet::Detector::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
+      Bullet::Detector::Association.should_not be_has_unused_preload_associations
     end
   end
 end

data/spec/bullet/association_for_peschkaj_spec.rb

@@ -2,7 +2,7 @@ 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/20
-describe Bullet::Association do
+describe Bullet::Detector::Association do
   
   describe "for peschkaj" do
     def setup_db
@@ -65,11 +65,11 @@ describe Bullet::Association do
     end
 
     before(:each) do
-      Bullet::Association.start_request
+      Bullet.start_request
     end
 
     after(:each) do
-      Bullet::Association.end_request
+      Bullet.end_request
     end
   
     it "should not detect unused preload associations" do
@@ -78,9 +78,9 @@ describe Bullet::Association do
         submission.name
         submission.user.name
       end
-      Bullet::Association.check_unused_preload_associations
-      Bullet::Association.should_not be_unused_preload_associations_for(Category, :submissions)
-      Bullet::Association.should_not be_unused_preload_associations_for(Submission, :user)
+      Bullet::Detector::UnusedEagerAssociation.check_unused_preload_associations
+      Bullet::Detector::Association.should_not be_unused_preload_associations_for(Category, :submissions)
+      Bullet::Detector::Association.should_not be_unused_preload_associations_for(Submission, :user)
     end
   end
 end