Class: Rufo::FileList

Inherits:
Object
  • Object
show all
Defined in:
lib/rufo/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(&: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(&: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

Instance Method Summary collapse

Constructor Details

#initialize(*patterns) {|_self| ... } ⇒ FileList

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

Yields:

  • (_self)

Yield Parameters:



97
98
99
100
101
102
103
104
105
 
# 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

Class Method Details

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



239
240
241
 
# File 'lib/rufo/file_list.rb', line 239

def glob(pattern, *args)
  Dir.glob(pattern, *args).sort
end

Instance Method Details

#<<(obj) ⇒ Object 



159
160
161
162
163
 
# File 'lib/rufo/file_list.rb', line 159

def <<(obj)
  resolve
  @items << obj
  self
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']



144
145
146
147
148
149
150
151
 
# 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

#excluded_from_list?(filename) ⇒ Boolean

Should the given file name be excluded from the list?

Returns:

  • (Boolean) 


209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# 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

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



114
115
116
117
118
119
120
 
# File 'lib/rufo/file_list.rb', line 114

def include(*filenames)
  filenames.each do |fn|
    @pending_add << fn
  end
  @pending = true
  self
end

#resolve ⇒ Object

Resolve all the pending adds now.



166
167
168
169
170
171
172
173
174
 
# 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

#to_a ⇒ Object

Return the internal array object.



154
155
156
157
 
# File 'lib/rufo/file_list.rb', line 154

def to_a
  resolve
  @items
end

#to_s ⇒ Object

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



194
195
196
197
 
# File 'lib/rufo/file_list.rb', line 194

def to_s
  resolve
  self.join(" ")
end