puppet-lint 0.2.0.pre1 → 0.2.0

data/.gitignore

@@ -3,3 +3,4 @@
 .rbenv-version
 Gemfile.lock
 vendor/gems
+coverage/

data/.travis.yml

@@ -5,20 +5,7 @@ rvm:
 branches:
   only:
     - master
+    - dust_bunny
 notifications:
   email:
     - tim@github.com
-env:
-  - PUPPET_VERSION=2.6.13
-  - PUPPET_VERSION=2.7.9
-  - PUPPET_VERSION=0.25.4
-matrix:
-  exclude:
-    - rvm: 1.9.2
-      env: PUPPET_VERSION=2.6.13
-    - rvm: 1.9.3
-      env: PUPPET_VERSION=2.6.13
-    - rvm: 1.9.2
-      env: PUPPET_VERSION=0.25.4
-    - rvm: 1.9.3
-      env: PUPPET_VERSION=0.25.4

data/Gemfile

@@ -5,4 +5,6 @@ puppetversion = ENV.key?('PUPPET_VERSION') ? "= #{ENV['PUPPET_VERSION']}" : ['>=
 gem 'rake'
 gem 'rspec'
 gem 'rdoc'
+gem 'ruby-prof'
 gem 'puppet', puppetversion
+gem 'rcov', :platform => :ruby_18

data/Rakefile

@@ -6,6 +6,11 @@ task :default => :test
 
 RSpec::Core::RakeTask.new(:test)
 
+RSpec::Core::RakeTask.new(:cov) do |t|
+  t.rcov = true
+  t.rcov_opts = '--exclude "spec" --xrefs'
+end
+
 ### RDOC Tasks ###
 require 'rdoc'
 if (RDoc::VERSION.split('.') <=> ['2','4','2']) >= 0

data/bin/puppet-lint

@@ -2,104 +2,6 @@
 
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
-help = <<HELP
-Puppet-lint
-
-Basic Command Line Usage:
-  puppet-lint [OPTIONS] [PATH]
-
-        PATH                         The path to the Puppet manifest.
-
-Options:
-HELP
-
-require 'optparse'
-require 'rubygems'
 require 'puppet-lint'
 
-opts = OptionParser.new do |opts|
-  opts.banner = help
-
-  opts.on("--version", "Display current version.") do
-    puts "Puppet-lint " + PuppetLint::VERSION
-    exit 0
-  end
-
-  opts.on("--with-filename", "Display the filename before the warning") do
-    PuppetLint.configuration.with_filename = true
-  end
-
-  opts.on("--error-level LEVEL", [:all, :warning, :error], "The level of error to return.", "(warning, error, all)") do |el|
-    PuppetLint.configuration.error_level = el
-  end
-
-  opts.on("--fail-on-warnings", "Return a non-zero exit status for warnings.") do
-    PuppetLint.configuration.fail_on_warnings = true
-  end
-
-  opts.on("--log-format FORMAT",
-    "Change the log format.", "Overrides --with-filename.",
-    "The following placeholders can be used:",
-    "%{filename}   - Filename without path.",
-    "%{path}       - Path as provided.",
-    "%{fullpath}   - Full path.",
-    "%{linenumber} - Line number.",
-    "%{kind}       - The kind of message.",
-    "              - (warning, error)",
-    "%{KIND}       - Uppercase version of %{kind}",
-    "%{check}      - Name of the check.",
-    "%{message}    - The message."
-  ) do |format|
-    PuppetLint.configuration.log_format = format
-  end
-
-  opts.separator ""
-  opts.separator "    Disable checks:"
-
-  PuppetLint.configuration.checks.each do |check|
-    opts.on("--no-#{check}-check", "Skip the #{check} check") do
-      PuppetLint.configuration.send("disable_#{check}")
-    end
-  end
-
-  opts.load(File.expand_path("~/.puppet-lintrc")) unless opts.load(".puppet-lintrc")
-end
-
-begin
-  opts.parse!
-rescue OptionParser::InvalidOption
-  puts "puppet-lint: #{$!.message}"
-  puts "puppet-lint: try 'puppet-lint --help' for more information"
-  exit
-end
-
-if ARGV[0].nil?
-  puts "puppet-lint: no file specified"
-  puts "puppet-lint: try 'puppet-lint --help' for more information"
-  exit
-end
-
-begin
-  path = ARGV[0]
-  if File.directory?(path)
-    Dir.chdir(path)
-    path = Dir.glob('**/*.pp')
-  else
-    path = [path]
-  end
-
-  path.each do |f|
-    l = PuppetLint.new
-    l.file = f
-    l.run
-    if l.errors? or (l.warnings? and PuppetLint.configuration.fail_on_warnings)
-      exit 1
-    end
-  end
-
-rescue PuppetLint::NoCodeError
-  puts "puppet-lint: no file specified or specified file does not exist"
-  puts "puppet-lint: try 'puppet-lint --help' for more information"
-  exit
-end
-
+PuppetLint::Bin.new(ARGV).run

data/lib/puppet-lint.rb

@@ -2,6 +2,7 @@ require 'puppet-lint/version'
 require 'puppet-lint/lexer'
 require 'puppet-lint/configuration'
 require 'puppet-lint/plugin'
+require 'puppet-lint/bin'
 
 unless String.respond_to?('prepend')
   class String
@@ -67,7 +68,7 @@ end
 class PuppetLint::NoCodeError < StandardError; end
 
 class PuppetLint
-  attr_reader :code, :file
+  attr_reader :data
 
   def initialize
     @data = nil
@@ -125,7 +126,7 @@ class PuppetLint
       end
     end
   end
-  
+
   def errors?
     @statistics[:error] != 0
   end
@@ -134,12 +135,6 @@ class PuppetLint
     @statistics[:warning] != 0
   end
 
-  def checks
-    PuppetLint::CheckPlugin.repository.map do |plugin|
-      plugin.new.checks
-    end.flatten
-  end
-
   def run
     if @data.nil?
       raise PuppetLint::NoCodeError
@@ -152,9 +147,6 @@ class PuppetLint
 end
 
 # Default configuration options
-PuppetLint.configuration.fail_on_warnings = false
-PuppetLint.configuration.error_level = :all
-PuppetLint.configuration.with_filename = false
-PuppetLint.configuration.log_format = ''
+PuppetLint.configuration.defaults
 
 require 'puppet-lint/plugins'

data/lib/puppet-lint/bin.rb

@@ -0,0 +1,115 @@
+require 'optparse'
+
+class PuppetLint::Bin
+  def initialize(args)
+    @args = args
+  end
+
+  def run
+    help = <<-EOHELP
+    Puppet-lint
+
+    Basic Command Line Usage:
+      puppet-lint [OPTIONS] [PATH]
+
+            PATH                         The path to the Puppet manifest.
+
+    Options:
+    EOHELP
+
+    opts = OptionParser.new do |opts|
+      opts.banner = help
+
+      opts.on("--version", "Display current version.") do
+        puts "Puppet-lint " + PuppetLint::VERSION
+        return 0
+      end
+
+      opts.on("--with-filename", "Display the filename before the warning") do
+        PuppetLint.configuration.with_filename = true
+      end
+
+      opts.on("--fail-on-warnings", "Return a non-zero exit status for warnings.") do
+        PuppetLint.configuration.fail_on_warnings = true
+      end
+
+      opts.on("--error-level LEVEL", [:all, :warning, :error], "The level of error to return.", "(warning, error, all)") do |el|
+        PuppetLint.configuration.error_level = el
+      end
+
+      opts.on("--log-format FORMAT",
+        "Change the log format.", "Overrides --with-filename.",
+        "The following placeholders can be used:",
+        "%{filename}   - Filename without path.",
+        "%{path}       - Path as provided.",
+        "%{fullpath}   - Full path.",
+        "%{linenumber} - Line number.",
+        "%{kind}       - The kind of message.",
+        "              - (warning, error)",
+        "%{KIND}       - Uppercase version of %{kind}",
+        "%{check}      - Name of the check.",
+        "%{message}    - The message."
+      ) do |format|
+        PuppetLint.configuration.log_format = format
+      end
+
+      opts.separator ""
+      opts.separator "    Disable checks:"
+
+      PuppetLint.configuration.checks.each do |check|
+        opts.on("--no-#{check}-check", "Skip the #{check} check") do
+          PuppetLint.configuration.send("disable_#{check}")
+        end
+      end
+
+      opts.load('/etc/puppet-lint.rc')
+      opts.load(File.expand_path('~/.puppet-lint.rc'))
+      if opts.load(File.expand_path('~/.puppet-lintrc'))
+        $stderr.puts 'Depreciated: Found ~/.puppet-lintrc instead of ~/.puppet-lint.rc'
+      end
+      opts.load('.puppet-lint.rc')
+      if opts.load('.puppet-lintrc')
+        $stderr.puts 'Depreciated: Read .puppet-lintrc instead of .puppet-lint.rc'
+      end
+    end
+
+    begin
+      opts.parse!(@args)
+    rescue OptionParser::InvalidOption
+      puts "puppet-lint: #{$!.message}"
+      puts "puppet-lint: try 'puppet-lint --help' for more information"
+      return 1
+    end
+
+    if @args[0].nil?
+      puts "puppet-lint: no file specified"
+      puts "puppet-lint: try 'puppet-lint --help' for more information"
+      return 1
+    end
+
+    begin
+      path = @args[0]
+      if File.directory?(path)
+        path = Dir.glob("#{path}/**/*.pp")
+      else
+        path = @args
+      end
+
+      return_val = 0
+      path.each do |f|
+        l = PuppetLint.new
+        l.file = f
+        l.run
+        if l.errors? or (l.warnings? and PuppetLint.configuration.fail_on_warnings)
+          return_val = 1
+        end
+      end
+      return return_val
+
+    rescue PuppetLint::NoCodeError
+      puts "puppet-lint: no file specified or specified file does not exist"
+      puts "puppet-lint: try 'puppet-lint --help' for more information"
+      return 1
+    end
+  end
+end

data/lib/puppet-lint/configuration.rb

@@ -54,8 +54,12 @@ class PuppetLint
       }
     end
 
