Class: PuppetLint::Lexer

Inherits:
Object
  • Object
show all
Defined in:
lib/puppet-lint/lexer.rb,
lib/puppet-lint/lexer/token.rb

Overview

Internal: The puppet-lint lexer. Converts your manifest into its tokenised form.

Defined Under Namespace

Classes: Token

Constant Summary collapse

KEYWORDS =

Internal: A Hash whose keys are Strings representing reserved keywords in the Puppet DSL. From github.com/puppetlabs/puppet/blob/master/lib/puppet/pops/parser/lexer2.rb#L116-L137 or thereabouts

{
  'case'     => true,
  'class'    => true,
  'default'  => true,
  'define'   => true,
  'import'   => true,
  'if'       => true,
  'elsif'    => true,
  'else'     => true,
  'inherits' => true,
  'node'     => true,
  'and'      => true,
  'or'       => true,
  'undef'    => true,
  'false'    => true,
  'true'     => true,
  'in'       => true,
  'unless'   => true,
  'function' => true,
  'type'     => true,
  'attr'     => true,
  'private'  => true,
}
APP_MANAGEMENT_TOKENS =

Internal: A Hash whose keys are Strings representing reserved keywords in the Puppet DSL when Application Management is enabled From github.com/puppetlabs/puppet/blob/master/lib/puppet/pops/parser/lexer2.rb#L142-L159 or therabouts Currently unused

{
  'application' => true,
  'consumes'    => true,
  'produces'    => true,
  'site'        => true,
}
REGEX_PREV_TOKENS =

Internal: A Hash whose keys are Symbols representing token types which a regular expression can follow.

{
  :NODE    => true,
  :LBRACE  => true,
  :RBRACE  => true,
  :MATCH   => true,
  :NOMATCH => true,
  :COMMA   => true,
  :LBRACK  => true,
  :IF      => true,
  :ELSIF   => true,
  :LPAREN  => true,
}
NAME_RE =

Internal: An Array of Arrays containing tokens that can be described by a single regular expression. Each sub-Array contains 2 elements, the name of the token as a Symbol and a regular expression describing the value of the token.

