class Rufo::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.- DEFAULT_IGNORE_PATTERNS
- DEFAULT_IGNORE_PROCS
- DELEGATING_METHODS
- GLOB_PATTERN
- 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
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.
# File lib/rufo/file_list.rb, line 239 def glob(pattern, *args) Dir.glob(pattern, *args).sort end
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/rufo/file_list.rb, line 97 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
# File lib/rufo/file_list.rb, line 159 def <<(obj) resolve @items << obj self 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/rufo/file_list.rb, line 144 def exclude(*patterns, &block) patterns.each do |pat| @exclude_patterns << pat end @exclude_procs << block if block_given? resolve_exclude unless @pending self end
Should the given file name be excluded from the list?
# File lib/rufo/file_list.rb, line 209 def excluded_from_list?(filename) return true if @exclude_patterns.any? do |pat| case pat when Regexp filename =~ pat when GLOB_PATTERN flags = File::FNM_PATHNAME flags |= File::FNM_EXTGLOB File.fnmatch?(pat, filename, flags) else filename == pat end end @exclude_procs.any? { |p| p.call(filename) } 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/rufo/file_list.rb, line 114 def include(*filenames) filenames.each do |fn| @pending_add << fn end @pending = true self end
Resolve all the pending adds now.
# File lib/rufo/file_list.rb, line 166 def resolve if @pending @pending = false @pending_add.each do |fn| resolve_add(fn) end @pending_add = [] resolve_exclude end self end
Return the internal array object.
# File lib/rufo/file_list.rb, line 154 def to_a resolve @items end
Convert a FileList
to a string by joining all elements with a space.
# File lib/rufo/file_list.rb, line 194 def to_s resolve self.join(" ") end
Private Instance Methods
Add matching glob patterns.
# File lib/rufo/file_list.rb, line 200 def add_matching(pattern) self.class.glob(pattern).each do |fn| self << fn unless excluded_from_list?(fn) end end