guard 1.2.3 → 1.3.0

data/lib/guard/dsl_describer.rb

@@ -1,9 +1,5 @@
-require 'guard/dsl'
-
 module Guard
 
-  autoload :UI, 'guard/ui'
-
   # The DslDescriber overrides methods to create an internal structure
   # of the Guardfile that is used in some inspection utility methods
   # like the CLI commands `show` and `list`.
@@ -13,6 +9,9 @@ module Guard
   #
   class DslDescriber < Dsl
 
+    require 'guard/dsl'
+    require 'guard/ui'
+
     class << self
 
       # Evaluate the DSL methods in the `Guardfile`.
@@ -52,15 +51,15 @@ module Guard
           installed
         end
 
-        UI.info 'Available guards:'
+        ::Guard::UI.info 'Available guards:'
 
         ::Guard.guard_gem_names.sort.uniq.each do |name|
-          UI.info "   #{ name }#{ installed_guards.include?(name) ? '*' : '' }"
+          ::Guard::UI.info "   #{ name }#{ installed_guards.include?(name) ? '*' : '' }"
         end
 
-        UI.info ''
-        UI.info 'See also https://github.com/guard/guard/wiki/List-of-available-Guards'
-        UI.info '* denotes ones already in your Guardfile'
+        ::Guard::UI.info ''
+        ::Guard::UI.info 'See also https://github.com/guard/guard/wiki/List-of-available-Guards'
+        ::Guard::UI.info '* denotes ones already in your Guardfile'
       end
 
       # Shows all Guard plugins and their options that are defined in
@@ -82,9 +81,9 @@ module Guard
         guardfile_structure.each do |group|
           unless group[:guards].empty?
             if group[:group]
-              UI.info "Group #{ group[:group] }:"
+              ::Guard::UI.info "Group #{ group[:group] }:"
             else
-              UI.info '(global):'
+              ::Guard::UI.info '(global):'
             end
 
             group[:guards].each do |guard|
@@ -94,12 +93,12 @@ module Guard
                 line += ": #{ guard[:options].inject({}) { |options, (k, v)| options[k.to_s] = v; options }.sort.collect { |k, v| "#{ k } => #{ v.inspect }" }.join(', ') }"
               end
 
-              UI.info line
+              ::Guard::UI.info line
             end
           end
         end
 
-        UI.info ''
+        ::Guard::UI.info ''
       end
 
       private

data/lib/guard/group.rb

@@ -32,10 +32,13 @@ module Guard
       @options = options
     end
 
+    # String representation of the Guard group.
+    #
+    # @return [String] the group name
+    #
     def to_s
       "#{@name} group"
     end
 
   end
-
 end

data/lib/guard/guard.rb

@@ -39,7 +39,10 @@ module Guard
   # the Guard::GuardName instance will be removed from the active guards.
   #
   class Guard
-    include Hook
+    require 'guard/hook'
+    require 'guard/ui'
+
+    include ::Guard::Hook
 
     attr_accessor :watchers, :options, :group
 

data/lib/guard/guardfile.rb

@@ -7,6 +7,9 @@ module Guard
   #
   class Guardfile
 
+    require 'guard'
+    require 'guard/ui'
+
     class << self
 
       # Creates the initial Guardfile template when it does not

data/lib/guard/hook.rb

@@ -9,6 +9,8 @@ module Guard
   #
   module Hook
 
+    require 'guard/ui'
+
     # The Hook module gets included.
     #
     # @param [Class] base the class that includes the module
@@ -57,7 +59,7 @@ module Guard
                       event
                     end.to_sym
 
-        UI.debug "Hook :#{ hook_name } executed for #{ self.class }"
+        ::Guard::UI.debug "Hook :#{ hook_name } executed for #{ self.class }"
 
         Hook.notify(self.class, hook_name, *args)
       end

data/lib/guard/interactor.rb

@@ -1,11 +1,5 @@
 module Guard
 
-  autoload :ReadlineInteractor, 'guard/interactors/readline'
-  autoload :CoollineInteractor, 'guard/interactors/coolline'
-  autoload :SimpleInteractor,   'guard/interactors/simple'
-  autoload :DslDescriber,       'guard/dsl_describer'
-  autoload :UI,                 'guard/ui'
-
   # The interactor triggers specific action from input
   # read by a interactor implementation.
   #
@@ -38,6 +32,14 @@ module Guard
   #
   class Interactor
 
