Class: Coradoc::CoreModel::Base

Inherits:
Lutaml::Model::Serializable
  • Object
show all
Defined in:
lib/coradoc/core_model/base.rb

Overview

Base class for all core models

Provides common functionality for schema-agnostic document models. This class establishes the foundational structure for all CoreModel classes, including semantic equivalence comparison and common attributes.

Examples:

Creating a base model

model = CoreModel::Base.new(
  id: "example-1",
  title: "Example Title",
  element_attributes: [
    CoreModel::ElementAttribute.new(name: "role", value: "note")
  ]
)

Semantic comparison

model1 = CoreModel::Base.new(id: "test", title: "Test")
model2 = CoreModel::Base.new(id: "test", title: "Test")
model1.semantically_equivalent?(model2) # => true

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#element_attributes ⇒ Array<ElementAttribute>

Returns collection of element attributes.

Returns:



38
 
# File 'lib/coradoc/core_model/base.rb', line 38

attribute :element_attributes, ElementAttribute, collection: true

#id ⇒ String?

Returns unique identifier for the element.

Returns:

  • (String, nil) —

    unique identifier for the element



30
 
# File 'lib/coradoc/core_model/base.rb', line 30

attribute :id, :string

#metadata_entries ⇒ Array<MetadataEntry>

Returns additional metadata entries.

Returns:



42
 
# File 'lib/coradoc/core_model/base.rb', line 42

attribute :metadata_entries, MetadataEntry, collection: true

#title ⇒ String?

Returns title of the element.

Returns:

  • (String, nil) —

    title of the element



34
 
# File 'lib/coradoc/core_model/base.rb', line 34

attribute :title, :string

Class Method Details

.build(**attrs) {|instance| ... } ⇒ Object

Construct an instance and yield it for in-place mutation.

This is the programmatic-construction entry point for CoreModel nodes. It calls new exactly as a caller would, then yields the resulting instance for append-style construction. No new class hierarchy, no method_missing — the block operates on the real model object.

Per-class fluent helpers (e.g., ListBlock#add_item, ListItem#add_text) compose naturally with build:

list = ListBlock.build do |ul|
  children.each { |c| ul.add_item { |li| li.add_link(c[:slug], text: c[:title]) } }
end

Without a block, build(**attrs) is identical to new(**attrs).

Yields:

  • (instance) 


60
61
62
63
64
 
# File 'lib/coradoc/core_model/base.rb', line 60

def self.build(**attrs)
  instance = new(**attrs)
  yield instance if block_given?
  instance
end

Instance Method Details

#accept(visitor) ⇒ void

This method returns an undefined value.

Accept a visitor to traverse this element

Implements the visitor pattern for document traversal. The visitor’s visit method will be called with this element.

Parameters:



166
167
168
 
# File 'lib/coradoc/core_model/base.rb', line 166

def accept(visitor)
  visitor.visit(self)
end

#attr ⇒ Hash #attr(name) ⇒ String?

Get all element attributes as a hash, or a specific attribute value by name

Overloads:

  • #attr ⇒ Hash

    Returns All attributes as key-value pairs.

    Returns:

    • (Hash) —

      All attributes as key-value pairs

  • #attr(name) ⇒ String?

    Returns The value or nil.

    Parameters:

    • name (String) —

      The attribute name

    Returns:

    • (String, nil) —

      The value or nil



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/coradoc/core_model/base.rb', line 102

def attr(name = nil)
  attrs = element_attributes || []
  if name.nil?
    # Return all attributes as hash
    attrs.each_with_object({}) { |a, h| h[a.name] = a.value }
  else
    # Return specific value
    attrs.find { |a| a.name == name }&.value
  end
end

#body_content? ⇒ Boolean

True when this node counts as “real body content” for the purposes of empty-document detection and similar structural queries. Default is true; metadata and ephemeral nodes (FrontmatterBlock, CommentBlock, CommentLine) override to false. Polymorphic dispatch keeps the predicate open for future “skip-me” types — no central walker to edit (OCP).

Returns:

  • (Boolean) 


176
177
178
 
# File 'lib/coradoc/core_model/base.rb', line 176

def body_content?
  true
end

#flat_text ⇒ String

Flatten this element to a plain-text string.

Subclasses that include ChildrenContent override this to concatenate their children’s text. Block-level elements without textual content (ListBlock, Table, etc.) fall back to the empty string — they are serialized structurally, not flattened into inline text.

Returns:

  • (String) 


155
156
157
 
# File 'lib/coradoc/core_model/base.rb', line 155

def flat_text
  ""
end

#metadata ⇒ Hash #metadata(key) ⇒ String?

Get all metadata as a hash, or a specific metadata value by key

Overloads:

  • #metadata ⇒ Hash

    Returns All metadata as key-value pairs.

    Returns:

    • (Hash) —

      All metadata as key-value pairs

  • #metadata(key) ⇒ String?

    Returns The value or nil.

    Parameters:

    • key (String) —

      The metadata key

    Returns:

    • (String, nil) —

      The value or nil



72
73
74
75
76
77
78
79
80
81
 
# File 'lib/coradoc/core_model/base.rb', line 72

def metadata(key = nil)
  entries = metadata_entries || []
  if key.nil?
    # Return all metadata as hash
    entries.each_with_object({}) { |e, h| h[e.key] = e.value }
  else
    # Return specific value
    entries.find { |e| e.key == key }&.value
  end
end

#semantically_equivalent?(other) ⇒ Boolean

Compare this model with another for semantic equivalence

Semantic equivalence means the models represent the same semantic content, even if their exact structure differs. This is different from equality, which requires exact matching.

Parameters:

  • other (Object) —

    the object to compare with

Returns:

  • (Boolean) —

    true if semantically equivalent, false otherwise



134
135
136
137
138
139
140
 
# File 'lib/coradoc/core_model/base.rb', line 134

def semantically_equivalent?(other)
  return false unless other.is_a?(self.class)

  comparable_attributes.all? do |attr|
    compare_attribute(attr, other)
  end
end

#set_attr(name, value) ⇒ Object

Set attribute value

Parameters:

  • name (String) —

    The attribute name

  • value (String) —

    The value to set



116
117
118
119
120
121
122
123
124
 
# File 'lib/coradoc/core_model/base.rb', line 116

def set_attr(name, value)
  self.element_attributes ||= []
  existing = element_attributes.find { |a| a.name == name }
  if existing
    existing.value = value
  else
    element_attributes << ElementAttribute.new(name: name, value: value)
  end
end

#set_metadata(key, value) ⇒ Object

Convenience method to set metadata

Parameters:

  • key (String) —

    The metadata key

  • value (String) —

    The value to set



86
87
88
89
90
91
92
93
94
 
# File 'lib/coradoc/core_model/base.rb', line 86

def set_metadata(key, value)
  self.metadata_entries ||= []
  existing = metadata_entries.find { |e| e.key == key }
  if existing
    existing.value = value
  else
    metadata_entries << MetadataEntry.new(key: key, value: value)
  end
end

#whitespace_only? ⇒ Boolean

True when this node is structurally present but carries no visible characters. Default is false; inline text and paragraph blocks override to inspect their text content.

Returns:

  • (Boolean) 


183
184
185
 
# File 'lib/coradoc/core_model/base.rb', line 183

def whitespace_only?
  false
end