Class: Coradoc::CoreModel::Builder

Inherits:
Object
  • Object
show all
Includes:
BlockBuilder, Detection, ElementBuilder, ListBuilder, TextBuilder
Defined in:
lib/coradoc/core_model/builder.rb,
lib/coradoc/core_model/builder/detection.rb,
lib/coradoc/core_model/builder/list_builder.rb,
lib/coradoc/core_model/builder/text_builder.rb,
lib/coradoc/core_model/builder/block_builder.rb,
lib/coradoc/core_model/builder/element_builder.rb

Overview

Builds CoreModel objects from generic AST

This class provides a clean separation between parsing and model construction, replacing the Parslet::Transform dependency with a dedicated builder that can be independently tested and maintained.

The builder uses AST detection logic to determine the appropriate CoreModel type to create, handling all current AST structures with graceful fallbacks.

The builder is organized into modules for maintainability:

  • Detection: Element type detection and extraction methods

  • ListBuilder: List building methods

  • BlockBuilder: Block building methods

  • TextBuilder: Text and inline building methods

  • ElementBuilder: Miscellaneous element building methods

Examples:

Building a document from AST

ast = {
  header: { title: "Document Title" },
  sections: [{ section: { title: "Introduction" } }],
  document_attributes: [{ key: "author", value: "John Doe" }]
}
document = CoreModel::Builder.build(ast)

Building individual blocks

block_ast = {
  block: {
    delimiter: "****",
    lines: ["This is a note"],
    attribute_list: { positional: ["NOTE"] }
  }
}
block = CoreModel::Builder.new.build_block(block_ast)

Defined Under Namespace

Modules: BlockBuilder, Detection, ElementBuilder, ListBuilder, TextBuilder

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ElementBuilder

#build_attribute, #build_bibliography_entry, #build_comment_block, #build_comment_line, #build_generic_element, #build_header, #build_include, #build_line_break, #build_section, #build_section_contents, #build_subsections, #build_table, #build_tag, #build_unparsed

Methods included from TextBuilder

#build_nested_inlines, #build_paragraph_content, #build_text, #build_text_element, #extract_inline_content, #extract_text_content

Methods included from BlockBuilder

#build_annotation_block, #build_generic_block, #extract_block_content, #extract_block_lines

Methods included from ListBuilder

#build_definition_content, #build_definition_item, #build_definition_list, #build_item_children, #build_list_block, #build_list_items, #build_nested_list, #build_ordered_list, #build_unordered_list, #extract_item_content

Methods included from Detection

#annotation_delimiters, #annotation_types, #detect_block_type, #detect_constrained, #detect_element_type, #detect_inline_format, #detect_marker_level, #detect_marker_type, #extract_annotation_label, #extract_annotation_type, #extract_level, #has_block_structure?, #has_header_structure?, #has_inline_structure?, #has_section_structure?, #inline_format_types, #list_markers

Constructor Details

#initialize ⇒ Builder

Initialize a new builder instance



63
64
65
 
# File 'lib/coradoc/core_model/builder.rb', line 63

def initialize
  # No logger setup needed - use Coradoc::Logger class methods
end

Class Method Details

.build(ast) ⇒ Hash

Build document from AST

Parameters:

  • ast (Hash) —

    the AST representation of a document

Returns:

  • (Hash) —

    document structure for compatibility with existing code



58
59
60
 
# File 'lib/coradoc/core_model/builder.rb', line 58

def self.build(ast)
  new.build_document(ast)
end

Instance Method Details

#build_attributes(attr_ast) ⇒ Object

Build attributes from attribute list AST (public version)



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/coradoc/core_model/builder.rb', line 205

def build_attributes(attr_ast)
  return [] unless attr_ast

  case attr_ast
  when Hash
    attributes = []

    if attr_ast[:positional]
      Array(attr_ast[:positional]).each do |pos|
        attributes << { positional: pos.to_s }
      end
    end

    if attr_ast[:named]
      Array(attr_ast[:named]).each do |named|
        next unless named.is_a?(Hash)

        attributes << {
          key: named[:key] || named[:named_key],
          value: named[:value] || named[:named_value]
        }
      end
    end

    attributes
  when Array
    attr_ast.map { |attr| build_attribute(attr) }.compact
  else
    []
  end
end

#build_block(ast) ⇒ Object

Build a block element with type detection



141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/coradoc/core_model/builder.rb', line 141

