class Git::Status::Git::Status::StatusFile

Represents a single file’s status in the git repository. Each instance holds information about a file’s state in the index and working tree.

@api public

Attributes

The file mode recorded in the index

@return [String, nil] the octal file mode (e.g. ‘“100644”`), or `nil`

The file mode recorded in HEAD

@return [String, nil] the octal file mode (e.g. ‘“100644”`), or `nil`

The repository-relative file path

@return [String] the path

The SHA of the index version of this file

@return [String, nil] the SHA-1 hex digest, or ‘nil` if unavailable

The SHA of the HEAD version of this file

@return [String, nil] the SHA-1 hex digest, or ‘nil` if unavailable

The merge stage for this file

@return [String, nil] ‘“0”` for normal entries, or a non-zero value during

a merge conflict

The change type for this file

@return [String, nil] ‘“M”` for modified, `“A”` for added, `“D”` for deleted,

or `nil` when not applicable

Whether this file is untracked

@return [Boolean, nil] ‘true` when the file is not tracked by git

Public Class Methods

new (base, hash)

Source

# File lib/git/status.rb, line 258
def initialize(base, hash)
  @base       = base
  @path       = hash[:path]
  @type       = hash[:type]
  @stage      = hash[:stage]
  @mode_index = hash[:mode_index]
  @mode_repo  = hash[:mode_repo]
  @sha_index  = hash[:sha_index]
  @sha_repo   = hash[:sha_repo]
  @untracked  = hash[:untracked]
end

Initialize a new StatusFile with the given git object and data hash

@param base [Git::Repository] the git object

@param hash [Hash] raw status data for this file

Public Instance Methods

blob (type = :index)

Source

# File lib/git/status.rb, line 278
def blob(type = :index)
  sha = type == :repo ? sha_repo : (sha_index || sha_repo)
  @base.object(sha) if sha
end

Return a blob object for the index or repo version of this file

@param type [Symbol] ‘:index` (default) for the index version, or

`:repo` for the HEAD version

@return [Git::Object::Blob, nil] the blob object, or ‘nil` if no SHA

is available for the requested version