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

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

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 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 64

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_label(source_node, semx_node) ⇒ Object 



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 421

def deduplicate_semx_label(source_node, semx_node)
  first_text = semx_node.children.find do |c|
    c.text? && !c.text.strip.empty?
  end
  return unless first_text

  semx_prefix = first_text.text[/\A(\s*\S+)/, 1]
  return unless semx_prefix && !semx_prefix.strip.empty?

  prev = source_node.previous_sibling
  return unless prev.is_a?(Nokogiri::XML::Text)

  label = semx_prefix.strip
  prev_text = prev.text.rstrip
  return unless prev_text.end_with?(label)

  prev.content = prev_text.sub(/#{Regexp.escape(label)}\s*\z/, "")
  first_text.content = first_text.text.sub(
    /\A\s*#{Regexp.escape(label)}\s*/, ""
  )
end

#deduplicate_semx_text(semx_text, rendered_so_far) ⇒ Object 



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

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

#raw_content_node?(node) ⇒ Boolean

Returns:

  • (Boolean) 


140
141
142
143
144
145
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 140

def raw_content_node?(node)
  node.is_a?(Lutaml::Model::Serializable) &&
    node.content.is_a?(String)
rescue NoMethodError
  false
end

#render_asciimath(el) ⇒ Object 



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

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 



275
276
277
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 275

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

#render_br ⇒ Object 



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

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

#render_cell_content(cell) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 92

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 



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

def render_comma(*)
  ", "
end

#render_concept(concept) ⇒ Object 



503
504
505
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 503

def render_concept(concept)
  render_mixed_inline(concept)
end

#render_em(el) ⇒ Object 



172
173
174
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 172

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

#render_eref(eref) ⇒ Object 



473
474
475
476
477
478
479
480
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 473

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 



507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 507

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 { |m| m.content.to_s }.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 



235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 235

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 



482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 482

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 



223
224
225
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 223

def render_fn_inline(el)
  render_fn(el)
end

#render_image(image) ⇒ Object 



279
280
281
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 279

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

#render_index(el) ⇒ Object 



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

def render_index(el)
  collect_index_term(el)
  nil
end

#render_inline_collections(node) ⇒ Object 



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 287

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

  inline_attrs = %i[em strong smallcap sub sup tt underline strike
                    xref eref link span stem concept fn br tab keyword
                    fmt_annotation_start fmt_annotation_end
                    fmt_stem fmt_fn_label fmt_concept
                    bookmark image semx fmt_xref_label]
  inline_attrs.each do |attr|
    values = safe_attr(node, attr)
    next if values.nil?

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

#render_inline_element(element) ⇒ Object 



593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 593

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 



375
376
377
378
379
380
381
382
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 375

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_link(link) ⇒ Object 



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 443

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 



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

def render_math(el)
  el.content.to_s
end

#render_mixed_content_in_order(node) ⇒ Object 



608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 608

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 



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
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 114

def render_mixed_inline(node)
  if raw_content_node?(node)
    raw = node.content
    if raw.is_a?(String) && !raw.strip.empty?
      return render_raw_content(raw)
    end
  end

  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 



283
284
285
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 283

def render_noop_inline(*)
  nil
end

#render_note_inline(el) ⇒ Object 



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

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

#render_ordered_inline(node) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 147

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_raw_content(raw_xml) ⇒ Object 



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 384

def render_raw_content(raw_xml)
  doc = Nokogiri::XML.fragment(raw_xml)
  doc.css("fmt-link").each do |el|
    target = el["target"] || el["href"]
    if target
      display_text = target.delete_prefix("mailto:")
      a = doc.document.create_element("a", display_text,
                                      "href" => target)
      el.replace(a)
    else
      el.replace(el.children)
    end
  end
  doc.traverse do |node|
    next unless node.element?
    next unless %w[xref eref stem link].include?(node.name)

    next_sib = node.next_sibling
    while next_sib.is_a?(Nokogiri::XML::Text) && next_sib.text.strip.empty?
      next_sib = next_sib.next_sibling
    end
    next unless next_sib&.element? && next_sib.name == "semx"

    deduplicate_semx_label(node, next_sib)
    node.remove
  end
  %w[semx fmt-xref].each do |tag|
    doc.css(tag).each { |el| el.replace(el.children) }
  end
  doc.css("[class]").each do |el|
    el["class"] = el["class"].split(/\s+/).map do |c|
      html_class_for_span(c)
    end.join(" ")
  end
  doc.inner_html
end

#render_semx_content(element, **_opts) ⇒ Object 



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
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 316

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 



231
232
233
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 231

def render_semx_inline(el)
  render_semx_content(el)
end

#render_small_caps(el) ⇒ Object 



192
193
194
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 192

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

#render_span(el) ⇒ Object 



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 212

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 



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

def render_stem(_el)
  nil
end

#render_stem_content(stem) ⇒ Object 



544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 544

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

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

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

  if stem.is_a?(Metanorma::Document::Components::TextElements::StemElement)
    if stem.math
      math_val = stem.math
      if math_val.is_a?(Lutaml::Model::Serializable)
        return math_val.to_xml
      end

      text = escape_html(coordinator.extract_text_value(math_val))
      return render_liquid("_stem_span.html.liquid", {
                             "data_attrs" => "",
                             "text" => text,
                           })
    elsif stem.asciimath
      text = escape_html(coordinator.extract_text_value(stem.asciimath))
      return render_liquid("_stem_span.html.liquid", {
                             "data_attrs" => "",
                             "text" => text,
                           })
    end
    if stem.latexmath
      text = escape_html(coordinator.extract_text_value(stem.latexmath))
      return render_liquid("_stem_span.html.liquid", {
                             "data_attrs" => "",
                             "text" => text,
                           })
    end
  end

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

#render_strike(el) ⇒ Object 



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

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

#render_strong(el) ⇒ Object 



176
177
178
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 176

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

#render_sub(el) ⇒ Object 



184
185
186
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 184

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

#render_sup(el) ⇒ Object 



188
189
190
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 188

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

#render_tab ⇒ Object 



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

def render_tab(*)
  "  "
end

#render_tt(el) ⇒ Object 



180
181
182
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 180

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

#render_underline(el) ⇒ Object 



196
197
198
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 196

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

#render_xref(xref) ⇒ Object 



462
463
464
465
466
467
468
469
470
471
 
# File 'lib/metanorma/html/renderers/inline_renderer.rb', line 462

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
55
56
57
58
59
60
61
62
 
# 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 = {}
  xml_mapping.mapping_elements_hash.each_value do |rule_or_array|
    Array(rule_or_array).each do |rule|
      element_to_attr[rule.name] = rule.to
      if rule.name.is_a?(Symbol)
        element_to_attr[rule.name.to_s] =
          rule.to
      end
    end
  end

  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