def build_block(ast)
  block_ast = ast[:block] || ast

  case detect_block_type(block_ast)
  when :annotation
    build_annotation_block(block_ast)
  when :list
    build_list_block(block_ast)
  else
    build_generic_block(block_ast)
  end
end

#build_document(ast) ⇒ Hash

Build document structure from AST

Parameters:

  • ast (Hash) —

    the document AST

Returns:

  • (Hash) —

    document structure with header, sections, and attributes



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/coradoc/core_model/builder.rb', line 71

def build_document(ast)
  case ast
  when Hash
    if ast.key?(:document)
      build_document_elements(ast[:document])
    else
      build_document_elements(ast)
    end
  when Array
    elements = ast.map { |element| build_element(element) }.compact
    group_document_elements(elements)
  else
    Coradoc::Logger.warn("Unexpected AST format: #{ast.class}")
    { sections: [] }
  end
end

#build_document_attributes(ast) ⇒ Object

Build document attributes



238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/coradoc/core_model/builder.rb', line 238

def build_document_attributes(ast)
  attrs_ast = ast[:document_attributes] || ast

  {
    type: :document_attributes,
    attributes: Array(attrs_ast).map do |attr|
      {
        key: attr[:key],
        value: attr[:value],
        line_break: attr[:line_break]
      }
    end
  }
end

#build_element(ast) ⇒ Object

Build any element from AST based on type detection

Parameters:

  • ast (Hash) —

    the element AST

Returns:

  • (Object) —

    the built element



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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/coradoc/core_model/builder.rb', line 92

def build_element(ast)
  return nil unless ast.is_a?(Hash)

  case detect_element_type(ast)
  when :header
    build_header(ast)
  when :section
    build_section(ast)
  when :block
    build_block(ast)
  when :list
    build_list(ast)
  when :paragraph
    build_paragraph(ast)
  when :inline
    build_inline(ast)
  when :text
    build_text(ast)
  when :attribute
    build_attribute(ast)
  when :document_attributes
    build_document_attributes(ast)
  when :line_break
    build_line_break(ast)
  when :comment_line
    build_comment_line(ast)
  when :comment_block
    build_comment_block(ast)
  when :include
    build_include(ast)
  when :table
    build_table(ast)
  when :unparsed
    build_unparsed(ast)
  when :tag
    build_tag(ast)
  when :bibliography_entry
    build_bibliography_entry(ast)
  else
    Coradoc::Logger.info("Unknown element type: #{ast.keys}")
    build_generic_element(ast)
  end
rescue StandardError => e
  Coradoc::Logger.error("Error building element: #{e.message}")
  Coradoc::Logger.info("AST: #{ast.inspect[0..200]}")
  nil
end

#build_inline(ast) ⇒ Object

Build inline element



193
194
195
196
197
198
199
200
201
202
 
# File 'lib/coradoc/core_model/builder.rb', line 193

def build_inline(ast)
  format_type = detect_inline_format(ast)

  InlineElement.new(
    format_type: format_type,
    constrained: detect_constrained(ast, format_type),
    content: extract_inline_content(ast, format_type),
    nested_elements: build_nested_inlines(ast)
  )
end

#build_list(ast) ⇒ Object

Build list element from various AST formats



155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/coradoc/core_model/builder.rb', line 155

def build_list(ast)
  if ast[:unordered]
    build_unordered_list(ast)
  elsif ast[:ordered]
    build_ordered_list(ast)
  elsif ast[:definition_list]
    build_definition_list(ast)
  else
    build_list_block(ast)
  end
end

#build_list_item(ast) ⇒ Object

Build individual list item



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/coradoc/core_model/builder.rb', line 168

def build_list_item(ast)
  item_ast = ast[:list_item] || ast

  ListItem.new(
    marker: item_ast[:marker]&.to_s,
    content: extract_item_content(item_ast),
    nested_list: build_nested_list(item_ast[:nested]),
    children: build_item_children(item_ast[:attached])
  )
end

#build_paragraph(ast) ⇒ Object

Build paragraph



180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/coradoc/core_model/builder.rb', line 180

def build_paragraph(ast)
  para_ast = ast[:paragraph] || ast

  {
    type: :paragraph,
    content: build_paragraph_content(para_ast[:lines]),
    id: para_ast[:id],
    title: para_ast[:title],
    attribute_list: para_ast[:attribute_list]
  }
end