Class: Psych::Merge::MergeResult

Inherits:
Ast::Merge::MergeResultBase
  • Object
show all
Defined in:
lib/psych/merge/merge_result.rb

Overview

Tracks the result of a merge operation, including the merged content,
decisions made, and statistics.

Inherits decision constants and base functionality from Ast::Merge::MergeResultBase.

Examples:

Basic usage

result = MergeResult.new
result.add_line("key: value", decision: :kept_template, source: :template)
result.to_yaml # => "key: value\n"

Constant Summary collapse

DECISION_KEPT_TEMPLATE =

Inherit decision constants from base class

Ast::Merge::MergeResultBase::DECISION_KEPT_TEMPLATE
DECISION_KEPT_DEST = 
Ast::Merge::MergeResultBase::DECISION_KEPT_DEST
DECISION_MERGED = 
Ast::Merge::MergeResultBase::DECISION_MERGED
DECISION_ADDED = 
Ast::Merge::MergeResultBase::DECISION_ADDED
DECISION_FREEZE_BLOCK = 
Ast::Merge::MergeResultBase::DECISION_FREEZE_BLOCK

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**options) ⇒ MergeResult

Initialize a new merge result

Parameters:

  • options (Hash) —

    Additional options for forward compatibility



27
28
29
30
31
32
33
34
35
36
 
# File 'lib/psych/merge/merge_result.rb', line 27

def initialize(**options)
  super(**options)
  @statistics = {
    template_lines: 0,
    dest_lines: 0,
    merged_lines: 0,
    freeze_preserved_lines: 0,
    total_decisions: 0,
  }
end

Instance Attribute Details

#statistics ⇒ Hash (readonly)

Returns Statistics about the merge.

Returns:

  • (Hash) —

    Statistics about the merge



23
24
25
 
# File 'lib/psych/merge/merge_result.rb', line 23

def statistics
  @statistics
end

Instance Method Details

#add_blank_line(decision: DECISION_MERGED, source: :merged) ⇒ Object

Add a blank line

Parameters:

  • decision (Symbol) (defaults to: DECISION_MERGED) —

    Decision for the blank line

  • source (Symbol) (defaults to: :merged) —

    Source



86
87
88
 
# File 'lib/psych/merge/merge_result.rb', line 86

def add_blank_line(decision: DECISION_MERGED, source: :merged)
  add_line("", decision: decision, source: source)
end

#add_freeze_block(freeze_node) ⇒ Object

Add content from a freeze block

Parameters:

  • freeze_node (FreezeNode) —

    Freeze block to add



93
94
95
96
97
98
99
100
101
102
 
# File 'lib/psych/merge/merge_result.rb', line 93

def add_freeze_block(freeze_node)
  freeze_node.lines.each_with_index do |line, idx|
    add_line(
      line.chomp,
      decision: DECISION_FREEZE_BLOCK,
      source: :destination,
      original_line: freeze_node.start_line + idx,
    )
  end
end

#add_line(line, decision:, source:, original_line: nil) ⇒ Object

Add a single line to the result

Parameters:

  • line (String) —

    Line content

  • decision (Symbol) —

    Decision that led to this line

  • source (Symbol) —

    Source of the line (:template, :destination, :merged)

  • original_line (Integer, nil) (defaults to: nil) —

    Original line number



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/psych/merge/merge_result.rb', line 44

def add_line(line, decision:, source:, original_line: nil)
  @lines << {
    content: line,
    decision: decision,
    source: source,
    original_line: original_line,
  }

  track_statistics(decision, source)
  track_decision(decision, source, line: original_line)
end

#add_lines(lines, decision:, source:, start_line: nil) ⇒ Object

Add multiple lines to the result

Parameters:

  • lines (Array<String>) —

    Lines to add

  • decision (Symbol) —

    Decision for all lines

  • source (Symbol) —

    Source of the lines

  • start_line (Integer, nil) (defaults to: nil) —

    Starting original line number



62
63
64
65
66
67
 
# File 'lib/psych/merge/merge_result.rb', line 62

def add_lines(lines, decision:, source:, start_line: nil)
  lines.each_with_index do |line, idx|
    original_line = start_line ? start_line + idx : nil
    add_line(line, decision: decision, source: source, original_line: original_line)
  end
end

#add_lines_from(lines, decision:, source:, start_line: nil) ⇒ Object

Add lines from an array, preserving trailing newlines

Parameters:

  • lines (Array<String>) —

    Lines to add

  • decision (Symbol) —

    Decision for all lines

  • source (Symbol) —

    Source of the lines

  • start_line (Integer, nil) (defaults to: nil) —

    Starting original line number



75
76
77
78
79
80
 
# File 'lib/psych/merge/merge_result.rb', line 75

def add_lines_from(lines, decision:, source:, start_line: nil)
  lines.each_with_index do |line, idx|
    original_line = start_line ? start_line + idx : nil
    add_line(line, decision: decision, source: source, original_line: original_line)
  end
end

#add_mapping_entry(entry, decision:, source:) ⇒ Object

Add content from a mapping entry

Parameters:

  • entry (MappingEntry) —

    Entry to add

  • decision (Symbol) —

    Decision that led to keeping this entry

  • source (Symbol) —

    Source of the entry



109
110
111
112
113
114
115
116
117
118
 
# File 'lib/psych/merge/merge_result.rb', line 109

def add_mapping_entry(entry, decision:, source:)
  return unless entry.start_line && entry.end_line

  (entry.start_line..entry.end_line).each do |line_num|
    line = entry.lines[line_num - 1]
    next unless line

    add_line(line.chomp, decision: decision, source: source, original_line: line_num)
  end
end

#content ⇒ String

Alias for to_yaml

Returns:

  • (String) 


132
133
134
 
# File 'lib/psych/merge/merge_result.rb', line 132

def content
  to_yaml
end

#to_yaml ⇒ String

Get the merged content as a YAML string

Returns:

  • (String) 


123
124
125
126
127
128
 
# File 'lib/psych/merge/merge_result.rb', line 123

def to_yaml
  content = @lines.map { |l| l[:content] }.join("\n")
  # Ensure trailing newline
  content += "\n" unless content.end_with?("\n") || content.empty?
  content
end