Class | Rake::FileList |
In: |
lib/rake.rb
|
Parent: | Object |
######################################################################### 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.
ARRAY_METHODS | = | (Array.instance_methods - Object.instance_methods).map { |n| n.to_s } | 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).collect{ |s| s.to_s }.sort.uniq | ||
DEFAULT_IGNORE_PATTERNS | = | [ /(^|[\/\\])CVS([\/\\]|$)/, /(^|[\/\\])\.svn([\/\\]|$)/, /\.bak$/, /~$/ | ||
DEFAULT_IGNORE_PROCS | = | [ proc { |fn| fn =~ /(^|[\/\\])core$/ && ! File.directory?(fn) } |
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.rb, line 1272 1272: def initialize(*patterns) 1273: @pending_add = [] 1274: @pending = false 1275: @exclude_patterns = DEFAULT_IGNORE_PATTERNS.dup 1276: @exclude_procs = DEFAULT_IGNORE_PROCS.dup 1277: @exclude_re = nil 1278: @items = [] 1279: patterns.each { |pattern| include(pattern) } 1280: yield self if block_given? 1281: end
# File lib/rake.rb, line 1388 1388: def calculate_exclude_regexp 1389: ignores = [] 1390: @exclude_patterns.each do |pat| 1391: case pat 1392: when Regexp 1393: ignores << pat 1394: when /[*?]/ 1395: Dir[pat].each do |p| ignores << p end 1396: else 1397: ignores << Regexp.quote(pat) 1398: end 1399: end 1400: if ignores.empty? 1401: @exclude_re = /^$/ 1402: else 1403: re_str = ignores.collect { |p| "(" + p.to_s + ")" }.join("|") 1404: @exclude_re = Regexp.new(re_str) 1405: end 1406: 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.
# File lib/rake.rb, line 1483 1483: def egrep(pattern) 1484: each do |fn| 1485: open(fn) do |inf| 1486: count = 0 1487: inf.each do |line| 1488: count += 1 1489: if pattern.match(line) 1490: if block_given? 1491: yield fn, count, line 1492: else 1493: puts "#{fn}:#{count}:#{line}" 1494: end 1495: end 1496: end 1497: end 1498: end 1499: 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/rake.rb, line 1324 1324: def exclude(*patterns, &block) 1325: patterns.each do |pat| 1326: @exclude_patterns << pat 1327: end 1328: if block_given? 1329: @exclude_procs << block 1330: end 1331: resolve_exclude if ! @pending 1332: self 1333: end
Should the given file name be excluded?
# File lib/rake.rb, line 1541 1541: def exclude?(fn) 1542: calculate_exclude_regexp unless @exclude_re 1543: fn =~ @exclude_re || @exclude_procs.any? { |p| p.call(fn) } 1544: end
Modify the current file list so that it contains only file name that exist on the file system.
# File lib/rake.rb, line 1509 1509: def existing! 1510: resolve 1511: @items = @items.select { |fn| File.exist?(fn) } 1512: self 1513: end
Return a new file list 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.rb, line 1473 1473: def ext(newext='') 1474: collect { |fn| fn.ext(newext) } 1475: 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/rake.rb, line 1442 1442: def gsub(pat, rep) 1443: inject(FileList.new) { |res, fn| res << fn.gsub(pat,rep) } 1444: end
@exclude_patterns = DEFAULT_IGNORE_PATTERNS.dup
# File lib/rake.rb, line 1557 1557: def import(array) 1558: @items = array 1559: self 1560: 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/rake.rb, line 1290 1290: def include(*filenames) 1291: # TODO: check for pending 1292: filenames.each do |fn| 1293: if fn.respond_to? :to_ary 1294: include(*fn.to_ary) 1295: else 1296: @pending_add << fn 1297: end 1298: end 1299: @pending = true 1300: self 1301: end
Lie about our class.
# File lib/rake.rb, line 1361 1361: def is_a?(klass) 1362: klass == Array || super(klass) 1363: 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/rake.rb, line 1461 1461: def pathmap(spec=nil) 1462: collect { |fn| fn.pathmap(spec) } 1463: end
Resolve all the pending adds now.
# File lib/rake.rb, line 1378 1378: def resolve 1379: if @pending 1380: @pending = false 1381: @pending_add.each do |fn| resolve_add(fn) end 1382: @pending_add = [] 1383: resolve_exclude 1384: end 1385: self 1386: end
Return the internal array object.
# File lib/rake.rb, line 1350 1350: def to_a 1351: resolve 1352: @items 1353: end