Class: Coradoc::AsciiDoc::Serializer::Serializers::Base

Inherits:

Object

• Object
• Coradoc::AsciiDoc::Serializer::Serializers::Base

Defined in:

lib/coradoc/asciidoc/serializer/serializers/base.rb

Overview

Base serializer class for converting Coradoc models to AsciiDoc format. Provides common serialization infrastructure and helpers. Each model type should have its own serializer that inherits from this.

Direct Known Subclasses

Admonition, Attribute, AttributeList, AttributeListAttribute, Audio, Author, Bibliography, BibliographyEntry, Coradoc::AsciiDoc::Serializer::Serializers::Block::Core, Break, CommentBlock, CommentLine, Document, DocumentAttributes, Header, Highlight, Image::Core, Include, Inline::Anchor, Inline::AttributeReference, Inline::Bold, Inline::CrossReference, Inline::CrossReferenceArg, Inline::Footnote, Inline::HardLineBreak, Inline::Highlight, Inline::Italic, Inline::Link, Inline::Monospace, Inline::Quotation, Inline::Small, Inline::Span, Inline::Stem, Inline::Strikethrough, Inline::Subscript, Inline::Superscript, Inline::Underline, LineBreak, List::Core, List::Definition, List::DefinitionItem, List::Item, NamedAttribute, Paragraph, ReviewerNote, Revision, Section, Table, TableCell, TableRow, Term, TextElement, Title, Video

Instance Method Summary

• #serialize(model, options_or_context = {}) ⇒ String

  Serialize a Coradoc model to AsciiDoc string.

• #to_adoc(_model, options_or_context = {}) ⇒ String

  Abstract method to be implemented by subclasses.

Instance Method Details

#serialize(model, options_or_context = {}) ⇒ String

Serialize a Coradoc model to AsciiDoc string

Parameters:

• model (Coradoc::AsciiDoc::Model::Base) —

  The model to serialize

• options_or_context (Hash, SerializationContext) (defaults to: {}) —

  Options or context

Returns:

• (String) —

  AsciiDoc representation

# File 'lib/coradoc/asciidoc/serializer/serializers/base.rb', line 17

def serialize(model, options_or_context = {})
  return '' if model.nil?

  context = SerializationContext.from_options(options_or_context)
  to_adoc(model, context)
end

#to_adoc(_model, options_or_context = {}) ⇒ String

Abstract method to be implemented by subclasses

Parameters:

• model (Coradoc::AsciiDoc::Model::Base) —

  The model to convert

• options_or_context (Hash, SerializationContext) (defaults to: {}) —

  Options or context

Returns:

• (String) —

  AsciiDoc representation

Raises:

• (NotImplementedError)

# File 'lib/coradoc/asciidoc/serializer/serializers/base.rb', line 28

def to_adoc(_model, options_or_context = {})
  SerializationContext.from_options(options_or_context)
  raise NotImplementedError,
        "#{self.class.name} must implement #to_adoc"
end