Class: Diff::LCS::Hunk

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

Overview

A Hunk is a group of Blocks which overlap because of the context surrounding each block. (So if we’re not using context, every hunk will contain one block.) Used in the diff program (bin/diff).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_old, data_new, piece, flag_context, file_length_difference) ⇒ Hunk

Create a hunk using references to both the old and new data, as well as the piece of data.



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/diff/lcs/hunk.rb', line 11

def initialize(data_old, data_new, piece, flag_context, file_length_difference)
  # At first, a hunk will have just one Block in it
  @blocks = [ Diff::LCS::Block.new(piece) ]
  @data_old = data_old
  @data_new = data_new

  before = after = file_length_difference
  after += @blocks[0].diff_size
  @file_length_difference = after # The caller must get this manually

  # Save the start & end of each array. If the array doesn't exist (e.g.,
  # we're only adding items in this block), then figure out the line
  # number based on the line number of the other file and the current
  # difference in file lengths.
  if @blocks[0].remove.empty?
    a1 = a2 = nil
  else
    a1 = @blocks[0].remove[0].position
    a2 = @blocks[0].remove[-1].position
  end

  if @blocks[0].insert.empty?
    b1 = b2 = nil
  else
    b1 = @blocks[0].insert[0].position
    b2 = @blocks[0].insert[-1].position
  end

  @start_old = a1 || (b1 - before)
  @start_new = b1 || (a1 + before)
  @end_old   = a2 || (b2 - after)
  @end_new   = b2 || (a2 + after)

  self.flag_context = flag_context
end

Instance Attribute Details

#blocks ⇒ Object (readonly)

Returns the value of attribute blocks.



47
48
49
 
# File 'lib/diff/lcs/hunk.rb', line 47

def blocks
  @blocks
end

#end_new ⇒ Object (readonly)

Returns the value of attribute end_new.



49
50
51
 
# File 'lib/diff/lcs/hunk.rb', line 49

def end_new
  @end_new
end

#end_old ⇒ Object (readonly)

Returns the value of attribute end_old.



49
50
51
 
# File 'lib/diff/lcs/hunk.rb', line 49

def end_old
  @end_old
end

#file_length_difference ⇒ Object (readonly)

Returns the value of attribute file_length_difference.



50
51
52
 
# File 'lib/diff/lcs/hunk.rb', line 50

def file_length_difference
  @file_length_difference
end

#flag_context ⇒ Object

Change the “start” and “end” fields to note that context should be added to this hunk.



54
55
56
 
# File 'lib/diff/lcs/hunk.rb', line 54

def flag_context
  @flag_context
end

#start_new ⇒ Object (readonly)

Returns the value of attribute start_new.



48
49
50
 
# File 'lib/diff/lcs/hunk.rb', line 48

def start_new
  @start_new
end

#start_old ⇒ Object (readonly)

Returns the value of attribute start_old.



48
49
50
 
# File 'lib/diff/lcs/hunk.rb', line 48

def start_old
  @start_old
end

Instance Method Details

#diff(format) ⇒ Object

Returns a diff string based on a format.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/diff/lcs/hunk.rb', line 95

def diff(format)
  case format
  when :old
    old_diff
  when :unified
    unified_diff
  when :context
    context_diff
  when :ed
    self
  when :reverse_ed, :ed_finish
    ed_diff(format)
  else
    raise "Unknown diff format #{format}."
  end
end

#merge(hunk) ⇒ Object Also known as: unshift

Merges this hunk and the provided hunk together if they overlap. Returns a truthy value so that if there is no overlap, you can know the merge was skipped.



75
76
77
78
79
80
81
82
83
 
# File 'lib/diff/lcs/hunk.rb', line 75

def merge(hunk)
  if overlaps?(hunk)
    @start_old = hunk.start_old
    @start_new = hunk.start_new
    blocks.unshift(*hunk.blocks)
  else
    nil
  end
end

#overlaps?(hunk) ⇒ Boolean

Determines whether there is an overlap between this hunk and the provided hunk. This will be true if the difference between the two hunks start or end positions is within one position of each other.

Returns:

  • (Boolean) 


89
90
91
92
 
# File 'lib/diff/lcs/hunk.rb', line 89

def overlaps?(hunk)
  hunk and (((@start_old - hunk.end_old) <= 1) or
            ((@start_new - hunk.end_new) <= 1))
end