guard 1.8.3 → 2.0.0.pre

data/lib/guard/ui.rb

@@ -1,5 +1,7 @@
 require 'lumberjack'
 
+require 'guard/ui/colors'
+
 module Guard
 
   # The UI class helps to format messages for the user. Everything that is logged
@@ -10,6 +12,7 @@ module Guard
   # processing, please just write it to STDOUT with `puts`.
   #
   module UI
+    include Colors
 
     class << self
 
@@ -17,8 +20,8 @@ module Guard
       #
       def logger
         @logger ||= begin
-          options = self.options.dup
-          Lumberjack::Logger.new(options.delete(:device) || $stderr, options)
+          opts = options.marshal_dump
+          Lumberjack::Logger.new(opts.delete(:device) { $stderr }, opts)
         end
       end
 
@@ -27,7 +30,7 @@ module Guard
       # @return [Hash] the logger options
       #
       def options
-        @options ||= { :level => :info, :template => ':time - :severity - :message', :time_format => '%H:%M:%S' }
+        @options ||= ::Guard::Options.new(level: :info, template: ':time - :severity - :message', time_format: '%H:%M:%S')
       end
 
       # Set the logger options
@@ -38,7 +41,7 @@ module Guard
       # @option options [String] time_format the time format
       #
       def options=(options)
-        @options = options
+        @options = ::Guard::Options.new(options)
       end
 
       # Show an info message.
@@ -47,10 +50,10 @@ module Guard
       # @option options [Boolean] reset whether to clean the output before
       # @option options [String] plugin manually define the calling plugin
       #
-      def info(message, options = { })
+      def info(message, options = {})
         filter(options[:plugin]) do |plugin|
           reset_line if options[:reset]
-          self.logger.info(message, plugin)
+          logger.info(message, plugin)
         end
       end
 
@@ -60,10 +63,10 @@ module Guard
       # @option options [Boolean] reset whether to clean the output before
       # @option options [String] plugin manually define the calling plugin
       #
-      def warning(message, options = { })
+      def warning(message, options = {})
         filter(options[:plugin]) do |plugin|
           reset_line if options[:reset]
-          self.logger.warn(color(message, :yellow), plugin)
+          logger.warn(color(message, :yellow), plugin)
         end
       end
 
@@ -73,10 +76,10 @@ module Guard
       # @option options [Boolean] reset whether to clean the output before
       # @option options [String] plugin manually define the calling plugin
       #
-      def error(message, options = { })
+      def error(message, options = {})
         filter(options[:plugin]) do |plugin|
           reset_line if options[:reset]
-          self.logger.error(color(message, :red), plugin)
+          logger.error(color(message, :red), plugin)
         end
       end
 
@@ -87,10 +90,12 @@ module Guard
       # @option options [Boolean] reset whether to clean the output before
       # @option options [String] plugin manually define the calling plugin
       #
-      def deprecation(message, options = { })
+      def deprecation(message, options = {})
+        return unless ::Guard.options.show_deprecations
+
         filter(options[:plugin]) do |plugin|
           reset_line if options[:reset]
-          self.logger.warn(color(message, :yellow), plugin)
+          logger.warn(color(message, :yellow), plugin)
         end
       end
 
@@ -100,10 +105,10 @@ module Guard
       # @option options [Boolean] reset whether to clean the output before
       # @option options [String] plugin manually define the calling plugin
       #
-      def debug(message, options = { })
+      def debug(message, options = {})
         filter(options[:plugin]) do |plugin|
           reset_line if options[:reset]
-          self.logger.debug(color(message, :yellow), plugin)
+          logger.debug(color(message, :yellow), plugin)
         end
       end
 
@@ -116,7 +121,7 @@ module Guard
       # Clear the output if clearable.
       #
       def clear(options = {})
-        if ::Guard.options[:clear] && (@clearable || options[:force])
+        if ::Guard.options.clear && (@clearable || options[:force])
           @clearable = false
           system('clear;')
         end
@@ -142,8 +147,8 @@ module Guard
           groups  = ::Guard.scope[:groups] || []
         end
 
-        scope_message ||= plugins.join(',') unless plugins.empty?
-        scope_message ||= groups.join(',') unless groups.empty?
+        scope_message ||= plugins.map(&:title).join(', ') unless plugins.empty?
+        scope_message ||= groups.map(&:title).join(', ') unless groups.empty?
         scope_message ||= 'all'
 
         info "#{ action } #{ scope_message }"
@@ -159,8 +164,8 @@ module Guard
       # @yieldparam [String] param the calling plugin name
       #
       def filter(plugin)
-        only   = self.options[:only]
-        except = self.options[:except]
+        only   = options.only
+        except = options.except
         plugin = plugin || calling_plugin_name
 
         if (!only && !except) || (only && only.match(plugin)) || (except && !except.match(plugin))
@@ -179,16 +184,6 @@ module Guard
         name ? name[1].split('/').map { |part| part.split(/[^a-z0-9]/i).map { |word| word.capitalize }.join }.join('::') : 'Guard'
       end
 
-      # 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
@@ -243,56 +238,5 @@ module Guard
 
     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/ui/colors.rb

@@ -0,0 +1,60 @@
+module Guard
+  module UI
+
+    module Colors
+
+      # 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
+end

data/lib/guard/version.rb

