Class: File

Inherits:
Object
  • Object
show all
Defined in:
lib/yard/core_ext/file.rb

Constant Summary

RELATIVE_PARENTDIR =
'..'
RELATIVE_SAMEDIR =
'.'

Manipulating Paths (collapse)

Reading Files (collapse)

Class Method Details

+ (String) cleanpath(path)

Cleans a path by removing extraneous '..', '.' and '/' characters

Examples:

Clean a path

File.cleanpath('a/b//./c/../e') # => "a/b/e"

Parameters:

  • path (String)

    the path to clean

Returns:

  • (String)

    the sanitized path



35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/yard/core_ext/file.rb', line 35

def self.cleanpath(path)
  path = path.split(SEPARATOR)
  path = path.inject([]) do |acc, comp|
    next acc if comp == RELATIVE_SAMEDIR
    if comp == RELATIVE_PARENTDIR && acc.size > 0 && acc.last != RELATIVE_PARENTDIR
      acc.pop
      next acc
    end
    acc << comp
  end
  File.join(*path)
end

+ (Object) open!(file, *args, &block)

Forces opening a file (for writing) by first creating the file's directory

Parameters:

  • file (String)

    the filename to open

Since:

  • 0.5.2



53
54
55
56
57
# File 'lib/yard/core_ext/file.rb', line 53

def self.open!(file, *args, &block)
  dir = dirname(file)
  FileUtils.mkdir_p(dir) unless directory?(dir)
  open(file, *args, &block)
end

+ (String) read_binary(file)

Reads a file with binary encoding

Returns:

  • (String)

    the ascii-8bit encoded data

Since:

  • 0.5.3



62
63
64
# File 'lib/yard/core_ext/file.rb', line 62

def self.read_binary(file)
  File.open(file, 'rb') {|f| f.read }
end

+ (String) relative_path(from, to)

Turns a path to into a relative path from starting point from. The argument from is assumed to be a filename. To treat it as a directory, make sure it ends in File::SEPARATOR ('/' on UNIX filesystems).

Parameters:

  • from (String)

    the starting filename (or directory with from_isdir set to true).

  • to (String)

    the final path that should be made relative.

Returns:

  • (String)

    the relative path from from to to.



18
19
20
21
22
23
24
25
26
27
# File 'lib/yard/core_ext/file.rb', line 18

def self.relative_path(from, to)
  from = expand_path(from).split(SEPARATOR)
  to = expand_path(to).split(SEPARATOR)
  from.length.times do
    break if from[0] != to[0]
    from.shift; to.shift
  end
  fname = from.pop
  join(*(from.map { RELATIVE_PARENTDIR } + to))
end