-
Notifications
You must be signed in to change notification settings - Fork 2.6k
/
path_list.rb
242 lines (216 loc) · 7.56 KB
/
path_list.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
require 'active_support/multibyte/unicode'
require 'find'
module Pod
class Sandbox
# The PathList class is designed to perform multiple glob matches against
# a given directory. Basically, it generates a list of all the children
# paths and matches the globs patterns against them, resulting in just one
# access to the file system.
#
# @note A PathList once it has generated the list of the paths this is
# updated only if explicitly requested by calling
# {#read_file_system}
#
class PathList
# @return [Pathname] The root of the list whose files and directories
# are used to perform the matching operations.
#
attr_reader :root
# Initialize a new instance
#
# @param [Pathname] root @see #root
#
def initialize(root)
root_dir = ActiveSupport::Multibyte::Unicode.normalize(root.to_s)
@root = Pathname.new(root_dir)
@glob_cache = {}
end
# @return [Array<String>] The list of absolute the path of all the files
# contained in {root}.
#
def files
read_file_system unless @files
@files
end
# @return [Array<String>] The list of absolute the path of all the
# directories contained in {root}.
#
def dirs
read_file_system unless @dirs
@dirs
end
# @return [void] Reads the file system and populates the files and paths
# lists.
#
def read_file_system
unless root.exist?
raise Informative, "Attempt to read non existent folder `#{root}`."
end
dirs = []
files = []
root_length = root.cleanpath.to_s.length + File::SEPARATOR.length
escaped_root = escape_path_for_glob(root)
Dir.glob(escaped_root + '**/*', File::FNM_DOTMATCH).each do |f|
directory = File.directory?(f)
# Ignore `.` and `..` directories
next if directory && f =~ /\.\.?$/
f = f.slice(root_length, f.length - root_length)
next if f.nil?
(directory ? dirs : files) << f
end
dirs.sort_by!(&:upcase)
files.sort_by!(&:upcase)
@dirs = dirs
@files = files
@glob_cache = {}
end
#-----------------------------------------------------------------------#
public
# @!group Globbing
# Similar to {glob} but returns the absolute paths.
#
# @param [String,Array<String>] patterns
# @see #relative_glob
#
# @param [Hash] options
# @see #relative_glob
#
# @return [Array<Pathname>]
#
def glob(patterns, options = {})
cache_key = options.merge(:patterns => patterns)
@glob_cache[cache_key] ||= relative_glob(patterns, options).map { |p| root.join(p) }
end
# The list of relative paths that are case insensitively matched by a
# given pattern. This method emulates {Dir#glob} with the
# {File::FNM_CASEFOLD} option.
#
# @param [String,Array<String>] patterns
# A single {Dir#glob} like pattern, or a list of patterns.
#
# @param [Hash] options
#
# @option options [String] :dir_pattern
# An optional pattern to append to a pattern, if it is the path
# to a directory.
#
# @option options [Array<String>] :exclude_patterns
# Exclude specific paths given by those patterns.
#
# @option options [Array<String>] :include_dirs
# Additional paths to take into account for matching.
#
# @return [Array<Pathname>]
#
def relative_glob(patterns, options = {})
return [] if patterns.empty?
dir_pattern = options[:dir_pattern]
exclude_patterns = options[:exclude_patterns]
include_dirs = options[:include_dirs]
if include_dirs
full_list = files + dirs
else
full_list = files
end
patterns_array = Array(patterns)
exact_matches = (full_list & patterns_array).to_set
unless patterns_array.empty?
list = patterns_array.flat_map do |pattern|
if exact_matches.include?(pattern)
pattern
else
if directory?(pattern) && dir_pattern
pattern += '/' unless pattern.end_with?('/')
pattern += dir_pattern
end
expanded_patterns = dir_glob_equivalent_patterns(pattern)
full_list.select do |path|
expanded_patterns.any? do |p|
File.fnmatch(p, path, File::FNM_CASEFOLD | File::FNM_PATHNAME)
end
end
end
end
end
list = list.map { |path| Pathname.new(path) }
if exclude_patterns
exclude_options = { :dir_pattern => '**/*', :include_dirs => include_dirs }
list -= relative_glob(exclude_patterns, exclude_options)
end
list
end
#-----------------------------------------------------------------------#
private
# @!group Private helpers
# @return [Bool] Wether a path is a directory. The result of this method
# computed without accessing the file system and is case
# insensitive.
#
# @param [String, Pathname] sub_path The path that could be a directory.
#
def directory?(sub_path)
sub_path = sub_path.to_s.downcase.sub(/\/$/, '')
dirs.any? { |dir| dir.downcase == sub_path }
end
# @return [Array<String>] An array of patterns converted from a
# {Dir.glob} pattern to patterns that {File.fnmatch} can handle.
# This is used by the {#relative_glob} method to emulate
# {Dir.glob}.
#
# The expansion provides support for:
#
# - Literals
#
# dir_glob_equivalent_patterns('{file1,file2}.{h,m}')
# => ["file1.h", "file1.m", "file2.h", "file2.m"]
#
# - Matching the direct children of a directory with `**`
#
# dir_glob_equivalent_patterns('Classes/**/file.m')
# => ["Classes/**/file.m", "Classes/file.m"]
#
# @param [String] pattern A {Dir#glob} like pattern.
#
def dir_glob_equivalent_patterns(pattern)
pattern = pattern.gsub('/**/', '{/**/,/}')
values_by_set = {}
pattern.scan(/\{[^}]*\}/) do |set|
values = set.gsub(/[{}]/, '').split(',')
values_by_set[set] = values
end
if values_by_set.empty?
[pattern]
else
patterns = [pattern]
values_by_set.each do |set, values|
patterns = patterns.flat_map do |old_pattern|
values.map do |value|
old_pattern.gsub(set, value)
end
end
end
patterns
end
end
# Escapes the glob metacharacters from a given path so it can used in
# Dir#glob and similar methods.
#
# @note See CocoaPods/CocoaPods#862.
#
# @param [String, Pathname] path
# The path to escape.
#
# @return [Pathname] The escaped path.
#
def escape_path_for_glob(path)
result = path.to_s
characters_to_escape = ['[', ']', '{', '}', '?', '*']
characters_to_escape.each do |character|
result.gsub!(character, "\\#{character}")
end
Pathname.new(result)
end
#-----------------------------------------------------------------------#
end
end
end