Class | FileList
In: | lib/facets/more/filelist.rb
Parent: | Object

# 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.

## Synopsis

      fl = FileList.new
      fl.include('./**/*')
      fl.exclude('./*~')

### Methods

* == [] add calculate_exclude_regexp clear_exclude clear_ignore_patterns clone dup egrep exclude exclude? ext gsub gsub! import include new resolve resolve_add resolve_exclude select_default_ignore_patterns sub sub! to_a to_ary to_s

### Constants

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$/

### Public Class methods

[](*args)

Create a new file list including the files listed. Similar to:

      FileList.new(*args)

clear_ignore_patterns()

Clear the ignore patterns.

new(*patterns) {|self if block_given?| ...}

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

select_default_ignore_patterns()

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.

### Public Instance methods

*(other)

Redefine * to return either a string or a new file list.

==(array)

Define equality.

add(*filenames)

Alias for include

calculate_exclude_regexp()
clear_exclude()

Clear all the exclude patterns so that we exclude nothing.

clone()

include Cloneable

dup()

Alias for clone

egrep(pattern) {|fn, count, line| ...}

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(*patterns)

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']

exclude?(fn)

Should the given file name be excluded?

ext(newext='')

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.

gsub(pat, rep)

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']

gsub!(pat, rep)

Same as `gsub` except that the original file list is modified.

import(array)
include(*filenames)

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 )

resolve()

Resolve all the pending adds now.

resolve_add(fn)
resolve_exclude()
sub(pat, rep)

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']

sub!(pat, rep)

Same as `sub` except that the oringal file list is modified.

to_a()

Return the internal array object.

to_ary()

Return the internal array object.

to_s()

Convert a FileList to a string by joining all elements with a space.

[Validate]