Class: Chef::ChefFS::PathUtils

Inherits:
Object
  • Object
show all
Defined in:
lib/chef/chef_fs/path_utils.rb

Class Method Summary collapse

Class Method Details

.descendant_of?(path, ancestor) ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
88
 
# File 'lib/chef/chef_fs/path_utils.rb', line 85

def self.descendant_of?(path, ancestor)
  path[0,ancestor.length] == ancestor &&
    (ancestor.length == path.length || path[ancestor.length,1] =~ /#{PathUtils.regexp_path_separator}/)
end

.is_absolute?(path) ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/chef/chef_fs/path_utils.rb', line 90

def self.is_absolute?(path)
  path =~ /^#{regexp_path_separator}/
end

.join(*parts) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/chef/chef_fs/path_utils.rb', line 43

def self.join(*parts)
  return "" if parts.length == 0
  # Determine if it started with a slash
  absolute = parts[0].length == 0 || parts[0].length > 0 && parts[0] =~ /^#{regexp_path_separator}/
  # Remove leading and trailing slashes from each part so that the join will work (and the slash at the end will go away)
  parts = parts.map { |part| part.gsub(/^\/|\/$/, "") }
  # Don't join empty bits
  result = parts.select { |part| part != "" }.join("/")
  # Put the / back on
  absolute ? "/#{result}" : result
end

.realest_path(path) ⇒ Object

Given a path which may only be partly real (i.e. /x/y/z when only /x exists, or /x/y/*/blah when /x/y/z/blah exists), call File.realpath on the biggest part that actually exists.

If /x is a symlink to /blarghle, and has no subdirectories, then: PathUtils.realest_path(‘/x/y/z’) == ‘/blarghle/y/z’ PathUtils.realest_path(‘/x/*/z’) == ‘/blarghle/*/z’ PathUtils.realest_path(‘/*/y/z’) == ‘/*/y/z’



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/chef/chef_fs/path_utils.rb', line 71

def self.realest_path(path)
  path = Pathname.new(path)
  begin
    path.realpath.to_s
  rescue Errno::ENOENT
    dirname = path.dirname
    if dirname
      PathUtils.join(realest_path(dirname), path.basename.to_s)
    else
      path.to_s
    end
  end
end

.regexp_path_separator ⇒ Object 



59
60
61
 
# File 'lib/chef/chef_fs/path_utils.rb', line 59

def self.regexp_path_separator
  Chef::ChefFS::windows? ? '[\/\\\\]' : '/'
end

.relative_to(dest, source) ⇒ Object

If you are in ‘source’, this is what you would have to type to reach ‘dest’ relative_to(‘/a/b/c/d/e’, ‘/a/b/x/y’) == ‘../../c/d/e’ relative_to(‘/a/b’, ‘/a/b’) == ‘.’



29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/chef/chef_fs/path_utils.rb', line 29

def self.relative_to(dest, source)
  # Skip past the common parts
  source_parts = Chef::ChefFS::PathUtils.split(source)
  dest_parts = Chef::ChefFS::PathUtils.split(dest)
  i = 0
  until i >= source_parts.length || i >= dest_parts.length || source_parts[i] != dest_parts[i]
    i+=1
  end
  # dot-dot up from 'source' to the common ancestor, then
  # descend to 'dest' from the common ancestor
  result = Chef::ChefFS::PathUtils.join(*(['..']*(source_parts.length-i) + dest_parts[i,dest.length-i]))
  result == '' ? '.' : result
end

.split(path) ⇒ Object 



55
56
57
 
# File 'lib/chef/chef_fs/path_utils.rb', line 55

def self.split(path)
  path.split(Regexp.new(regexp_path_separator))
end