Module: Coradoc::AsciiDoc

Defined in:: lib/coradoc/asciidoc.rb,
lib/coradoc/asciidoc.rb,
lib/coradoc/asciidoc.rb,
lib/coradoc/asciidoc.rb,
lib/coradoc/asciidoc/model.rb,
lib/coradoc/asciidoc/parser.rb,
lib/coradoc/asciidoc/version.rb,
lib/coradoc/asciidoc/model/tag.rb,
lib/coradoc/asciidoc/transform.rb,
lib/coradoc/asciidoc/model/base.rb,
lib/coradoc/asciidoc/model/list.rb,
lib/coradoc/asciidoc/model/term.rb,
lib/coradoc/asciidoc/serializer.rb,
lib/coradoc/asciidoc/serializer.rb,
lib/coradoc/asciidoc/model/audio.rb,
lib/coradoc/asciidoc/model/block.rb,
lib/coradoc/asciidoc/model/break.rb,
lib/coradoc/asciidoc/model/image.rb,
lib/coradoc/asciidoc/model/table.rb,
lib/coradoc/asciidoc/model/title.rb,
lib/coradoc/asciidoc/model/video.rb,
lib/coradoc/asciidoc/parse_error.rb,
lib/coradoc/asciidoc/parser/base.rb,
lib/coradoc/asciidoc/parser/list.rb,
lib/coradoc/asciidoc/parser/stem.rb,
lib/coradoc/asciidoc/parser/term.rb,
lib/coradoc/asciidoc/parser/text.rb,
lib/coradoc/asciidoc/transformer.rb,
lib/coradoc/asciidoc/model/author.rb,
lib/coradoc/asciidoc/model/header.rb,
lib/coradoc/asciidoc/model/inline.rb,
lib/coradoc/asciidoc/parser/block.rb,
lib/coradoc/asciidoc/parser/cache.rb,
lib/coradoc/asciidoc/parser/table.rb,
lib/coradoc/asciidoc/model/include.rb,
lib/coradoc/asciidoc/model/section.rb,
lib/coradoc/asciidoc/model/spacing.rb,
lib/coradoc/asciidoc/parser/header.rb,
lib/coradoc/asciidoc/parser/inline.rb,
lib/coradoc/asciidoc/model/attached.rb,
lib/coradoc/asciidoc/model/document.rb,
lib/coradoc/asciidoc/model/resolver.rb,
lib/coradoc/asciidoc/model/revision.rb,
lib/coradoc/asciidoc/parser/content.rb,
lib/coradoc/asciidoc/parser/section.rb,
lib/coradoc/asciidoc/model/attribute.rb,
lib/coradoc/asciidoc/model/highlight.rb,
lib/coradoc/asciidoc/model/list/core.rb,
lib/coradoc/asciidoc/model/list/item.rb,
lib/coradoc/asciidoc/model/paragraph.rb,
lib/coradoc/asciidoc/model/table_row.rb,
lib/coradoc/asciidoc/parser/citation.rb,
lib/coradoc/asciidoc/model/admonition.rb,
lib/coradoc/asciidoc/model/anchorable.rb,
lib/coradoc/asciidoc/model/block/core.rb,
lib/coradoc/asciidoc/model/block/open.rb,
lib/coradoc/asciidoc/model/block/pass.rb,
lib/coradoc/asciidoc/model/block/side.rb,
lib/coradoc/asciidoc/model/glossaries.rb,
lib/coradoc/asciidoc/model/image/core.rb,
lib/coradoc/asciidoc/model/line_break.rb,
lib/coradoc/asciidoc/model/resolvable.rb,
lib/coradoc/asciidoc/model/table_cell.rb,
lib/coradoc/asciidoc/parser/paragraph.rb,
lib/coradoc/asciidoc/model/block/quote.rb,
lib/coradoc/asciidoc/model/inline/base.rb,
lib/coradoc/asciidoc/model/inline/bold.rb,
lib/coradoc/asciidoc/model/inline/link.rb,
lib/coradoc/asciidoc/model/inline/span.rb,
lib/coradoc/asciidoc/model/inline/stem.rb,
lib/coradoc/asciidoc/parser/admonition.rb,
lib/coradoc/asciidoc/model/bibliography.rb,
lib/coradoc/asciidoc/model/comment_line.rb,
lib/coradoc/asciidoc/model/content_list.rb,
lib/coradoc/asciidoc/model/inline/small.rb,
lib/coradoc/asciidoc/model/list/ordered.rb,
lib/coradoc/asciidoc/model/text_element.rb,
lib/coradoc/asciidoc/transform/registry.rb,
lib/coradoc/asciidoc/model/block/example.rb,
lib/coradoc/asciidoc/model/block/listing.rb,
lib/coradoc/asciidoc/model/block/literal.rb,
lib/coradoc/asciidoc/model/comment_block.rb,
lib/coradoc/asciidoc/model/inline/anchor.rb,
lib/coradoc/asciidoc/model/inline/italic.rb,
lib/coradoc/asciidoc/model/list/nestable.rb,
lib/coradoc/asciidoc/model/reviewer_note.rb,
lib/coradoc/asciidoc/model/serialization.rb,
lib/coradoc/asciidoc/parser/bibliography.rb,
lib/coradoc/asciidoc/model/attribute_list.rb,
lib/coradoc/asciidoc/model/list/unordered.rb,
lib/coradoc/asciidoc/serializer/formatter.rb,
lib/coradoc/asciidoc/model/inline/footnote.rb,
lib/coradoc/asciidoc/model/list/definition.rb,
lib/coradoc/asciidoc/model/named_attribute.rb,
lib/coradoc/asciidoc/parser/attribute_list.rb,
lib/coradoc/asciidoc/model/inline/highlight.rb,
lib/coradoc/asciidoc/model/inline/monospace.rb,
lib/coradoc/asciidoc/model/inline/quotation.rb,
lib/coradoc/asciidoc/model/inline/subscript.rb,
lib/coradoc/asciidoc/model/inline/underline.rb,
lib/coradoc/asciidoc/parser/block_assembler.rb,
lib/coradoc/asciidoc/transformer/list_rules.rb,
lib/coradoc/asciidoc/transformer/misc_rules.rb,
lib/coradoc/asciidoc/transformer/text_rules.rb,
lib/coradoc/asciidoc/model/block/source_code.rb,
lib/coradoc/asciidoc/model/image/block_image.rb,
lib/coradoc/asciidoc/transform/to_core_model.rb,
lib/coradoc/asciidoc/transformer/block_rules.rb,
lib/coradoc/asciidoc/model/bibliography_entry.rb,
lib/coradoc/asciidoc/model/image/inline_image.rb,
lib/coradoc/asciidoc/model/inline/superscript.rb,
lib/coradoc/asciidoc/parser/metadata_detector.rb,
lib/coradoc/asciidoc/serializer/registrations.rb,
lib/coradoc/asciidoc/transformer/header_rules.rb,
lib/coradoc/asciidoc/transformer/inline_rules.rb,
lib/coradoc/asciidoc/model/document_attributes.rb,
lib/coradoc/asciidoc/transform/from_core_model.rb,
lib/coradoc/asciidoc/model/inline/strikethrough.rb,
lib/coradoc/asciidoc/model/list/definition_item.rb,
lib/coradoc/asciidoc/model/serialization/errors.rb,
lib/coradoc/asciidoc/model/video/attribute_list.rb,
lib/coradoc/asciidoc/parser/document_attributes.rb,
lib/coradoc/asciidoc/serializer/adoc_serializer.rb,
lib/coradoc/asciidoc/serializer/serializers/tag.rb,
lib/coradoc/asciidoc/serializer/element_registry.rb,
lib/coradoc/asciidoc/serializer/serializers/base.rb,
lib/coradoc/asciidoc/serializer/serializers/list.rb,
lib/coradoc/asciidoc/serializer/serializers/term.rb,
lib/coradoc/asciidoc/serializer/spacing_strategy.rb,
lib/coradoc/asciidoc/model/block/reviewer_comment.rb,
lib/coradoc/asciidoc/model/inline/cross_reference.rb,
lib/coradoc/asciidoc/model/inline/hard_line_break.rb,
lib/coradoc/asciidoc/serializer/serializers/audio.rb,
lib/coradoc/asciidoc/serializer/serializers/block.rb,
lib/coradoc/asciidoc/serializer/serializers/break.rb,
lib/coradoc/asciidoc/serializer/serializers/image.rb,
lib/coradoc/asciidoc/serializer/serializers/table.rb,
lib/coradoc/asciidoc/serializer/serializers/title.rb,
lib/coradoc/asciidoc/serializer/serializers/video.rb,
lib/coradoc/asciidoc/transformer/structural_rules.rb,
lib/coradoc/asciidoc/model/attribute_list/matchers.rb,
lib/coradoc/asciidoc/serializer/serializers/author.rb,
lib/coradoc/asciidoc/serializer/serializers/header.rb,
lib/coradoc/asciidoc/serializer/serializers/inline.rb,
lib/coradoc/asciidoc/model/attribute_list_attribute.rb,
lib/coradoc/asciidoc/serializer/fallback_serializer.rb,
lib/coradoc/asciidoc/serializer/serializers/include.rb,
lib/coradoc/asciidoc/serializer/serializers/section.rb,
lib/coradoc/asciidoc/model/image/core/attribute_list.rb,
lib/coradoc/asciidoc/serializer/serializers/document.rb,
lib/coradoc/asciidoc/serializer/serializers/revision.rb,
lib/coradoc/asciidoc/model/inline/attribute_reference.rb,
lib/coradoc/asciidoc/model/inline/cross_reference_arg.rb,
lib/coradoc/asciidoc/serializer/serialization_context.rb,
lib/coradoc/asciidoc/serializer/serializers/attribute.rb,
lib/coradoc/asciidoc/serializer/serializers/highlight.rb,
lib/coradoc/asciidoc/serializer/serializers/list/core.rb,
lib/coradoc/asciidoc/serializer/serializers/list/item.rb,
lib/coradoc/asciidoc/serializer/serializers/paragraph.rb,
lib/coradoc/asciidoc/serializer/serializers/table_row.rb,
lib/coradoc/asciidoc/serializer/serializers/admonition.rb,
lib/coradoc/asciidoc/serializer/serializers/block/core.rb,
lib/coradoc/asciidoc/serializer/serializers/block/open.rb,
lib/coradoc/asciidoc/serializer/serializers/block/pass.rb,
lib/coradoc/asciidoc/serializer/serializers/block/side.rb,
lib/coradoc/asciidoc/serializer/serializers/image/core.rb,
lib/coradoc/asciidoc/serializer/serializers/line_break.rb,
lib/coradoc/asciidoc/serializer/serializers/table_cell.rb,
lib/coradoc/asciidoc/serializer/serializers/block/quote.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/bold.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/link.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/span.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/stem.rb,
lib/coradoc/asciidoc/model/rejected_positional_attribute.rb,
lib/coradoc/asciidoc/serializer/serializers/bibliography.rb,
lib/coradoc/asciidoc/serializer/serializers/comment_line.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/small.rb,
lib/coradoc/asciidoc/serializer/serializers/list/ordered.rb,
lib/coradoc/asciidoc/serializer/serializers/text_element.rb,
lib/coradoc/asciidoc/model/serialization/asciidoc_adapter.rb,
lib/coradoc/asciidoc/model/serialization/asciidoc_mapping.rb,
lib/coradoc/asciidoc/serializer/serializers/block/example.rb,
lib/coradoc/asciidoc/serializer/serializers/block/listing.rb,
lib/coradoc/asciidoc/serializer/serializers/block/literal.rb,
lib/coradoc/asciidoc/serializer/serializers/comment_block.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/anchor.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/italic.rb,
lib/coradoc/asciidoc/serializer/serializers/reviewer_note.rb,
lib/coradoc/asciidoc/serializer/serializers/attribute_list.rb,
lib/coradoc/asciidoc/serializer/serializers/list/unordered.rb,
lib/coradoc/asciidoc/transform/to_core_model_registrations.rb,
lib/coradoc/asciidoc/model/image/block_image/attribute_list.rb,
lib/coradoc/asciidoc/model/serialization/asciidoc_transform.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/footnote.rb,
lib/coradoc/asciidoc/serializer/serializers/list/definition.rb,
lib/coradoc/asciidoc/serializer/serializers/named_attribute.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/highlight.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/monospace.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/quotation.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/subscript.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/underline.rb,
lib/coradoc/asciidoc/transform/from_core_model_registrations.rb,
lib/coradoc/asciidoc/serializer/serializers/block/source_code.rb,
lib/coradoc/asciidoc/model/serialization/asciidoc_mapping_rule.rb,
lib/coradoc/asciidoc/serializer/serializers/bibliography_entry.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/superscript.rb,
lib/coradoc/asciidoc/serializer/serializers/document_attributes.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/strikethrough.rb,
lib/coradoc/asciidoc/serializer/serializers/list/definition_item.rb,
lib/coradoc/asciidoc/serializer/serializers/block/reviewer_comment.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/cross_reference.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/hard_line_break.rb,
lib/coradoc/asciidoc/serializer/serializers/attribute_list_attribute.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/attribute_reference.rb,
lib/coradoc/asciidoc/serializer/serializers/inline/cross_reference_arg.rb

