Class: Coradoc::Html::Converters::ReviewerNote

Inherits:
Base
  • Object
show all
Defined in:
lib/coradoc/html/converters/reviewer_note.rb

Overview

Converter for CoreModel::AnnotationBlock (reviewer note) to HTML <aside>

Class Method Summary collapse

Methods inherited from Base

build_class_attribute, build_element, build_html_attributes, convert_content_to_html, convert_element_to_core, convert_node_to_core, escape_attribute, escape_html, extract_model_attributes, extract_node_attributes, extract_text_fallback, find_converter_class_by_name, find_converter_for_model, handle_unknown_content, render_core_abbreviation, render_core_annotation_block, render_core_bibliography, render_core_bibliography_entry, render_core_block, render_core_block_image, render_core_definition_item, render_core_definition_list, render_core_footnote, render_core_footnote_reference, render_core_inline_element, render_core_inline_image, render_core_list_block, render_core_list_item, render_core_span, render_core_structural_element, render_core_table_cell, render_core_table_row, render_core_term, render_core_toc, render_core_toc_entry, resolve_block_semantic_type, resolve_format_specific_semantic, transform_to_coremodel, treat_children

Class Method Details

.build_attributes(reviewer_note) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/coradoc/html/converters/reviewer_note.rb', line 78

def self.build_attributes(reviewer_note)
  attrs = [%( class="reviewer-note")]

  # Add reviewer metadata as data attributes
  metadata = reviewer_note.metadata || {}

  attrs << %( data-reviewer="#{escape_html(metadata[:reviewer])}") if metadata[:reviewer]

  attrs << %( data-date="#{escape_html(metadata[:date])}") if metadata[:date]

  attrs << %( data-from="#{escape_html(metadata[:from])}") if metadata[:from]

  attrs << %( data-to="#{escape_html(metadata[:to])}") if metadata[:to]

  attrs.join
end

.build_header(reviewer_note) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/coradoc/html/converters/reviewer_note.rb', line 50

def self.build_header(reviewer_note)
  # Build header with label and visible metadata
  header_parts = []
  header_parts << %(<div class="reviewer-note-header">)
  header_parts << %(  <span class="reviewer-note-label">Reviewer's note</span>)

  # Build metadata display if any metadata exists
  metadata_items = []
  metadata = reviewer_note.metadata || {}
  metadata_items << %(reviewer=#{escape_html(metadata[:reviewer])}) if metadata[:reviewer]
  metadata_items << %(date=#{escape_html(metadata[:date])}) if metadata[:date]
  metadata_items << %(from=#{escape_html(metadata[:from])}) if metadata[:from]
  metadata_items << %(to=#{escape_html(metadata[:to])}) if metadata[:to]

  unless metadata_items.empty?
    header_parts << %(  <div class="reviewer-note-metadata">)
    metadata_items.each do |item|
      header_parts << %(    <span class="metadata-item">#{item}</span>)
    end
    header_parts << %(  </div>)
  end

  header_parts << %(</div>)
  header_parts << %(<div class="reviewer-note-content">)

  header_parts.join("\n")
end

.convert_item(item, _options = {}) ⇒ Object 



107
108
109
110
111
112
113
114
 
# File 'lib/coradoc/html/converters/reviewer_note.rb', line 107

def self.convert_item(item, _options = {})
  case item
  when String
    "<p>#{escape_html(item)}</p>"
  else
    convert_content_to_html(item)
  end
end

.extract_content(nodes) ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/coradoc/html/converters/reviewer_note.rb', line 116

def self.extract_content(nodes)
  # Extract and convert content nodes
  nodes.map do |node|
    if node.text? && !node.text.strip.empty?
      node.text.strip
    elsif node.element?
      case node.name
      when 'p'
        Paragraph.to_coradoc(node)
      else
        node.text.strip
      end
    end
  end.compact
end

.process_content(content, options = {}) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/coradoc/html/converters/reviewer_note.rb', line 95

def self.process_content(content, options = {})
  return '' if content.nil?

  if content.is_a?(Array)
    content.map { |item| convert_item(item, options) }.join("\n")
  elsif content.is_a?(String)
    "<p>#{escape_html(content)}</p>"
  else
    convert_item(content, options)
  end
end

.to_coradoc(element, _options = {}) ⇒ Object

Convert HTML <aside> with reviewer data to CoreModel::AnnotationBlock



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/coradoc/html/converters/reviewer_note.rb', line 25

def self.to_coradoc(element, _options = {})
  return nil unless element.name == 'aside'
  return nil unless element['data-reviewer'] # Must have reviewer attribute

  # Extract reviewer metadata
  reviewer = element['data-reviewer']
  date = element['data-date']
  from = element['data-from']
  to = element['data-to']

  # Extract content
  content = extract_content(element.children)

  Coradoc::CoreModel::AnnotationBlock.new(
    annotation_type: 'reviewer_note',
    content: content,
    metadata: {
      reviewer: reviewer,
      date: date,
      from: from,
      to: to
    }
  )
end

.to_html(reviewer_note, options = {}) ⇒ Object

Convert CoreModel::AnnotationBlock (reviewer note) to HTML <aside>



9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/coradoc/html/converters/reviewer_note.rb', line 9

def self.to_html(reviewer_note, options = {})
  return '' unless reviewer_note

  # Build aside attributes with reviewer metadata
  attrs = build_attributes(reviewer_note)

  # Build header with label and visible metadata
  header = build_header(reviewer_note)

  # Process reviewer note content
  content = process_content(reviewer_note.content, options)

  %(<aside#{attrs}>\n#{header}#{content}\n</div>\n</aside>)
end