class Rake::FileList - rake-10.3.2 Documentation

# class Rake::FileList

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_METHODS

  List of array methods (that are not in `Object`) that need to be delegated.

DELEGATING_METHODS
MUST_DEFINE

  List of additional methods that must be delegated.

MUST_NOT_DEFINE

  List of methods that should not be delegated here (we define special versions of them explicitly below).

SPECIAL_RETURN

  List of delegated methods that return new array values which need wrapping.

### Public Class Methods

new(*patterns) { |self| ... } click to toggle source

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/file_list.rb, line 99
    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

### Public Instance Methods

*(other) click to toggle source

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

    # File lib/rake/file_list.rb, line 189
    def *(other)
      result = @items * other
      case result
      when Array
        FileList.new.import(result)
      else
        result
      end
    end

==(array) click to toggle source

A FileList is equal through array equality.

    # File lib/rake/file_list.rb, line 167
    def ==(array)
      to_ary == array
    end

add(*filenames)
Alias for: include
clear_exclude() click to toggle source

Clear all the exclude patterns so that we exclude nothing.

    # File lib/rake/file_list.rb, line 160
    def clear_exclude
      @exclude_patterns = []
      @exclude_procs = []
      self
    end

exclude(*patterns, &block) click to toggle source

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/file_list.rb, line 150
    def exclude(*patterns, &block)
      patterns.each do |pat|
        @exclude_patterns << pat
      end
      @exclude_procs << block if block_given?
      resolve_exclude unless @pending
      self
    end

include(*filenames) click to toggle source

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/file_list.rb, line 116
    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

Also aliased as: add
is_a?(klass) click to toggle source

Lie about our class.

Calls superclass method

    # File lib/rake/file_list.rb, line 183
    def is_a?(klass)
      klass == Array || super(klass)
    end

Also aliased as: kind_of?
kind_of?(klass)
Alias for: is_a?
resolve() click to toggle source

Resolve all the pending adds now.

    # File lib/rake/file_list.rb, line 200
    def resolve
      if @pending
        @pending = false
        @pending_add.each do |fn| resolve_add(fn) end
        @pending_add = []
        resolve_exclude
      end
      self
    end

to_a() click to toggle source

Return the internal array object.

    # File lib/rake/file_list.rb, line 172
    def to_a
      resolve
      @items
    end

to_ary() click to toggle source

Return the internal array object.

    # File lib/rake/file_list.rb, line 178
    def to_ary
      to_a
    end