Defined Under Namespace

Modules: Model, Parser, Serializer, Transform Classes: Error, ParseError, Transformer

Constant Summary collapse

Base = Backward-compatible aliases for model classes These allow tests and legacy code to use Coradoc::AsciiDoc::Document instead of Coradoc::AsciiDoc::Model::Document

Model::Base

Document =

Model::Document

Section =

Model::Section

Paragraph =

Model::Paragraph

TextElement =

Model::TextElement

Title =

Model::Title

Header =

Model::Header

Admonition =

Model::Admonition

Table =

Model::Table

TableRow =

Model::TableRow

TableCell =

Model::TableCell

Term =

Model::Term

Break =

Model::Break

Audio =

Model::Audio

Video =

Model::Video

Bibliography =

Model::Bibliography

BibliographyEntry =

Model::BibliographyEntry

CommentBlock =

Model::CommentBlock

CommentLine =

Model::CommentLine

LineBreak =

Model::LineBreak

Include =

Model::Include

Attribute =

Model::Attribute

AttributeList =

Model::AttributeList

Author =

Model::Author

Revision =

Model::Revision

NamedAttribute =

Model::NamedAttribute

ContentList =

Model::ContentList

Tag =

Model::Tag

Highlight =

Model::Highlight

DocumentAttributes =

