class Git::Path

A base class that represents and validates a filesystem path

Use for tracking things relevant to a Git repository, such as the working directory or index file.

Public Class Methods

Source

# File lib/git/path.rb, line 18
def initialize(path, must_exist: true)
  path = File.expand_path(path)

  raise ArgumentError, 'path does not exist', [path] if must_exist && !File.exist?(path)

  @path = path
end

Public Instance Methods

path ()

Source

# File lib/git/path.rb, line 10
def path
  Git::Deprecation.warn(
    'The .path accessor is deprecated and will be removed in v5.0. ' \
    'Use .to_s instead.'
  )
  @path
end

readable? ()

Source

# File lib/git/path.rb, line 26
def readable?
  File.readable?(@path)
end

to_s ()

Source

# File lib/git/path.rb, line 34
def to_s
  @path
end

writable? ()

Source

# File lib/git/path.rb, line 30
def writable?
  File.writable?(@path)
end