Class: Git::Diff::DiffFile

Inherits:
Object
  • Object
show all
Defined in:
lib/git/diff.rb

Overview

Information about a single changed file within a Git::Diff

Examples:

Access diff file information

diff.each do |file|
  puts file.path
  puts file.binary? ? 'binary' : file.patch
end

Constant Summary collapse

NIL_BLOB_REGEXP =

Regexp matching a nil blob SHA (all-zero hash of 4 to 40 hex digits)

/\A0{4,40}\z/

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base, hash)

Creates a new DiffFile from parsed diff data

Examples:

file = Git::Diff::DiffFile.new(base,
  patch: "diff --git ...", path: 'lib/git.rb',
  mode: '100644', src: 'abc123', dst: 'def456',
  type: 'modified', binary: false)

Parameters:

  • base (Git::Repository) —

    the git repository

  • hash (Hash) —

    the parsed diff attributes



292
293
294
295
296
297
298
299
300
301
 
# File 'lib/git/diff.rb', line 292

def initialize(base, hash)
  @base = base
  @patch = hash[:patch]
  @path = hash[:path]
  @mode = hash[:mode]
  @src = hash[:src]
  @dst = hash[:dst]
  @type = hash[:type]
  @binary = hash[:binary]
end

Instance Attribute Details

#dst ⇒ String

The destination (post-change) blob SHA

Returns:

  • (String) —

    the destination blob SHA



265
266
267
 
# File 'lib/git/diff.rb', line 265

def dst
  @dst
end

#mode ⇒ String

The file mode

Returns:

  • (String) —

    the octal file mode (e.g. "100644")



253
254
255
 
# File 'lib/git/diff.rb', line 253

def mode
  @mode
end

#patch ⇒ String?

The raw diff patch text for this file

Returns:

  • (String, nil) —

    the patch text



241
242
243
 
# File 'lib/git/diff.rb', line 241

def patch
  @patch
end

#path ⇒ String?

The file path relative to the repository root

Returns:

  • (String, nil) —

    the file path



247
248
249
 
# File 'lib/git/diff.rb', line 247

def path
  @path
end

#src ⇒ String

The source (pre-change) blob SHA

Returns:

  • (String) —

    the source blob SHA



259
260
261
 
# File 'lib/git/diff.rb', line 259

def src
  @src
end

#type ⇒ String

The type of change

Returns:

  • (String) —

    the change type (e.g. "modified", "new", "deleted")



271
272
273
 
# File 'lib/git/diff.rb', line 271

def type
  @type
end

Instance Method Details

#binary? ⇒ Boolean

Returns true if this file is a binary file

Examples:

diff['path/to/image.png'].binary? # => true

Returns:

  • (Boolean) —

    true if the file is binary, false otherwise



310
311
312
 
# File 'lib/git/diff.rb', line 310

def binary?
  !!@binary
end

#blob(type = :dst) ⇒ Git::Object::Blob?

Returns the blob object for this file

Examples:

Retrieve the destination blob

file.blob       # => #<Git::Object::Blob ...>

Retrieve the source blob

file.blob(:src) # => #<Git::Object::Blob ...>

Parameters:

  • type (Symbol) (defaults to: :dst) —

    :src to retrieve the source blob, or :dst (default) for the destination blob

Returns:

  • (Git::Object::Blob, nil) —

    the blob object, or nil if the blob SHA is the null SHA



328
329
330
331
332
333
334
 
# File 'lib/git/diff.rb', line 328

def blob(type = :dst)
  if type == :src && !NIL_BLOB_REGEXP.match(@src)
    @base.object(@src)
  elsif !NIL_BLOB_REGEXP.match(@dst)
    @base.object(@dst)
  end
end