Module: RubyGit::Status

Defined in:

lib/ruby_git/status.rb,
lib/ruby_git/status/entry.rb,
lib/ruby_git/status/stash.rb,
lib/ruby_git/status/branch.rb,
lib/ruby_git/status/parser.rb,
lib/ruby_git/status/report.rb,
lib/ruby_git/status/ignored_entry.rb,
lib/ruby_git/status/renamed_entry.rb,
lib/ruby_git/status/ordinary_entry.rb,
lib/ruby_git/status/unmerged_entry.rb,
lib/ruby_git/status/untracked_entry.rb,
lib/ruby_git/status/submodule_status.rb

Overview

The working tree status

Defined Under Namespace

Classes: Branch, Entry, IgnoredEntry, OrdinaryEntry, Parser, RenamedEntry, Report, Stash, SubmoduleStatus, UnmergedEntry, UntrackedEntry

Class Method Summary

• .parse(status_output) ⇒ RubyGit::Status::Report

  Parse output of git status and return a structured report.

Class Method Details

.parse(status_output) ⇒ RubyGit::Status::Report

Parse output of git status and return a structured report

Examples:

output = `git status -u --porcelain=v2 --renames --branch --show-stash -z`
status = RubyGit::Status.parse(output)
status.branch.name #=> 'main'

Parameters:

• status_output (String) —

  the raw output from git status command

Returns:

• (RubyGit::Status::Report) —

  a structured representation of git status

# File 'lib/ruby_git/status.rb', line 29

def self.parse(status_output)
  Parser.parse(status_output)
end