bullet 2.0.0.beta.2 → 2.0.1

data/lib/bullet/notification/base.rb

@@ -0,0 +1,57 @@
+module Bullet
+  module Notification
+    class Base
+      attr_accessor :notifier
+      attr_reader :base_class, :associations, :path
+
+      def initialize( base_class, associations, path = nil )
+        @base_class = base_class
+        @associations = associations.is_a?( Array ) ? associations : [ associations ]
+        @path = path
+      end
+
+      def title
+      end
+
+      def body
+      end
+
+      def body_with_caller
+        body
+      end
+
+      def standard_notice
+        @standard_notifice ||= title + "\n" + body
+      end
+
+      def full_notice
+        @full_notice ||= title + "\n" + body_with_caller
+      end
+
+      def notify_inline
+        self.notifier.inline_notify( self.full_notice )
+      end
+
+      def notify_out_of_channel
+        self.notifier.out_of_channel_notify( self.full_notice )
+      end
+
+      def eql?( other )
+        klazz_associations_str == other.klazz_associations_str
+      end
+
+      def hash
+        klazz_associations_str.hash
+      end
+
+      protected
+      def klazz_associations_str
+        "  #{@base_class} => [#{@associations.map(&:inspect).join(', ')}]"
+      end
+
+      def associations_str
+        ":include => #{@associations.map{|a| a.to_s.to_sym unless a.is_a? Hash}.inspect}"
+      end
+    end
+  end
+end

data/lib/bullet/notification/counter_cache.rb

@@ -0,0 +1,13 @@
+module Bullet
+  module Notification
+    class CounterCache < Base
+      def body
+        klazz_associations_str
+      end
+
+      def title
+        "Need Counter Cache"
+      end
+    end
+  end
+end

data/lib/bullet/notification/n_plus_one_query.rb

@@ -0,0 +1,32 @@
+module Bullet
+  module Notification
+    class NPlusOneQuery < Base
+      def initialize( callers, base_class, associations, path = nil )
+        super( base_class, associations, path )
+
+        @callers = callers
+      end
+
+      def body_with_caller
+        "#{body}\n#{call_stack_messages}"
+      end
+      
+      def body
+        "#{klazz_associations_str}\n  Add to your finder: #{associations_str}"
+      end
+
+      def title
+        "N+1 Query #{@path ? "in #{@path}" : 'detected'}"
+      end
+
+      protected
+      def call_stack_messages
+        @callers.collect do |c|
+          [ 'N+1 Query method call stack', 
+            c.collect {|line| "  #{line}"} ].flatten
+        end.join( "\n" )
+      end
+
+    end
+  end
+end

data/lib/bullet/notification/unused_eager_loading.rb

@@ -0,0 +1,14 @@
+module Bullet
+  module Notification
+    class UnusedEagerLoading < Base
+      def body
+        "#{klazz_associations_str}\n  Remove from your finder: #{associations_str}"
+      end
+
+      def title
+        "Unused Eager Loading #{@path ? "in #{@path}" : 'detected'}" 
+      end
+
+    end
+  end
+end

data/lib/bullet/notification.rb

@@ -1,83 +1,8 @@
 module Bullet
-  class NotificationError < StandardError
-  end
-
   module Notification
