guard 0.8.4 → 0.8.5

data/lib/guard/templates/Guardfile

@@ -1,2 +1,2 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme

data/lib/guard/ui.rb

@@ -1,188 +1,193 @@
-module Guard
-
-  # The UI class helps to format messages for the user.
-  #
-  module UI
-    class << self
-
-      color_enabled = nil
-
-      # Show an info message.
-      #
-      # @param [String] message the message to show
-      # @option options [Boolean] reset whether to clean the output before
-      #
-      def info(message, options = { })
-        unless ENV['GUARD_ENV'] == 'test'
-          reset_line if options[:reset]
-          puts color(message) if message != ''
-        end
-      end
-
-      # Show a red error message that is prefixed with ERROR.
-      #
-      # @param [String] message the message to show
-      # @option options [Boolean] reset whether to clean the output before
-      #
-      def error(message, options = { })
-        unless ENV['GUARD_ENV'] == 'test'
-          reset_line if options[:reset]
-          puts color('ERROR: ', :red) + message
-        end
-      end
-
-      # Show a red deprecation message that is prefixed with DEPRECATION.
-      #
-      # @param [String] message the message to show
-      # @option options [Boolean] reset whether to clean the output before
-      #
-      def deprecation(message, options = { })
-        unless ENV['GUARD_ENV'] == 'test'
-          reset_line if options[:reset]
-          puts color('DEPRECATION: ', :red) + message
-        end
-      end
-
-      # Show a debug message that is prefixed with DEBUG and a timestamp.
-      #
-      # @param [String] message the message to show
-      # @option options [Boolean] reset whether to clean the output before
-      #
-      def debug(message, options = { })
-        unless ENV['GUARD_ENV'] == 'test'
-          reset_line if options[:reset]
-          puts color("DEBUG (#{Time.now.strftime('%T')}): ", :yellow) + message if ::Guard.options && ::Guard.options[:debug]
-        end
-      end
-
-      # Reset a line.
-      #
-      def reset_line
-        print(color_enabled? ? "\r\e[0m" : "\r\n")
-      end
-
-      # Clear the output.
-      #
-      def clear
-        system('clear;')
-      end
-
-      private
-
-      # Reset a color sequence.
-      #
-      # @deprecated
-      # @param [String] text the text
-      #
-      def reset_color(text)
-        deprecation('UI.reset_color(text) is deprecated, please use color(text, ' ') instead.')
-        color(text, '')
-      end
-
-      # Checks if color output can be enabled.
-      #
-      # @return [Boolean] whether color is enabled or not
-      #
-      def color_enabled?
-        if @color_enabled.nil?
-          if RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i
-            if ENV['ANSICON']
-              @color_enabled = true
-            else
-              begin
-                require 'rubygems' unless ENV['NO_RUBYGEMS']
-                require 'Win32/Console/ANSI'
-                @color_enabled = true
-              rescue LoadError
-                @color_enabled = false
-                info "You must 'gem install win32console' to use color on Windows"
-              end
-            end
-          else
-            @color_enabled = true
-          end
-        end
-
-        @color_enabled
-      end
-
-      # Colorizes a text message. See the constant in the UI class for possible
-      # color_options parameters. You can pass optionally :bright, a foreground
-      # color and a background color.
-      #
-      # @example
-      #
-      #   color('Hello World', :red, :bright)
-      #
-      # @param [String] the text to colorize
-      # @param [Array] color_options the color options
-      #
-      def color(text, *color_options)
-        color_code = ''
-        color_options.each do |color_option|
-          color_option = color_option.to_s
-          if color_option != ''
-            if !(color_option =~ /\d+/)
-              color_option = const_get("ANSI_ESCAPE_#{ color_option.upcase }")
-            end
-            color_code += ';' + color_option
-          end
-        end
-        color_enabled? ? "\e[0#{ color_code }m#{ text }\e[0m" : text
-      end
-
-    end
-
-    # Brighten the color
-    ANSI_ESCAPE_BRIGHT    = '1'
-
-    # Black foreground color
-    ANSI_ESCAPE_BLACK     = '30'
-
-    # Red foreground color
-    ANSI_ESCAPE_RED       = '31'
-
-    # Green foreground color
-    ANSI_ESCAPE_GREEN     = '32'
-
-    # Yellow foreground color
-    ANSI_ESCAPE_YELLOW    = '33'
-
-    # Blue foreground color
-    ANSI_ESCAPE_BLUE      = '34'
-
-    # Magenta foreground color
-    ANSI_ESCAPE_MAGENTA   = '35'
-
-    # Cyan foreground color
-    ANSI_ESCAPE_CYAN      = '36'
-
-    # White foreground color
-    ANSI_ESCAPE_WHITE     = '37'
-
-    # Black background color
-    ANSI_ESCAPE_BGBLACK   = '40'
-
-    # Red background color
-    ANSI_ESCAPE_BGRED     = '41'
-
-    # Green background color
-    ANSI_ESCAPE_BGGREEN   = '42'
-
-    # Yellow background color
-    ANSI_ESCAPE_BGYELLOW  = '43'
-
-    # Blue background color
-    ANSI_ESCAPE_BGBLUE    = '44'
-
-    # Magenta background color
-    ANSI_ESCAPE_BGMAGENTA = '45'
-
-    # Cyan background color
-    ANSI_ESCAPE_BGCYAN    = '46'
-
-    # White background color
-    ANSI_ESCAPE_BGWHITE   = '47'
-
-  end
-end
+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).
+  #
+  # If your Guard 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
+
+      # Show an info message.
+      #
+      # @param [String] message the message to show
+      # @option options [Boolean] reset whether to clean the output before
+      #
+      def info(message, options = { })
+        unless ENV['GUARD_ENV'] == 'test'
+          reset_line if options[:reset]
+          STDERR.puts color(message) if message != ''
+        end
+      end
+
+      # Show a red error message that is prefixed with ERROR.
+      #
+      # @param [String] message the message to show
+      # @option options [Boolean] reset whether to clean the output before
+      #
+      def error(message, options = { })
+        unless ENV['GUARD_ENV'] == 'test'
+          reset_line if options[:reset]
+          STDERR.puts color('ERROR: ', :red) + message
+        end
+      end
+
+      # Show a red deprecation message that is prefixed with DEPRECATION.
+      #
+      # @param [String] message the message to show
+      # @option options [Boolean] reset whether to clean the output before
+      #
+      def deprecation(message, options = { })
+        unless ENV['GUARD_ENV'] == 'test'
+          reset_line if options[:reset]
+          STDERR.puts color('DEPRECATION: ', :red) + message
+        end
+      end
+
+      # Show a debug message that is prefixed with DEBUG and a timestamp.
+      #
+      # @param [String] message the message to show
+      # @option options [Boolean] reset whether to clean the output before
+      #
+      def debug(message, options = { })
+        unless ENV['GUARD_ENV'] == 'test'
+          reset_line if options[:reset]
+          STDERR.puts color("DEBUG (#{Time.now.strftime('%T')}): ", :yellow) + message if ::Guard.options && ::Guard.options[:debug]
+        end
+      end
+
+      # Reset a line.
+      #
+      def reset_line
+        STDERR.print(color_enabled? ? "\r\e[0m" : "\r\n")
+      end
+
+      # Clear the output.
+      #
+      def clear
+        system('clear;')
+      end
+
+      private
+
+      # Reset a color sequence.
+      #
+      # @deprecated
+      # @param [String] text the text
+      #
+      def reset_color(text)
+        deprecation('UI.reset_color(text) is deprecated, please use color(text, ' ') instead.')
+        color(text, '')
+      end
+
+      # Checks if color output can be enabled.
+      #
+      # @return [Boolean] whether color is enabled or not
+      #
+      def color_enabled?
+        if @color_enabled.nil?
+          if RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i
+            if ENV['ANSICON']
+              @color_enabled = true
+            else
+              begin
+                require 'rubygems' unless ENV['NO_RUBYGEMS']
+                require 'Win32/Console/ANSI'
+                @color_enabled = true
+              rescue LoadError
+                @color_enabled = false
+                info "You must 'gem install win32console' to use color on Windows"
+              end
+            end
+          else
+            @color_enabled = true
+          end
+        end
+
+        @color_enabled
+      end
+
+      # Colorizes a text message. See the constant in the UI class for possible
+      # color_options parameters. You can pass optionally :bright, a foreground
+      # color and a background color.
+      #
+      # @example
+      #
+      #   color('Hello World', :red, :bright)
+      #
+      # @param [String] the text to colorize
+      # @param [Array] color_options the color options
+      #
+      def color(text, *color_options)
+        color_code = ''
+        color_options.each do |color_option|
+          color_option = color_option.to_s
+          if color_option != ''
+            if !(color_option =~ /\d+/)
+              color_option = const_get("ANSI_ESCAPE_#{ color_option.upcase }")
+            end
+            color_code += ';' + color_option
+          end
+        end
+        color_enabled? ? "\e[0#{ color_code }m#{ text }\e[0m" : text
+      end
+
+    end
+
+    # Brighten the color
+    ANSI_ESCAPE_BRIGHT    = '1'
+
+    # Black foreground color
+    ANSI_ESCAPE_BLACK     = '30'
+
+    # Red foreground color
+    ANSI_ESCAPE_RED       = '31'
+
+    # Green foreground color
+    ANSI_ESCAPE_GREEN     = '32'
+
+    # Yellow foreground color
+    ANSI_ESCAPE_YELLOW    = '33'
+
+    # Blue foreground color
+    ANSI_ESCAPE_BLUE      = '34'
+
+    # Magenta foreground color
+    ANSI_ESCAPE_MAGENTA   = '35'
+
+    # Cyan foreground color
+    ANSI_ESCAPE_CYAN      = '36'
+
+    # White foreground color
+    ANSI_ESCAPE_WHITE     = '37'
+
+    # Black background color
+    ANSI_ESCAPE_BGBLACK   = '40'
+
+    # Red background color
+    ANSI_ESCAPE_BGRED     = '41'
+
+    # Green background color
+    ANSI_ESCAPE_BGGREEN   = '42'
+
+    # Yellow background color
+    ANSI_ESCAPE_BGYELLOW  = '43'
+
+    # Blue background color
+    ANSI_ESCAPE_BGBLUE    = '44'
+
+    # Magenta background color
+    ANSI_ESCAPE_BGMAGENTA = '45'
+
+    # Cyan background color
+    ANSI_ESCAPE_BGCYAN    = '46'
+
+    # White background color
+    ANSI_ESCAPE_BGWHITE   = '47'
+
+  end
+end

