Class: Markbridge::Parsers::TextFormatter::Handlers::BaseHandler Abstract

Inherits:

Object

• Object
• Markbridge::Parsers::TextFormatter::Handlers::BaseHandler

Defined in:

lib/markbridge/parsers/text_formatter/handlers/base_handler.rb

Overview

This class is abstract.

Subclass and override #process to implement a custom handler

Base class for TextFormatter XML element handlers

Handlers process s9e/TextFormatter XML elements and convert them to AST nodes. Each handler implements the process method to handle a specific element type.

Direct Known Subclasses

AttachmentHandler, AttributeHandler, CodeHandler, EmailHandler, ImageHandler, ListHandler, QuoteHandler, SimpleHandler, TableCellHandler, UrlHandler

Instance Method Summary

• #element_class ⇒ Class

  The AST element class this handler creates Used for introspection and documentation.

• #process(element:, parent:) ⇒ AST::Element^?

  Process an XML element and convert it to AST node(s).

Instance Method Details

#element_class ⇒ Class

The AST element class this handler creates Used for introspection and documentation

Returns:

• (Class) —

  the AST node class

Raises:

• (NotImplementedError)

# File 'lib/markbridge/parsers/text_formatter/handlers/base_handler.rb', line 27

def element_class
  raise NotImplementedError, "#{self.class} must implement #element_class"
end

#process(element:, parent:) ⇒ AST::Element^?

Process an XML element and convert it to AST node(s)

Parameters:

• element (Nokogiri::XML::Element) —

  the XML element to process

• parent (AST::Element) —

  the parent AST node to add children to

Returns:

• (AST::Element, nil) —

  the created element if children should be processed, nil otherwise

Raises:

• (NotImplementedError)

# File 'lib/markbridge/parsers/text_formatter/handlers/base_handler.rb', line 19

def process(element:, parent:)
  raise NotImplementedError, "#{self.class} must implement #process"
end