Class: Git::DiffResult

Inherits:

Data

• Object
• Data
• Git::DiffResult

Defined in:

lib/git/diff_result.rb

Overview

Immutable result object from git diff commands

Contains summary statistics and per-file information from various diff formats. The files array contains one of:

• DiffFileNumstatInfo (from --numstat)
• DiffFileRawInfo (from --raw)
• DiffFilePatchInfo (from --patch)

Instance Attribute Summary

• #dirstat ⇒ DirstatInfo^? readonly

  Directory statistics if requested, nil otherwise.

• #files ⇒ Array<DiffFileNumstatInfo, DiffFileRawInfo, DiffFilePatchInfo> readonly

  Per-file information.

• #files_changed ⇒ Integer readonly

  Number of files changed (from --shortstat).

• #total_deletions ⇒ Integer readonly

  Total lines deleted across all files (from --shortstat).

• #total_insertions ⇒ Integer readonly

  Total lines inserted across all files (from --shortstat).

Instance Attribute Details

#dirstat ⇒ DirstatInfo^? (readonly)

Returns directory statistics if requested, nil otherwise.

Returns:

• (DirstatInfo, nil) —

  directory statistics if requested, nil otherwise

# File 'lib/git/diff_result.rb', line 31

DiffResult = Data.define(:files_changed, :total_insertions, :total_deletions, :files, :dirstat)

#files ⇒ Array<DiffFileNumstatInfo, DiffFileRawInfo, DiffFilePatchInfo> (readonly)

Returns per-file information.

Returns:

• (Array<DiffFileNumstatInfo, DiffFileRawInfo, DiffFilePatchInfo>) —

  per-file information

# File 'lib/git/diff_result.rb', line 31

DiffResult = Data.define(:files_changed, :total_insertions, :total_deletions, :files, :dirstat)

#files_changed ⇒ Integer (readonly)

Returns number of files changed (from --shortstat).

Returns:

• (Integer) —

  number of files changed (from --shortstat)

# File 'lib/git/diff_result.rb', line 31

DiffResult = Data.define(:files_changed, :total_insertions, :total_deletions, :files, :dirstat)

#total_deletions ⇒ Integer (readonly)

Returns total lines deleted across all files (from --shortstat).

Returns:

• (Integer) —

  total lines deleted across all files (from --shortstat)

# File 'lib/git/diff_result.rb', line 31

DiffResult = Data.define(:files_changed, :total_insertions, :total_deletions, :files, :dirstat)

#total_insertions ⇒ Integer (readonly)

Returns total lines inserted across all files (from --shortstat).

Returns:

• (Integer) —

  total lines inserted across all files (from --shortstat)

# File 'lib/git/diff_result.rb', line 31

DiffResult = Data.define(:files_changed, :total_insertions, :total_deletions, :files, :dirstat)