Class: Mato::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/mato/config.rb

Constant Summary collapse

DEFAULT_MARKDOWN_OPTIONS = 
{
  render: {
    hardbreaks: true,
    unsafe: true,
    escaped_char_spans: false,
  },
  extension: {
    table: true,
    strikethrough: true,
    autolink: true,
    tagfilter: true,
    tasklist: false,
    shortcodes: false,
    footnotes: true,
  },
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Config

Returns a new instance of Config.



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/mato/config.rb', line 50

def initialize
  @text_filters = []
  @markdown_filters = []
  @html_filters = []

  @markdown_parser = Commonmarker
  @html_parser = Nokogiri::HTML4::DocumentFragment

  @document_factory = Document

  @markdown_options = DEFAULT_MARKDOWN_OPTIONS
  @markdown_plugins = { syntax_highlighter: nil }
end

Instance Attribute Details

#document_factory ⇒ Class<Mato::Document>

Returns:



42
43
44
 
# File 'lib/mato/config.rb', line 42

def document_factory
  @document_factory
end

#html_filters ⇒ Array<Proc>

Returns:

  • (Array<Proc>) 


33
34
35
 
# File 'lib/mato/config.rb', line 33

def html_filters
  @html_filters
end

#html_parser ⇒ Cass<Nokogiri::HTML4::DocumentFragment>

Returns:

  • (Cass<Nokogiri::HTML4::DocumentFragment>) 


39
40
41
 
# File 'lib/mato/config.rb', line 39

def html_parser
  @html_parser
end

#markdown_filters ⇒ Array<Proc>

Returns:

  • (Array<Proc>) 


30
31
32
 
# File 'lib/mato/config.rb', line 30

def markdown_filters
  @markdown_filters
end

#markdown_options ⇒ Hash

Returns Commonmarker’s options.

Returns:

  • (Hash) —

    Commonmarker’s options



45
46
47
 
# File 'lib/mato/config.rb', line 45

def markdown_options
  @markdown_options
end

#markdown_parser ⇒ Class<Commonmarker]

Returns Class<Commonmarker].

Returns:

  • (Class<Commonmarker]) —

    Class<Commonmarker]



36
37
38
 
# File 'lib/mato/config.rb', line 36

def markdown_parser
  @markdown_parser
end

#markdown_plugins ⇒ Hash

Returns Commonmarker’s plugins.

Returns:

  • (Hash) —

    Commonmarker’s plugins



48
49
50
 
# File 'lib/mato/config.rb', line 48

def markdown_plugins
  @markdown_plugins
end

#text_filters ⇒ Array<Proc>

Returns:

  • (Array<Proc>) 


27
28
29
 
# File 'lib/mato/config.rb', line 27

def text_filters
  @text_filters
end

Instance Method Details

#append_html_filter(html_filter, timeout: nil, on_timeout: nil, on_error: nil) ⇒ Object 



82
83
84
85
86
 
# File 'lib/mato/config.rb', line 82

def append_html_filter(html_filter, timeout: nil, on_timeout: nil, on_error: nil)
  raise "html_filter must respond to call()" unless html_filter.respond_to?(:call)

  html_filters.push(wrap(html_filter, timeout: timeout, on_timeout: on_timeout, on_error: on_error))
end

#append_markdown_filter(markdown_filter, timeout: nil, on_timeout: nil, on_error: nil) ⇒ Object 



76
77
78
79
80
 
# File 'lib/mato/config.rb', line 76

def append_markdown_filter(markdown_filter, timeout: nil, on_timeout: nil, on_error: nil)
  raise "markdown_filter must respond to call()" unless markdown_filter.respond_to?(:call)

  markdown_filters.push(wrap(markdown_filter, timeout: timeout, on_timeout: on_timeout, on_error: on_error))
end

#append_text_filter(text_filter, timeout: nil, on_timeout: nil, on_error: nil) ⇒ Object 



70
71
72
73
74
 
# File 'lib/mato/config.rb', line 70

def append_text_filter(text_filter, timeout: nil, on_timeout: nil, on_error: nil)
  raise "text_filter must respond to call()" unless text_filter.respond_to?(:call)

  text_filters.push(wrap(text_filter, timeout: timeout, on_timeout: on_timeout, on_error: on_error))
end

#configure(&block) {|config| ... } ⇒ Object

Parameters:

  • block (Proc)

Yield Parameters:



66
67
68
 
# File 'lib/mato/config.rb', line 66

def configure(&block)
  block.call(self)
end