+    require 'guard'
+    require 'guard/ui'
+    require 'guard/dsl_describer'
+    require 'guard/notifier'
+    require 'guard/interactors/readline'
+    require 'guard/interactors/coolline'
+    require 'guard/interactors/simple'
+
     ACTIONS = {
       :help         => %w[help h],
       :reload       => %w[reload r],
@@ -64,11 +66,11 @@ module Guard
     def self.fabricate
       case @interactor
       when :coolline
-        CoollineInteractor.new if CoollineInteractor.available?
+        ::Guard::CoollineInteractor.new if ::Guard::CoollineInteractor.available?
       when :readline
-        ReadlineInteractor.new if ReadlineInteractor.available?
+        ::Guard::ReadlineInteractor.new if ::Guard::ReadlineInteractor.available?
       when :simple
-        SimpleInteractor.new
+        ::Guard::SimpleInteractor.new
       when :off
         nil
       else
@@ -90,7 +92,9 @@ module Guard
     # @return [Interactor] an interactor implementation
     #
     def self.auto_detect
-      [CoollineInteractor, ReadlineInteractor, SimpleInteractor].detect { |interactor| interactor.available?(true) }.new
+      [::Guard::CoollineInteractor, ::Guard::ReadlineInteractor, ::Guard::SimpleInteractor].detect do |interactor|
+        interactor.available?(true)
+      end.new
     end
 
     # Template method for checking if the Interactor is
@@ -143,7 +147,7 @@ module Guard
       when :help
         help
       when :show
-        DslDescriber.show(::Guard.options)
+        ::Guard::DslDescriber.show(::Guard.options)
       when :stop
         ::Guard.stop
         exit

data/lib/guard/interactors/coolline.rb

@@ -1,13 +1,15 @@
-module Guard
+require 'guard'
+require 'guard/ui'
+require 'guard/interactor'
+require 'guard/interactors/helpers/terminal'
+require 'guard/interactors/helpers/completion'
 
-  autoload :TerminalHelper,   'guard/interactors/helpers/terminal'
-  autoload :CompletionHelper, 'guard/interactors/helpers/completion'
-  autoload :UI,               'guard/ui'
+module Guard
 
   # Interactor that uses coolline for getting the user input.
   # This enables history support and auto-completion,
   #
-  class CoollineInteractor < Interactor
+  class CoollineInteractor < ::Guard::Interactor
     include ::Guard::CompletionHelper
     include ::Guard::TerminalHelper
 

data/lib/guard/interactors/helpers/completion.rb

@@ -1,3 +1,5 @@
+require 'guard'
+
 module Guard
   
   # Module for providing word completion to an interactor.

data/lib/guard/interactors/readline.rb

@@ -1,8 +1,10 @@
-module Guard
+require 'guard'
+require 'guard/ui'
+require 'guard/interactor'
+require 'guard/interactors/helpers/terminal'
+require 'guard/interactors/helpers/completion'
 
-  autoload :TerminalHelper,   'guard/interactors/helpers/terminal'
-  autoload :CompletionHelper, 'guard/interactors/helpers/completion'
-  autoload :UI,               'guard/ui'
+module Guard
 
   # Interactor that used readline for getting the user input.
   # This enables history support and auto-completion, but is
@@ -10,7 +12,7 @@ module Guard
   #
   # @see http://bugs.ruby-lang.org/issues/5539
   #
-  class ReadlineInteractor < Interactor
+  class ReadlineInteractor < ::Guard::Interactor
     include ::Guard::CompletionHelper
     include ::Guard::TerminalHelper
 
@@ -29,6 +31,10 @@ module Guard
         ::Guard::UI.error 'The :readline interactor runs only fine on JRuby, Linux or with the gem \'rb-readline\' installed.' unless silent
         false
       end
+
+    rescue LoadError => e
+      ::Guard::UI.error "Please install Ruby Readline support or add \"gem 'rb-readline'\" to your Gemfile and run Guard with \"bundle exec\"." unless silent
+      false      
     end
 
     # Initialize the interactor.
@@ -49,10 +55,10 @@ module Guard
     #
     def stop
       # Erase the current line for Ruby Readline
-      if Readline.respond_to?(:refresh_line)
+      if Readline.respond_to?(:refresh_line) && !defined?(::JRUBY_VERSION)
         Readline.refresh_line
       end
-      
+
       # Erase the current line for Rb-Readline
       if defined?(RbReadline) && RbReadline.rl_outstream
         RbReadline._rl_erase_entire_line
@@ -60,7 +66,7 @@ module Guard
 
       super
     end
-    
+
     # Read a line from stdin with Readline.
     #
     def read_line

data/lib/guard/interactors/simple.rb

@@ -1,9 +1,11 @@
+require 'guard/interactor'
+
 module Guard
 
   # Simple interactor that that reads user
   # input from standard input.
   #
-  class SimpleInteractor < Interactor
+  class SimpleInteractor < ::Guard::Interactor
 
     # Read a line from stdin with Readline.
     #

data/lib/guard/notifier.rb

@@ -1,14 +1,6 @@
 require 'yaml'
-
 require 'rbconfig'
 require 'pathname'
-require 'guard/ui'
-require 'guard/notifiers/gntp'
-require 'guard/notifiers/growl'
-require 'guard/notifiers/growl_notify'
-require 'guard/notifiers/libnotify'
-require 'guard/notifiers/notifysend'
-require 'guard/notifiers/rb_notifu'
 
 module Guard
 
@@ -40,17 +32,32 @@ module Guard
   # Guard can be configured to make use of more than one notifier at once, @see Guard::Dsl
   #
   module Notifier
+
+    require 'guard'
+    require 'guard/ui'
+    require 'guard/notifiers/gntp'
+    require 'guard/notifiers/growl'
+    require 'guard/notifiers/growl_notify'
+    require 'guard/notifiers/libnotify'
+    require 'guard/notifiers/notifysend'
+    require 'guard/notifiers/rb_notifu'
+    require 'guard/notifiers/emacs'
+    require 'guard/notifiers/terminal_notifier'
+
     extend self
 
-    # List of available notifiers.
-    NOTIFIERS = {
-        :gntp         => ::Guard::Notifier::GNTP,
-        :growl        => ::Guard::Notifier::Growl,
-        :growl_notify => ::Guard::Notifier::GrowlNotify,
-        :libnotify    => ::Guard::Notifier::Libnotify,
-        :notifysend   => ::Guard::Notifier::NotifySend,
-        :notifu       => ::Guard::Notifier::Notifu
-    }
+    # List of available notifiers. 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]
+    ]
 
     # Get the available notifications.
     #
