Class: Coradoc::Reference::Materializer::Base

Inherits:

Object

• Object
• Coradoc::Reference::Materializer::Base

Defined in:

lib/coradoc/reference/materializer/base.rb

Overview

Protocol base. Subclasses declare their (kind, presentation, format) tuple via class-level .kind, .presentation, .format methods, then implement #materialize to produce a CoreModel::InlineElement subtree.

Materializers consume Results — they never touch the catalog directly. The Presentation tells them where the target lives.

Direct Known Subclasses

Passthrough

Class Method Summary

• .format ⇒ Object
• .kind ⇒ Object
• .presentation ⇒ Object

Instance Method Summary

• #materialize(edge:, result:, node:, presentation:, pages:) ⇒ CoreModel::Base^?

  Render one resolved edge.

Class Method Details

.format ⇒ Object

# File 'lib/coradoc/reference/materializer/base.rb', line 23

def format
  :any
end

.kind ⇒ Object

# File 'lib/coradoc/reference/materializer/base.rb', line 15

def kind
  nil
end

.presentation ⇒ Object

# File 'lib/coradoc/reference/materializer/base.rb', line 19

def presentation
  :any
end

Instance Method Details

#materialize(edge:, result:, node:, presentation:, pages:) ⇒ CoreModel::Base^?

Render one resolved edge.

Parameters:

• edge (Edge)
• result (Result::Base) —

  the resolved outcome

• node (CoreModel::Base) —

  the original edge-bearing node; return it unchanged to keep the node as authored

• presentation (Presentation::Base)
• pages (Array<Presentation::Page>)

Returns:

• (CoreModel::Base, nil) —

  replacement node, the original node to keep it, or nil to drop it from the tree

Raises:

• (NotImplementedError)

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

def materialize(edge:, result:, node:, presentation:, pages:)
  raise NotImplementedError
end