class Guard::Watcher
enable processing the file system change result.
When a watcher matches a change, an optional action block is executed to
modifications.
The watcher defines a RegExp that will be matched against file system
def self.match_files(guard, files)
-
(Array
- the matched watcher response
Parameters:
-
files
(Array
) -- the changed files -
guard
(Guard::Plugin
) -- the Guard plugin which watchers are used
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) 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
def self.match_files?(plugins, files)
-
(Boolean)
- Whether a file matches
Parameters:
-
files
(Array
) -- the files to test -
plugins
(Array
) -- the Guard plugins to use the
def self.match_files?(plugins, files) plugins.any? do |plugin| plugin.watchers.any? do |watcher| files.any? { |file| watcher.match(file) } end end end
def self.match_guardfile?(files)
-
(Boolean)
- whether one of these files is the Guardfile
Parameters:
-
files
(Array
) -- the files to test
def self.match_guardfile?(files) files.any? { |file| File.expand_path(file) == ::Guard.evaluator.guardfile_path } end
def call_action(matches)
-
(String)
- the final paths
Parameters:
-
matches
(String, MatchData
) -- the matched path or the match from the
def call_action(matches) begin @action.arity > 0 ? @action.call(matches) : @action.call rescue Exception => e ::Guard::UI.error "Problem with watch action!\n#{ e.message }\n\n#{ e.backtrace.join("\n") }" end end
def initialize(pattern, action = nil)
-
action
(Block
) -- the action to execute before passing the result to -
pattern
(String, Regexp
) -- the pattern to be watched by 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 ::Guard::UI.info "*"*20 + "\nDEPRECATION WARNING!\n" + "*"*20 ::Guard::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 ::Guard::UI.info "\"#{@pattern}\" has been converted to #{ Regexp.new(@pattern).inspect }\n" @pattern = Regexp.new(@pattern) end end
def match(file)
-
(Array
- an array of matches (or containing a single path)
Parameters:
-
file
(String
) -- the file to test
def match(file) f = file deleted = file.start_with?('!') f = deleted ? f[1..-1] : f if @pattern.is_a?(Regexp) if m = f.match(@pattern) m = m.to_a m[0] = file m end else f == @pattern ? [file] : nil end end