Class: Git::Diff

Inherits:

Object

• Object
• Git::Diff

Includes:

Enumerable

Defined in:

lib/git/diff.rb

Overview

object that holds the last X commits on given branch

Defined Under Namespace

Classes: DiffFile

Instance Attribute Summary

• #from readonly

  Returns the value of attribute from.

• #to readonly

  Returns the value of attribute to.

Instance Method Summary

• #[](key)

  enumerable methods.

• #deletions
• #each(&block)

  :yields: each Git::DiffFile in turn.

• #initialize(base, from = nil, to = nil) ⇒ Diff constructor

  A new instance of Diff.

• #insertions
• #lines
• #name_status
• #patch(file = nil) (also: #to_s)

  if file is provided and is writable, it will write the patch into the file.

• #path(path)
• #size
• #stats

Constructor Details

#initialize(base, from = nil, to = nil) ⇒ Diff

Returns a new instance of Diff.

# File 'lib/git/diff.rb', line 9

def initialize(base, from = nil, to = nil)
  @base = base
  @from = from && from.to_s
  @to = to && to.to_s

  @path = nil
  @full_diff = nil
  @full_diff_files = nil
  @stats = nil
end

Instance Attribute Details

#from (readonly)

Returns the value of attribute from.

# File 'lib/git/diff.rb', line 19

def from
  @from
end

#to (readonly)

Returns the value of attribute to.

# File 'lib/git/diff.rb', line 19

def to
  @to
end

Instance Method Details

#[](key)

enumerable methods

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

def [](key)
  process_full
  @full_diff_files.assoc(key)[1]
end

#deletions

# File 'lib/git/diff.rb', line 40

def deletions
  cache_stats
  @stats[:total][:deletions]
end

#each(&block)

:yields: each Git::DiffFile in turn

# File 'lib/git/diff.rb', line 69

def each(&block) # :yields: each Git::DiffFile in turn
  process_full
  @full_diff_files.map { |file| file[1] }.each(&block)
end

#insertions

# File 'lib/git/diff.rb', line 45

def insertions
  cache_stats
  @stats[:total][:insertions]
end

#lines

# File 'lib/git/diff.rb', line 35

def lines
  cache_stats
  @stats[:total][:lines]
end

#name_status

# File 'lib/git/diff.rb', line 21

def name_status
  cache_name_status
end

#patch(file = nil) Also known as: to_s

if file is provided and is writable, it will write the patch into the file

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

def patch(file = nil)
  cache_full
  @full_diff
end

#path(path)

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

def path(path)
  @path = path
  return self
end

#size

# File 'lib/git/diff.rb', line 30

def size
  cache_stats
  @stats[:total][:files]
end

#stats

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

def stats
  cache_stats
  @stats
end