Class: Rake::FileList
- Inherits:
-
Object
- Object
- Rake::FileList
- Includes:
- Cloneable
- 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 collapse
- 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 }
- 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 + - & | ]
- DELEGATING_METHODS =
(ARRAY_METHODS + MUST_DEFINE - MUST_NOT_DEFINE). map { |s| s.to_s }.sort.uniq
- GLOB_PATTERN =
%r{[*?\[\{]}
- DEFAULT_IGNORE_PATTERNS =
[ /(^|[\/\\])CVS([\/\\]|$)/, /(^|[\/\\])\.svn([\/\\]|$)/, /\.bak$/, /~$/ ]
- DEFAULT_IGNORE_PROCS =
[ proc { |fn| fn =~ /(^|[\/\\])core$/ && ! File.directory?(fn) } ]
Class Method Summary collapse
-
.[](*args) ⇒ Object
Create a new file list including the files listed.
-
.glob(pattern, *args) ⇒ Object
Get a sorted list of files matching the pattern.
Instance Method Summary collapse
-
#*(other) ⇒ Object
Redefine * to return either a string or a new file list.
- #<<(obj) ⇒ Object
-
#==(array) ⇒ Object
A FileList is equal through array equality.
-
#clear_exclude ⇒ Object
Clear all the exclude patterns so that we exclude nothing.
-
#egrep(pattern, *options) ⇒ Object
Grep each of the files in the filelist using the given pattern.
-
#exclude(*patterns, &block) ⇒ Object
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 ⇒ Object
Return a new file list that only contains file names from the current file list that exist on the file system.
-
#existing! ⇒ Object
Modify the current file list so that it contains only file name that exist on the file system.
-
#ext(newext = '') ⇒ Object
Return a new FileList with
String#ext
method applied to each member of the array. -
#gsub(pat, rep) ⇒ Object
Return a new FileList with the results of running
gsub
against each element of the original list. -
#gsub!(pat, rep) ⇒ Object
Same as
gsub
except that the original file list is modified. -
#import(array) ⇒ Object
:nodoc:.
-
#include(*filenames) ⇒ Object
(also: #add)
Add file names defined by glob patterns to the file list.
-
#initialize(*patterns) {|_self| ... } ⇒ FileList
constructor
Create a file list from the globbable patterns given.
-
#is_a?(klass) ⇒ Boolean
(also: #kind_of?)
Lie about our class.
-
#partition(&block) ⇒ Object
FileList version of partition.
-
#pathmap(spec = nil, &block) ⇒ Object
Apply the pathmap spec to each of the included file names, returning a new file list with the modified paths.
-
#resolve ⇒ Object
Resolve all the pending adds now.
-
#sub(pat, rep) ⇒ Object
Return a new FileList with the results of running
sub
against each element of the original list. -
#sub!(pat, rep) ⇒ Object
Same as
sub
except that the original file list is modified. -
#to_a ⇒ Object
Return the internal array object.
-
#to_ary ⇒ Object
Return the internal array object.
-
#to_s ⇒ Object
Convert a FileList to a string by joining all elements with a space.
Methods included from Cloneable
Constructor Details
#initialize(*patterns) {|_self| ... } ⇒ FileList
100 101 102 103 104 105 106 107 108 |
# File 'lib/rake/file_list.rb', line 100 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) ⇒ Object
401 402 403 |
# File 'lib/rake/file_list.rb', line 401 def [](*args) new(*args) end |
.glob(pattern, *args) ⇒ Object
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.
408 409 410 |
# File 'lib/rake/file_list.rb', line 408 def glob(pattern, *args) Dir.glob(pattern, *args).sort end |
Instance Method Details
#*(other) ⇒ Object
Redefine * to return either a string or a new file list.
194 195 196 197 198 199 200 201 202 |
# File 'lib/rake/file_list.rb', line 194 def *(other) result = @items * other case result when Array self.class.new.import(result) else result end end |
#<<(obj) ⇒ Object
204 205 206 207 208 |
# File 'lib/rake/file_list.rb', line 204 def <<(obj) resolve @items << Rake.from_pathname(obj) self end |
#==(array) ⇒ Object
A FileList is equal through array equality.
172 173 174 |
# File 'lib/rake/file_list.rb', line 172 def ==(array) to_ary == array end |
#clear_exclude ⇒ Object
Clear all the exclude patterns so that we exclude nothing.
165 166 167 168 169 |
# File 'lib/rake/file_list.rb', line 165 def clear_exclude @exclude_patterns = [] @exclude_procs = [] self end |
#egrep(pattern, *options) ⇒ Object
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.
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 |
# File 'lib/rake/file_list.rb', line 294 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) ⇒ Object
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']
151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/rake/file_list.rb', line 151 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 |
#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.
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 |
# File 'lib/rake/file_list.rb', line 365 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 |
#existing ⇒ Object
Return a new file list that only contains file names from the current file list that exist on the file system.
321 322 323 |
# File 'lib/rake/file_list.rb', line 321 def existing select { |fn| File.exist?(fn) } end |
#existing! ⇒ Object
Modify the current file list so that it contains only file name that exist on the file system.
327 328 329 330 331 |
# File 'lib/rake/file_list.rb', line 327 def existing! resolve @items = @items.select { |fn| File.exist?(fn) } self end |
#ext(newext = '') ⇒ Object
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.
285 286 287 |
# File 'lib/rake/file_list.rb', line 285 def ext(newext='') collect { |fn| fn.ext(newext) } end |
#gsub(pat, rep) ⇒ Object
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']
254 255 256 |
# File 'lib/rake/file_list.rb', line 254 def gsub(pat, rep) inject(self.class.new) { |res, fn| res << fn.gsub(pat, rep) } end |
#gsub!(pat, rep) ⇒ Object
Same as gsub
except that the original file list is modified.
265 266 267 268 |
# File 'lib/rake/file_list.rb', line 265 def gsub!(pat, rep) each_with_index { |fn, i| self[i] = fn.gsub(pat, rep) } self end |
#import(array) ⇒ Object
:nodoc:
392 393 394 395 |
# File 'lib/rake/file_list.rb', line 392 def import(array) # :nodoc: @items = array self end |
#include(*filenames) ⇒ Object 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 )
117 118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/rake/file_list.rb', line 117 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.
188 189 190 |
# File 'lib/rake/file_list.rb', line 188 def is_a?(klass) klass == Array || super(klass) end |
#partition(&block) ⇒ Object
FileList version of partition. Needed because the nested arrays should be FileLists in this version.
335 336 337 338 339 340 341 342 |
# File 'lib/rake/file_list.rb', line 335 def partition(&block) # :nodoc: resolve result = @items.partition(&block) [ self.class.new.import(result[0]), self.class.new.import(result[1]), ] end |
#pathmap(spec = nil, &block) ⇒ Object
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.)
273 274 275 |
# File 'lib/rake/file_list.rb', line 273 def pathmap(spec=nil, &block) collect { |fn| fn.pathmap(spec, &block) } end |
#resolve ⇒ Object
Resolve all the pending adds now.
211 212 213 214 215 216 217 218 219 |
# File 'lib/rake/file_list.rb', line 211 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) ⇒ Object
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']
243 244 245 |
# File 'lib/rake/file_list.rb', line 243 def sub(pat, rep) inject(self.class.new) { |res, fn| res << fn.sub(pat, rep) } end |
#sub!(pat, rep) ⇒ Object
Same as sub
except that the original file list is modified.
259 260 261 262 |
# File 'lib/rake/file_list.rb', line 259 def sub!(pat, rep) each_with_index { |fn, i| self[i] = fn.sub(pat, rep) } self end |
#to_a ⇒ Object
Return the internal array object.
177 178 179 180 |
# File 'lib/rake/file_list.rb', line 177 def to_a resolve @items end |
#to_ary ⇒ Object
Return the internal array object.
183 184 185 |
# File 'lib/rake/file_list.rb', line 183 def to_ary to_a end |
#to_s ⇒ Object
Convert a FileList to a string by joining all elements with a space.
345 346 347 348 |
# File 'lib/rake/file_list.rb', line 345 def to_s resolve self.join(' ') end |