-    def self.ignore_paths
-      settings[:ignore_paths] ||= []
+    def defaults
+      settings.clear
+      self.with_filename = false
+      self.fail_on_warnings = false
+      self.error_level = :all
+      self.log_format = ''
     end
   end
 end

data/lib/puppet-lint/lexer.rb

@@ -1,31 +1,43 @@
 require 'pp'
 require 'strscan'
+require 'puppet-lint/lexer/token'
+require 'set'
 
 class PuppetLint
+  class LexerError < RuntimeError; end
   class Lexer
-    KEYWORDS = [
-      'class',
-      'case',
-      'default',
-      'define',
-      'import',
-      'if',
-      'else',
-      'elsif',
-      'inherits',
-      'node',
-      'and',
-      'or',
-      'undef',
-      'true',
-      'false',
-      'in',
-      'unless',
-    ]
+    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(?:0[xX][0-9A-Fa-f]+|0?\d+(?:\.\d+)?(?:[eE]-?\d+)?)\b/],
+      [: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(\])/],
@@ -65,10 +77,18 @@ class PuppetLint
       [:SEMIC, /\A(;)/],
       [:QMARK, /\A(\?)/],
       [:BACKSLASH, /\A(\\)/],
-      [:DIV, /\A(\/)/],
       [:TIMES, /\A(\*)/],
     ]
 
