bullet 2.0.0.beta.3 → 2.0.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Richard Huang (flyerhzm@gmail.com)
+Copyright (c) 2009 - 2010 Richard Huang (flyerhzm@gmail.com)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.textile

@@ -164,8 +164,7 @@ end
 
 after(:each)
   if Bullet.enable?
-    Bullet.growl_notification
-    Bullet.log_notification('Test: ')
+    Bullet.perform_out_of_channel_notifications
     Bullet.end_request
   end
 end
@@ -412,4 +411,4 @@ In the meanwhile, there's a log appended into <code>log/bullet.log</code> file.
 ****************************************************************************
 
 
-Copyright (c) 2009 Richard Huang (flyerhzm@gmail.com), released under the MIT license
+Copyright (c) 2009 - 2010 Richard Huang (flyerhzm@gmail.com), released under the MIT license

data/README_for_rails2.textile

@@ -184,8 +184,7 @@ end
 
 after(:each)
   if Bullet.enable?
-    Bullet.growl_notification
-    Bullet.log_notification('Test: ')
+    Bullet.perform_out_of_channel_notifications
     Bullet.end_request
   end
 end
@@ -418,4 +417,4 @@ In the meanwhile, there's a log appended into <code>log/bullet.log</code> file.
 ****************************************************************************
 
 
-Copyright (c) 2009 Richard Huang (flyerhzm@gmail.com), released under the MIT license
+Copyright (c) 2009 - 2010 Richard Huang (flyerhzm@gmail.com), released under the MIT license

data/lib/bullet/notification/base.rb

@@ -1,7 +1,7 @@
 module Bullet
   module Notification
     class Base
-      attr_accessor :presenter
+      attr_accessor :notifier
       attr_reader :base_class, :associations, :path
 
       def initialize( base_class, associations, path = nil )
@@ -15,11 +15,11 @@ module Bullet
 
       def body
       end
-      
+
       def body_with_caller
         body
       end
-      
+
       def standard_notice
         @standard_notifice ||= title + "\n" + body
       end
@@ -28,14 +28,12 @@ module Bullet
         @full_notice ||= title + "\n" + body_with_caller
       end
 
-      def present_inline
-        return unless self.presenter.respond_to? :inline
-        self.presenter.send( :inline, self ) 
+      def notify_inline
+        self.notifier.inline_notify( self.full_notice )
       end
 
-      def present_out_of_channel
-        return unless self.presenter.respond_to? :out_of_channel
-        self.presenter.send( :out_of_channel, self )
+      def notify_out_of_channel
+        self.notifier.out_of_channel_notify( self.full_notice )
       end
 
       def eql?( other )

data/lib/bullet/rack.rb

@@ -26,9 +26,11 @@ module Bullet
 
     # 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?
+      # response may be ["Not Found"], ["Move Permanently"], etc.
+      (response.is_a?(Array) && response.size <= 1) ||
+      !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
@@ -39,4 +41,4 @@ module Bullet
       headers["Expires"] = "Wed, 09 Sep 2009 09:09:09 GMT"
     end
   end
-end
+end

data/lib/bullet/version.rb

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

data/lib/bullet.rb

@@ -12,11 +12,10 @@ module Bullet
   autoload :Rack, 'bullet/rack'
   autoload :BulletLogger, 'bullet/logger'
   autoload :Notification, 'bullet/notification'
-  autoload :Presenter, 'bullet/presenter'
   autoload :Detector, 'bullet/detector'
   autoload :Registry, 'bullet/registry'
   autoload :NotificationCollector, 'bullet/notification_collector'
-  
+
   if defined? Rails::Railtie
     # compatible with rails 3.0.0.beta4
     class BulletRailtie < Rails::Railtie
@@ -27,23 +26,18 @@ module Bullet
   end
 
   class <<self
-    attr_accessor :enable, :alert, :console, :growl, :growl_password, :rails_logger, :bullet_logger, :disable_browser_cache, :xmpp
+    attr_accessor :enable, :disable_browser_cache
     attr_reader :notification_collector
