FileList
A FileList is essentially an array with helper methods to make file manipulation 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.
fl = FileList.new fl.include('./**/*') fl.exclude('./*~')
ARRAY_METHODS | = | Array.instance_methods - Object.instance_methods |
List of array methods (that are not in Object) that need to be delegated. | ||
MUST_DEFINE | = | %w[to_a inspect] |
List of additional methods that must be delegated. | ||
MUST_NOT_DEFINE | = | %w[to_a to_ary partition *] |
List of methods that should not be delegated here (we define special versions of them explicitly below). | ||
SPECIAL_RETURN | = | %w[ map collect sort sort_by select find_all reject grep compact flatten uniq values_at + - & | ] |
List of delegated methods that return new array values which need wrapping. | ||
DELEGATING_METHODS | = | (ARRAY_METHODS + MUST_DEFINE - MUST_NOT_DEFINE).sort.uniq |
DEFAULT_IGNORE_PATTERNS | = | [ /(^|[\/\\])CVS([\/\\]|$)/, /(^|[\/\\])\.svn([\/\\]|$)/, /(^|[\/\\])_darcs([\/\\]|$)/, /\.bak$/, /~$/, /(^|[\/\\])core$/ |
Create a new file list including the files listed. Similar to:
FileList.new(*args)
[ + ]
# File lib/more/facets/filelist.rb, line 439 def [](*args) new(*args) end
Clear the ignore patterns.
[ + ]
# File lib/more/facets/filelist.rb, line 460 def clear_ignore_patterns @exclude_patterns = [ /^$/ ] 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/more/facets/filelist.rb, line 169 def initialize(*patterns) @pending_add = [] @pending = false @exclude_patterns = DEFAULT_IGNORE_PATTERNS.dup @exclude_re = nil @items = [] patterns.each { |pattern| include(pattern) } yield self if block_given? end
Set the ignore patterns back to the default value. The default patterns will ignore files
- containing "CVS" in the file path
- containing ".svn" in the file path
- containing "_darcs" in the file path
- ending with ".bak"
- ending with "~"
- named "core"
Note that file names beginning with "." are automatically ignored by Ruby‘s glob patterns and are not specifically listed in the ignore patterns.
[ + ]
# File lib/more/facets/filelist.rb, line 455 def select_default_ignore_patterns @exclude_patterns = DEFAULT_IGNORE_PATTERNS.dup end
Redefine * to return either a string or a new file list.
[ + ]
# File lib/more/facets/filelist.rb, line 252 def *(other) result = @items * other case result when Array FileList.new.import(result) else result end end
Define equality.
[ + ]
# File lib/more/facets/filelist.rb, line 235 def ==(array) to_ary == array end
Alias for include
[ + ]
# File lib/more/facets/filelist.rb, line 273 def calculate_exclude_regexp ignores = [] @exclude_patterns.each do |pat| case pat when Regexp ignores << pat when /[*.]/ Dir[pat].each do |p| ignores << p end else ignores << Regexp.quote(pat) end end if ignores.empty? @exclude_re = /^$/ else re_str = ignores.collect { |p| "(" + p.to_s + ")" }.join("|") @exclude_re = Regexp.new(re_str) end end
[ + ]
# File lib/more/facets/filelist.rb, line 229 def clear_exclude @exclude_patterns = [] calculate_exclude_regexp if ! @pending end
[ + ]
# File lib/more/facets/filelist.rb, line 85 def clone sibling = self.class.new instance_variables.each do |ivar| value = self.instance_variable_get(ivar) sibling.instance_variable_set(ivar, value.rake_dup) end sibling end
Alias for clone
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.
[ + ]
# File lib/more/facets/filelist.rb, line 369 def egrep(pattern) each do |fn| open(fn) do |inf| count = 0 inf.each do |line| count += 1 if pattern.match(line) if block_given? yield fn, count, line else puts "#{fn}:#{count}:#{line}" end end end end end 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.
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/more/facets/filelist.rb, line 219 def exclude(*patterns) patterns.each do |pat| @exclude_patterns << pat end if ! @pending calculate_exclude_regexp reject! { |fn| fn =~ @exclude_re } end self end
Should the given file name be excluded?
[ + ]
# File lib/more/facets/filelist.rb, line 415 def exclude?(fn) calculate_exclude_regexp unless @exclude_re fn =~ @exclude_re end
Return a new array 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/more/facets/filelist.rb, line 360 def ext(newext='') collect { |fn| fn.ext(newext) } 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/more/facets/filelist.rb, line 336 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/more/facets/filelist.rb, line 347 def gsub!(pat, rep) each_with_index { |fn, i| self[i] = fn.gsub(pat,rep) } self end
[ + ]
# File lib/more/facets/filelist.rb, line 430 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/more/facets/filelist.rb, line 186 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
Resolve all the pending adds now.
[ + ]
# File lib/more/facets/filelist.rb, line 263 def resolve if @pending @pending = false @pending_add.each do |fn| resolve_add(fn) end @pending_add = [] resolve_exclude end self end
[ + ]
# File lib/more/facets/filelist.rb, line 293 def resolve_add(fn) case fn when Array fn.each { |f| self.resolve_add(f) } when %r{[*?]} add_matching(fn) else self << fn end end
[ + ]
# File lib/more/facets/filelist.rb, line 304 def resolve_exclude @exclude_patterns.each do |pat| case pat when Regexp reject! { |fn| fn =~ pat } when /[*.]/ reject_list = Dir[pat] reject! { |fn| reject_list.include?(fn) } else reject! { |fn| fn == pat } end end self end
Return a new FileList with the results of running sub against each element of the oringal list.
Example:
FileList['a.c', 'b.c'].sub(/\.c$/, '.o') => ['a.o', 'b.o']
[ + ]
# File lib/more/facets/filelist.rb, line 325 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/more/facets/filelist.rb, line 341 def sub!(pat, rep) each_with_index { |fn, i| self[i] = fn.sub(pat,rep) } self end
Return the internal array object.
[ + ]
# File lib/more/facets/filelist.rb, line 240 def to_a resolve @items end
Return the internal array object.
[ + ]
# File lib/more/facets/filelist.rb, line 246 def to_ary resolve @items end