guard 1.4.0 → 1.5.0

data/lib/guard/notifier.rb

@@ -14,6 +14,7 @@ module Guard
   # * rb-notifu
   # * emacs
   # * Terminal Notifier
+  # * Terminal Title
   # * Tmux
   #
   # Please see the documentation of each notifier for more information about the requirements
@@ -46,22 +47,26 @@ module Guard
     require 'guard/notifiers/rb_notifu'
     require 'guard/notifiers/emacs'
     require 'guard/notifiers/terminal_notifier'
+    require 'guard/notifiers/terminal_title'
     require 'guard/notifiers/tmux'
 
     extend self
 
-    # List of available notifiers. It needs to be a nested hash instead of
+    # List of available notifiers, grouped by functionality. It needs to be a nested hash instead of
     # a simpler Hash, because it maintains its order on Ruby 1.8.7 also.
     NOTIFIERS = [
-      [:growl,             ::Guard::Notifier::Growl],
-      [:gntp,              ::Guard::Notifier::GNTP],
-      [:growl_notify,      ::Guard::Notifier::GrowlNotify],
-      [:libnotify,         ::Guard::Notifier::Libnotify],
-      [:notifysend,        ::Guard::Notifier::NotifySend],
-      [:notifu,            ::Guard::Notifier::Notifu],
-      [:emacs,             ::Guard::Notifier::Emacs],
-      [:terminal_notifier, ::Guard::Notifier::TerminalNotifier],
-      [:tmux,              ::Guard::Notifier::Tmux]
+      [
+        [:gntp,              ::Guard::Notifier::GNTP],
+        [:growl,             ::Guard::Notifier::Growl],
+        [:growl_notify,      ::Guard::Notifier::GrowlNotify],
+        [:terminal_notifier, ::Guard::Notifier::TerminalNotifier],
+        [:libnotify,         ::Guard::Notifier::Libnotify],
+        [:notifysend,        ::Guard::Notifier::NotifySend],
+        [:notifu,            ::Guard::Notifier::Notifu]
+      ],
+      [[:emacs,             ::Guard::Notifier::Emacs]],
+      [[:tmux,              ::Guard::Notifier::Tmux]],
+      [[:terminal_title,    ::Guard::Notifier::TerminalTitle]]
     ]
 
     # Get the available notifications.
@@ -110,6 +115,17 @@ module Guard
       ENV['GUARD_NOTIFY'] = 'false'
     end
 
+    # Toggle the system notifications on/off
+    #
+    def toggle
+      if ENV['GUARD_NOTIFY'] == 'true'
+        ::Guard::UI.info 'Turn off notifications'
+        turn_off
+      else
+        turn_on
+      end
+    end
+
     # Test if the notifications are on.
     #
     # @return [Boolean] whether the notifications are on
@@ -164,20 +180,26 @@ module Guard
 
     # Get the notifier module for the given name.
     #
-    # @param [Symbol] the notifier name
+    # @param [Symbol] name the notifier name
     # @return [Module] the notifier module
     #
     def get_notifier_module(name)
-      notifier = NOTIFIERS.detect { |n| n.first == name }
+      notifier = NOTIFIERS.flatten(1).detect { |n| n.first == name }
       notifier ? notifier.last : notifier
     end
 
     # Auto detect the available notification library. This goes through
     # the list of supported notification gems and picks the first that
-    # is available.
+    # is available in each notification group.
     #
     def auto_detect_notification
-      available = NOTIFIERS.map { |n| n.first }.any? { |notifier| add_notification(notifier, { }, true) }
+      available = nil
+
+      NOTIFIERS.each do |group|
+        added = group.map { |n| n.first }.find { |notifier| add_notification(notifier, { }, true) }
+        available = available || added
+      end
+
       ::Guard::UI.info('Guard could not detect any of the supported notification libraries.') unless available
     end
 

data/lib/guard/notifiers/emacs.rb

@@ -3,14 +3,6 @@ require 'rbconfig'
 module Guard
   module Notifier
 
-    # Default options for EmacsClient
-    DEFAULTS = {
-      :client  => 'emacsclient',
-      :success => 'ForestGreen',
-      :failed  => 'Firebrick',
-      :default => 'Black',
-    }
-
     # Send a notification to Emacs with emacsclient (http://www.emacswiki.org/emacs/EmacsClient).
     #
     # @example Add the `:emacs` notifier to your `Guardfile`
@@ -19,6 +11,13 @@ module Guard
     module Emacs
       extend self
 
+      DEFAULTS = {
+        :client  => 'emacsclient',
+        :success => 'ForestGreen',
+        :failed  => 'Firebrick',
+        :default => 'Black',
+      }
+
       # Test if Emacs with running server is available.
       #
       # @param [Boolean] silent true if no error messages should be shown