-    def notification?
-    end
-
-    def notification_response
-    end
-
-    def console_title
-    end
-
-    def log_message(path = nil)
-    end
-
-    def javascript_notification
-      str = ''
-      if Bullet.alert || Bullet.console
-        response = notification_response
-      end
-      unless response.blank?
-        if Bullet.alert
-          str << wrap_js_association("alert(#{response.join("\n").inspect});")
-        end
-        if Bullet.console
-          code = <<-CODE
-            if (typeof(console) !== 'undefined') {
-
-              if (console.groupCollapsed && console.groupEnd && console.log) {
-
-                console.groupCollapsed(#{console_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
-      end
-      str
-    end
-
-    def growl_notification
-      if Bullet.growl
-        response = notification_response
-        unless response.blank?
-          begin
-            growl = Growl.new('localhost', 'ruby-growl', ['Bullet Notification'], nil, Bullet.growl_password)
-            growl.notify('Bullet Notification', 'Bullet Notification', response.join("\n"))
-          rescue
-          end
-        end
-      end
-    end
-
-    def log_notification(path)
-      if Bullet.bullet_logger || Bullet.rails_logger
-        Rails.logger.warn '' if Bullet.rails_logger
-        messages = log_messages(path)
-        messages.each do |message|
-          Bullet.logger.info(message.join("\n")) if Bullet.bullet_logger
-          Rails.logger.warn(message.join("\n")) if Bullet.rails_logger
-        end
-        Bullet.logger_file.flush if Bullet.bullet_logger
-      end
-    end
-
-    private
-      def wrap_js_association(message)
-        str = ''
-        str << "<script type=\"text/javascript\">/*<![CDATA[*/"
-        str << message
-        str << "/*]]>*/</script>\n"
-      end
+    autoload :Base, 'bullet/notification/base'
+    autoload :UnusedEagerLoading, 'bullet/notification/unused_eager_loading'
+    autoload :NPlusOneQuery, 'bullet/notification/n_plus_one_query'
+    autoload :CounterCache, 'bullet/notification/counter_cache'
   end
 end

data/lib/bullet/notification_collector.rb

@@ -0,0 +1,25 @@
+require 'set'
+
+module Bullet
+  class NotificationCollector
+    attr_reader :collection
+
+    def initialize
+      reset
+    end
+
+    def reset
+      @collection = Set.new
+    end
+
+    def add( value )
+      @collection << value
+    end
+
+    def notifications_present?
+      !@collection.empty?
+    end
+
+  end
+end
+

data/lib/bullet/rack.rb

@@ -0,0 +1,44 @@
+module Bullet
+  class Rack
+    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.gather_inline_notifications
+          headers['Content-Length'] = response_body.length.to_s
+        end
+        Bullet.perform_out_of_channel_notifications
+      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 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
+
+    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
+end

data/lib/bullet/registry/association.rb

@@ -0,0 +1,16 @@
+module Bullet
+  module Registry
+    class Association < Base
+      def merge( base, associations )
+        @registry.merge!( { base => associations } )
+        unique( @registry[base] )
+      end
+
+      def similarly_associated( base, associations )
+        @registry.select do |key, value|
+          key.include?( base ) and value == associations
+        end.collect( &:first ).flatten!
+      end
+    end
+  end
+end

data/lib/bullet/registry/base.rb

@@ -0,0 +1,39 @@
+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] ||= []
+        @registry[key] << value
+        unique( @registry[key] )
+      end
+
+      private
+      def unique( array )
+        array.flatten!
+        array.uniq!
+      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.0.1"
+end
+

data/lib/bullet.rb

@@ -1,31 +1,47 @@
-require 'bulletware'
+require 'set'
+require 'uniform_notifier'
 
 module Bullet
+  class NotificationError < StandardError; end
+
   if Rails.version =~ /^3.0/
     autoload :ActiveRecord, 'bullet/active_record3'
   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
+    # compatible with rails 3.0.0.beta4
+    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 +50,59 @@ 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
+      for_each_active_notifier_with_notification do |notification|
+        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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bullet
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  hash: 13
+  prerelease: false
   segments: 
   - 2
   - 0
-  - 0
-  - beta
-  - 2
-  version: 2.0.0.beta.2
+  - 1
+  version: 2.0.1
 platform: ruby
 authors: 
 - Richard Huang
@@ -16,78 +15,97 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-07 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: 
 - MIT-LICENSE
 - README.textile
 - README_for_rails2.textile
-- Rakefile
-- VERSION
-- bullet.gemspec
-- lib/bullet.rb
+files: 
 - 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/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/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/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
+- lib/bullet/notification_collector.rb
+- lib/bullet/rack.rb
+- lib/bullet/registry/association.rb
+- lib/bullet/registry/base.rb
+- lib/bullet/registry/object.rb
+- 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 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: []
+