Class: Rake::FileList

Inherits:
Object
  • Object
show all
Includes:
Cloneable
Defined in:
lib/rake.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
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([\/\\]|$)/,
  /\.bak$/,
  /~$/,
  /(^|[\/\\])core$/
]

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Cloneable

#clone

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:



845
846
847
848
849
850
851
852
853
 
# File 'lib/rake.rb', line 845

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)



1114
1115
1116
 
# File 'lib/rake.rb', line 1114

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

.clear_ignore_patterns ⇒ Object

Clear the ignore patterns.



1134
1135
1136
 
# File 'lib/rake.rb', line 1134

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

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



1129
1130
1131
 
# File 'lib/rake.rb', line 1129

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.



929
930
931
932
933
934
935
936
937
 
# File 'lib/rake.rb', line 929

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

#==(array) ⇒ Object

Define equality.



912
913
914
 
# File 'lib/rake.rb', line 912

def ==(array)
  to_ary == array
end

#calculate_exclude_regexp ⇒ Object 



950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
 
# File 'lib/rake.rb', line 950

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.



906
907
908
909
 
# File 'lib/rake.rb', line 906

def clear_exclude
  @exclude_patterns = []
  calculate_exclude_regexp if ! @pending
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.



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
 
# File 'lib/rake.rb', line 1047

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



895
896
897
898
899
900
901
902
 
# File 'lib/rake.rb', line 895

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) 


1091
1092
1093
1094
 
# File 'lib/rake.rb', line 1091

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.



1037
1038
1039
 
# File 'lib/rake.rb', line 1037

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



1013
1014
1015
 
# File 'lib/rake.rb', line 1013

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.



1024
1025
1026
1027
 
# File 'lib/rake.rb', line 1024

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

#import(array) ⇒ Object 



1105
1106
1107
1108
 
# File 'lib/rake.rb', line 1105

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 )



862
863
864
865
866
867
868
869
870
871
872
873
 
# File 'lib/rake.rb', line 862

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.



1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/rake.rb', line 1067

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.



940
941
942
943
944
945
946
947
948
 
# File 'lib/rake.rb', line 940

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 



970
971
972
973
974
975
976
977
978
979
 
# File 'lib/rake.rb', line 970

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 



981
982
983
984
985
986
987
988
989
990
991
992
993
994
 
# File 'lib/rake.rb', line 981

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



1002
1003
1004
 
# File 'lib/rake.rb', line 1002

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.



1018
1019
1020
1021
 
# File 'lib/rake.rb', line 1018

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.



917
918
919
920
 
# File 'lib/rake.rb', line 917

def to_a
  resolve
  @items
end

#to_ary ⇒ Object

Return the internal array object.



923
924
925
926
 
# File 'lib/rake.rb', line 923

def to_ary
  resolve
  @items
end

#to_s ⇒ Object

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



1077
1078
1079
1080
 
# File 'lib/rake.rb', line 1077

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