-
Notifications
You must be signed in to change notification settings - Fork 788
/
path_utils.rb
314 lines (283 loc) · 8.14 KB
/
path_utils.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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# frozen_string_literal: true
module Sprockets
# Internal: File and path related utilities. Mixed into Environment.
#
# Probably would be called FileUtils, but that causes namespace annoyances
# when code actually wants to reference ::FileUtils.
module PathUtils
extend self
# Public: Like `File.stat`.
#
# path - String file or directory path
#
# Returns nil if the file does not exist.
def stat(path)
if File.exist?(path)
File.stat(path.to_s)
else
nil
end
end
# Public: Like `File.file?`.
#
# path - String file path.
#
# Returns true path exists and is a file.
def file?(path)
if stat = self.stat(path)
stat.file?
else
false
end
end
# Public: Like `File.directory?`.
#
# path - String file path.
#
# Returns true path exists and is a directory.
def directory?(path)
if stat = self.stat(path)
stat.directory?
else
false
end
end
# Public: A version of `Dir.entries` that filters out `.` files and `~`
# swap files.
#
# path - String directory path
#
# Returns an empty `Array` if the directory does not exist.
def entries(path)
if File.directory?(path)
entries = Dir.entries(path, encoding: Encoding.default_internal)
entries.reject! { |entry|
entry.start_with?(".".freeze) ||
(entry.start_with?("#".freeze) && entry.end_with?("#".freeze)) ||
entry.end_with?("~".freeze)
}
entries.sort!
entries
else
[]
end
end
# Public: Check if path is absolute or relative.
#
# path - String path.
#
# Returns true if path is absolute, otherwise false.
if File::ALT_SEPARATOR
require 'pathname'
# On Windows, ALT_SEPARATOR is \
# Delegate to Pathname since the logic gets complex.
def absolute_path?(path)
Pathname.new(path).absolute?
end
else
def absolute_path?(path)
path[0] == File::SEPARATOR
end
end
if File::ALT_SEPARATOR
SEPARATOR_PATTERN = "#{Regexp.quote(File::SEPARATOR)}|#{Regexp.quote(File::ALT_SEPARATOR)}"
else
SEPARATOR_PATTERN = "#{Regexp.quote(File::SEPARATOR)}"
end
# Public: Check if path is explicitly relative.
# Starts with "./" or "../".
#
# path - String path.
#
# Returns true if path is relative, otherwise false.
def relative_path?(path)
path =~ /^\.\.?($|#{SEPARATOR_PATTERN})/ ? true : false
end
# Internal: Get relative path for root path and subpath.
#
# path - String path
# subpath - String subpath of path
#
# Returns relative String path if subpath is a subpath of path, or nil if
# subpath is outside of path.
def split_subpath(path, subpath)
return "" if path == subpath
path = File.join(path, ''.freeze)
if subpath.start_with?(path)
subpath[path.length..-1]
else
nil
end
end
# Internal: Detect root path and base for file in a set of paths.
#
# paths - Array of String paths
# filename - String path of file expected to be in one of the paths.
#
# Returns [String root, String path]
def paths_split(paths, filename)
paths.each do |path|
if subpath = split_subpath(path, filename)
return path, subpath
end
end
nil
end
# Internal: Get path's extensions.
#
# path - String
#
# Returns an Array of String extnames.
def path_extnames(path)
File.basename(path).scan(/\.[^.]+/)
end
# Internal: Match path extnames against available extensions.
#
# path - String
# extensions - Hash of String extnames to values
#
# Returns [String extname, Object value] or nil nothing matched.
def match_path_extname(path, extensions)
match, key = nil, String.new("")
path_extnames(path).reverse_each do |extname|
key.prepend(extname)
if value = extensions[key]
match = [key.dup, value]
elsif match
break
end
end
match
end
# Internal: Match paths in a directory against available extensions.
#
# path - String directory
# basename - String basename of target file
# extensions - Hash of String extnames to values
#
# Examples
#
# exts = { ".js" => "application/javascript" }
# find_matching_path_for_extensions("app/assets", "application", exts)
# # => ["app/assets/application.js", "application/javascript"]
#
# Returns an Array of [String path, Object value] matches.
def find_matching_path_for_extensions(path, basename, extensions)
matches = []
entries(path).each do |entry|
next unless File.basename(entry).start_with?(basename)
extname, value = match_path_extname(entry, extensions)
if basename == entry.chomp(extname)
filename = File.join(path, entry)
if file?(filename)
matches << [filename, value]
end
end
end
matches
end
# Internal: Returns all parents for path
#
# path - String absolute filename or directory
# root - String path to stop at (default: system root)
#
# Returns an Array of String paths.
def path_parents(path, root = nil)
root = "#{root}#{File::SEPARATOR}" if root
parents = []
loop do
parent = File.dirname(path)
break if parent == path
break if root && !path.start_with?(root)
parents << path = parent
end
parents
end
# Internal: Find target basename checking upwards from path.
#
# basename - String filename: ".sprocketsrc"
# path - String path to start search: "app/assets/javascripts/app.js"
# root - String path to stop at (default: system root)
#
# Returns String filename or nil.
def find_upwards(basename, path, root = nil)
path_parents(path, root).each do |dir|
filename = File.join(dir, basename)
return filename if file?(filename)
end
nil
end
# Public: Stat all the files under a directory.
#
# dir - A String directory
#
# Returns an Enumerator of [path, stat].
def stat_directory(dir)
return to_enum(__method__, dir) unless block_given?
self.entries(dir).each do |entry|
path = File.join(dir, entry)
if stat = self.stat(path)
yield path, stat
end
end
nil
end
# Public: Recursive stat all the files under a directory.
#
# dir - A String directory
#
# Returns an Enumerator of [path, stat].
def stat_tree(dir, &block)
return to_enum(__method__, dir) unless block_given?
self.stat_directory(dir) do |path, stat|
yield path, stat
if stat.directory?
stat_tree(path, &block)
end
end
nil
end
# Public: Recursive stat all the files under a directory in alphabetical
# order.
#
# dir - A String directory
#
# Returns an Enumerator of [path, stat].
def stat_sorted_tree(dir, &block)
return to_enum(__method__, dir) unless block_given?
self.stat_directory(dir).sort_by { |path, stat|
stat.directory? ? "#{path}/" : path
}.each do |path, stat|
yield path, stat
if stat.directory?
stat_sorted_tree(path, &block)
end
end
nil
end
# Public: Write to a file atomically. Useful for situations where you
# don't want other processes or threads to see half-written files.
#
# Utils.atomic_write('important.file') do |file|
# file.write('hello')
# end
#
# Returns nothing.
def atomic_write(filename)
dirname, basename = File.split(filename)
basename = [
basename,
Thread.current.object_id,
Process.pid,
rand(1000000)
].join('.'.freeze)
tmpname = File.join(dirname, basename)
File.open(tmpname, 'wb+') do |f|
yield f
end
File.rename(tmpname, filename)
ensure
File.delete(tmpname) if File.exist?(tmpname)
end
end
end