Class: FileList

Inherits:
Object show all
Defined in:
lib/more/facets/filelist.rb

Overview

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('./*~')

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
MUST_DEFINE =

List of additional methods that must be delegated.

%w[to_a 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).sort.uniq
DEFAULT_IGNORE_PATTERNS = 
[
  /(^|[\/\\])CVS([\/\\]|$)/,
  /(^|[\/\\])\.svn([\/\\]|$)/,
  /(^|[\/\\])_darcs([\/\\]|$)/,
  /\.bak$/,
  /~$/,
  /(^|[\/\\])core$/
]

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:

  • _self (FileList) —

    the object that the method was called on



160
161
162
163
164
165
166
167
168
 
# File 'lib/more/facets/filelist.rb', line 160

def initialize(*patterns)
  @pending_add = []
  @pending = false
  @exclude_patterns = DEFAULT_IGNORE_PATTERNS.dup
  @exclude_re = nil
  @items = []
  patterns.each { |pattern| include(pattern) }
  yield self if block_given?
end

Class Method Details

.[](*args) ⇒ Object

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

FileList.new(*args)



430
431
432
 
# File 'lib/more/facets/filelist.rb', line 430

def [](*args)
  new(*args)
end

.clear_ignore_patterns ⇒ Object

Clear the ignore patterns.



451
452
453
 
# File 'lib/more/facets/filelist.rb', line 451

def clear_ignore_patterns
  @exclude_patterns = [ /^$/ ]
end

.select_default_ignore_patterns ⇒ Object

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.



446
447
448
 
# File 'lib/more/facets/filelist.rb', line 446

def select_default_ignore_patterns
  @exclude_patterns = DEFAULT_IGNORE_PATTERNS.dup
end

Instance Method Details

#*(other) ⇒ Object

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



243
244
245
246
247
248
249
250
251
 
# File 'lib/more/facets/filelist.rb', line 243

def *(other)
  result = @items * other
  case result
  when Array
    FileList.new.import(result)
  else
    result
  end
end

#==(array) ⇒ Object

Define equality.



226
227
228
 
# File 'lib/more/facets/filelist.rb', line 226

def ==(array)
  to_ary == array
end

#calculate_exclude_regexp ⇒ Object 



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/more/facets/filelist.rb', line 264

def calculate_exclude_regexp
  ignores = []
  @exclude_patterns.each do |pat|
    case pat
    when Regexp
      ignores << pat
    when /[*.]/
      Dir[pat].each do |p| ignores << p end
    else
      ignores << Regexp.quote(pat)
    end
  end
  if ignores.empty?
    @exclude_re = /^$/
  else
    re_str = ignores.collect { |p| "(" + p.to_s + ")" }.join("|")
    @exclude_re = Regexp.new(re_str)
  end
end

#clear_exclude ⇒ Object

Clear all the exclude patterns so that we exclude nothing.



220
221
222
223
 
# File 'lib/more/facets/filelist.rb', line 220

def clear_exclude
  @exclude_patterns = []
  calculate_exclude_regexp if ! @pending
end

#clone ⇒ Object Also known as: dup

include Cloneable



76
77
78
79
80
81
82
83
 
# File 'lib/more/facets/filelist.rb', line 76

def clone
  sibling = self.class.new
  instance_variables.each do |ivar|
    value = self.instance_variable_get(ivar)
    sibling.instance_variable_set(ivar, value.rake_dup)
  end
  sibling
end

#egrep(pattern) ⇒ Object

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.



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/more/facets/filelist.rb', line 360

def egrep(pattern)
  each do |fn|
    open(fn) do |inf|
      count = 0

      inf.each do |line|
        count += 1
        if pattern.match(line)
          if block_given?
            yield fn, count, line
          else
            puts "#{fn}:#{count}:#{line}"
          end
        end
      end

    end
  end
end

#exclude(*patterns) ⇒ 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.

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



210
211
212
213
214
215
216
217
 
# File 'lib/more/facets/filelist.rb', line 210

