Module: Coradoc::Mirror::Partitioner

Defined in:
lib/coradoc/mirror/partitioner.rb

Overview

Doc-level structural partitioning of built Mirror nodes into the

preface, sections, *bibliography, *trailing

shape per the

@metanorma/mirror JS contract.

Extracted from Handlers::Structural so handlers stay focused on mapping one CoreModel element → one Mirror node, while the post-emission restructure lives in its own module (MECE).

Constant Summary collapse

SECTION_TYPES =

Mirror node types that count as “section” for partition bucketing. Includes the legacy ‘section’ type plus all JS SECTION_TYPES (clause, annex, abstract, foreword, introduction, terms, definitions, references, content_section, acknowledgements).

Set.new(%w[
  clause annex content_section abstract foreword introduction
  acknowledgements terms definitions references section
]).freeze
METADATA_TYPES =

Mirror node types that are doc-level metadata, not body content. They pass through the partitioner untouched (in document order) so the renderer can choose to skip them — they never land in the preface bucket where they would render as visible body.

Set.new(%w[frontmatter]).freeze

Class Method Summary collapse

Class Method Details

.partition(children) ⇒ Hash{Symbol=>Array<Node>}

Single-pass state machine over a flat list of built Mirror nodes.

Loose blocks before any section appears → :preface. Once a section appears → :sections; subsequent loose blocks also go into :sections (preserves document order). Once a bibliography appears → :trailing. Footnotes blocks always go into :trailing regardless of state.

Metadata blocks (frontmatter) are returned in their own bucket, outside the preface/sections/trailing flow, so they survive the partition round-trip but are never rendered as body content.

Parameters:

  • children (Array<Node>) —

    flat list of built Mirror nodes

Returns:

  • (Hash{Symbol=>Array<Node>}) —

    buckets under :preface, :sections, :bibliography, :trailing, :metadata



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/coradoc/mirror/partitioner.rb', line 45

def partition(children)
  buckets = { preface: [], sections: [], bibliography: [],
              trailing: [], metadata: [] }
  state = :preface

  children.each do |child|
    case child.type
    when 'preface'
      buckets[:preface].concat(child.content || [])
    when 'bibliography'
      buckets[:bibliography] << child
      state = :trailing
    else
      if METADATA_TYPES.include?(child.type)
        buckets[:metadata] << child
      elsif SECTION_TYPES.include?(child.type)
        buckets[:sections] << child
        state = :sections
      elsif child.type == 'footnotes'
        buckets[:trailing] << child
      else
        buckets[state] << child
      end
    end
  end

  buckets
end