@@ -41,28 +40,33 @@ module Guard
       # @param [String] message the notification message body
       # @param [String] image the path to the notification image
       # @param [Hash] options additional notification library options
-      # @option options [Boolean] sticky make the notification sticky
+      # @option options [String] success the color to use for success notifications (default is 'ForestGreen')
+      # @option options [String] failed the color to use for failure notifications (default is 'Firebrick')
+      # @option options [String] pending the color to use for pending notifications
+      # @option options [String] default the default color to use (default is 'Black')
+      # @option options [String] client the client to use for notification (default is 'emacsclient')
       # @option options [String, Integer] priority specify an int or named key (default is 0)
       #
       def notify(type, title, message, image, options = { })
-        system(%(#{ DEFAULTS[:client] } --eval "(set-face-background 'modeline \\"#{ emacs_color(type) }\\")"))
+        options = DEFAULTS.merge options
+        color   = emacs_color type, options
+        system(%(#{ options[:client] } --eval "(set-face-background 'modeline \\"#{ color }\\")"))
       end
 
       # Get the Emacs color for the notification type.
       # You can configure your own color by overwrite the defaults.
       #
       # @param [String] type the notification type
+      # @param [Hash] options aditional notification options
+      # @option options [String] success the color to use for success notifications (default is 'ForestGreen')
+      # @option options [String] failed the color to use for failure notifications (default is 'Firebrick')
+      # @option options [String] pending the color to use for pending notifications
+      # @option options [String] default the default color to use (default is 'Black')
       # @return [String] the name of the emacs color
       #
-      def emacs_color(type)
-        case type
-            when 'success'
-              DEFAULTS[:success]
-            when 'failed'
-              DEFAULTS[:failed]
-            else
-              DEFAULTS[:default]
-        end
+      def emacs_color(type, options = {})
+        default = options[:default] || DEFAULTS[:default]
+        options.fetch(type.to_sym, default)
       end
     end
   end

data/lib/guard/notifiers/terminal_title.rb

@@ -0,0 +1,35 @@
+# Module for notifying test result to terminal title
+module Guard
+  module Notifier
+    module TerminalTitle
+      extend self
+
+      # Test if the notification library is available.
+      #
+      # @param [Boolean] silent true if no error messages should be shown
+      # @return [Boolean] the availability status
+      #
+      def available?(silent = false)
+        true
+      end
+
+      # Show a system notification.
+      #
+      # @param [String] type the notification type. Either 'success', 'pending', 'failed' or 'notify'
+      # @param [String] title the notification title
+      # @param [String] message the notification message body
+      # @param [String] image the path to the notification image
+      # @param [Hash] options additional notification library options
+      #
+      def notify(type, title, message, image, options = { })
+        message.sub!(/^\n/, '')
+        message.sub!(/\n.*/m, '')
+        set_terminal_title("[#{title}] #{message}")
+      end
+
+      def set_terminal_title(text)
+        puts "\e]2;#{text}\a"
+      end
+    end
+  end
+end

data/lib/guard/notifiers/tmux.rb

@@ -3,20 +3,34 @@ module Guard
 
     # Default options for Tmux
 
-    # Changes the color of the Tmux status bar
+    # Changes the color of the Tmux status bar and optionally
+    # shows messages in the status bar.
     #
     # @example Add the `:tmux` notifier to your `Guardfile`
     #   notification :tmux
     #
+    # @example Enable text messages
+    #   notification :tmux, :display_message => true
+    #
+    # @example Customize the tmux status colored for notifications
+    #   notification :tmux, :color_location => 'status-right-bg'
+    #
     module Tmux
       extend self
 
       DEFAULTS = {
-        :client           => 'tmux',
-        :tmux_environment => 'TMUX',
-        :success          => 'green',
-        :failed           => 'red',
-        :default          => 'green'
+        :client                 => 'tmux',
+        :tmux_environment       => 'TMUX',
+        :success                => 'green',
+        :failed                 => 'red',
+        :pending                => 'yellow',
+        :default                => 'green',
+        :timeout                => 5,
+        :display_message        => false,
+        :default_message_format => '%s - %s',
+        :default_message_color  => 'white',
+        :line_separator         => ' - ',
+        :color_location         => 'status-left-bg'
       }
 
       # Test if currently running in a Tmux session
@@ -33,19 +47,60 @@ module Guard
         end
       end
 
-      # Show a system notification.
+      # Show a system notification. By default, the Tmux notifier only makes use of a color based
+      # notification, changing the background color of the `color_location` to the color defined
+      # in either the `success`, `failed`, `pending` or `default`, depending on the notification type.
+      # If you also want display a text message, you have to enable it explicit by setting `display_message`
+      # to `true`.
       #
       # @param [String] type the notification type. Either 'success', 'pending', 'failed' or 'notify'
       # @param [String] title the notification title
       # @param [String] message the notification message body
       # @param [String] image the path to the notification image
       # @param [Hash] options additional notification library options
-      # @option options [Boolean] sticky make the notification sticky
-      # @option options [String, Integer] priority specify an int or named key (default is 0)
+      # @option options [String] color_location the location where to draw the color notification
+      # @option options [Boolean] display_message whether to display a message or not
       #
       def notify(type, title, message, image, options = { })
         color = tmux_color type, options
-        system("#{ DEFAULTS[:client] } set -g status-left-bg #{ color }")
+        color_location = options[:color_location] || DEFAULTS[:color_location]
+        system("#{ DEFAULTS[:client] } set -g #{ color_location } #{ color }")
+
+        show_message = options[:display_message] || DEFAULTS[:display_message]
+        display_message(type, title, message, options) if show_message
+      end
+
+      # Display a message in the status bar of tmux.
+      #
+      # @param [String] type the notification type. Either 'success', 'pending', 'failed' or 'notify'
+      # @param [String] title the notification title
+      # @param [String] message the notification message body
+      # @param [Hash] options additional notification library options
+      # @option options [Integer] timeout the amount of seconds to show the message in the status bar
+      # @option options [String] success_message_format a string to use as formatter for the success message.
+      # @option options [String] failed_message_format a string to use as formatter for the failed message.
+      # @option options [String] pending_message_format a string to use as formatter for the pending message.
+      # @option options [String] default_message_format a string to use as formatter when no format per type is defined.
+      # @option options [String] success_message_color the success notification foreground color name.
+      # @option options [String] failed_message_color the failed notification foreground color name.
+      # @option options [String] pending_message_color the pending notification foreground color name.
+      # @option options [String] default_message_color a notification foreground color to use when no color per type is defined.
+      # @option options [String] line_separator a string to use instead of a line-break.
+      #
+      def display_message(type, title, message, options = { })
+          message_format = options["#{ type }_message_format".to_sym] || options[:default_message_format] || DEFAULTS[:default_message_format]
+          message_color = options["#{ type }_message_color".to_sym] || options[:default_message_color] || DEFAULTS[:default_message_color]
+          display_time = options[:timeout] || DEFAULTS[:timeout]
+          separator = options[:line_separator] || DEFAULTS[:line_separator]
+
+          color = tmux_color type, options
+          formatted_message = message.split("\n").join(separator)
+          display_message = message_format % [title, formatted_message]
+
+          system("#{ DEFAULTS[:client] } set display-time #{ display_time * 1000 }")
+          system("#{ DEFAULTS[:client] } set message-fg #{ message_color }")
+          system("#{ DEFAULTS[:client] } set message-bg #{ color }")
+          system("#{ DEFAULTS[:client] } display-message '#{ display_message }'")
       end
 
       # Get the Tmux color for the notification type.
@@ -60,6 +115,8 @@ module Guard
           options[:success] || DEFAULTS[:success]
         when 'failed'
           options[:failed]  || DEFAULTS[:failed]
+        when 'pending'
+          options[:pending] || DEFAULTS[:pending]
         else
           options[:default] || DEFAULTS[:default]
         end

data/lib/guard/runner.rb

@@ -7,6 +7,8 @@ module Guard
     require 'guard'
     require 'guard/ui'
     require 'guard/watcher'
+    
+    require 'lumberjack'
 
     # Deprecation message for the `run_on_change` method
     RUN_ON_CHANGE_DEPRECATION = <<-EOS.gsub(/^\s*/, '')
@@ -47,8 +49,10 @@ module Guard
     # @see self.run_supervised_task
     #
     def run(task, scopes = {})
-      scoped_guards(scopes) do |guard|
-        run_supervised_task(guard, task)
+      Lumberjack.unit_of_work do
+       scoped_guards(scopes) do |guard|
+          run_supervised_task(guard, task)
+        end
       end
     end
 

data/lib/guard/ui.rb

@@ -1,26 +1,53 @@
+require 'lumberjack'
+
 module Guard
 
   # The UI class helps to format messages for the user. Everything that is logged
   # through this class is considered either as an error message or a diagnostic
-  # message and is written to standard error (STDERR).
+  # message and is written to standard error ($stderr).
   #
   # If your Guard plugin does some output that is piped into another process for further
   # processing, please just write it to STDOUT with `puts`.
   #
   module UI
+    
     class << self
 
-      color_enabled = nil
+      # Get the Guard::UI logger instance
+      #
+      def logger
+        @logger ||= Lumberjack::Logger.new($stderr, self.options)
+      end
+      
+      # Get the logger options
+      #
+      # @return [Hash] the logger options
+      #
+      def options
+        @options ||= { :level => :info, :template => ':time - :severity - :message', :time_format => '%H:%M:%S' }
+      end
+
+      # Set the logger options
+      #
+      # @param [Hash] options the logger options
+      # @option options [Symbol] level the log level
+      # @option options [String] template the logger template
+      # @option options [String] time_format the time format
+      #
+      def options=(options)
+        @options = options
+      end
 
       # Show an info message.
       #
       # @param [String] message the message to show
       # @option options [Boolean] reset whether to clean the output before
+      # @option options [String] plugin manually define the calling plugin
       #
       def info(message, options = { })
-        unless ENV['GUARD_ENV'] == 'test'
+        filter(options[:plugin]) do |plugin|
           reset_line if options[:reset]
-          STDERR.puts color(message) if message != ''
+          self.logger.info(message, plugin)
         end
       end
 
@@ -28,11 +55,12 @@ module Guard
       #
       # @param [String] message the message to show
       # @option options [Boolean] reset whether to clean the output before
+      # @option options [String] plugin manually define the calling plugin
       #
       def warning(message, options = { })
-        unless ENV['GUARD_ENV'] == 'test'
+        filter(options[:plugin]) do |plugin|
           reset_line if options[:reset]
-          STDERR.puts color('WARNING: ', :yellow) + message
+          self.logger.warn(color(message, :yellow), plugin)
         end
       end
 
@@ -40,23 +68,26 @@ module Guard
       #
       # @param [String] message the message to show
       # @option options [Boolean] reset whether to clean the output before
+      # @option options [String] plugin manually define the calling plugin
       #
       def error(message, options = { })
-        unless ENV['GUARD_ENV'] == 'test'
+        filter(options[:plugin]) do |plugin|
           reset_line if options[:reset]
-          STDERR.puts color('ERROR: ', :red) + message
+          self.logger.error(color(message, :red), plugin)
         end
       end
 
       # Show a red deprecation message that is prefixed with DEPRECATION.
+      # It has a log level of `warn`.
       #
       # @param [String] message the message to show
       # @option options [Boolean] reset whether to clean the output before
+      # @option options [String] plugin manually define the calling plugin
       #
       def deprecation(message, options = { })
-        unless ENV['GUARD_ENV'] == 'test'
+        filter(options[:plugin]) do |plugin|
           reset_line if options[:reset]
-          STDERR.puts color('DEPRECATION: ', :red) + message
+          self.logger.warn(color(message, :yellow), plugin)
         end
       end
 
@@ -64,18 +95,19 @@ module Guard
       #
       # @param [String] message the message to show
       # @option options [Boolean] reset whether to clean the output before
+      # @option options [String] plugin manually define the calling plugin
       #
       def debug(message, options = { })
-        unless ENV['GUARD_ENV'] == 'test'
+        filter(options[:plugin]) do |plugin|
           reset_line if options[:reset]
-          STDERR.puts color("DEBUG (#{Time.now.strftime('%T')}): ", :yellow) + message if ::Guard.options && ::Guard.options[:debug]
+          self.logger.debug(color(message, :yellow), plugin)
         end
       end
 
       # Reset a line.
       #
       def reset_line
-        STDERR.print(color_enabled? ? "\r\e[0m" : "\r\n")
+        $stderr.print(color_enabled? ? "\r\e[0m" : "\r\n")
       end
 
       # Clear the output if clearable.
@@ -107,6 +139,34 @@ module Guard
       end
 
       private
+     
+      # Filters log messages depending on either the
+      # `:only`` or `:except` option.
+      #
+      # @param [String] plugin the calling plugin name
+      # @yield When the message should be logged
+      # @yieldparam [String] param the calling plugin name 
+      #
+      def filter(plugin)
+        only   = self.options[:only]
+        except = self.options[:except]
+        plugin = plugin || calling_plugin_name
+        
+        if (!only && !except) || (only && only.match(plugin)) || (except && !except.match(plugin))
+          yield plugin
+        end
+      end
+
+      # Tries to extract the calling Guard plugin name
+      # from the call stack.
+      #
+      # @param [Integer] depth the stack depth
+      # @return [String] the Guard plugin name
+      #
+      def calling_plugin_name(depth = 2)
+        name = /(guard\/[a-z_]*)(\/[a-z_]*)?.rb:/i.match(caller[depth])
+        name ? name[1].split('/').map { |part| part.split(/[^a-z0-9]/i).map { |word| word.capitalize }.join }.join('::') : 'Guard'
+      end
 
       # Reset a color sequence.
       #
@@ -161,7 +221,7 @@ module Guard
         color_options.each do |color_option|
           color_option = color_option.to_s
           if color_option != ''
-            if !(color_option =~ /\d+/)
+            unless color_option =~ /\d+/
               color_option = const_get("ANSI_ESCAPE_#{ color_option.upcase }")
             end
             color_code += ';' + color_option