Class: Slideck::Parser Private

Inherits:

Object

• Object
• Slideck::Parser

Defined in:

lib/slideck/parser.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Responsible for extracting metadata and slides from content

Instance Method Summary

• #initialize(string_scanner, metadata_parser) ⇒ Parser constructor

  Create a Parser instance.

• #parse(content) ⇒ Hash{Symbol => Hash, Array<String>}

  Parse metadata and slides from content.

Constructor Details

#initialize(string_scanner, metadata_parser) ⇒ Parser

Create a Parser instance

Examples:

Parser.new(StringScanner, Slideck::MetadataParser)

Parameters:

• string_scanner (StringScanner) —

  the content scanner

• metadata_parser (Slideck::MetadataParser) —

  the metadata parser

# File 'lib/slideck/parser.rb', line 43

def initialize(string_scanner, metadata_parser)
  @string_scanner = string_scanner
  @metadata_parser = metadata_parser
end

Instance Method Details

#parse(content) ⇒ Hash{Symbol => Hash, Array<String>}

Parse metadata and slides from content

Examples:

parser.parse("align: center\n---\nSlide1\n---\nSlide2\n---")

Parameters:

• content (String) —

  the content to parse slides from

Returns:

• (Hash{Symbol => Hash, Array<String>}) —

  the metadata and slides content

# File 'lib/slideck/parser.rb', line 60

def parse(content)
  scanner = @string_scanner.new(content)
  slides = split_into_slides(scanner)
  metadata = extract_metadata(slides.first && slides.first[:content])

  {metadata: metadata, slides: metadata.empty? ? slides : slides[1..-1]}
end