class Git::DiffStats

Lazy diff statistics for a comparison between two trees

Supports comparing (1) two commits, (2) a commit against the working tree, or (3) the index against the working tree.

@example Get the insertion and deletion counts

stats = repo.diff_stats
stats.insertions #=> 3
stats.deletions  #=> 1

@api public

Public Class Methods

new (base, from, to, path_limiter = nil)

Source

# File lib/git/diff_stats.rb, line 32
def initialize(base, from, to, path_limiter = nil)
  # Eagerly check for invalid arguments
  [from, to].compact.each do |arg|
    raise ArgumentError, "Invalid argument: '#{arg}'" if arg.start_with?('-')
  end

  @base = base
  @from = from
  @to = to
  @path_limiter = path_limiter
  @fetch_stats = nil
end

Initializes diff-stats state for a tree comparison.

@private

@param base [Git::Repository] the git object used to fetch diff stats

@param from [String] the first commit or object to compare

@param to [String, nil] the second commit or object to compare

@param path_limiter [String, Pathname, Array<String, Pathname>, nil]

path(s) to limit the diff

@return [void]

@raise [ArgumentError] when ‘from` or `to` starts with `“-”`

Public Instance Methods

deletions ()

Source

# File lib/git/diff_stats.rb, line 52
def deletions
  fetch_stats[:total][:deletions]
end

Returns the total number of lines deleted

@example Get the deletion count

stats = repo.diff_stats
stats.deletions #=> 5

@return [Integer] the total deletion count

files ()

Source

# File lib/git/diff_stats.rb, line 86
def files
  fetch_stats[:files]
end

Returns a hash of statistics for each file in the diff

@example Get per-file statistics

stats = repo.diff_stats
stats.files #=> { "lib/foo.rb" => { insertions: 3, deletions: 1 } }

@return [Hash{String=>Hash{Symbol=>Integer}}]

per-file statistics keyed by file path

insertions ()

Source

# File lib/git/diff_stats.rb, line 63
def insertions
  fetch_stats[:total][:insertions]
end

Returns the total number of lines inserted

@example Get the insertion count

stats = repo.diff_stats
stats.insertions #=> 3

@return [Integer] the total insertion count

lines ()

Source

# File lib/git/diff_stats.rb, line 74
def lines
  fetch_stats[:total][:lines]
end

Returns the total number of lines changed (insertions + deletions)

@example Get the total changed-line count

stats = repo.diff_stats
stats.lines #=> 8

@return [Integer] the total changed-line count

total ()

Source

# File lib/git/diff_stats.rb, line 98
def total
  fetch_stats[:total]
end

Returns a hash of the total statistics for the diff

@example Get total statistics

stats = repo.diff_stats
stats.total #=> { insertions: 3, deletions: 1, lines: 4, files: 1 }

@return [Hash{Symbol=>Integer}]

aggregate statistics for the entire diff

Private Instance Methods

fetch_stats ()

Source

# File lib/git/diff_stats.rb, line 107
def fetch_stats
  @fetch_stats ||= @base.diff_numstat(@from, @to, path_limiter: @path_limiter)
end

Lazily fetches and caches the stats from the git lib

@return [Hash] the fetched stats hash