guard 0.7.0 → 0.8.0

data/lib/guard/version.rb

@@ -1,3 +1,6 @@
 module Guard
-  VERSION = "0.7.0" unless defined? Guard::VERSION
+  unless defined? Guard::VERSION
+    # The current gem version of Guard
+    VERSION = '0.8.0'
+  end
 end

data/lib/guard/watcher.rb

@@ -1,7 +1,18 @@
 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
@@ -10,14 +21,25 @@ module Guard
       if @pattern.is_a?(String) && @pattern =~ /(^(\^))|(>?(\\\.)|(\.\*))|(\(.*\))|(\[.*\])|(\$$)/
         unless @@warning_printed
           UI.info "*"*20 + "\nDEPRECATION WARNING!\n" + "*"*20
-          UI.info "You have strings in your Guardfile's watch patterns that seem to represent regexps.\nGuard matchs String with == and Regexp with Regexp#match.\nYou should either use plain String (without Regexp special characters) or real Regexp.\n"
+          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"
+
+        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|
@@ -30,10 +52,17 @@ module Guard
             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|
@@ -42,6 +71,11 @@ module Guard
       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)
@@ -50,15 +84,25 @@ module Guard
       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 }
+      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")}"
+        UI.error "Problem with watch action!\n#{ e.message }\n\n#{ e.backtrace.join("\n") }"
       end
     end
 

data/man/guard.1

@@ -41,7 +41,7 @@ Tells Guard to watch PATH instead of \fB\./\fR\.
 .P
 \fB\-G\fR, \fB\-\-guardfile\fR \fIFILE\fR Tells Guard to use FILE as its Guardfile instead of \fB\./Guardfile\fR or \fB~/\.Guardfile\fR\.
 .
-.SS "init <a href=\"guard\.html\">GUARD</a>"
+.SS "init [GUARD]"
 If no Guardfile is present in the current directory, creates an empty Guardfile\.
 .
 .P

data/man/guard.1.html

@@ -112,7 +112,7 @@
 <p><code>-G</code>, <code>--guardfile</code> <var>FILE</var>
   Tells Guard to use FILE as its Guardfile instead of <code>./Guardfile</code> or <code>~/.Guardfile</code>.</p>
 
-<h3 id="init-GUARD">init <a href="guard.html">GUARD</a></h3>
+<h3 id="init-GUARD-">init [GUARD]</h3>
 
 <p>If no Guardfile is present in the current directory, creates an empty Guardfile.</p>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-14 00:00:00.000000000Z
+date: 2011-09-28 00:00:00.000000000Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70188716349680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70188716349680
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70247827024180 !ruby/object:Gem::Requirement
+  requirement: &70188716356800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70247827024180
+  version_requirements: *70188716356800
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70247827022860 !ruby/object:Gem::Requirement
+  requirement: &70188716375700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +43,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70247827022860
+  version_requirements: *70188716375700
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70247827021760 !ruby/object:Gem::Requirement
+  requirement: &70188716379040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,18 +54,29 @@ dependencies:
         version: 0.3.1
   type: :development
   prerelease: false
-  version_requirements: *70247827021760
+  version_requirements: *70188716379040
 - !ruby/object:Gem::Dependency
-  name: thor
-  requirement: &70247827021080 !ruby/object:Gem::Requirement
+  name: yard
+  requirement: &70188716412560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.6
-  type: :runtime
+        version: 0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: *70188716412560
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: &70188716830780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :development
   prerelease: false
-  version_requirements: *70247827021080
+  version_requirements: *70188716830780
 description: Guard is a command line tool to easily handle events on file system modifications.
 email:
 - thibaud@thibaud.me
@@ -70,6 +92,7 @@ files:
 - lib/guard/cli.rb
 - lib/guard/dsl.rb
 - lib/guard/dsl_describer.rb
+- lib/guard/group.rb
 - lib/guard/guard.rb
 - lib/guard/hook.rb
 - lib/guard/interactor.rb