-    
-    DETECTORS = [ Bullet::Detector::NPlusOneQuery, 
+
+    delegate :alert=, :console=, :growl=, :rails_logger=, :xmpp=, :to => UniformNotifier
+
+    DETECTORS = [ Bullet::Detector::NPlusOneQuery,
                   Bullet::Detector::UnusedEagerAssociation,
                   Bullet::Detector::Counter ]
 
-    PRESENTERS = [ Bullet::Presenter::JavascriptAlert,
-                   Bullet::Presenter::JavascriptConsole,
-                   Bullet::Presenter::Growl,
-                   Bullet::Presenter::Xmpp,
-                   Bullet::Presenter::RailsLogger,
-                   Bullet::Presenter::BulletLogger ]
-                   
     def enable=(enable)
       @enable = enable
-      if enable? 
+      if enable?
         Bullet::ActiveRecord.enable
         if Rails.version =~ /^2./
           Bullet::ActionController.enable
@@ -55,64 +49,59 @@ module Bullet
       @enable == true
     end
 
-    def growl=(growl)
-      Bullet::Presenter::Growl.setup_connection( self.growl_password ) if growl
-    end
-
-    def xmpp=(xmpp)
-      Bullet::Presenter::Xmpp.setup_connection( xmpp ) if xmpp
-    end
-
-    def bullet_logger=(bullet_logger)
-      Bullet::Presenter::BulletLogger.setup if bullet_logger
+    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
 
     def start_request
-      @notification_collector ||= Bullet::NotificationCollector.new
-      @notification_collector.reset
+      notification_collector.reset
       DETECTORS.each {|bullet| bullet.start_request}
     end
 
     def end_request
       DETECTORS.each {|bullet| bullet.end_request}
     end
-    
+
     def clear
       DETECTORS.each {|bullet| bullet.clear}
     end
 
-    def active_presenters
-      PRESENTERS.select { |presenter| presenter.send :active? }
+    def notification_collector
+      @notification_collector ||= Bullet::NotificationCollector.new
     end
 
     def notification?
       Bullet::Detector::UnusedEagerAssociation.check_unused_preload_associations
-      @notification_collector.notifications_present?
+      notification_collector.notifications_present?
     end
 
     def gather_inline_notifications
       responses = []
-      for_each_active_presenter_with_notification do |notification|
-        responses << notification.present_inline
+      for_each_active_notifier_with_notification do |notification|
+        responses << notification.notify_inline
       end
       responses.join( "\n" )
     end
 
     def perform_out_of_channel_notifications
-      for_each_active_presenter_with_notification do |notification|
-        notification.present_out_of_channel
+      for_each_active_notifier_with_notification do |notification|
+        notification.notify_out_of_channel
       end
     end
 
     private
-      def for_each_active_presenter_with_notification
-        active_presenters.each do |presenter|
-          @notification_collector.collection.each do |notification|
-            notification.presenter = presenter
+      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
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bullet
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  hash: 15
+  prerelease: false
   segments: 
   - 2
   - 0
   - 0
-  - beta
-  - 3
-  version: 2.0.0.beta.3
+  version: 2.0.0
 platform: ruby
 authors: 
 - Richard Huang
@@ -16,101 +15,97 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-14 00:00:00 +08:00
+date: 2010-11-19 00:00:00 +08:00
 default_executable: 
-dependencies: []
-
-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.
-email: flyerhzm@gmail.com
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id001
+  name: uniform_notifier
+  prerelease: false
+  type: :runtime
+description: A rails plugin to kill N+1 queries and unused eager loading.
+email: 
+- flyerhzm@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README.textile
-- README_for_rails2.textile
-files: 
-- .rspec
-- Hacking.textile
 - MIT-LICENSE
 - README.textile
 - README_for_rails2.textile
-- Rakefile
-- VERSION
-- autotest/discover.rb
-- bullet.gemspec
-- lib/bullet.rb
+files: 
 - lib/bullet/action_controller2.rb
 - lib/bullet/active_record2.rb
 - lib/bullet/active_record3.rb
-- lib/bullet/detector.rb
 - lib/bullet/detector/association.rb
 - lib/bullet/detector/base.rb
 - lib/bullet/detector/counter.rb
 - lib/bullet/detector/n_plus_one_query.rb
 - lib/bullet/detector/unused_eager_association.rb
-- lib/bullet/notification.rb
+- lib/bullet/detector.rb
 - lib/bullet/notification/base.rb
 - lib/bullet/notification/counter_cache.rb
 - lib/bullet/notification/n_plus_one_query.rb
 - lib/bullet/notification/unused_eager_loading.rb
+- lib/bullet/notification.rb
 - lib/bullet/notification_collector.rb
-- lib/bullet/presenter.rb
-- lib/bullet/presenter/base.rb
-- lib/bullet/presenter/bullet_logger.rb
-- lib/bullet/presenter/growl.rb
-- lib/bullet/presenter/javascript_alert.rb
-- lib/bullet/presenter/javascript_console.rb
-- lib/bullet/presenter/javascript_helpers.rb
-- lib/bullet/presenter/rails_logger.rb
-- lib/bullet/presenter/xmpp.rb
 - lib/bullet/rack.rb
-- lib/bullet/registry.rb
 - lib/bullet/registry/association.rb
 - lib/bullet/registry/base.rb
 - lib/bullet/registry/object.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_helper.rb
-- tasks/bullet_tasks.rake
+- lib/bullet/registry.rb
+- lib/bullet/version.rb
+- lib/bullet.rb
+- MIT-LICENSE
+- README.textile
+- README_for_rails2.textile
 has_rdoc: true
 homepage: http://github.com/flyerhzm/bullet
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
+      hash: 23
       segments: 
       - 1
       - 3
-      - 1
-      version: 1.3.1
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A rails plugin to kill N+1 queries and unused eager loading
-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
+summary: A rails plugin to kill N+1 queries and unused eager loading.
+test_files: []
+

data/.rspec

@@ -1 +0,0 @@
---colour --format d

data/Hacking.textile

@@ -1,100 +0,0 @@
-h1. Bullet Overview for Developers
-This file aims to give developers a quick tour of the bullet internals, making
-it (hopefully) easier to extend or enhance the Bullet gem.
-
-h2. General Control Flow aka. 10000 Meter View
-When Rails is initialized, Bullet will extend ActiveRecord (and if you're using
-Rails 2.x ActiveController too) with the relevant modules and methods found
-in lib/bullet/active_recordX.rb and lib/bullet/action_controller2.rb. If you're 
-running Rails 3, Bullet will integrate itself as a middleware into the Rack
-stack, so ActionController does not need to be extended.
-
-The ActiveRecord extensions will call methods in a given detector class, when 
-certain methods are called. 
-
-Detector classes contain all the logic to recognize 
-a noteworthy event. If such an event is detected, an instance of the
-corresponding Notification class is created and stored in a Set instance in the
-main Bullet module (the 'notification collector'). 
-
-Notification instances contain the message that will be displayed, and will
-use a Presenter class to display their message to the user.
-
-Each Presenter knows how to present the message either "inline" (as in: the
-message text will be inlined into the request response, such as javascript
-alerts) or "out-of-channel" (completely independent of the request response,
-such as growl or xmpp).
-
-So the flow of a request goes like this:
-1. Bullet.start_request is called, which resets all the detectors and empties
-   the notification collector
-2. The request is handled by Rails, and the installed ActiveRecord extensions
-   trigger Detector callbacks
-3. Detectors once called, will determine whether something noteworthy happend. 
-   If yes, then a Notification is created and stored in the notification collector.
-4. Rails finishes handling the request
-5. For each notification in the collector, Bullet will iterate over each
-   Presenter and will try to generate an inline message that will be appended to
-   the generated reponse body.
-6. The response is returned to the client.
-7. Bullet will try to generate an out-of-channel message for each notification.
-8. Bullet calls end_request for each detector.
-9. Goto 1.
-
-h2. Adding Presenters
-To add a presenter, you will need to:
-* Add the class to the PRESENTERS constant in the main Bullet module
-* Add an autoload directive to lib/bullet/presenter.rb
-* Create your presenter class in the Bullet::Presenter namespace
-
-Presenter classes will need the following class methods:
-* .active? which returns a boolean to indicate if the presenter is active (so
-* that presenters the user doesn't want can be skipped).
-
-and at least one of:
-* .out_of_channel( notification ) which will display the notification to the
-  user outside of the request response
-or
-* .inline( notification ) which will generate the notification presentation fit
-  to be appended to the generated HTML request response (if you want to inject
-  content on the result page, such as a javascript alert).
-
-Have a look at lib/bullet/javascript_alert.rb as a trivial example for an
-inline presenter and lib/bullet/rails_logger.rb to see how a minimal
-out-of-channel presenter looks like.
-
-h2. Adding Notification Types
-If you want to add more kinds of things that Bullet can detect, a little more
-work is needed than if you were just adding a Presenter, but the concepts are
-similar.
-
-* Add the class to the DETECTORS constant in the main Bullet module
-* Add (if needed) Rails monkey patches to Bullet.enable
-* Create your presenter class in the Bullet::Detector namespace
-* Add an autoload directive to lib/bullet/detector.rb
-* Create a corresponding notification class in the Bullet::Notification namespace
-* Add an autoload directive to lib/bullet/notification.rb
-
-As a rule of thumb, you can assume that each Detector will have its own
-Notification class. If you follow the principle of Separation of Concerns I
-can't really think of an example where one would deviate from this rule.
-
-Since the detection of pathological associations is a bit hairy, I'd recommend
-having a look at the counter cache detector and associated notification to get
-a feel for what is needed to get off the ground.
-
-h3. Detectors
-The only things you'll need to consider when building your Detector class is
-that it will need to supply the .start_request, .end_request and .clear class
-methods. 
-
-Simple implementations are provided by Bullet::Detector::Base for start_request
-and end_request, you will have to supply your own clear method.
-
-h3. Notifications
-For notifications you will want to supply a #title and #body instance method,
-and check to see if the #initialize and #full_notice methods in the
-Bullet::Notification::Base class fit your needs. 
-
-The interaction with the presenters encapsulated in the Base class, so you
-won't have to worry about that.

data/Rakefile

@@ -1,51 +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 bullet 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
-
-RSpec::Core::RakeTask.new(:spec)
-
-desc "Run all examples using rcov"
-RSpec::Core::RakeTask.new :rcov => :cleanup_rcov_files do |t|
-  t.rcov = true
-  t.rcov_opts =  %[-Ilib -Ispec --exclude "gems/*,spec/spec_helper.rb"]
-  t.rcov_opts << %[--no-html --aggregate coverage.data]
-end
-
-task :cleanup_rcov_files do
-  rm_rf 'coverage.data'
-end
-
-task :clobber do
-  rm_rf 'pkg'
-  rm_rf 'tmp'
-  rm_rf 'coverage'
-end
-
-begin
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "bullet"
-    gemspec.summary = "A rails 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
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end

data/VERSION

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

data/autotest/discover.rb

@@ -1 +0,0 @@
-Autotest.add_discovery { "rspec2" }

data/bullet.gemspec

@@ -1,90 +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.3"
-
-  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-07-14}
-  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 = [
-    ".rspec",
-     "Hacking.textile",
-     "MIT-LICENSE",
-     "README.textile",
-     "README_for_rails2.textile",
-     "Rakefile",
-     "VERSION",
-     "autotest/discover.rb",
-     "bullet.gemspec",
-     "lib/bullet.rb",
-     "lib/bullet/action_controller2.rb",
-     "lib/bullet/active_record2.rb",
-     "lib/bullet/active_record3.rb",
-     "lib/bullet/detector.rb",
-     "lib/bullet/detector/association.rb",
-     "lib/bullet/detector/base.rb",
-     "lib/bullet/detector/counter.rb",
-     "lib/bullet/detector/n_plus_one_query.rb",
-     "lib/bullet/detector/unused_eager_association.rb",
-     "lib/bullet/notification.rb",
-     "lib/bullet/notification/base.rb",
-     "lib/bullet/notification/counter_cache.rb",
-     "lib/bullet/notification/n_plus_one_query.rb",
-     "lib/bullet/notification/unused_eager_loading.rb",
-     "lib/bullet/notification_collector.rb",
-     "lib/bullet/presenter.rb",
-     "lib/bullet/presenter/base.rb",
-     "lib/bullet/presenter/bullet_logger.rb",
-     "lib/bullet/presenter/growl.rb",
-     "lib/bullet/presenter/javascript_alert.rb",
-     "lib/bullet/presenter/javascript_console.rb",
-     "lib/bullet/presenter/javascript_helpers.rb",
-     "lib/bullet/presenter/rails_logger.rb",
-     "lib/bullet/presenter/xmpp.rb",
-     "lib/bullet/rack.rb",
-     "lib/bullet/registry.rb",
-     "lib/bullet/registry/association.rb",
-     "lib/bullet/registry/base.rb",
-     "lib/bullet/registry/object.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_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 rails 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/presenter/base.rb

@@ -1,9 +0,0 @@
-module Bullet
-  module Presenter
-    class Base
-      def self.active?
-        false
-      end
-    end
-  end
-end