data/lib/guard/version.rb

@@ -1,6 +1,6 @@
-module Guard
-  unless defined? Guard::VERSION
-    # The current gem version of Guard
-    VERSION = '0.8.4'
-  end
-end
+module Guard
+  unless defined? Guard::VERSION
+    # The current gem version of Guard
+    VERSION = '0.8.5'
+  end
+end

data/lib/guard/watcher.rb

@@ -1,110 +1,114 @@
-module Guard
-
-  # The watcher defines a RegExp that will be matched against file system modifications.
-  # When a watcher matches a change, an optional action block is executed to enable
-  # processing the file system change result.
-  #
-  class Watcher
-
-    attr_accessor :pattern, :action
-
-    # Initialize a file watcher.
-    #
-    # @param [String, Regexp] pattern the pattern to be watched by the guard
-    # @param [Block] action the action to execute before passing the result to the Guard
-    #
-    def initialize(pattern, action = nil)
-      @pattern, @action = pattern, action
-      @@warning_printed ||= false
-
-      # deprecation warning
-      if @pattern.is_a?(String) && @pattern =~ /(^(\^))|(>?(\\\.)|(\.\*))|(\(.*\))|(\[.*\])|(\$$)/
-        unless @@warning_printed
-          UI.info "*"*20 + "\nDEPRECATION WARNING!\n" + "*"*20
-          UI.info <<-MSG
-            You have a string in your Guardfile watch patterns that seem to represent a Regexp.
-            Guard matches String with == and Regexp with Regexp#match.
-            You should either use plain String (without Regexp special characters) or real Regexp.
-          MSG
-          @@warning_printed = true
-        end
-
-        UI.info "\"#{@pattern}\" has been converted to #{ Regexp.new(@pattern).inspect }\n"
-        @pattern = Regexp.new(@pattern)
-      end
-    end
-
-    # Finds the files that matches a Guard.
-    #
-    # @param [Guard::Guard] guard the guard which watchers are used
-    # @param [Array<String>] files the changed files
-    # @return [Array<String>] the matched files
-    #
-    def self.match_files(guard, files)
-      guard.watchers.inject([]) do |paths, watcher|
-        files.each do |file|
-          if matches = watcher.match_file?(file)
-            if watcher.action
-              result = watcher.call_action(matches)
-              paths << Array(result) if result.respond_to?(:empty?) && !result.empty?
-            else
-              paths << matches[0]
-            end
-          end
-        end
-
-        paths.flatten.map { |p| p.to_s }
-      end
-    end
-
-    # Test if a file would be matched by any of the Guards watchers.
-    #
-    # @param [Array<Guard::Guard>] guards the guards to use the watchers from
-    # @param [Array<String>] files the files to test
-    # @return [Boolean] Whether a file matches
-    #
-    def self.match_files?(guards, files)
-      guards.any? do |guard|
-        guard.watchers.any? do |watcher|
-          files.any? { |file| watcher.match_file?(file) }
-        end
-      end
-    end
-
-    # Test the watchers pattern against a file.
-    #
-    # @param [String] file the file to test
-    # @return [Boolean] whether the given file is matched
-    #
-    def match_file?(file)
-      if @pattern.is_a?(Regexp)
-        file.match(@pattern)
-      else
-        file == @pattern ? [file] : nil
-      end
-    end
-
-    # Test if any of the files is the Guardfile.
-    #
-    # @param [Array<String>] the files to test
-    # @return [Boolean] whether one of these files is the Guardfile
-    #
-    def self.match_guardfile?(files)
-      files.any? { |file| "#{ Dir.pwd }/#{ file }" == Dsl.guardfile_path }
-    end
-
-    # Executes a watcher action.
-    #
-    # @param [String, MatchData] the matched path or the match from the Regex
-    # @return [String] the final paths
-    #
-    def call_action(matches)
-      begin
-        @action.arity > 0 ? @action.call(matches) : @action.call
-      rescue Exception => e
-        UI.error "Problem with watch action!\n#{ e.message }\n\n#{ e.backtrace.join("\n") }"
-      end
-    end
-
-  end
-end
+module Guard
+
+  # The watcher defines a RegExp that will be matched against file system modifications.
+  # When a watcher matches a change, an optional action block is executed to enable
+  # processing the file system change result.
+  #
+  class Watcher
+
+    attr_accessor :pattern, :action
+
+    # Initialize a file watcher.
+    #
+    # @param [String, Regexp] pattern the pattern to be watched by the guard
+    # @param [Block] action the action to execute before passing the result to the Guard
+    #
+    def initialize(pattern, action = nil)
+      @pattern, @action = pattern, action
+      @@warning_printed ||= false
+
+      # deprecation warning
+      if @pattern.is_a?(String) && @pattern =~ /(^(\^))|(>?(\\\.)|(\.\*))|(\(.*\))|(\[.*\])|(\$$)/
+        unless @@warning_printed
+          UI.info "*"*20 + "\nDEPRECATION WARNING!\n" + "*"*20
+          UI.info <<-MSG
+            You have a string in your Guardfile watch patterns that seem to represent a Regexp.
+            Guard matches String with == and Regexp with Regexp#match.
+            You should either use plain String (without Regexp special characters) or real Regexp.
+          MSG
+          @@warning_printed = true
+        end
+
+        UI.info "\"#{@pattern}\" has been converted to #{ Regexp.new(@pattern).inspect }\n"
+        @pattern = Regexp.new(@pattern)
+      end
+    end
+
+    # Finds the files that matches a Guard.
+    #
+    # @param [Guard::Guard] guard the guard which watchers are used
+    # @param [Array<String>] files the changed files
+    # @return [Array<Object>] the matched watcher response
+    #
+    def self.match_files(guard, files)
+      guard.watchers.inject([]) do |paths, watcher|
+        files.each do |file|
+          if matches = watcher.match_file?(file)
+            if watcher.action
+              result = watcher.call_action(matches)
+              if guard.options[:any_return]
+                paths << result 
+              elsif result.respond_to?(:empty?) && !result.empty?
+                paths << Array(result)
+              end
+            else
+              paths << matches[0]
+            end
+          end
+        end
+        
+        guard.options[:any_return] ? paths : paths.flatten.map { |p| p.to_s }
+      end
+    end
+
+    # Test if a file would be matched by any of the Guards watchers.
+    #
+    # @param [Array<Guard::Guard>] guards the guards to use the watchers from
+    # @param [Array<String>] files the files to test
+    # @return [Boolean] Whether a file matches
+    #
+    def self.match_files?(guards, files)
+      guards.any? do |guard|
+        guard.watchers.any? do |watcher|
+          files.any? { |file| watcher.match_file?(file) }
+        end
+      end
+    end
+
+    # Test the watchers pattern against a file.
+    #
+    # @param [String] file the file to test
+    # @return [Boolean] whether the given file is matched
+    #
+    def match_file?(file)
+      if @pattern.is_a?(Regexp)
+        file.match(@pattern)
+      else
+        file == @pattern ? [file] : nil
+      end
+    end
+
+    # Test if any of the files is the Guardfile.
+    #
+    # @param [Array<String>] the files to test
+    # @return [Boolean] whether one of these files is the Guardfile
+    #
+    def self.match_guardfile?(files)
+      files.any? { |file| "#{ Dir.pwd }/#{ file }" == Dsl.guardfile_path }
+    end
+
+    # Executes a watcher action.
+    #
+    # @param [String, MatchData] the matched path or the match from the Regex
+    # @return [String] the final paths
+    #
+    def call_action(matches)
+      begin
+        @action.arity > 0 ? @action.call(matches) : @action.call
+      rescue Exception => e
+        UI.error "Problem with watch action!\n#{ e.message }\n\n#{ e.backtrace.join("\n") }"
+      end
+    end
+
+  end
+end