bullet 2.0.0.rc3 → 2.0.0

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,16 +49,12 @@ 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
@@ -75,15 +65,11 @@ module Bullet
     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? }
-    end
-
     def notification_collector
       @notification_collector ||= Bullet::NotificationCollector.new
     end
@@ -95,23 +81,23 @@ module Bullet
 
     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|
+      def for_each_active_notifier_with_notification
+        UniformNotifier.active_notifiers.each do |notifier|
           notification_collector.collection.each do |notification|
-            notification.presenter = presenter
+            notification.notifier = notifier
             yield notification
           end
         end

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_notify
-        self.presenter.send( :inline_notify, 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_notify
-        self.presenter.send( :out_of_channel_notify, self )
+      def notify_out_of_channel
+        self.notifier.out_of_channel_notify( self.full_notice )
       end
 
       def eql?( other )

data/lib/bullet/rack.rb

@@ -30,7 +30,7 @@ module Bullet
       (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

data/lib/bullet/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bullet
 version: !ruby/object:Gem::Version 
-  hash: 977940588
-  prerelease: true
+  hash: 15
+  prerelease: false
   segments: 
   - 2
   - 0
   - 0
-  - rc3
-  version: 2.0.0.rc3
+  version: 2.0.0
 platform: ruby
 authors: 
 - Richard Huang
@@ -16,10 +15,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-02 00:00:00 +08:00
+date: 2010-11-19 00:00:00 +08:00
 default_executable: 
-dependencies: []
-
+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
@@ -47,15 +61,6 @@ files:
 - lib/bullet/notification/unused_eager_loading.rb
 - lib/bullet/notification.rb
 - lib/bullet/notification_collector.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/presenter.rb
 - lib/bullet/rack.rb
 - lib/bullet/registry/association.rb
 - lib/bullet/registry/base.rb

data/lib/bullet/presenter.rb

@@ -1,13 +0,0 @@
-module Bullet
-  module Presenter
-    autoload :Base, 'bullet/presenter/base'
-    autoload :JavascriptAlert, 'bullet/presenter/javascript_alert'
-    autoload :JavascriptConsole, 'bullet/presenter/javascript_console'
-    autoload :Growl, 'bullet/presenter/growl'
-    autoload :Xmpp, 'bullet/presenter/xmpp'
-    autoload :RailsLogger, 'bullet/presenter/rails_logger'
-    autoload :BulletLogger, 'bullet/presenter/bullet_logger'
-    
-    autoload :JavascriptHelpers, 'bullet/presenter/javascript_helpers'
-  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

data/lib/bullet/presenter/bullet_logger.rb

@@ -1,28 +0,0 @@
-module Bullet
-  module Presenter
-    class BulletLogger < Base
-      @logger_file = nil
-      @logger = nil
-
-      def self.active? 
-        @logger
-      end
-
-      def self.out_of_channel_notify( notice )
-        return unless active?
-        @logger.info notice.full_notice
-        @logger_file.flush
-      end
-
-      def self.setup
-        @logger_file = File.open( Rails.root.join('log/bullet.log'), 'a+' )
-        @logger = Logger.new( @logger_file )
-
-        def @logger.format_message( severity, timestamp, progname, msg )
-          "#{timestamp.to_formatted_s(:db)}[#{severity}] #{msg}\n"
-        end
-      end
-
-    end
-  end
-end

data/lib/bullet/presenter/growl.rb

@@ -1,40 +0,0 @@
-module Bullet
-  module Presenter
-    class Growl < Base
-      @growl = nil
-
-      def self.active? 
-        @growl
-      end
-
-      def self.out_of_channel_notify( notice )
-        return unless active?
-        notify( notice.standard_notice )
-      end
-
-      def self.setup_connection( password )
-        require 'ruby-growl'
-        @password = password
-        @growl = connect
-
-        notify 'Bullet Growl notifications have been turned on'
-      rescue MissingSourceFile
-        @growl = nil
-        raise NotificationError.new( 'You must install the ruby-growl gem to use Growl notifications: `sudo gem install ruby-growl`' )
-      end
-
-      private
-        def self.connect
-          ::Growl.new 'localhost',
-                      'ruby-growl',
-                      [ 'Bullet Notification' ],
-                      nil,
-                      @password
-        end
-
-        def self.notify( message )
-          @growl.notify( 'Bullet Notification', 'Bullet Notification', message )
-        end
-    end 
-  end
-end

data/lib/bullet/presenter/javascript_alert.rb

@@ -1,15 +0,0 @@
-module Bullet
-  module Presenter
-    class JavascriptAlert < Base
-      def self.active?
-        Bullet.alert
-      end
-
-      def self.inline_notify( notice )
-        return '' unless self.active?
-
-        JavascriptHelpers::wrap_js_association "alert( #{notice.standard_notice.inspect} ); "
-      end
-    end
-  end
-end

data/lib/bullet/presenter/javascript_console.rb

@@ -1,28 +0,0 @@
-module Bullet
-  module Presenter
-    class JavascriptConsole < Base
-      def self.active?
-        Bullet.console
-      end
-
-      def self.inline_notify( notice )
-        return '' unless active?
-
-        code = <<-CODE
-          if (typeof(console) !== 'undefined') {
-            if (console.groupCollapsed && console.groupEnd && console.log) {
-              console.groupCollapsed(#{notice.title.inspect});
-              console.log(#{notice.body_with_caller.inspect});
-              console.groupEnd();
-
-            } else if (console.log) {
-              console.log(#{notice.full_notice.inspect});
-            }
-          }
-        CODE
-
-        JavascriptHelpers::wrap_js_association code
-      end
-    end
-  end
-end

data/lib/bullet/presenter/javascript_helpers.rb

@@ -1,13 +0,0 @@
-module Bullet
-  module Presenter
-    module JavascriptHelpers
-      def self.wrap_js_association( message )
-        %{ 
-          <script type="text/javascript">/*<![CDATA[*/
-          #{message}
-          /*]]>*/</script>
-        }
-      end
-    end
-  end
-end

data/lib/bullet/presenter/rails_logger.rb

@@ -1,15 +0,0 @@
-module Bullet
-  module Presenter
-    class RailsLogger < Base
-      def self.active?
-        Bullet.rails_logger
-      end
-
-      def self.out_of_channel_notify( notice )
-        return unless active?
-        Rails.logger.warn ''
-        Rails.logger.warn notice.full_notice
-      end
-    end
-  end
-end

data/lib/bullet/presenter/xmpp.rb

@@ -1,56 +0,0 @@
-module Bullet
-  module Presenter
-    class Xmpp < Base
-      @receiver = nil
-      @xmpp = nil
-      @password = nil
-
-      def self.active?
-        @xmpp
-      end
-
-      def self.out_of_channel_notify( notice )
-        return unless active?
-        notify( notice.standard_notice )
-      end
-
-      def self.setup_connection( xmpp_information )
-        require 'xmpp4r'
-
-        @receiver = xmpp_information[:receiver]
-        @password = xmpp_information[:password]
-        @account  = xmpp_information[:account]
-        @show_online_status = xmpp_information[:show_online_status]
-
-        connect
-      rescue MissingSourceFile
-        @xmpp = nil
-        raise NotificationError.new( 'You must install the xmpp4r gem to use XMPP notifications: `sudo gem install xmpp4r`' )
-      end
-
-      private
-      def self.connect
-        jid = Jabber::JID.new( @account )
-        @xmpp = Jabber::Client.new( jid )
-        @xmpp.connect
-        @xmpp.auth( @password )
-        @xmpp.send( presence_status ) if @show_online_status
-      end
-
-      def self.notify( message )
-        message = Jabber::Message.new( @receiver, message ).
-                                  set_type( :normal ).
-                                  set_id( '1' ).
-                                  set_subject( 'Bullet Notification' )
-        @xmpp.send( message )
-      end
-
-      def self.presence_status
-        project_name = Rails.root.basename.to_s.camelcase
-        time = Time.now
-
-        Jabber::Presence.new.set_status( "Bullet in project '#{project_name}' started on #{time}" )
-      end
-    end
-  end
-end