Class: Mbrao::ParsingEngines::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/mbrao/parsing_engines/base.rb

Overview

A base class for all parsers.

Direct Known Subclasses

PlainText

Instance Method Summary (collapse)

Instance Method Details

- (String|HashWithIndifferentAccess) filter_content(content, locales = [], options = {})

Filters content of a post by locale.

Parameters:

  • content (Content) —

    The content to filter.

  • locales (String|Array) (defaults to: []) —

    The desired locales. Can include * to match all.

  • options (Hash) (defaults to: {}) —

    Options to customize parsing.

Returns:

  • (String|HashWithIndifferentAccess) —

    Return the filtered content in the desired locales. If only one locale is required, then a String is returned, else a HashWithIndifferentAccess with locales as keys.

Raises:



36
37
38
 
# File 'lib/mbrao/parsing_engines/base.rb', line 36

def filter_content(content, locales = [], options = {})
  raise Mbrao::Exceptions::Unimplemented.new
end

- (Object) parse(content, options = {})

Parses a content and return a Content object.

Parameters:

  • content (Object) —

    The content to parse.

  • options (Hash) (defaults to: {}) —

    Options to customize parsing.



44
45
46
47
48
 
# File 'lib/mbrao/parsing_engines/base.rb', line 44

def parse(content, options = {})
  metadata, body = separate_components(content, options)
  metadata = parse_metadata(metadata, options)
  Mbrao::Content.create(metadata, body)
end

- (Hash) parse_metadata(content, options = {})

Parses metadata part and returns all valid metadata.

Parameters:

  • content (Object) —

    The content to parse.

  • options (Hash) (defaults to: {}) —

    Options to customize parsing.

Returns:

  • (Hash) —

    All valid metadata for the content.

Raises:



26
27
28
 
# File 'lib/mbrao/parsing_engines/base.rb', line 26

def parse_metadata(content, options = {})
  raise Mbrao::Exceptions::Unimplemented.new
end

- (Array) separate_components(content, options = {})

Parses a whole post content and return its metadata and content parts.

Parameters:

  • content (Object) —

    The content to parse.

  • options (Hash) (defaults to: {}) —

    Options to customize parsing.

Returns:

  • (Array) —

    An array of metadata and contents parts.

Raises:



17
18
19
 
# File 'lib/mbrao/parsing_engines/base.rb', line 17

def separate_components(content, options = {})
  raise Mbrao::Exceptions::Unimplemented.new
end