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_ |
List of array methods (that are not in Object) that need to be delegated. |
| DEFAULT_ |
|
| DEFAULT_ |
|
| DELEGATING_ |
|
| MUST_ |
List of additional methods that must be delegated. |
| MUST_ |
List of methods that should not be delegated here (we define special versions of them explicitly below). |
| SPECIAL_ |
List of delegated methods that return new array values which need wrapping. |
| Public Methods | |
|---|---|
| * | Redefine * to return either a string or a new file list. |
| == | Define equality. |
| [] | Create a new file list including the files listed. Similar to: |
| add | Alias for #include |
| calculate_ |
|
| clear_ |
Clear all the exclude patterns so that we exclude nothing. |
| egrep | 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. |
| exclude | 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. |
| exclude? | Should the given file name be excluded? |
| 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 | Return a new array with String#ext method applied to each member of the array. |
| gsub | Return a new FileList with the results of running gsub against each element of the original list. |
| gsub! | Same as gsub except that the original file list is modified. |
| import | @exclude_patterns = DEFAULT_IGNORE_PATTERNS.dup |
| include | Add file names defined by glob patterns to the file list. If an array is given, add each element of the array. |
| is_ |
Lie about our class. |
| kind_ |
Alias for #is_a? |
| new | 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. |
| partition | FileList version of partition. Needed because the nested arrays should be FileLists in this version. |
| pathmap | 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.) |
| resolve | Resolve all the pending adds now. |
| sub | Return a new FileList with the results of running sub against each element of the oringal list. |
| sub! | Same as sub except that the oringal file list is modified. |
| to_ |
Return the internal array object. |
| to_ |
Return the internal array object. |
| to_ |
Convert a FileList to a string by joining all elements with a space. |
| Private Methods | |
|---|---|
| add_ |
Add matching glob patterns. |
| resolve_ |
|
| resolve_ |
|
<code/>and<pre/>for code samples.