Module: Sprockets::PathUtils

Extended by:
PathUtils
Included in:
Base, Loader, PathDependencyUtils, PathDigestUtils, PathUtils, Paths
Defined in:
lib/sprockets/path_utils.rb

Overview

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.

Constant Summary collapse

SEPARATOR_PATTERN =
"#{Regexp.quote(File::SEPARATOR)}"

Instance Method Summary collapse

Instance Method Details

#absolute_path?(path) ⇒ Boolean

On Windows, ALT_SEPARATOR is \ Delegate to Pathname since the logic gets complex.

Returns:

  • (Boolean)


79
80
81
# File 'lib/sprockets/path_utils.rb', line 79

def absolute_path?(path)
  Pathname.new(path).absolute?
end

#atomic_write(filename) ⇒ Object

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.



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
# File 'lib/sprockets/path_utils.rb', line 348

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

#directory?(path) ⇒ Boolean

Public: Like `File.directory?`.

path - String file path.

Returns true path exists and is a directory.

Returns:

  • (Boolean)


42
43
44
45
46
47
48
# File 'lib/sprockets/path_utils.rb', line 42

def directory?(path)
  if stat = self.stat(path)
    stat.directory?
  else
    false
  end
end

#entries(path) ⇒ Object

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.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/sprockets/path_utils.rb', line 56

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

#file?(path) ⇒ Boolean

Public: Like `File.file?`.

path - String file path.

Returns true path exists and is a file.

Returns:

  • (Boolean)


29
30
31
32
33
34
35
# File 'lib/sprockets/path_utils.rb', line 29

def file?(path)
  if stat = self.stat(path)
    stat.file?
  else
    false
  end
end

#find_matching_path_for_extensions(path, basename, extensions) ⇒ Object

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.



231
232
233
234
235
236
237
238
239
240
241
242
243
244
# File 'lib/sprockets/path_utils.rb', line 231

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

#find_upwards(basename, path, root = nil) ⇒ Object

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.



273
274
275
276
277
278
279
# File 'lib/sprockets/path_utils.rb', line 273

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

#join(base, path) ⇒ Object

Public: Joins path to base path.

base - Root path path - Extending path

Example

join('base/path/', '../file.js')
# => 'base/file.js'

Returns string path starting from base and ending at path



127
128
129
# File 'lib/sprockets/path_utils.rb', line 127

def join(base, path)
  (Pathname.new(base) + path).to_s
end

#match_path_extname(path, extensions) ⇒ Object

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.



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'lib/sprockets/path_utils.rb', line 202

def match_path_extname(path, extensions)
  basename = File.basename(path)

  i = basename.index('.'.freeze)
  while i && i < basename.length - 1
    extname = basename[i..-1]
    if value = extensions[extname]
      return extname, value
    end

    i = basename.index('.'.freeze, i+1)
  end

  nil
end

#path_extnames(path) ⇒ Object

Internal: Get path's extensions.

path - String

Returns an Array of String extnames.



192
193
194
# File 'lib/sprockets/path_utils.rb', line 192

def path_extnames(path)
  File.basename(path).scan(/\.[^.]+/)
end

#path_parents(path, root = nil) ⇒ Object

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.



252
253
254
255
256
257
258
259
260
261
262
263
264
# File 'lib/sprockets/path_utils.rb', line 252

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

#paths_split(paths, filename) ⇒ Object

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]



178
179
180
181
182
183
184
185
# File 'lib/sprockets/path_utils.rb', line 178

def paths_split(paths, filename)
  paths.each do |path|
    if subpath = split_subpath(path, filename)
      return path, subpath
    end
  end
  nil
end

#relative_path?(path) ⇒ Boolean

Public: Check if path is explicitly relative. Starts with “./” or “../”.

path - String path.

Returns true if path is relative, otherwise false.

Returns:

  • (Boolean)


100
101
102
# File 'lib/sprockets/path_utils.rb', line 100

def relative_path?(path)
  path =~ /^\.\.?($|#{SEPARATOR_PATTERN})/ ? true : false
end

#relative_path_from(start, dest) ⇒ Object

Public: Get relative path from `start` to `dest`.

start - String start path (file or dir) dest - String destination path

Returns relative String path from `start` to `dest`



110
111
112
113
114
# File 'lib/sprockets/path_utils.rb', line 110

def relative_path_from(start, dest)
  start, dest = Pathname.new(start), Pathname.new(dest)
  start = start.dirname unless start.directory?
  dest.relative_path_from(start).to_s
end

#set_pipeline(path, mime_exts, pipeline_exts, pipeline) ⇒ Object

Public: Sets pipeline for path

path - String path extensions - List of file extensions pipeline - Pipeline

Examples

set_pipeline('path/file.js.erb', config[:mime_exts], config[:pipeline_exts], :source)
# => 'path/file.source.js.erb'

set_pipeline('path/some.file.source.js.erb', config[:mime_exts], config[:pipeline_exts], :debug)
# => 'path/some.file.debug.js.erb'

Returns string path with pipeline parsed in



146
147
148
149
150
151
152
153
# File 'lib/sprockets/path_utils.rb', line 146

def set_pipeline(path, mime_exts, pipeline_exts, pipeline)
  extension, _ = match_path_extname(path, mime_exts)
  path.chomp!(extension)
  pipeline_old, _ = match_path_extname(path, pipeline_exts)
  path.chomp!(pipeline_old)

  "#{path}.#{pipeline}#{extension}"
end

#split_subpath(path, subpath) ⇒ Object

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.



162
163
164
165
166
167
168
169
170
# File 'lib/sprockets/path_utils.rb', line 162

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

#stat(path) ⇒ Object

Public: Like `File.stat`.

path - String file or directory path

Returns nil if the file does not exist.



16
17
18
19
20
21
22
# File 'lib/sprockets/path_utils.rb', line 16

def stat(path)
  if File.exist?(path)
    File.stat(path.to_s)
  else
    nil
  end
end

#stat_directory(dir) ⇒ Object

Public: Stat all the files under a directory.

dir - A String directory

Returns an Enumerator of [path, stat].



286
287
288
289
290
291
292
293
294
295
296
297
# File 'lib/sprockets/path_utils.rb', line 286

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

#stat_sorted_tree(dir, &block) ⇒ Object

Public: Recursive stat all the files under a directory in alphabetical order.

dir - A String directory

Returns an Enumerator of [path, stat].



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
# File 'lib/sprockets/path_utils.rb', line 324

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

#stat_tree(dir, &block) ⇒ Object

Public: Recursive stat all the files under a directory.

dir - A String directory

Returns an Enumerator of [path, stat].



304
305
306
307
308
309
310
311
312
313
314
315
316
# File 'lib/sprockets/path_utils.rb', line 304

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