Model::DocumentAttributes

Inline = Namespace aliases for nested modules

Model::Inline

Block =

Model::Block

List =

Model::List

Image =

Model::Image

Anchorable = Module aliases for mixins

Model::Anchorable

Attached =

Model::Attached

Spacing =

Model::Spacing

VERSION =

'2.0.0'

Class Method Summary collapse

.handles_model?(model) ⇒ Boolean

Check if this format can transform the given model to CoreModel.
.parse(text) ⇒ Coradoc::AsciiDoc::Model::Document

Parse AsciiDoc text and return an AsciiDoc document model.
.parse_to_core(text) ⇒ Coradoc::CoreModel::Document

Parse AsciiDoc text and convert to CoreModel.
.serialize(document) ⇒ String

Serialize a document model to AsciiDoc string.
.to_core(document) ⇒ Coradoc::CoreModel::Base

Transform an AsciiDoc model to CoreModel.

Class Method Details

.handles_model?(model) ⇒ `Boolean`

Check if this format can transform the given model to CoreModel

Parameters:

model (Object) —

The model to check

Returns:

(Boolean) —

true if this format handles the model type



64
65
66

# File 'lib/coradoc/asciidoc.rb', line 64

def handles_model?(model)
  model.is_a?(Coradoc::AsciiDoc::Model::Base)