/\A(((::)?[_a-z0-9][-\w]*)(::[a-z0-9][-\w]*)*)/
KNOWN_TOKENS = 
[
  [:TYPE, /\A(Integer|Float|Boolean|Regexp|String|Array|Hash|Resource|Class|Collection|Scalar|Numeric|CatalogEntry|Data|Tuple|Struct|Optional|NotUndef|Variant|Enum|Pattern|Any|Callable|Type|Runtime|Undef|Default)\b/],
  [:CLASSREF, /\A(((::){0,1}[A-Z][-\w]*)+)/],
  [:NUMBER, /\A\b((?:0[xX][0-9A-Fa-f]+|0?\d+(?:\.\d+)?(?:[eE]-?\d+)?))\b/],
  [:FUNCTION_NAME, /#{NAME_RE}\(/],
  [:NAME, NAME_RE],
  [:LBRACK, /\A(\[)/],
  [:RBRACK, /\A(\])/],
  [:LBRACE, /\A(\{)/],
  [:RBRACE, /\A(\})/],
  [:LPAREN, /\A(\()/],
  [:RPAREN, /\A(\))/],
  [:ISEQUAL, /\A(==)/],
  [:MATCH, /\A(=~)/],
  [:FARROW, /\A(=>)/],
  [:EQUALS, /\A(=)/],
  [:APPENDS, /\A(\+=)/],
  [:PARROW, /\A(\+>)/],
  [:PLUS, /\A(\+)/],
  [:GREATEREQUAL, /\A(>=)/],
  [:RSHIFT, /\A(>>)/],
  [:GREATERTHAN, /\A(>)/],
  [:LESSEQUAL, /\A(<=)/],
  [:LLCOLLECT, /\A(<<\|)/],
  [:OUT_EDGE, /\A(<-)/],
  [:OUT_EDGE_SUB, /\A(<~)/],
  [:LCOLLECT, /\A(<\|)/],
  [:LSHIFT, /\A(<<)/],
  [:LESSTHAN, /\A(<)/],
  [:NOMATCH, /\A(!~)/],
  [:NOTEQUAL, /\A(!=)/],
  [:NOT, /\A(!)/],
  [:RRCOLLECT, /\A(\|>>)/],
  [:RCOLLECT, /\A(\|>)/],
  [:IN_EDGE, /\A(->)/],
  [:IN_EDGE_SUB, /\A(~>)/],
  [:MINUS, /\A(-)/],
  [:COMMA, /\A(,)/],
  [:DOT, /\A(\.)/],
  [:COLON, /\A(:)/],
  [:SEMIC, /\A(;)/],
  [:QMARK, /\A(\?)/],
  [:BACKSLASH, /\A(\\)/],
  [:TIMES, /\A(\*)/],
  [:MODULO, /\A(%)/],
  [:PIPE, /\A(\|)/],
]
FORMATTING_TOKENS =

Internal: A Hash whose keys are Symbols representing token types which are considered to be formatting tokens (i.e. tokens that don’t contain code).

{
  :WHITESPACE    => true,
  :NEWLINE       => true,
  :COMMENT       => true,
  :MLCOMMENT     => true,
  :SLASH_COMMENT => true,
  :INDENT        => true,
}

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Lexer

Returns a new instance of Lexer.



29
30
31
32
33
 
# File 'lib/puppet-lint/lexer.rb', line 29

def initialize
  @line_no = 1
  @column = 1
  @@heredoc_queue ||= []
end

Instance Method Details

#get_heredoc_segment(string, eos_text, interpolate = true) ⇒ Object

Internal: Splits a heredoc String into segments if it is to be interpolated.

string - The String heredoc. eos_text - The String endtext for the heredoc. interpolate - A Boolean that specifies whether this heredoc can contain

interpolated values (defaults to True).

Returns an Array consisting of two Strings, the String up to the first terminator and the terminator that was found.



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/puppet-lint/lexer.rb', line 527

def get_heredoc_segment(string, eos_text, interpolate=true)
  if interpolate
    regexp = /(([^\\]|^|[^\\])([\\]{2})*[$]+|\|?\s*-?#{Regexp.escape(eos_text)})/
  else
    regexp = /\|?\s*-?#{Regexp.escape(eos_text)}/
  end

  str = string.scan_until(regexp)
  begin
    str =~ /\A(.*?)([$]+|\|?\s*-?#{Regexp.escape(eos_text)})\Z/m
    value = $1
    terminator = $2
    [value, terminator]
  rescue
    [nil, nil]
  end
end

#get_string_segment(string, terminators) ⇒ Object

Internal: Split a string on multiple terminators, excluding escaped terminators.

string - The String to be split. terminators - The String of terminators that the String should be split

on.

Returns an Array consisting of two Strings, the String up to the first terminator and the terminator that was found.



390
391
392
393
394
395
396
397
 
# File 'lib/puppet-lint/lexer.rb', line 390

def get_string_segment(string, terminators)
  str = string.scan_until(/([^\\]|^|[^\\])([\\]{2})*[#{terminators}]+/)
  begin
    [str[0..-2], str[-1,1]]
  rescue
    [nil, nil]
  end
end

#interpolate_heredoc(string, name) ⇒ Object

Internal: Tokenise the contents of a heredoc.

string - The String to be tokenised. name - The String name/endtext of the heredoc.

Returns nothing.



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/puppet-lint/lexer.rb', line 468

def interpolate_heredoc(string, name)
  ss = StringScanner.new(string)
  eos_text = name[/\A"?(.+?)"?(:.+?)?(\/.*)?\Z/, 1]
  first = true
  interpolate = name.start_with?('"')
  value, terminator = get_heredoc_segment(ss, eos_text, interpolate)
  until value.nil?
    if terminator =~ /\A\|?\s*-?\s*#{Regexp.escape(eos_text)}/
      if first
        tokens << new_token(:HEREDOC, value, :raw => "#{value}#{terminator}")
        first = false
      else
        tokens << new_token(:HEREDOC_POST, value, :raw => "#{value}#{terminator}")
      end
    else
      if first
        tokens << new_token(:HEREDOC_PRE, value)
        first = false
      else
        tokens << new_token(:HEREDOC_MID, value)
      end
      if ss.scan(/\{/).nil?
        var_name = ss.scan(/(::)?(\w+(-\w+)*::)*\w+(-\w+)*/)
        if var_name.nil?
          tokens << new_token(:HEREDOC_MID, "$")
        else
          tokens << new_token(:UNENC_VARIABLE, var_name)
        end
      else
        contents = ss.scan_until(/\}/)[0..-2]
        raw = contents.dup
        if contents.match(/\A(::)?([\w-]+::)*[\w-]|(\[.+?\])*/) && !contents.match(/\A\w+\(/)
          contents = "$#{contents}" unless contents.start_with?("$")
        end

        lexer = PuppetLint::Lexer.new
        lexer.tokenise(contents)
        lexer.tokens.each do |token|
          tokens << new_token(token.type, token.value)
        end
        if lexer.tokens.length == 1 && lexer.tokens[0].type == :VARIABLE
          tokens.last.raw = raw
        end
      end
    end
    value, terminator = get_heredoc_segment(ss, eos_text, interpolate)
  end
end

#interpolate_string(string, line, column) ⇒ Object

Internal: Tokenise the contents of a double quoted string.

string - The String to be tokenised. line - The Integer line number of the start of the passed string. column - The Integer column number of the start of the passed string.

Returns nothing.



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/puppet-lint/lexer.rb', line 406

def interpolate_string(string, line, column)
  ss = StringScanner.new(string)
  first = true
  value, terminator = get_string_segment(ss, '"$')
  until value.nil?
    if terminator == "\""
      if first
        tokens << new_token(:STRING, value, :line => line, :column => column)
        first = false
      else
        line += value.scan(/(\r\n|\r|\n)/).size
        token_column = column + (ss.pos - value.size)
        tokens << new_token(:DQPOST, value, :line => line, :column => token_column)
        @column = token_column + 1
        @line_no = line
      end
    else
      if first
        tokens << new_token(:DQPRE, value, :line => line, :column => column)
        first = false
      else
        line += value.scan(/(\r\n|\r|\n)/).size
        token_column = column + (ss.pos - value.size)
        tokens << new_token(:DQMID, value, :line => line, :column => token_column)
      end
      if ss.scan(/\{/).nil?
        var_name = ss.scan(/(::)?(\w+(-\w+)*::)*\w+(-\w+)*/)
        if var_name.nil?
          token_column = column + ss.pos - 1
          tokens << new_token(:DQMID, "$", :line => line, :column => token_column)
        else
          token_column = column + (ss.pos - var_name.size)
          tokens << new_token(:UNENC_VARIABLE, var_name, :line => line, :column => token_column)
        end
      else
        contents = ss.scan_until(/\}/)[0..-2]
        raw = contents.dup
        if contents.match(/\A(::)?([\w-]+::)*[\w-]+(\[.+?\])*/) && !contents.match(/\A\w+\(/)
          contents = "$#{contents}"
        end
        lexer = PuppetLint::Lexer.new
        lexer.tokenise(contents)
        lexer.tokens.each do |token|
          tok_col = column + token.column + (ss.pos - contents.size - 1)
          tok_line = token.line + line - 1
          tokens << new_token(token.type, token.value, :line => tok_line, :column => tok_col)
        end
        if lexer.tokens.length == 1 && lexer.tokens[0].type == :VARIABLE
          tokens.last.raw = raw
        end
      end
    end
    value, terminator = get_string_segment(ss, '"$')
  end
end

#new_token(type, value, *args) ⇒ Object

Internal: Create a new PuppetLint::Lexer::Token object, calculate its line number and column and then add it to the Linked List of tokens.

type - The Symbol token type. value - The token value. opts - A Hash of additional values required to determine line number and

      column:
:line   - The Integer line number if calculated externally.
:column - The Integer column number if calculated externally.
:raw    - The String raw value of the token (if necessary).

Returns the instantiated PuppetLint::Lexer::Token object.



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/puppet-lint/lexer.rb', line 334

def new_token(type, value, *args)
  # This bit of magic is used instead of an "opts = {}" argument so that we
  # can safely deprecate the old "length" parameter that might still be
  # passed by 3rd party plugins that haven't updated yet.
  opts = args.last.is_a?(Hash) ? args.last : {}

  column = opts[:column] || @column
  line_no = opts[:line] || @line_no

  token = Token.new(type, value, line_no, column)
  unless tokens.last.nil?
    token.prev_token = tokens.last
    tokens.last.next_token = token

    unless FORMATTING_TOKENS.include?(token.type)
      prev_nf_idx = tokens.rindex { |r| ! FORMATTING_TOKENS.include? r.type }
      unless prev_nf_idx.nil?
        prev_nf_token = tokens[prev_nf_idx]
        prev_nf_token.next_code_token = token
        token.prev_code_token = prev_nf_token
      end
    end
  end

  if opts[:raw]
    token.raw = opts[:raw]
  end

  if type == :NEWLINE
    @line_no += 1
    @column = 1
  else
    lines = token.to_manifest.split(/(?:\r\n|\r|\n)/, -1)
    @line_no += lines.length - 1
    if lines.length > 1
      # if the token renders to multiple lines, set the column state to the
      # length of the last line plus 1 (because column numbers are
      # 1 indexed)
      @column = lines.last.size + 1
    else
      @column += (lines.last || "").size
    end
  end

  token
end

#possible_regex? ⇒ Boolean

Internal: Given the tokens already processed, determine if the next token could be a regular expression.

Returns true if the next token could be a regex, otherwise return false.

Returns:

  • (Boolean) 


308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/puppet-lint/lexer.rb', line 308

def possible_regex?
  prev_token = tokens.reject { |r|
    FORMATTING_TOKENS.include? r.type
  }.last

  return true if prev_token.nil?

  if REGEX_PREV_TOKENS.include? prev_token.type
    true
  else
    false
  end
end

#slurp_string(string) ⇒ Object 



293
294
295
296
297
298
299
300
301
302
 
# File 'lib/puppet-lint/lexer.rb', line 293

def slurp_string(string)
  dq_str_regexp = /(\$\{|(\A|[^\\])(\\\\)*")/m
  scanner = StringScanner.new(string)
  contents = scanner.scan_until(dq_str_regexp)
  until scanner.matched.end_with?('"')
    contents += scanner.scan_until(/\}/m)
    contents += scanner.scan_until(dq_str_regexp)
  end
  contents
end

#tokenise(code) ⇒ Object

Internal: Convert a Puppet manifest into tokens.

code - The Puppet manifest to be tokenised as a String.

Returns an Array of PuppetLint::Lexer::Token objects. Raises PuppetLint::LexerError if it encounters unexpected characters (usually the result of syntax errors).



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/puppet-lint/lexer.rb', line 169

def tokenise(code)
  i = 0

  while i < code.size
    chunk = code[i..-1]

    found = false

    KNOWN_TOKENS.each do |type, regex|
      if value = chunk[regex, 1]
        length = value.size
        if type == :NAME
          if KEYWORDS.include? value
            tokens << new_token(value.upcase.to_sym, value)
          else
            tokens << new_token(type, value)
          end
        else
          tokens << new_token(type, value)
        end
        i += length
        found = true
        break
      end
    end

    unless found
      if var_name = chunk[/\A\$((::)?(\w+(-\w+)*::)*\w+(-\w+)*(\[.+?\])*)/, 1]
        length = var_name.size + 1
        tokens << new_token(:VARIABLE, var_name)

      elsif chunk.match(/\A'(.*?)'/m)
        str_content = StringScanner.new(code[i+1..-1]).scan_until(/(\A|[^\\])(\\\\)*'/m)
        length = str_content.size + 1
        tokens << new_token(:SSTRING, str_content[0..-2])

      elsif chunk.match(/\A"/)
        str_contents = slurp_string(code[i+1..-1])
        _ = code[0..i].split("\n")
        interpolate_string(str_contents, _.count, _.last.length)
        length = str_contents.size + 1

      elsif heredoc_name = chunk[/\A@\(("?.+?"?(:.+?)?(\/.*?)?)\)/, 1]
        @@heredoc_queue << heredoc_name
        tokens << new_token(:HEREDOC_OPEN, heredoc_name)
        length = heredoc_name.size + 3

      elsif comment = chunk[/\A(#.*)/, 1]
        length = comment.size
        comment.sub!(/#/, '')
        tokens << new_token(:COMMENT, comment)

      elsif slash_comment = chunk[/\A(\/\/.*)/, 1]
        length = slash_comment.size
        slash_comment.sub!(/\/\//, '')
        tokens << new_token(:SLASH_COMMENT, slash_comment)

      elsif mlcomment = chunk[/\A(\/\*.*?\*\/)/m, 1]
        length = mlcomment.size
        mlcomment_raw = mlcomment.dup
        mlcomment.sub!(/\A\/\* ?/, '')
        mlcomment.sub!(/ ?\*\/\Z/, '')
        mlcomment.gsub!(/^ *\*/, '')
        tokens << new_token(:MLCOMMENT, mlcomment, :raw => mlcomment_raw)

      elsif chunk.match(/\A\/.*?\//) && possible_regex?
        str_content = StringScanner.new(code[i+1..-1]).scan_until(/(\A|[^\\])(\\\\)*\//m)
        length = str_content.size + 1
        tokens << new_token(:REGEX, str_content[0..-2])

      elsif eolindent = chunk[/\A((\r\n|\r|\n)[ \t]+)/m, 1]
        eol = eolindent[/\A([\r\n]+)/m, 1]
        tokens << new_token(:NEWLINE, eol)
        length = eol.size

        if @@heredoc_queue.empty?
          indent = eolindent[/\A[\r\n]+([ \t]+)/m, 1]
          tokens << new_token(:INDENT, indent)
          length += indent.size
        else
          heredoc_tag = @@heredoc_queue.shift
          heredoc_name = heredoc_tag[/\A"?(.+?)"?(:.+?)?(\/.*)?\Z/, 1]
          str_contents = StringScanner.new(code[i+length..-1]).scan_until(/\|?\s*-?\s*#{heredoc_name}/)
          interpolate_heredoc(str_contents, heredoc_tag)
          length += str_contents.size
        end

      elsif whitespace = chunk[/\A([ \t]+)/, 1]
        length = whitespace.size
        tokens << new_token(:WHITESPACE, whitespace)

      elsif eol = chunk[/\A(\r\n|\r|\n)/, 1]
        length = eol.size
        tokens << new_token(:NEWLINE, eol)

        unless @@heredoc_queue.empty?
          heredoc_tag = @@heredoc_queue.shift
          heredoc_name = heredoc_tag[/\A"?(.+?)"?(:.+?)?(\/.*)?\Z/, 1]
          str_contents = StringScanner.new(code[i+length..-1]).scan_until(/\|?\s*-?\s*#{heredoc_name}/)
          _ = code[0..i+length].split("\n")
          interpolate_heredoc(str_contents, heredoc_tag)
          length += str_contents.size
        end

      elsif chunk.match(/\A\//)
        length = 1
        tokens << new_token(:DIV, '/')

      elsif chunk.match(/\A@/)
        length = 1
        tokens << new_token(:AT, '@')

      else
        raise PuppetLint::LexerError.new(@line_no, @column)
      end

      i += length
    end
  end

  tokens
end

#tokens ⇒ Object

Internal: Access the internal token storage.

Returns an Array of PuppetLint::Lexer::Toxen objects.



158
159
160
 
# File 'lib/puppet-lint/lexer.rb', line 158

def tokens
  @tokens ||= []
end