Class: SlimLint::Document

Inherits:
Object
  • Object
show all
Defined in:
lib/slim_lint/document.rb

Overview

Represents a parsed Slim document and its associated metadata.

Constant Summary collapse

FRONTMATTER_RE = 
/
  # From the start of the string
  \A
  # First-capture match --- followed by optional whitespace up
  # to a newline then 0 or more chars followed by an optional newline.
  # This matches the --- and the contents of the frontmatter
  (---\s*\n.*?\n?)
  # From the start of the line
  ^
  # Second capture match --- or ... followed by optional whitespace
  # and newline. This matches the closing --- for the frontmatter.
  (---|\.\.\.)\s*$\n?
/mx

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, options) ⇒ Document

Parses the specified Slim code into a SlimLint::Document.

Parameters:

  • source (String) —

    Slim code to parse

  • options (Hash)

Options Hash (options):

  • :file (String) —

    file name of document that was parsed

Raises:

  • (Slim::Parser::Error) —

    if there was a problem parsing the document



41
42
43
44
45
46
 
# File 'lib/slim_lint/document.rb', line 41

def initialize(source, options)
  @config = options[:config]
  @file = options.fetch(:file, nil)

  process_source(source)
end

Instance Attribute Details

#config ⇒ SlimLint::Configuration (readonly)

Returns Configuration used to parse template.

Returns:



21
22
23
 
# File 'lib/slim_lint/document.rb', line 21

def config
  @config
end

#file ⇒ String (readonly)

Returns Slim template file path.

Returns:

  • (String) —

    Slim template file path



24
25
26
 
# File 'lib/slim_lint/document.rb', line 24

def file
  @file
end

#sexp ⇒ SlimLint::Sexp (readonly)

Returns Sexpression representing the parsed document.

Returns:



27
28
29
 
# File 'lib/slim_lint/document.rb', line 27

def sexp
  @sexp
end

#source ⇒ String (readonly)

Returns original source code.

Returns:

  • (String) —

    original source code



30
31
32
 
# File 'lib/slim_lint/document.rb', line 30

def source
  @source
end

#source_lines ⇒ Array<String> (readonly)

Returns original source code as an array of lines.

Returns:

  • (Array<String>) —

    original source code as an array of lines



33
34
35
 
# File 'lib/slim_lint/document.rb', line 33

def source_lines
  @source_lines
end