end

.parse(text) ⇒ `Coradoc::AsciiDoc::Model::Document`

Parse AsciiDoc text and return an AsciiDoc document model

Parameters:

text (String) —

AsciiDoc content to parse

Returns:

(Coradoc::AsciiDoc::Model::Document) —

Parsed document model

# File 'lib/coradoc/asciidoc.rb', line 46

def parse(text)
  ast = Coradoc::AsciiDoc::Parser::Base.parse(text)
  Coradoc::AsciiDoc::Transformer.transform(ast)
end

.parse_to_core(text) ⇒ `Coradoc::CoreModel::Document`

Parse AsciiDoc text and convert to CoreModel

Parameters:

text (String) —

AsciiDoc content to parse

Returns:

(Coradoc::CoreModel::Document) —

CoreModel document

# File 'lib/coradoc/asciidoc.rb', line 55

def parse_to_core(text)
  doc = parse(text)
  Coradoc::AsciiDoc::Transform::ToCoreModel.transform(doc)
end

.serialize(document) ⇒ `String`

Serialize a document model to AsciiDoc string

Parameters:

document (Coradoc::AsciiDoc::Model::Document, Coradoc::CoreModel::Base) —

Document model to serialize

Returns:

(String) —

AsciiDoc representation

# File 'lib/coradoc/asciidoc.rb', line 81

def serialize(document)
  case document
  when Coradoc::CoreModel::Base
    # Convert CoreModel to AsciiDoc model first
    adoc_model = Coradoc::AsciiDoc::Transform::FromCoreModel.transform(document)
    adoc_model.to_adoc
  else
    document.to_adoc
  end
end

.to_core(document) ⇒ `Coradoc::CoreModel::Base`

Transform an AsciiDoc model to CoreModel

Parameters:

document (Coradoc::AsciiDoc::Model::Base) —

AsciiDoc document model

Returns:

(Coradoc::CoreModel::Base) —

CoreModel



72
73
74

# File 'lib/coradoc/asciidoc.rb', line 72

def to_core(document)
  Transform::ToCoreModel.transform(document)
end

Module: Coradoc::AsciiDoc

Defined Under Namespace

Constant Summary collapse

Class Method Summary collapse

Class Method Details

.handles_model?(model) ⇒ Boolean

.parse(text) ⇒ Coradoc::AsciiDoc::Model::Document

.parse_to_core(text) ⇒ Coradoc::CoreModel::Document

.serialize(document) ⇒ String

.to_core(document) ⇒ Coradoc::CoreModel::Base

.handles_model?(model) ⇒ `Boolean`

.parse(text) ⇒ `Coradoc::AsciiDoc::Model::Document`

.parse_to_core(text) ⇒ `Coradoc::CoreModel::Document`

.serialize(document) ⇒ `String`

.to_core(document) ⇒ `Coradoc::CoreModel::Base`