Class: Metanorma::Html::Renderers::InlineRenderer

Inherits:
Object
  • Object
show all
Defined in:
lib/metanorma/html/renderers/inline_renderer.rb

Constant Summary collapse

STEM_FORMATS =

Stem content formats in priority order. Each entry binds an attribute reader on the stem element to the value-render path (raw XML when serializable, escaped text otherwise). Adding a new format = one entry here.

[
  { attr: :math, raw_xml: true },
  { attr: :asciimath },
  { attr: :latexmath },
].freeze

Instance Method Summary collapse

Constructor Details

#initialize(coordinator) ⇒ InlineRenderer

Returns a new instance of InlineRenderer.



7
8
9
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 7

def initialize(coordinator)
  @coordinator = coordinator
end

Instance Method Details

#build_semx_skip_set(node) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 56

def build_semx_skip_set(node)
  skip_after = {
    "link" => "semx",
    "xref" => "semx",
    "eref" => "semx",
    "stem" => nil,
    "concept" => "fmt-concept",
    "refterm" => nil,
    "renderterm" => nil,
    "origin" => "semx",
  }
  skip = {}
  node.element_order.each_with_index do |el, i|
    next unless el.element?

    next_tag = skip_after[el.name]
    next unless next_tag

    next_el = node.element_order[i + 1]
    if next_tag.nil?
      skip[i] = true
    elsif next_el&.element? && next_el.name == next_tag
      skip[i] = true
    end
  end
  skip
end

#deduplicate_semx_text(semx_text, rendered_so_far) ⇒ Object 



355
356
357
358
359
360
361
362
363
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 355

