Class: Git::Status

Inherits:

Object

• Object
• Git::Status

Includes:

Enumerable

Defined in:

lib/git/status.rb,
lib/git/status.rb,
lib/git/status.rb

Overview

The Status class gets the status of a git repository. It identifies which files have been modified, added, or deleted, including untracked files. The Status object is an Enumerable of StatusFile objects.

Examples:

Inspect repository status

repo = Git.open('/path/to/repo')
status = repo.status
status.changed.each { |path, _file| puts "Modified: #{path}" }
status.added.each { |path, _file| puts "Added: #{path}" }
status.deleted.each { |path, _file| puts "Deleted: #{path}" }
status.untracked.each { |path, _file| puts "Untracked: #{path}" }

Defined Under Namespace

Classes: StatusFile, StatusFileFactory

Instance Method Summary

• #[](file) ⇒ Git::Status::StatusFile^?

  Return the StatusFile for the given path.

• #added ⇒ Hash{String => Git::Status::StatusFile}

  Return files added to the index that are not yet in HEAD.

• #added?(file) ⇒ Boolean

  Return true if file has been added to the index.

• #changed ⇒ Hash{String => Git::Status::StatusFile}

  Return files modified in the index and/or working tree.

• #changed?(file) ⇒ Boolean

  Return true if file has been modified in the index or working tree.

• #deleted ⇒ Hash{String => Git::Status::StatusFile}

  Return files deleted from the index.

• #deleted?(file) ⇒ Boolean

  Return true if file has been deleted from the index.

• #each

  Iterate over all status files.

• #initialize(base) ⇒ Status constructor

  Create a new Status for the given repository.

• #pretty ⇒ String

  Return a formatted multi-line string representation of the status.

• #untracked ⇒ Hash{String => Git::Status::StatusFile}

  Return files present in the working tree but not tracked by git.

• #untracked?(file) ⇒ Boolean

  Return true if file is not tracked by git.

Constructor Details

#initialize(base) ⇒ Status

Create a new Status for the given repository

Parameters:

• base (Git::Repository) —

  the git object backing this status

# File 'lib/git/status.rb', line 25

def initialize(base)
  @base = base
  # The factory returns a hash of file paths to StatusFile objects.
  @files = StatusFileFactory.new(base).construct_files
end

Instance Method Details

#[](file) ⇒ Git::Status::StatusFile^?

Return the StatusFile for the given path

Parameters:

• file (String) —

  the repository-relative path

Returns:

• (Git::Status::StatusFile, nil) —

  the status file, or nil if not found

# File 'lib/git/status.rb', line 96

def [](file) = @files[file]

#added ⇒ Hash{String => Git::Status::StatusFile}

Return files added to the index that are not yet in HEAD

Returns:

• (Hash{String => Git::Status::StatusFile}) —

  added files keyed by path

# File 'lib/git/status.rb', line 44

def added     = @added ||= select_files { |f| f.type == 'A' }

#added?(file) ⇒ Boolean

Return true if file has been added to the index

Parameters:

• file (String) —

  the repository-relative path to check

Returns:

• (Boolean) —

  true if the file has been added

# File 'lib/git/status.rb', line 72

def added?(file)     = file_in_collection?(:added, file)

#changed ⇒ Hash{String => Git::Status::StatusFile}

Return files modified in the index and/or working tree

Includes both staged modifications (index vs HEAD) and unstaged modifications (working tree vs index).

Returns:

• (Hash{String => Git::Status::StatusFile}) —

  changed files keyed by path

# File 'lib/git/status.rb', line 38

def changed   = @changed ||= select_files { |f| f.type == 'M' }

#changed?(file) ⇒ Boolean

Return true if file has been modified in the index or working tree

Parameters:

• file (String) —

  the repository-relative path to check

Returns:

• (Boolean) —

  true if the file has been modified

# File 'lib/git/status.rb', line 64

def changed?(file)   = file_in_collection?(:changed, file)

#deleted ⇒ Hash{String => Git::Status::StatusFile}

Return files deleted from the index

Returns:

• (Hash{String => Git::Status::StatusFile}) —

  deleted files keyed by path

# File 'lib/git/status.rb', line 50

def deleted   = @deleted ||= select_files { |f| f.type == 'D' }

#deleted?(file) ⇒ Boolean

Return true if file has been deleted from the index

Parameters:

• file (String) —

  the repository-relative path to check

Returns:

• (Boolean) —

  true if the file has been deleted

# File 'lib/git/status.rb', line 80

def deleted?(file)   = file_in_collection?(:deleted, file)

#each ⇒ Enumerator<Git::Status::StatusFile> #each {|file| ... } ⇒ Array<Git::Status::StatusFile>

Iterate over all status files

Overloads:

• #each ⇒ Enumerator<Git::Status::StatusFile>

  Returns an enumerator over all status files.

  Returns:

  • (Enumerator<Git::Status::StatusFile>) —

    an enumerator over all status files

• #each {|file| ... } ⇒ Array<Git::Status::StatusFile>

  Returns the full list of status files.

  Yields:

  • (file) —

    each StatusFile in the repository

  Yield Parameters:

  • file (Git::Status::StatusFile) —

    a single file's status

  Yield Returns:

  • (void)

  Returns:

  • (Array<Git::Status::StatusFile>) —

    the full list of status files

# File 'lib/git/status.rb', line 114

def each(&) = @files.values.each(&)

#pretty ⇒ String

Return a formatted multi-line string representation of the status

Returns:

• (String) —

  one indented block per file showing its SHA, mode, type, stage, and untracked flag

# File 'lib/git/status.rb', line 121

def pretty
  map { |file| pretty_file(file) }.join << "\n"
end

#untracked ⇒ Hash{String => Git::Status::StatusFile}

Return files present in the working tree but not tracked by git

Returns:

• (Hash{String => Git::Status::StatusFile}) —

  untracked files keyed by path

# File 'lib/git/status.rb', line 56

def untracked = @untracked ||= select_files(&:untracked)

#untracked?(file) ⇒ Boolean

Return true if file is not tracked by git

Parameters:

• file (String) —

  the repository-relative path to check

Returns:

• (Boolean) —

  true if the file is untracked

# File 'lib/git/status.rb', line 88

def untracked?(file) = file_in_collection?(:untracked, file)