+    FORMATTING_TOKENS = {
+      :WHITESPACE => true,
+      :NEWLINE => true,
+      :COMMENT => true,
+      :MLCOMMENT => true,
+      :SLASH_COMMENT => true,
+      :INDENT => true,
+    }
+
     def tokens
       @tokens ||= []
     end
@@ -87,12 +107,12 @@ class PuppetLint
           if value = chunk[regex, 1]
             if type == :NAME
               if KEYWORDS.include? value
-                tokens << new_token(value.upcase.to_sym, value, code[0..i])
+                tokens << new_token(value.upcase.to_sym, value, :chunk => code[0..i])
               else
-                tokens << new_token(type, value, code[0..i])
+                tokens << new_token(type, value, :chunk => code[0..i])
               end
             else
-              tokens << new_token(type, value, code[0..i])
+              tokens << new_token(type, value, :chunk => code[0..i])
             end
             i += value.size
             found = true
@@ -101,65 +121,67 @@ class PuppetLint
         end
 
         unless found
-          if identifier = chunk[/\A([a-z]\w*)/, 1]
-            tokens << new_token(:IDENTIFIER, identifier, code[0..i])
-            i += identifier.size
-
-          elsif var_name = chunk[/\A\$((::)?([\w-]+::)*[\w-]+)/, 1]
-            tokens << new_token(:VARIABLE, var_name, code[0..i])
+          if var_name = chunk[/\A\$((::)?([\w-]+::)*[\w-]+)/, 1]
+            tokens << new_token(:VARIABLE, var_name, :chunk => code[0..i])
             i += var_name.size + 1
 
