Class: PuppetLint::Lexer

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

Defined Under Namespace

Classes: Token

Constant Summary collapse

KEYWORDS = 
{
  'class' => true,
  'case' => true,
  'default' => true,
  'define' => true,
  'import' => true,
  'if' => true,
  'else' => true,
  'elsif' => true,
  'inherits' => true,
  'node' => true,
  'and' => true,
  'or' => true,
  'undef' => true,
  'true' => true,
  'false' => true,
  'in' => true,
  'unless' => true,
}
REGEX_PREV_TOKENS = 
{
  :NODE => true,
  :LBRACE => true,
  :RBRACE => true,
  :MATCH => true,
  :NOMATCH => true,
  :COMMA => true,
}
KNOWN_TOKENS = 
[
  [:CLASSREF, /\A(((::){0,1}[A-Z][-\w]*)+)/],
  [:NUMBER, /\A\b((?:0[xX][0-9A-Fa-f]+|0?\d+(?:\.\d+)?(?:[eE]-?\d+)?))\b/],
  [:NAME, /\A(((::)?[a-z0-9][-\w]*)(::[a-z0-9][-\w]*)*)/],
  [: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(:)/],
  [:AT, /\A(@)/],
  [:SEMIC, /\A(;)/],
  [:QMARK, /\A(\?)/],
  [:BACKSLASH, /\A(\\)/],
  [:TIMES, /\A(\*)/],
]
FORMATTING_TOKENS = 
{
  :WHITESPACE => true,
  :NEWLINE => true,
  :COMMENT => true,
  :MLCOMMENT => true,
  :SLASH_COMMENT => true,
  :INDENT => true,
}

Instance Method Summary collapse

Instance Method Details

#get_string_segment(string, terminators) ⇒ Object 



251
252
253
254
255
256
257
258
 
# File 'lib/puppet-lint/lexer.rb', line 251

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_string(string, line, column) ⇒ Object 



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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/puppet-lint/lexer.rb', line 260

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.count("\n")
        token_column = column + (ss.pos - value.size)
        tokens << new_token(:DQPOST, value, :line => line, :column => token_column)
      end
    else
      if first
        tokens << new_token(:DQPRE, value, :line => line, :column => column)
        first = false
      else
        line += value.count("\n")
        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-]+/)
        unless var_name.nil?
          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]
        if contents.match(/\A(::)?([\w-]+::)*[\w-]+\Z/)
          token_column = column + (ss.pos - contents.size - 1)
          tokens << new_token(:VARIABLE, contents, :line => line, :column => token_column)
        else
          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
        end
      end
    end
    value, terminator = get_string_segment(ss, '"$')
  end
end

#new_token(type, value, opts = {}) ⇒ Object 



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
 
# File 'lib/puppet-lint/lexer.rb', line 219

def new_token(type, value, opts = {})
  if opts[:chunk]
    line_no = opts[:chunk].count("\n") + 1
    if line_no == 1
      column = opts[:chunk].length
    else
      column = opts[:chunk].length - opts[:chunk].rindex("\n") - 1
    end
    column += 1 if column == 0
  else
    column = opts[:column]
    line_no = opts[:line]
  end

  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

  token
end

#possible_regex? ⇒ Boolean

Returns:

  • (Boolean) 


205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/puppet-lint/lexer.rb', line 205

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

#tokenise(code) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
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
 
# File 'lib/puppet-lint/lexer.rb', line 109

def tokenise(code)
  code.chomp!

  i = 0

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

    found = false

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

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

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

      elsif chunk.match(/\A"/)
        str_contents = StringScanner.new(code[i+1..-1]).scan_until(/(\A|[^\\])(\\\\)*"/m)
        _ = code[0..i].split("\n")
        interpolate_string(str_contents, _.count, _.last.length)
        i += str_contents.size + 1

      elsif comment = chunk[/\A(#.*)/, 1]
        comment_size = comment.size
        comment.sub!(/# ?/, '')
        tokens << new_token(:COMMENT, comment, :chunk => code[0..i])
        i += comment_size

      elsif slash_comment = chunk[/\A(\/\/.*)/, 1]
        slash_comment_size = slash_comment.size
        slash_comment.sub!(/\/\/ ?/, '')
        tokens << new_token(:SLASH_COMMENT, slash_comment, :chunk => code[0..i])
        i += slash_comment_size

      elsif mlcomment = chunk[/\A(\/\*.*?\*\/)/m, 1]
        mlcomment_size = mlcomment.size
        mlcomment.sub!(/\A\/\* ?/, '')
        mlcomment.sub!(/ ?\*\/\Z/, '')
        mlcomment.gsub!(/^ ?\* ?/, '')
        mlcomment.gsub!(/\n/, ' ')
        mlcomment.strip!
        tokens << new_token(:MLCOMMENT, mlcomment, :chunk => code[0..i])
        i += mlcomment_size

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

      elsif indent = chunk[/\A\n([ \t]+)/m, 1]
        tokens << new_token(:NEWLINE, '\n', :chunk => code[0..i])
        tokens << new_token(:INDENT, indent, :chunk => code[0..i+1])
        i += indent.size + 1

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

      elsif chunk.match(/\A\n/)
        tokens << new_token(:NEWLINE, '\n', :chunk => code[0..i])
        i += 1

      elsif chunk.match(/\A\//)
        tokens << new_token(:DIV, '/', :chunk => code[0..i])
        i += 1

      else
        raise PuppetLint::LexerError.new(code, i)
      end
    end
  end

  tokens
end

#tokens ⇒ Object 



105
106
107
 
# File 'lib/puppet-lint/lexer.rb', line 105

def tokens
  @tokens ||= []
end