@@ -85,7 +92,7 @@ module Guard
         ENV['GUARD_NOTIFY'] = 'false'
       else
         notifications.each do |notification|
-          ::Guard::UI.info "Guard uses #{ NOTIFIERS[notification[:name]].to_s.split('::').last } to send notifications."
+          ::Guard::UI.info "Guard uses #{ get_notifier_module(notification[:name]).to_s.split('::').last } to send notifications."
         end
 
         ENV['GUARD_NOTIFY'] = 'true'
@@ -116,7 +123,9 @@ module Guard
     def add_notification(name, options = { }, silent = false)
       return turn_off if name == :off
 
-      if NOTIFIERS.has_key?(name) && NOTIFIERS[name].available?(silent)
+      notifier = get_notifier_module(name)
+      
+      if notifier && notifier.available?(silent)
         self.notifications = notifications << { :name => name, :options => options }
         true
       else
@@ -138,7 +147,7 @@ module Guard
 
         notifications.each do |notification|
           begin
-            NOTIFIERS[notification[:name]].notify(type, title, message, image, options.merge(notification[:options]))
+            get_notifier_module(notification[:name]).notify(type, title, message, image, options.merge(notification[:options]))
           rescue Exception => e
             ::Guard::UI.error "Error sending notification with #{ notification[:name] }: #{ e.message }"
           end
@@ -148,12 +157,22 @@ module Guard
 
     private
 
+    # Get the notifier module for the given name.
+    #
+    # @param [Symbol] the notifier name
+    # @return [Module] the notifier module
+    #
+    def get_notifier_module(name)
+      notifier = NOTIFIERS.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.
     #
     def auto_detect_notification
-      available = [:growl_notify, :gntp, :growl, :libnotify, :notifysend, :notifu].any? { |notifier| add_notification(notifier, { }, true) }
+      available = NOTIFIERS.map { |n| n.first }.any? { |notifier| add_notification(notifier, { }, true) }
       ::Guard::UI.info('Guard could not detect any of the supported notification libraries.') unless available
     end
 
@@ -171,14 +190,14 @@ module Guard
     #
     def image_path(image)
       case image
-      when :failed
-        images_path.join('failed.png').to_s
-      when :pending
-        images_path.join('pending.png').to_s
-      when :success
-        images_path.join('success.png').to_s
-      else
-        image
+        when :failed
+          images_path.join('failed.png').to_s
+        when :pending
+          images_path.join('pending.png').to_s
+        when :success
+          images_path.join('success.png').to_s
+        else
+          image
       end
     end
 
@@ -198,14 +217,14 @@ module Guard
     #
     def notification_type(image)
       case image
-      when :failed
-        'failed'
-      when :pending
-        'pending'
-      when :success
-        'success'
-      else
-        'notify'
+        when :failed
+          'failed'
+        when :pending
+          'pending'
+        when :success
+          'success'
+        else
+          'notify'
       end
     end
   end

data/lib/guard/notifiers/emacs.rb

@@ -0,0 +1,69 @@
+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`
+    #   notification :emacs
+    #
+    module Emacs
+      extend self
+
+      # Test if Emacs with running server is available.
+      #
+      # @param [Boolean] silent true if no error messages should be shown
+      # @return [Boolean] the availability status
+      #
+      def available?(silent = false)
+        result = `#{DEFAULTS[:client]} --eval '1' 2> /dev/null || echo 0`
+
+        if result.chomp! == "1"
+          true
+        else
+          false
+        end
+      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
+      # @option options [Boolean] sticky make the notification sticky
+      # @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)}\\")"))
+      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
+      # @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
+      end
+    end
+  end
+end