Class: Rake::FileList
Relationships & Source Files | |
Inherits: | Object |
Defined in: | lib/rake/file_list.rb |
Overview
A FileList is essentially an array with a few helper methods defined to make file manipulation a bit easier.
FileLists are lazy. When given a list of glob patterns for possible files to be included in the file list, instead of searching the file structures to find the files, a FileList
holds the pattern for latter use.
This allows us to define a number of FileList
to match any number of files, but only search out the actual files when then FileList
itself is actually used. The key is that the first time an element of the FileList/Array is requested, the pending patterns are resolved into a real list of file names.
Constant Summary
-
ARRAY_METHODS =
List of array methods (that are not in
Object
) that need to be delegated.(Array.instance_methods - Object.instance_methods). map { |n| n.to_s }
-
DEFAULT_IGNORE_PATTERNS =
# File 'lib/rake/file_list.rb', line 374[ /(^|[\/\\])CVS([\/\\]|$)/, /(^|[\/\\])\.svn([\/\\]|$)/, /\.bak$/, /~$/ ]
-
DEFAULT_IGNORE_PROCS =
# File 'lib/rake/file_list.rb', line 380[ proc { |fn| fn =~ /(^|[\/\\])core$/ && ! File.directory?(fn) } ]
-
DELEGATING_METHODS =
# File 'lib/rake/file_list.rb', line 62(ARRAY_METHODS + MUST_DEFINE - MUST_NOT_DEFINE). map { |s| s.to_s }.sort.uniq
-
MUST_DEFINE =
List of additional methods that must be delegated.
%w[inspect <=>]
-
MUST_NOT_DEFINE =
List of methods that should not be delegated here (we define special versions of them explicitly below).
%w[to_a to_ary partition * <<]
-
SPECIAL_RETURN =
List of delegated methods that return new array values which need wrapping.
%w[ map collect sort sort_by select find_all reject grep compact flatten uniq values_at + - & | ]
Class Method Summary
-
.[](*args)
Create a new file list including the files listed.
-
.glob(pattern, *args)
Get a sorted list of files matching the pattern.
-
.new(*patterns) {|_self| ... } ⇒ FileList
constructor
Create a file list from the globbable patterns given.
Instance Method Summary
-
#*(other)
Redefine * to return either a string or a new file list.
- #<<(obj)
-
#==(array)
A FileList is equal through array equality.
-
#add(*filenames)
Alias for #include.
-
#clear_exclude
Clear all the exclude patterns so that we exclude nothing.
-
#egrep(pattern, *options)
Grep each of the files in the filelist using the given pattern.
-
#exclude(*patterns, &block)
Register a list of file name patterns that should be excluded from the list.
-
#excluded_from_list?(fn) ⇒ Boolean
Should the given file name be excluded from the list?
-
#existing
Return a new file list that only contains file names from the current file list that exist on the file system.
-
#existing!
Modify the current file list so that it contains only file name that exist on the file system.
-
#ext(newext = '')
Return a new
FileList
withString#ext
method applied to each member of the array. -
#gsub(pat, rep)
Return a new
FileList
with the results of runninggsub
against each element of the original list. -
#gsub!(pat, rep)
Same as #gsub except that the original file list is modified.
-
#include(*filenames)
(also: #add)
Add file names defined by glob patterns to the file list.
-
#is_a?(klass) ⇒ Boolean
(also: #kind_of?)
Lie about our class.
-
#kind_of?(klass)
Alias for #is_a?.
-
#pathmap(spec = nil)
Apply the pathmap spec to each of the included file names, returning a new file list with the modified paths.
-
#resolve
Resolve all the pending adds now.
-
#sub(pat, rep)
Return a new
FileList
with the results of runningsub
against each element of the original list. -
#sub!(pat, rep)
Same as #sub except that the original file list is modified.
-
#to_a
Return the internal array object.
-
#to_ary
Return the internal array object.
-
#to_s
Convert a
FileList
to a string by joining all elements with a space. -
#add_matching(pattern)
private
Add matching glob patterns.
Constructor Details
.new(*patterns) {|_self| ... } ⇒ FileList
Create a file list from the globbable patterns given. If you wish to perform multiple includes or excludes at object build time, use the “yield self” pattern.
Example:
file_list = FileList.new('lib/**/*.rb', 'test/test*.rb')
pkg_files = FileList.new('lib/**/*') do |fl|
fl.exclude(/\bCVS\b/)
end
# File 'lib/rake/file_list.rb', line 99
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
Class Method Details
.[](*args)
Create a new file list including the files listed. Similar to:
FileList.new(*args)
# File 'lib/rake/file_list.rb', line 393
def [](*args) new(*args) end
.glob(pattern, *args)
Get a sorted list of files matching the pattern. This method should be preferred to Dir and Dir.glob(pattern) because the files returned are guaranteed to be sorted.
# File 'lib/rake/file_list.rb', line 400
def glob(pattern, *args) Dir.glob(pattern, *args).sort end
Instance Method Details
#*(other)
Redefine * to return either a string or a new file list.
#<<(obj)
[ GitHub ]# File 'lib/rake/file_list.rb', line 199
def <<(obj) resolve @items << Rake.from_pathname(obj) self end
#==(array)
A FileList is equal through array equality.
# File 'lib/rake/file_list.rb', line 167
def ==(array) to_ary == array end
#add(*filenames)
Alias for #include.
# File 'lib/rake/file_list.rb', line 128
alias :add :include
#add_matching(pattern) (private)
Add matching glob patterns.
# File 'lib/rake/file_list.rb', line 346
def add_matching(pattern) FileList.glob(pattern).each do |fn| self << fn unless excluded_from_list?(fn) end end
#clear_exclude
Clear all the exclude patterns so that we exclude nothing.
# File 'lib/rake/file_list.rb', line 160
def clear_exclude @exclude_patterns = [] @exclude_procs = [] self end
#egrep(pattern, *options)
Grep each of the files in the filelist using the given pattern. If a block is given, call the block on each matching line, passing the file name, line number, and the matching line of text. If no block is given, a standard emacs style file:linenumber:line message will be printed to standard out. Returns the number of matched items.
# File 'lib/rake/file_list.rb', line 289
def egrep(pattern, * ) matched = 0 each do |fn| begin open(fn, "r", * ) 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
#exclude(*patterns, &block)
Register a list of file name patterns that should be excluded from the list. Patterns may be regular expressions, glob patterns or regular strings. In addition, a block given to exclude will remove entries that return true when given to the block.
Note that glob patterns are expanded against the file system. If a file is explicitly added to a file list, but does not exist in the file system, then an glob pattern in the exclude list will not exclude the file.
Examples:
FileList['a.c', 'b.c'].exclude("a.c") => ['b.c']
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']
If “a.c” is not a file, then …
FileList['a.c', 'b.c'].exclude("a.*") => ['a.c', 'b.c']
# File 'lib/rake/file_list.rb', line 150
def exclude(*patterns, &block) patterns.each do |pat| @exclude_patterns << Rake.from_pathname(pat) end @exclude_procs << block if block_given? resolve_exclude unless @pending self end
#excluded_from_list?(fn) ⇒ Boolean
Should the given file name be excluded from the list?
NOTE: This method was formerly named “exclude?”, but Rails introduced an exclude? method as an array method and setup a conflict with file list. We renamed the method to avoid confusion. If you were using “FileList#exclude?” in your user code, you will need to update.
# File 'lib/rake/file_list.rb', line 360
def excluded_from_list?(fn) return true if @exclude_patterns.any? do |pat| case pat when Regexp fn =~ pat when /[*?]/ File.fnmatch?(pat, fn, File::FNM_PATHNAME) else fn == pat end end @exclude_procs.any? { |p| p.call(fn) } end
#existing
Return a new file list that only contains file names from the current file list that exist on the file system.
# File 'lib/rake/file_list.rb', line 316
def existing select { |fn| File.exist?(fn) } end
#existing!
Modify the current file list so that it contains only file name that exist on the file system.
# File 'lib/rake/file_list.rb', line 322
def existing! resolve @items = @items.select { |fn| File.exist?(fn) } self end
#ext(newext = '')
Return a new FileList
with String#ext
method applied to each member of the array.
This method is a shortcut for:
array.collect { |item| item.ext(newext) }
ext
is a user added method for the Array class.
# File 'lib/rake/file_list.rb', line 280
def ext(newext='') collect { |fn| fn.ext(newext) } end
#gsub(pat, rep)
Return a new FileList
with the results of running gsub
against each element of the original list.
Example:
FileList['lib/test/file', 'x/y'].gsub(/\//, "\\")
#=> ['lib\\test\\file', 'x\\y']
# File 'lib/rake/file_list.rb', line 249
def gsub(pat, rep) inject(FileList.new) { |res, fn| res << fn.gsub(pat, rep) } end
#gsub!(pat, rep)
Same as #gsub except that the original file list is modified.
# File 'lib/rake/file_list.rb', line 260
def gsub!(pat, rep) each_with_index { |fn, i| self[i] = fn.gsub(pat, rep) } self end
#include(*filenames) Also known as: #add
Add file names defined by glob patterns to the file list. If an array is given, add each element of the array.
Example:
file_list.include("*.java", "*.cfg")
file_list.include %w( math.c lib.h *.o )
# File 'lib/rake/file_list.rb', line 116
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
#is_a?(klass) ⇒ Boolean
Also known as: #kind_of?
Lie about our class.
# File 'lib/rake/file_list.rb', line 183
def is_a?(klass) klass == Array || super(klass) end
#kind_of?(klass)
Alias for #is_a?.
# File 'lib/rake/file_list.rb', line 186
alias kind_of? is_a?
#pathmap(spec = nil)
Apply the pathmap spec to each of the included file names, returning a new file list with the modified paths. (See String#pathmap
for details.)
# File 'lib/rake/file_list.rb', line 268
def pathmap(spec=nil) collect { |fn| fn.pathmap(spec) } end
#resolve
Resolve all the pending adds now.
# File 'lib/rake/file_list.rb', line 206
def resolve if @pending @pending = false @pending_add.each do |fn| resolve_add(fn) end @pending_add = [] resolve_exclude end self end
#sub(pat, rep)
Return a new FileList
with the results of running sub
against each element of the original list.
Example:
FileList['a.c', 'b.c'].sub(/\.c$/, '.o') => ['a.o', 'b.o']
# File 'lib/rake/file_list.rb', line 238
def sub(pat, rep) inject(FileList.new) { |res, fn| res << fn.sub(pat, rep) } end
#sub!(pat, rep)
Same as #sub except that the original file list is modified.
# File 'lib/rake/file_list.rb', line 254
def sub!(pat, rep) each_with_index { |fn, i| self[i] = fn.sub(pat, rep) } self end
#to_a
Return the internal array object.
# File 'lib/rake/file_list.rb', line 172
def to_a resolve @items end
#to_ary
Return the internal array object.
# File 'lib/rake/file_list.rb', line 178
def to_ary to_a end
#to_s
Convert a FileList
to a string by joining all elements with a space.
# File 'lib/rake/file_list.rb', line 340
def to_s resolve self.join(' ') end