bullet 2.0.0.beta.2 → 2.0.0.beta.3

data/lib/bullet/detector/unused_eager_association.rb

@@ -0,0 +1,39 @@
+module Bullet
+  module Detector
+    class UnusedEagerAssociation < Association
+      # 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 self.check_unused_preload_associations
+        @@checked = true
+        object_associations.each do |object, association|
+          object_association_diff = diff_object_association object, association
+          next if object_association_diff.empty?
+
+          create_notification object.class, object_association_diff
+        end
+      end
+      
+      protected
+      def self.create_notification(klazz, associations)
+        notice = Bullet::Notification::UnusedEagerLoading.new( klazz, associations )
+        Bullet.notification_collector.add( notice )
+      end
+
+      def self.call_object_association( object, association )
+        eager_loadings.similarly_associated( object, association ).
+                       collect { |related_object| call_object_associations[related_object] }.
+                       compact.
+                       flatten.
+                       uniq
+      end
+
+      def self.diff_object_association( object, association )
+        potential_objects = association - call_object_association( object, association )
+        potential_objects.reject {|a| a.is_a?( Hash ) }
+      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/base.rb

@@ -0,0 +1,59 @@
+module Bullet
+  module Notification
+    class Base
+      attr_accessor :presenter
+      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 present_inline
+        return unless self.presenter.respond_to? :inline
+        self.presenter.send( :inline, self ) 
+      end
+
+      def present_out_of_channel
+        return unless self.presenter.respond_to? :out_of_channel
+        self.presenter.send( :out_of_channel, self )
+      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_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/presenter.rb

@@ -0,0 +1,13 @@
+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

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

data/lib/bullet/presenter/bullet_logger.rb

@@ -0,0 +1,28 @@
+module Bullet
+  module Presenter
+    class BulletLogger < Base
+      @logger_file = nil
+      @logger = nil
+
+      def self.active? 
+        @logger
+      end
+
+      def self.out_of_channel( 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

@@ -0,0 +1,40 @@
+module Bullet
+  module Presenter
+    class Growl < Base
+      @growl = nil
+
+      def self.active? 
+        @growl
+      end
+
+      def self.out_of_channel( 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

@@ -0,0 +1,15 @@
+module Bullet
+  module Presenter
+    class JavascriptAlert < Base
+      def self.active?
+        Bullet.alert
+      end
+
+      def self.inline( 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

@@ -0,0 +1,28 @@
+module Bullet
+  module Presenter
+    class JavascriptConsole < Base
+      def self.active?
+        Bullet.console
+      end
+
+      def self.inline( 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

@@ -0,0 +1,13 @@
+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

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