Class: Mbrao::ParsingEngines::PlainText

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

Overview

A class for parsing plain text files.

Instance Method Summary (collapse)

Methods inherited from Base

#parse

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. If none are specified, the default Mbrao locale will be requested.

  • 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.



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/mbrao/parsing_engines/plain_text.rb', line 57

def filter_content(content, locales = [], options = {})
  body = content.body.ensure_string.strip
  content_tags = sanitize_tags(options[:content_tags], ["{{content: %ARGS%}}", "{{/content}}"])
  locales = ::Mbrao::Content.validate_locales(locales, content)

  # Split the content
  result = scan_content(body, content_tags.first, content_tags.last)

  # Now filter results
  perform_filter_content(result, locales)
end

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

Parses metadata part and returns all valid metadata.

Parameters:

  • content (String) —

    The content to parse.

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

    Options to customize parsing.

Returns:

  • (Hash) —

    All valid metadata for the content.



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/mbrao/parsing_engines/plain_text.rb', line 37

def parse_metadata(content, options = {})
  rv = YAML.load(content)
  rv ||= {}
  raise ArgumentError unless rv.is_a?(Hash)
  rv
rescue => e
  if options[:default]
    options[:default]
  else
    raise ::Mbrao::Exceptions::InvalidMetadata, e.to_s
  end
end

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

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

Parameters:

  • content (String) —

    The content to parse.

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

    Options to customize parsing.

Returns:

  • (Array) —

    An array of metadata and contents parts.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/mbrao/parsing_engines/plain_text.rb', line 17

def separate_components(content, options = {})
  metadata, content, scanner, start_tag, end_tag = prepare_for_separation(content, options)

  if scanner.scan_until(start_tag)
    metadata = scanner.scan_until(end_tag)

    if metadata
      metadata = metadata.partition(end_tag).first
      content = scanner.rest.strip
    end
  end

  [metadata.ensure_string.strip, content]
end