Class: Coradoc::Html::Converters::Ordered

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

Overview

Converter for Ordered (numbered) lists

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

.to_coradoc(node, state = {}) ⇒ Coradoc::CoreModel::ListBlock

Convert HTML <ol> to CoreModel::ListBlock

Parameters:

  • node (Nokogiri::XML::Node) —

    HTML node

  • state (Hash) (defaults to: {}) —

    Conversion state

Returns:

  • (Coradoc::CoreModel::ListBlock) —

    Ordered list model



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/coradoc/html/converters/ordered.rb', line 13

def to_coradoc(node, state = {})
  items = node.css('> li').map do |li_node|
    Coradoc::Html::Converters::ListItem.to_coradoc(li_node, state)
  end

  attrs = extract_node_attributes(node)

  list = Coradoc::CoreModel::ListBlock.new(
    marker_type: 'ordered',
    items: items
  )
  list.id = attrs[:id] if attrs[:id]

  # Extract start value if present
  list.start = attrs[:start].to_i if attrs[:start]

  list
end

.to_html(model, state = {}) ⇒ String

Convert CoreModel::ListBlock (ordered) to HTML <ol>

Parameters:

  • model (Coradoc::CoreModel::ListBlock) —

    Ordered list model

  • state (Hash) (defaults to: {}) —

    Conversion state

Returns:

  • (String) —

    HTML string



36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/coradoc/html/converters/ordered.rb', line 36

def to_html(model, state = {})
  items_html = model.items.map do |item|
    Coradoc::Html::Converters::ListItem.to_html(item, state)
  end.join("\n")

  attrs = {}
  attrs[:id] = model.id if model.id

  # Add start attribute if not starting from 1
  attrs[:start] = model.start if model.start && model.start != 1

  build_element('ol', "\n#{items_html}\n", attrs)
end