class Ratch::FileList
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.
Constants
- ARRAY_METHODS
List of array methods (that are not in
Object
) that need to be delegated.- DEFAULT_IGNORE_PATTERNS
- DEFAULT_IGNORE_PROCS
- DELEGATING_METHODS
- MUST_DEFINE
List of additional methods that must be delegated.
- MUST_NOT_DEFINE
List of methods that should not be delegated here (we define special versions of them explicitly below).
- SPECIAL_RETURN
List of delegated methods that return new array values which need wrapping.
Public Class Methods
Create a new file list including the files listed. Similar to:
FileList.new(*args)
# File lib/ratch/file_list.rb, line 83 def self.[](*args) new(*args) end
Same a new but removes the default exclusions.
# File lib/ratch/file_list.rb, line 88 def self.all(*args) obj = new(*args) obj.clear_exclude obj end
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/ratch/file_list.rb, line 105 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
Public Instance Methods
Redefine * to return either a string or a new file list.
# File lib/ratch/file_list.rb, line 198 def *(other) result = @items * other case result when Array FileList.new.import(result) else result end end
Define equality.
# File lib/ratch/file_list.rb, line 176 def ==(array) to_ary == array end
Clear all the exclude patterns so that we exclude nothing.
# File lib/ratch/file_list.rb, line 169 def clear_exclude @exclude_patterns = [] @exclude_procs = [] self end
# File lib/ratch/file_list.rb, line 390 def clone sibling = dup sibling.freeze if frozen? sibling end
Clone an object by making a new object and setting all the instance variables to the same values.
# File lib/ratch/file_list.rb, line 379 def dup sibling = self.class.new instance_variables.each do |ivar| value = self.instance_variable_get(ivar) new_value = value.clone rescue value sibling.instance_variable_set(ivar, new_value) end sibling.taint if tainted? sibling end
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 emac style file:linenumber:line message will be printed to standard out. Returns the number of matched items.
# File lib/ratch/file_list.rb, line 293 def egrep(pattern, *options) matched = 0 each do |fn| begin open(fn, "rb", *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 puts "Error while processing '#{fn}': #{ex}" end end matched end
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/ratch/file_list.rb, line 156 def exclude(*patterns, &block) patterns.each do |pat| @exclude_patterns << pat end if block_given? @exclude_procs << block end resolve_exclude if ! @pending self end
Should the given file name be excluded?
# File lib/ratch/file_list.rb, line 358 def exclude?(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
Return a new file list that only contains file names from the current file list that exist on the file system.
# File lib/ratch/file_list.rb, line 320 def existing select { |fn| File.exist?(fn) } end
Modify the current file list so that it contains only file name that exist on the file system.
# File lib/ratch/file_list.rb, line 326 def existing! resolve @items = @items.select { |fn| File.exist?(fn) } self end
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/ratch/file_list.rb, line 252 def gsub(pat, rep) inject(FileList.new) { |res, fn| res << fn.gsub(pat,rep) } end
Same as gsub
except that the original file list is modified.
# File lib/ratch/file_list.rb, line 263 def gsub!(pat, rep) each_with_index { |fn, i| self[i] = fn.gsub(pat,rep) } self end
# File lib/ratch/file_list.rb, line 372 def import(array) @items = array self end
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/ratch/file_list.rb, line 122 def include(*filenames) # TODO: check for pending filenames.each do |fn| if fn.respond_to? :to_ary include(*fn.to_ary) else @pending_add << fn end end @pending = true self end
Lie about our class.
# File lib/ratch/file_list.rb, line 192 def is_a?(klass) klass == Array || super(klass) end
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/ratch/file_list.rb, line 271 def pathmap(spec=nil) collect { |fn| fn.pathmap(spec) } end
Resolve all the pending adds now.
# File lib/ratch/file_list.rb, line 209 def resolve if @pending @pending = false @pending_add.each do |fn| resolve_add(fn) end @pending_add = [] resolve_exclude end self end
Return a new FileList
with the results of running sub
against each element of the orignal list.
Example:
FileList['a.c', 'b.c'].sub(/\.c$/, '.o') => ['a.o', 'b.o']
# File lib/ratch/file_list.rb, line 241 def sub(pat, rep) inject(FileList.new) { |res, fn| res << fn.sub(pat,rep) } end
Same as sub
except that the oringal file list is modified.
# File lib/ratch/file_list.rb, line 257 def sub!(pat, rep) each_with_index { |fn, i| self[i] = fn.sub(pat,rep) } self end
Return the internal array object.
# File lib/ratch/file_list.rb, line 181 def to_a resolve @items end
Return the internal array object.
# File lib/ratch/file_list.rb, line 187 def to_ary to_a end
Convert a FileList
to a string by joining all elements with a space.
# File lib/ratch/file_list.rb, line 344 def to_s resolve self.join(' ') end
Private Instance Methods
Add matching glob patterns.
# File lib/ratch/file_list.rb, line 350 def add_matching(pattern) Dir[pattern].each do |fn| self << fn unless exclude?(fn) end end
# File lib/ratch/file_list.rb, line 219 def resolve_add(fn) case fn when %r{[*?\[\{]} add_matching(fn) else self << fn end end
# File lib/ratch/file_list.rb, line 229 def resolve_exclude reject! { |fn| exclude?(fn) } self end