def deduplicate_semx_text(semx_text, rendered_so_far)
  first_word = semx_text[/\A\s*(\S+)/, 1]
  return semx_text unless first_word

  tail = rendered_so_far[-200..]
  return semx_text unless tail&.rstrip&.end_with?(first_word)

  semx_text.sub(/\A\s*#{Regexp.escape(first_word)}\s*/, "")
end

#render_asciimath(el) ⇒ Object 



247
248
249
250
251
252
253
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 247

def render_asciimath(el)
  text = escape_html(Array(el.text).join)
  render_liquid("_stem_span.html.liquid", {
                  "data_attrs" => "",
                  "text" => text,
                })
end

#render_bookmark(bookmark) ⇒ Object 



264
265
266
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 264

def render_bookmark(bookmark, **)
  coordinator.render_bookmark(bookmark, **)
end

#render_br ⇒ Object 



182
183
184
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 182

def render_br(*)
  render_liquid("_br.html.liquid", {})
end

#render_cell_content(cell) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 84

def render_cell_content(cell)
  parts = []
  walked = walk_ordered(cell) do |type, obj|
    case type
    when :text
      parts << escape_html(obj)
    when :tab
      parts << "  "
    when :element
      parts << if coordinator.block_element?(obj)
                 coordinator.render(obj) || ""
               else
                 render_inline_element(obj) || ""
               end
    end
  end
  unless walked
    parts << (render_mixed_content_in_order(cell) || "")
  end
  parts.join
end

#render_comma ⇒ Object 



228
229
230
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 228

def render_comma(*)
  ", "
end

#render_concept(concept) ⇒ Object 



434
435
436
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 434

def render_concept(concept)
  render_mixed_inline(concept)
end

#render_em(el) ⇒ Object 



150
151
152
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 150

def render_em(el)
  render_inline_tag("em", el)
end

#render_eref(eref) ⇒ Object 



404
405
406
407
408
409
410
411
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 404

def render_eref(eref)
  citeas = safe_attr(eref, :citeas)
  if citeas
    escape_html(citeas)
  else
    render_mixed_inline(eref)
  end
end

#render_fmt_stem(fmt_stem) ⇒ Object 



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 438

def render_fmt_stem(fmt_stem)
  semx_items = Array(fmt_stem.semx)
  return nil if semx_items.empty?

  semx = semx_items.first
  math_items = Array(semx.math)
  ascii_items = Array(semx.asciimath)

  source_formats = {}
  if ascii_items.any?
    ascii_text = ascii_items.map { |a| a.text.to_s.strip }.join
    source_formats["asciimath"] = ascii_text unless ascii_text.empty?
  end

  data_attrs = ""
  unless source_formats.empty?
    data_attrs = " data-stem-formats='#{escape_html(source_formats.to_json)}'"
  end

  if math_items.any?
    content = math_items.map(&:to_xml).join
    unless content.empty?
      return render_liquid("_math_container.html.liquid", {
                             "data_attrs" => data_attrs,
                             "content" => content,
                           })
    end
  elsif ascii_items.any?
    text = escape_html(ascii_items.map { |a| a.text.to_s.strip }.join)
    return render_liquid("_stem_span.html.liquid", {
                           "data_attrs" => data_attrs,
                           "text" => text,
                         })
  end
  nil
end

#render_fmt_xref(el) ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 213

def render_fmt_xref(el)
  target = safe_attr(el, :target) || safe_attr(el, :to_attr)
  if target
    attrs = element_attrs(href: "##{escape_html(target)}",
                          class: "xref")
    content = render_mixed_inline(el)
    render_liquid("_link.html.liquid", {
                    "attrs" => attrs,
                    "content" => content,
                  })
  else
    render_mixed_inline(el)
  end
end

#render_fn(fn) ⇒ Object 



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 413

def render_fn(fn)
  fn_id = safe_attr(fn, :id)
  number = coordinator.footnote_collector.register(fn)

  label = safe_attr(fn, :fn_label) || safe_attr(fn, :reference)
  return nil unless label

  popup_parts = Array(fn.p).map do |para|
    render_mixed_inline(para) || ""
  end
  popup_html = popup_parts.join

  assigns = {
    "attrs" => element_attrs(id: fn_id, class: "fn-marker"),
    "number" => number,
    "label" => escape_html(label.to_s),
    "popup_html" => popup_html.strip.empty? ? nil : popup_html,
  }
  render_liquid("_fn_marker.html.liquid", assigns)
end

#render_fn_inline(el) ⇒ Object 



201
202
203
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 201

def render_fn_inline(el)
  render_fn(el)
end

#render_image(image) ⇒ Object 



268
269
270
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 268

def render_image(image)
  coordinator.render_image(image)
end

#render_index(el) ⇒ Object 



255
256
257
258
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 255

def render_index(el)
  collect_index_term(el)
  nil
end

#render_inline_collections(node) ⇒ Object 



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 276

def render_inline_collections(node)
  parts = []
  texts = node.text
  if texts.is_a?(Array)
    texts.each do |t|
      parts << if t.is_a?(String)
                 escape_html(t)
               else
                 render_inline_element(t) || ""
               end
    end
  elsif texts.is_a?(String)
    parts << escape_html(texts)
  end

  # Derive the element-mapped attribute list from the node's own
  # xml_mapping rather than maintaining a parallel hardcoded list.
  # The model is the single source of truth; adding a new inline
  # element type via map_element on the model class is enough.
  node.class.mappings[:xml].elements.each do |rule|
    next if rule.to == :text

    values = safe_attr(node, rule.to)
    next if values.nil?

    Array(values).each { |v| parts << (render_inline_element(v) || "") }
  end
  parts.join
end

#render_inline_element(element) ⇒ Object 



518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 518

def render_inline_element(element, **)
  return nil if element.nil?

  if element.is_a?(String)
    return escape_html(element)
  end

  method = coordinator.lookup_dispatch(element.class, :inline_registry)
  if method
    coordinator.public_send(method, element)
  elsif element.is_a?(Lutaml::Model::Serializable) && element.mixed?
    render_mixed_inline(element)
  end
end

#render_inline_tag(tag_name, element, **extra_attrs) ⇒ Object 



365
366
367
368
369
370
371
372
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 365

def render_inline_tag(tag_name, element, **extra_attrs)
  content = render_mixed_inline(element)
  render_liquid("_element.html.liquid", {
                  "tag" => tag_name,
                  "extra_attrs" => element_attrs(**extra_attrs),
                  "content" => content,
                })
end

#render_input(el) ⇒ Object

Form inputs render as disabled HTML inputs — this is a document rendering, not an interactive form.



234
235
236
237
238
239
240
241
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 234

def render_input(el)
  attrs = element_attrs(
    type: safe_attr(el, :type) || "text",
    disabled: "disabled",
    checked: safe_attr(el, :checked) ? "checked" : nil,
  )
  "<input#{attrs}>"
end

#render_link(link) ⇒ Object 



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 374

def render_link(link)
  target = safe_attr(link, :target) || safe_attr(link, :href)
  attrs = element_attrs(href: target, id: safe_attr(link, :id))
  content = safe_attr(link, :content)
  if content && !Array(content).join.strip.empty?
    inner = render_mixed_inline(link)
    render_liquid("_link.html.liquid", {
                    "attrs" => attrs,
                    "content" => inner,
                  })
  else
    display_text = escape_html(target.to_s.delete_prefix("mailto:"))
    render_liquid("_link.html.liquid", {
                    "attrs" => attrs,
                    "display_text" => display_text,
                  })
  end
end

#render_math(el) ⇒ Object 



243
244
245
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 243

def render_math(el)
  el.to_xml
end

#render_mixed_content_in_order(node) ⇒ Object 



533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 533

def render_mixed_content_in_order(node)
  parts = []
  node.each_mixed_content do |child|
    parts << case child
             when String
               escape_html(child)
             else
               if coordinator.block_element?(child)
                 coordinator.render(child) || ""
               else
                 render_inline_element(child) || ""
               end
             end
  end
  parts.join
end

#render_mixed_inline(node) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 106

def render_mixed_inline(node)
  if node.is_a?(Lutaml::Model::Serializable) && node.element_order && !node.element_order.empty?
    render_ordered_inline(node)
  elsif node.is_a?(Lutaml::Model::Serializable)
    parts = []
    node.each_mixed_content do |child|
      parts << case child
               when String
                 escape_html(child)
               else
                 render_inline_element(child) || ""
               end
    end
    parts.join
  else
    render_inline_collections(node)
  end
end

#render_noop_inline ⇒ Object 



272
273
274
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 272

def render_noop_inline(*)
  nil
end

#render_note_inline(el) ⇒ Object 



260
261
262
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 260

def render_note_inline(el)
  coordinator.render_note(el)
end

#render_ordered_inline(node) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 125

def render_ordered_inline(node)
  parts = []
  walked = walk_ordered(node) do |type, obj|
    case type
    when :text
      parts << escape_html(obj)
    when :tab
      parts << "  "
    when :element
      parts << (render_inline_element(obj) || "")
    end
  end
  unless walked
    node.each_mixed_content do |child|
      parts << case child
               when String
                 escape_html(child)
               else
                 render_inline_element(child) || ""
               end
    end
  end
  parts.join
end

#render_semx_content(element, **_opts) ⇒ Object 



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 306

def render_semx_content(element, **_opts)
  parts = []
  display_attrs = %i[text fmt_xref fmt_link fmt_concept span strong em sup p semx
                     asciimath math sub_child tt_child br_child tab_child
                     stem_child figure_child formula_child sourcecode_child]
  label_stripped = false

  walked = walk_ordered(element,
                        allow_filter: display_attrs) do |type, obj|
    case type
    when :text
      text = obj
      unless label_stripped
        text = deduplicate_semx_text(text, parts.join)
        label_stripped = true
      end
      parts << escape_html(text)
    when :element
      parts << if obj.is_a?(Metanorma::Document::Components::Paragraphs::ParagraphBlock)
                 coordinator.render_paragraph(obj) || ""
               else
                 render_inline_element(obj) || ""
               end
    end
  end

  unless walked
    display_attrs.each do |attr|
      val = safe_attr(element, attr)
      next if val.nil?

      if val.is_a?(Array)
        val.each do |v|
          parts << if v.is_a?(Metanorma::Document::Components::Paragraphs::ParagraphBlock)
                     coordinator.render_paragraph(v) || ""
                   else
                     render_inline_element(v) || ""
                   end
        end
      elsif val.is_a?(String)
        parts << escape_html(val)
      else
        parts << (render_inline_element(val) || "")
      end
    end
  end
  parts.join
end

#render_semx_inline(el) ⇒ Object 



209
210
211
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 209

def render_semx_inline(el)
  render_semx_content(el)
end

#render_small_caps(el) ⇒ Object 



170
171
172
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 170

def render_small_caps(el)
  render_inline_tag("span", el, class: "small-caps")
end

#render_span(el) ⇒ Object 



190
191
192
193
194
195
196
197
198
199
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 190

def render_span(el)
  xml_class = safe_attr(el, :class_attr).to_s
  html_class = html_class_for_span(xml_class) unless xml_class.empty?
  attrs = element_attrs(style: safe_attr(el, :style), class: html_class)
  content = render_mixed_inline(el)
  render_liquid("_inline_span.html.liquid", {
                  "attrs" => attrs,
                  "content" => content,
                })
end

#render_stem(_el) ⇒ Object 



205
206
207
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 205

def render_stem(_el)
  nil
end

#render_stem_content(stem) ⇒ Object 



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 485

def render_stem_content(stem)
  return nil if stem.nil?

  return nil if stem.is_a?(Metanorma::Document::Components::Inline::StemInlineElement) ||
    stem.is_a?(Metanorma::Document::Components::Inline::FmtStemElement)

  unless stem.is_a?(Metanorma::Document::Components::TextElements::StemElement)
    text = coordinator.extract_text_value(stem)
    unless text.empty?
      return render_liquid("_stem_span.html.liquid", {
                             "data_attrs" => "",
                             "text" => escape_html(text),
                           })
    end
    return nil
  end

  STEM_FORMATS.each do |format|
    value = stem.public_send(format[:attr])
    next unless value

    if format[:raw_xml] && value.is_a?(Lutaml::Model::Serializable)
      return value.to_xml
    end

    return render_liquid("_stem_span.html.liquid", {
                           "data_attrs" => "",
                           "text" => escape_html(coordinator.extract_text_value(value)),
                         })
  end
  nil
end

#render_strike(el) ⇒ Object 



178
179
180
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 178

def render_strike(el)
  render_inline_tag("s", el)
end

#render_strong(el) ⇒ Object 



154
155
156
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 154

def render_strong(el)
  render_inline_tag("strong", el)
end

#render_sub(el) ⇒ Object 



162
163
164
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 162

def render_sub(el)
  render_inline_tag("sub", el)
end

#render_sup(el) ⇒ Object 



166
167
168
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 166

def render_sup(el)
  render_inline_tag("sup", el)
end

#render_tab ⇒ Object 



186
187
188
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 186

def render_tab(*)
  "  "
end

#render_tt(el) ⇒ Object 



158
159
160
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 158

def render_tt(el)
  render_inline_tag("tt", el)
end

#render_underline(el) ⇒ Object 



174
175
176
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 174

def render_underline(el)
  render_inline_tag("u", el)
end

#render_xref(xref) ⇒ Object 



393
394
395
396
397
398
399
400
401
402
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 393

def render_xref(xref)
  target = safe_attr(xref, :target) || safe_attr(xref, :to_attr)
  attrs = element_attrs(href: "##{escape_html(target)}",
                        id: safe_attr(xref, :id))
  content = render_mixed_inline(xref)
  render_liquid("_link.html.liquid", {
                  "attrs" => attrs,
                  "content" => content,
                })
end

#walk_ordered(node, allow_filter: nil) ⇒ Object 



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
46
47
48
49
50
51
52
53
54
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 11

def walk_ordered(node, allow_filter: nil)
  return false unless node.is_a?(Lutaml::Model::Serializable)
  return false unless node.element_order.is_a?(Array) && !node.element_order.empty?

  xml_mapping = node.class.mappings_for(:xml, node.lutaml_register)
  return false unless xml_mapping

  element_to_attr =
    Renderers::ElementOrderTraversal.element_to_attr_map(xml_mapping)

  skip_indices = build_semx_skip_set(node)

  indices = Hash.new(0)

  node.element_order.each_with_index do |el, i|
    next if skip_indices.include?(i)

    if el.text?
      text = el.text_content
      yield :text, text if text && block_given?
    elsif el.element?
      if el.name == "tab"
        yield :tab, nil if block_given?
        next
      end

      attr_name = element_to_attr[el.name]
      next unless attr_name

      next if allow_filter && !allow_filter.include?(attr_name)

      coll = node.public_send(attr_name)
      obj = if coll.is_a?(Array)
              idx = indices[attr_name]
              indices[attr_name] += 1
              coll[idx]
            else
              coll
            end
      yield :element, obj if obj && block_given?
    end
  end
  true
end