class Rake::FileList
list of file names.
FileList/Array is requested, the pending patterns are resolved into a real
actually used. The key is that the first time an element of the
files, but only search out the actual files when then FileList itself is
This allows us to define a number of FileList to match any number of
to find the files, a FileList holds the pattern for latter use.
to be included in the file list, instead of searching the file structures
FileLists are lazy. When given a list of glob patterns for possible files
make file manipulation a bit easier.
A FileList is essentially an array with a few helper methods defined to
#
def *(other)
def *(other) result = @items * other case result when Array self.class.new.import(result) else result end end
def <<(obj)
def <<(obj) resolve @items << Rake.from_pathname(obj) self end
def ==(array)
def ==(array) to_ary == array end
def [](*args)
Create a new file list including the files listed. Similar to:
def [](*args) new(*args) end
def add_matching(pattern)
def add_matching(pattern) self.class.glob(pattern).each do |fn| self << fn unless excluded_from_list?(fn) end end
def clear_exclude
def clear_exclude @exclude_patterns = [] @exclude_procs = [] self end
def egrep(pattern, *options)
a standard emacs style file:linenumber:line message will be printed to
name, line number, and the matching line of text. If no block is given,
block is given, call the block on each matching line, passing the file
Grep each of the files in the filelist using the given pattern. If a
def egrep(pattern, *options) matched = 0 each do |fn| begin File.open(fn, "r", *options) do |inf| count = 0 inf.each do |line| count += 1 if pattern.match(line) matched += 1 if block_given? yield fn, count, line else puts "#{fn}:#{count}:#{line}" end end end end rescue StandardError => ex $stderr.puts "Error while processing '#{fn}': #{ex}" end end matched end
def exclude(*patterns, &block)
FileList['a.c', 'b.c'].exclude("a.*") => ['a.c', 'b.c']
If "a.c" is not a file, then ...
FileList['a.c', 'b.c'].exclude("a.*") => ['b.c']
If "a.c" is a file, then ...
FileList['a.c', 'b.c'].exclude(/^a/) => ['b.c']
FileList['a.c', 'b.c'].exclude("a.c") => ['b.c']
Examples:
file.
system, then an glob pattern in the exclude list will not exclude the
is explicitly added to a file list, but does not exist in the file
Note that glob patterns are expanded against the file system. If a file
return true when given to the block.
strings. In addition, a block given to exclude will remove entries that
list. Patterns may be regular expressions, glob patterns or regular
Register a list of file name patterns that should be excluded from the
def exclude(*patterns, &block) patterns.each do |pat| if pat.respond_to? :to_ary exclude(*pat.to_ary) else @exclude_patterns << Rake.from_pathname(pat) end end @exclude_procs << block if block_given? resolve_exclude unless @pending self end
def excluded_from_list?(fn)
confusion. If you were using "FileList#exclude?" in your user
conflict with file list. We renamed the method to avoid
introduced an exclude? method as an array method and setup a
NOTE: This method was formerly named "exclude?", but Rails
Should the given file name be excluded from the list?
def excluded_from_list?(fn) return true if @exclude_patterns.any? do |pat| case pat when Regexp fn =~ pat when GLOB_PATTERN flags = File::FNM_PATHNAME # Ruby <= 1.9.3 does not support File::FNM_EXTGLOB flags |= File::FNM_EXTGLOB if defined? File::FNM_EXTGLOB File.fnmatch?(pat, fn, flags) else fn == pat end end @exclude_procs.any? { |p| p.call(fn) } end
def existing
Return a new file list that only contains file names from the current
def existing select { |fn| File.exist?(fn) }.uniq end
def existing!
Modify the current file list so that it contains only file name that
def existing! resolve @items = @items.select { |fn| File.exist?(fn) }.uniq self end
def ext(newext="")
array.collect { |item| item.ext(newext) }
This method is a shortcut for:
each member of the array.
Return a new FileList with String#ext method applied to
def ext(newext="") collect { |fn| fn.ext(newext) } end
def glob(pattern, *args)
should be preferred to Dir[pattern] and Dir.glob(pattern) because
Get a sorted list of files matching the pattern. This method
def glob(pattern, *args) Dir.glob(pattern, *args).sort end
def gsub(pat, rep)
=> ['lib\\test\\file', 'x\\y']
FileList['lib/test/file', 'x/y'].gsub(/\//, "\\")
Example:
element of the original list.
Return a new FileList with the results of running +gsub+ against each
def gsub(pat, rep) inject(self.class.new) { |res, fn| res << fn.gsub(pat, rep) } end
def gsub!(pat, rep)
def gsub!(pat, rep) each_with_index { |fn, i| self[i] = fn.gsub(pat, rep) } self end
def import(array) # :nodoc:
def import(array) # :nodoc: @items = array self end
def include(*filenames)
file_list.include %w( math.c lib.h *.o )
file_list.include("*.java", "*.cfg")
Example:
is given, add each element of the array.
Add file names defined by glob patterns to the file list. If an array
def include(*filenames) # TODO: check for pending filenames.each do |fn| if fn.respond_to? :to_ary include(*fn.to_ary) else @pending_add << Rake.from_pathname(fn) end end @pending = true self end
def initialize(*patterns)
end
fl.exclude(/\bCVS\b/)
pkg_files = FileList.new('lib/**/*') do |fl|
file_list = FileList.new('lib/**/*.rb', 'test/test*.rb')
Example:
"yield self" pattern.
perform multiple includes or excludes at object build time, use the
Create a file list from the globbable patterns given. If you wish to
def initialize(*patterns) @pending_add = [] @pending = false @exclude_patterns = DEFAULT_IGNORE_PATTERNS.dup @exclude_procs = DEFAULT_IGNORE_PROCS.dup @items = [] patterns.each { |pattern| include(pattern) } yield self if block_given? end
def is_a?(klass)
def is_a?(klass) klass == Array || super(klass) end
def partition(&block) # :nodoc:
be FileLists in this version.
FileList version of partition. Needed because the nested arrays should
def partition(&block) # :nodoc: resolve result = @items.partition(&block) [ self.class.new.import(result[0]), self.class.new.import(result[1]), ] end
def pathmap(spec=nil, &block)
new file list with the modified paths. (See String#pathmap for
Apply the pathmap spec to each of the included file names, returning a
def pathmap(spec=nil, &block) collect { |fn| fn.pathmap(spec, &block) } end
def resolve
def resolve if @pending @pending = false @pending_add.each do |fn| resolve_add(fn) end @pending_add = [] resolve_exclude end self end
def resolve_add(fn) # :nodoc:
def resolve_add(fn) # :nodoc: case fn when GLOB_PATTERN add_matching(fn) else self << fn end end
def resolve_exclude # :nodoc:
def resolve_exclude # :nodoc: reject! { |fn| excluded_from_list?(fn) } self end
def sub(pat, rep)
FileList['a.c', 'b.c'].sub(/\.c$/, '.o') => ['a.o', 'b.o']
Example:
element of the original list.
Return a new FileList with the results of running +sub+ against each
def sub(pat, rep) inject(self.class.new) { |res, fn| res << fn.sub(pat, rep) } end
def sub!(pat, rep)
def sub!(pat, rep) each_with_index { |fn, i| self[i] = fn.sub(pat, rep) } self end
def to_a
def to_a resolve @items end
def to_ary
def to_ary to_a end
def to_s
def to_s resolve self.join(" ") end