def exclude(*patterns)
  patterns.each do |pat| @exclude_patterns << pat end
  if ! @pending
    calculate_exclude_regexp
    reject! { |fn| fn =~ @exclude_re }
  end
  self
end

#exclude?(fn) ⇒ Boolean

Should the given file name be excluded?

Returns:

  • (Boolean) 


406
407
408
409
 
# File 'lib/more/facets/filelist.rb', line 406

def exclude?(fn)
  calculate_exclude_regexp unless @exclude_re
  fn =~ @exclude_re
end

#ext(newext = '') ⇒ Object

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.



351
352
353
 
# File 'lib/more/facets/filelist.rb', line 351

def ext(newext='')
  collect { |fn| fn.ext(newext) }
end

#gsub(pat, rep) ⇒ Object

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



327
328
329
 
# File 'lib/more/facets/filelist.rb', line 327

def gsub(pat, rep)
  inject(FileList.new) { |res, fn| res << fn.gsub(pat,rep) }
end

#gsub!(pat, rep) ⇒ Object

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



338
339
340
341
 
# File 'lib/more/facets/filelist.rb', line 338

def gsub!(pat, rep)
  each_with_index { |fn, i| self[i] = fn.gsub(pat,rep) }
  self
end

#import(array) ⇒ Object 



421
422
423
424
 
# File 'lib/more/facets/filelist.rb', line 421

def import(array)
  @items = array
  self
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 )



177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/more/facets/filelist.rb', line 177

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

#partition(&block) ⇒ Object

FileList version of partition. Needed because the nested arrays should be FileLists in this version.



382
383
384
385
386
387
388
389
 
# File 'lib/more/facets/filelist.rb', line 382

def partition(&block) # :nodoc:
  resolve
  result = @items.partition(&block)
  [
    FileList.new.import(result[0]),
    FileList.new.import(result[1]),
  ]
end

#resolve ⇒ Object

Resolve all the pending adds now.



254
255
256
257
258
259
260
261
262
 
# File 'lib/more/facets/filelist.rb', line 254

def resolve
  if @pending
    @pending = false
    @pending_add.each do |fn| resolve_add(fn) end
    @pending_add = []
    resolve_exclude
  end
  self
end

#resolve_add(fn) ⇒ Object 



284
285
286
287
288
289
290
291
292
293
 
# File 'lib/more/facets/filelist.rb', line 284

def resolve_add(fn)
  case fn
  when Array
    fn.each { |f| self.resolve_add(f) }
  when %r{[*?]}
    add_matching(fn)
  else
    self << fn
  end
end

#resolve_exclude ⇒ Object 



295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/more/facets/filelist.rb', line 295

def resolve_exclude
  @exclude_patterns.each do |pat|
    case pat
    when Regexp
      reject! { |fn| fn =~ pat }
    when /[*.]/
      reject_list = Dir[pat]
      reject! { |fn| reject_list.include?(fn) }
    else
      reject! { |fn| fn == pat }
    end
  end
  self
end

#sub(pat, rep) ⇒ Object

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



316
317
318
 
# File 'lib/more/facets/filelist.rb', line 316

def sub(pat, rep)
  inject(FileList.new) { |res, fn| res << fn.sub(pat,rep) }
end

#sub!(pat, rep) ⇒ Object

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



332
333
334
335
 
# File 'lib/more/facets/filelist.rb', line 332

def sub!(pat, rep)
  each_with_index { |fn, i| self[i] = fn.sub(pat,rep) }
  self
end

#to_a ⇒ Object

Return the internal array object.



231
232
233
234
 
# File 'lib/more/facets/filelist.rb', line 231

def to_a
  resolve
  @items
end

#to_ary ⇒ Object

Return the internal array object.



237
238
239
240
 
# File 'lib/more/facets/filelist.rb', line 237

def to_ary
  resolve
  @items
end

#to_s ⇒ Object

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



392
393
394
395
 
# File 'lib/more/facets/filelist.rb', line 392

def to_s
  resolve if @pending
  self.join(' ')
end