@@ -1,4 +1,3 @@
 module Guard
-  # The current gem version of Guard
-  VERSION = '1.8.3'
+  VERSION = '2.0.0.pre'
 end

data/lib/guard/watcher.rb

@@ -1,19 +1,22 @@
+require 'guard/ui'
+
 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.
+  # 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
 
-    require 'guard/ui'
-
     attr_accessor :pattern, :action
 
-    # Initialize a file watcher.
+    # Initializes a file watcher.
     #
-    # @param [String, Regexp] pattern the pattern to be watched by the Guard plugin
-    # @param [Block] action the action to execute before passing the result to the Guard plugin
+    # @param [String, Regexp] pattern the pattern to be watched by the Guard
+    #   plugin
+    # @param [Block] action the action to execute before passing the result to
+    #   the Guard plugin
     #
     def initialize(pattern, action = nil)
       @pattern, @action = pattern, action
@@ -36,14 +39,15 @@ module Guard
       end
     end
 
-    # Finds the files that matches a Guard.
+    # Finds the files that matches a Guard plugin.
     #
-    # @param [Guard::Guard] guard the Guard plugin which watchers are used
+    # @param [Guard::Plugin] guard the Guard plugin which watchers are used
     # @param [Array<String>] files the changed files
     # @return [Array<Object>] the matched watcher response
     #
     def self.match_files(guard, files)
       return [] if files.empty?
+
       guard.watchers.inject([]) do |paths, watcher|
         files.each do |file|
           if matches = watcher.match(file)
@@ -64,31 +68,35 @@ module Guard
       end
     end
 
-    # Test if a file would be matched by any of the Guard plugin watchers.
+    # Tests if a file would be matched by any of the Guard plugin watchers.
     #
-    # @param [Array<Guard::Guard>] guards the Guard plugins to use the watchers from
+    # @param [Array<Guard::Plugin>] plugins the Guard plugins 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|
+    def self.match_files?(plugins, files)
+      plugins.any? do |plugin|
+        plugin.watchers.any? do |watcher|
           files.any? { |file| watcher.match(file) }
         end
       end
     end
 
-    # @deprecated Use .match instead
+    # Tests if any of the files is the Guardfile.
     #
-    def match_file?(file)
-      ::Guard::UI.info "Guard::Watcher.match_file? is deprecated, please use Guard::Watcher.match instead."
-      match(file)
+    # @param [Array<String>] files 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 }" == ::Guard.evaluator.guardfile_path }
     end
 
     # Test the watchers pattern against a file.
     #
     # @param [String] file the file to test
-    # @return [Array<String>] an array of matches (or containing a single path if the pattern is a string)
+    # @return [Array<String>] an array of matches (or containing a single path
+    #   if the pattern is a string)
     #
     def match(file)
       f = file
@@ -105,18 +113,10 @@ module Guard
       end
     end
 
-    # Test if any of the files is the Guardfile.
-    #
-    # @param [Array<String>] files 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] matches the matched path or the match from the Regex
+    # @param [String, MatchData] matches the matched path or the match from the
+    #   Regex
     # @return [String] the final paths
     #
     def call_action(matches)

data/man/guard.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GUARD" "1" "December 2012" "" ""
+.TH "GUARD" "1" "September 2013" "" ""
 .
 .SH "NAME"
 \fBguard\fR \- Guard keeps an eye on your file modifications\.
@@ -98,11 +98,11 @@ Thibaud Guillaume\-Gentil is the main author\.
 .P
 A list of contributors based on all commits can be found here: https://github\.com/guard/guard/contributors
 .
-.P
-For an exhaustive list of all the contributors, please see the CHANGELOG: https://github\.com/guard/guard/blob/master/CHANGELOG\.md
+.SH "CHANGELOG"
+The changelog can be found at: https://github\.com/guard/guard/blob/master/CHANGELOG\.md
 .
 .P
 This manual has been written by Remy Coutable\.
 .
 .SH "WWW"
-https://github\.com/guard/guard
+http://guardgem\.org/

data/man/guard.1.html

@@ -59,6 +59,7 @@
     <a href="#COMMANDS">COMMANDS</a>
     <a href="#EXAMPLES">EXAMPLES</a>
     <a href="#AUTHORS-CONTRIBUTORS">AUTHORS / CONTRIBUTORS</a>
+    <a href="#CHANGELOG">CHANGELOG</a>
     <a href="#WWW">WWW</a>
   </div>
 
@@ -173,19 +174,20 @@ For instance to initialize guard-rspec, run <code>guard init rspec</code>.</p>
 <p>A list of contributors based on all commits can be found here:
 https://github.com/guard/guard/contributors</p>
 
-<p>For an exhaustive list of all the contributors, please see the CHANGELOG:
-https://github.com/guard/guard/blob/master/CHANGELOG.md</p>
+<h2 id="CHANGELOG">CHANGELOG</h2>
+
+<p>The changelog can be found at: https://github.com/guard/guard/blob/master/CHANGELOG.md</p>
 
 <p>This manual has been written by Remy Coutable.</p>
 
 <h2 id="WWW">WWW</h2>
 
-<p>https://github.com/guard/guard</p>
+<p>http://guardgem.org/</p>
 
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>December 2012</li>
+    <li class='tc'>September 2013</li>
     <li class='tr'>guard(1)</li>
   </ol>