-          elsif sstring = chunk[/\A'(.*?)'/, 1]
-            tokens << new_token(:SSTRING, sstring, code[0..i])
-            i += sstring.size + 2
+          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(/[^\\]"/m)
+            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 chunk.match(/\A\//)
-            str_content = StringScanner.new(code[i+1..-1]).scan_until(/[^\\]\//m)
-            tokens << new_token(:REGEX, str_content, code[0..i])
-            i += str_content.size + 1
-
           elsif comment = chunk[/\A(#.*)/, 1]
             comment_size = comment.size
             comment.sub!(/# ?/, '')
-            tokens << new_token(:COMMENT, comment, code[0..i])
+            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, code[0..i])
+            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!(/^\/\* ?/, '')
-            mlcomment.sub!(/ ?\*\/$/, '')
-            tokens << new_token(:MLCOMMENT, mlcomment, code[0..i])
+            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', code[0..i])
-            tokens << new_token(:INDENT, indent, code[0..i+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, code[0..i])
+            tokens << new_token(:WHITESPACE, whitespace, :chunk => code[0..i])
             i += whitespace.size
 
           elsif chunk.match(/\A\n/)
-            tokens << new_token(:NEWLINE, '\n', code[0..i])
+            tokens << new_token(:NEWLINE, '\n', :chunk => code[0..i])
             i += 1
 
-          else
-            value = chunk[0,1]
-            tokens << new_token(value, value, code[0..i])
+          elsif chunk.match(/\A\//)
+            tokens << new_token(:DIV, '/', :chunk => code[0..i])
             i += 1
+
+          else
+            raise PuppetLint::LexerError, chunk
           end
         end
       end
@@ -167,16 +189,54 @@ class PuppetLint
       tokens
     end
 
-    def new_token(type, value, chunk)
-      lines = chunk.split("\n")
-      line_no = lines.empty? ? 1 : lines.count
-      column = lines.empty? ? 1 : lines.last.length
+    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
+
+    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
 
-      PuppetLint::Token.new(type, value, line_no, column)
+      token
     end
 
     def get_string_segment(string, terminators)
-      str = string.scan_until(/([^\\]|^|[^\\])([\\]{2})*[#{terminators}]/)
+      str = string.scan_until(/([^\\]|^|[^\\])([\\]{2})*[#{terminators}]+/)
       begin
         [str[0..-2], str[-1,1]]
       rescue
@@ -191,34 +251,41 @@ class PuppetLint
       until value.nil?
         if terminator == "\""
           if first
-            tokens << PuppetLint::Token.new(:STRING, value, line, column) 
+            tokens << new_token(:STRING, value, :line => line, :column => column)
             first = false
           else
             line += value.count("\n")
             token_column = column + (ss.pos - value.size)
-            tokens << PuppetLint::Token.new(:DQPOST, value, line, token_column)
+            tokens << new_token(:DQPOST, value, :line => line, :column => token_column)
           end
         else
           if first
-            tokens << PuppetLint::Token.new(:DQPRE, value, line, column)
+            tokens << new_token(:DQPRE, value, :line => line, :column => column)
             first = false
           else
             line += value.count("\n")
             token_column = column + (ss.pos - value.size)
-            tokens << PuppetLint::Token.new(:DQMID, value, line, token_column)
+            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 << PuppetLint::Token.new(:UNENC_VARIABLE, var_name, line, token_column)
+              tokens << new_token(:UNENC_VARIABLE, var_name, :line => line, :column => token_column)
             end
           else
-            var_name = ss.scan(/(::)?([\w-]+::)*[\w-]+/)
-            unless var_name.nil?
-              token_column = column + (ss.pos - var_name.size)
-              tokens << PuppetLint::Token.new(:VARIABLE, var_name, line, token_column)
-              ss.scan(/\}/)
+            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
@@ -226,19 +293,4 @@ class PuppetLint
       end
     end
   end
-
-  class Token
-    attr_reader :type, :value, :line, :column
-
-    def initialize(type, value, line, column)
-      @value = value
-      @type = type
-      @line = line
-      @column = column
-    end
-
-    def inspect
-      "<Token #{@type.inspect} (#{@value}) @#{@line}:#{@column}>"
-    end
-  end
 end