Class: Canon::DiffFormatter::ByLine::HtmlFormatter

Inherits:
BaseFormatter
  • Object
show all
Defined in:
lib/canon/diff_formatter/by_line/html_formatter.rb

Overview

HTML formatter with DOM-guided diffing Uses DOM parsing and element matching for intelligent HTML diffs

Instance Attribute Summary collapse

Attributes inherited from BaseFormatter

#context_lines, #diff_grouping_lines, #diff_mode, #legacy_terminal, #show_diffs, #use_color, #visualization_map

Instance Method Summary collapse

Methods inherited from BaseFormatter

#apply_bg, #apply_color, #apply_theme_style, #changed_content_styles, #compute_line_num_width, #content_style, #display_mode, for_format, #marker_style, #normalize_color_for_rainbow, #structure_color, #structure_styles, #styled_marker, #theme, #theme_color, #theme_style, #unchanged_content_style, #visualization_chars

Constructor Details

#initialize(use_color: true, context_lines: 3, diff_grouping_lines: nil, visualization_map: nil, html_version: :html4, show_diffs: :all, differences: [], diff_mode: :separate, legacy_terminal: false, equivalent: nil, character_visualization: true) ⇒ HtmlFormatter

rubocop:disable-next Metrics/ParameterLists



14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/canon/diff_formatter/by_line/html_formatter.rb', line 14

def initialize(use_color: true, context_lines: 3,
               diff_grouping_lines: nil, visualization_map: nil,
               html_version: :html4, show_diffs: :all, differences: [],
               diff_mode: :separate, legacy_terminal: false,
               equivalent: nil, character_visualization: true)
  super(use_color: use_color, context_lines: context_lines,
        diff_grouping_lines: diff_grouping_lines,
        visualization_map: visualization_map,
        show_diffs: show_diffs, differences: differences,
        diff_mode: diff_mode, legacy_terminal: legacy_terminal,
        equivalent: equivalent,
        character_visualization: character_visualization)
  @html_version = html_version
end

Instance Attribute Details

#html_version ⇒ Object (readonly)

Returns the value of attribute html_version.



11
12
13
 
# File 'lib/canon/diff_formatter/by_line/html_formatter.rb', line 11

def html_version
  @html_version
end

Instance Method Details

#format(doc1, doc2) ⇒ String

Format DOM-guided HTML diff

Parameters:

  • doc1 (String) —

    First HTML document

  • doc2 (String) —

    Second HTML document

Returns:

  • (String) —

    Formatted diff



34
35
36
37
38
39
40
41
 
# File 'lib/canon/diff_formatter/by_line/html_formatter.rb', line 34

def format(doc1, doc2)
  compute_line_num_width(doc1, doc2)
  return "" if should_skip_diff_display?

  # The DiffNode pipeline is the only renderer: without
  # DiffNodes there is nothing to report (#84).
  format_with_pipeline(doc1, doc2)
end

#format_context_from_lines(context, lines1, _lines2) ⇒ Object

Format a context using its DiffLines



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/canon/diff_formatter/by_line/html_formatter.rb', line 89

def format_context_from_lines(context, lines1, _lines2)
  output = []

  context.lines.each do |diff_line|
    case diff_line.type
    when :unchanged
      line_num = diff_line.line_number + 1
      output << format_unified_line(line_num, line_num, " ",
                                    diff_line.content)
    when :removed
      line_num = diff_line.line_number + 1
      formatting = diff_line.formatting?
      informative = diff_line.informative?

      output << if formatting
                  # Formatting-only removal: [ marker
                  format_unified_line(line_num, nil, "[",
                                      diff_line.content,
                                      theme_color(:formatting,
                                                  :marker) || :black,
                                      formatting: true)
                elsif informative
                  # Informative removal: < marker
                  format_unified_line(line_num, nil, "<",
                                      diff_line.content,
                                      theme_color(:informative,
                                                  :marker) || :blue,
                                      informative: true)
                else
                  # Normative removal: - marker
                  format_unified_line(line_num, nil, "-",
                                      diff_line.content,
                                      theme_color(:removed,
                                                  :marker) || :red)
                end
    when :added
      line_num = diff_line.line_number + 1
      formatting = diff_line.formatting?
      informative = diff_line.informative?

      output << if formatting
                  # Formatting-only addition: ] marker
                  format_unified_line(nil, line_num, "]",
                                      diff_line.content,
                                      theme_color(:formatting,
                                                  :marker) || :white,
                                      formatting: true)
                elsif informative
                  # Informative addition: > marker
                  format_unified_line(nil, line_num, ">",
                                      diff_line.content,
                                      theme_color(:informative,
                                                  :marker) || :cyan,
                                      informative: true)
                else
                  # Normative addition: + marker
                  format_unified_line(nil, line_num, "+",
                                      diff_line.content,
                                      theme_color(:added,
                                                  :marker) || :green)
                end
    when :changed
      line_num = diff_line.line_number + 1
      formatting = diff_line.formatting?
      informative = diff_line.informative?
      old_content = lines1[diff_line.line_number]
      new_content = diff_line.content

      if formatting
        fmt_color = theme_color(:formatting, :marker) || :black
        output << format_unified_line(line_num, nil, "[",
                                      old_content,
                                      fmt_color,
                                      formatting: true)
        output << format_unified_line(nil, line_num, "]",
                                      new_content,
                                      fmt_color,
                                      formatting: true)
      elsif informative
        inf_color = theme_color(:informative, :marker) || :blue
        output << format_unified_line(line_num, nil, "<",
                                      old_content,
                                      inf_color,
                                      informative: true)
        output << format_unified_line(nil, line_num, ">",
                                      new_content,
                                      inf_color,
                                      informative: true)
      else
        output << format_unified_line(line_num, nil, "-",
                                      old_content,
                                      theme_color(:removed,
                                                  :marker) || :red)
        output << format_unified_line(nil, line_num, "+",
                                      new_content,
                                      theme_color(:added,
                                                  :marker) || :green)
      end
    end
  end

  output.join("\n")
end

#format_report(report, doc1, doc2) ⇒ Object

Format a DiffReport for display



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/canon/diff_formatter/by_line/html_formatter.rb', line 61

def format_report(report, doc1, doc2)
  return "" if report.contexts.empty?

  lines1 = doc1.split("\n")
  lines2 = doc2.split("\n")

  output = []

  # Detect non-ASCII characters
  non_ascii = Legend.detect_non_ascii(doc1, @visualization_map)
  non_ascii.merge!(Legend.detect_non_ascii(doc2, @visualization_map))

  # Add Unicode legend if needed
  unless non_ascii.empty?
    output << Legend.build_legend(non_ascii, use_color: @use_color)
    output << ""
  end

  # Format each context
  report.contexts.each_with_index do |context, idx|
    output << "" if idx.positive?
    output << format_context_from_lines(context, lines1, lines2)
  end

  output.join("\n")
end

#format_with_pipeline(doc1, doc2) ⇒ Object

Format using new DiffReportBuilder pipeline



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/canon/diff_formatter/by_line/html_formatter.rb', line 44

def format_with_pipeline(doc1, doc2)
  # Layer 2: Map DiffNodes to DiffLines
  diff_lines = Canon::Diff::DiffNodeMapper.map(@differences, doc1, doc2)

  # Layers 3-5: Build report through pipeline
  report = Canon::Diff::DiffReportBuilder.build(
    diff_lines,
    show_diffs: @show_diffs,
    context_lines: @context_lines,
    grouping_lines: @diff_grouping_lines,
  )

  # Layer 6: Format the report
  format_report(report, doc1, doc2)
end