puppet-lint 0.4.0.pre1 → 1.0.0

data/.travis.yml

@@ -1,11 +1,10 @@
+before_install: gem update --system 2.1.11
 rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-branches:
-  only:
-    - master
-    - dust_bunny
+  - 2.0.0
+  - 2.1.0
 notifications:
   email:
     - tim@github.com

data/Gemfile

@@ -1,6 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
-gem 'rake'
-gem 'rspec'
-gem 'ruby-prof'
-gem 'rcov', :platform => :ruby_18
+gemspec

data/README.md

@@ -2,12 +2,11 @@
 
 [![Build
 Status](https://secure.travis-ci.org/rodjek/puppet-lint.png)](http://travis-ci.org/rodjek/puppet-lint)
-[![Dependency
-Status](https://gemnasium.com/rodjek/puppet-lint.png)](http://gemnasium.com/rodjek/puppet-lint)
+[![Inline docs](http://inch-ci.org/github/rodjek/puppet-lint.png?branch=master)](http://inch-ci.org/github/rodjek/puppet-lint)
 
 The goal of this project is to implement as many of the recommended Puppet
 style guidelines from the [Puppet Labs style
-guide](http://docs.puppetlabs.com/guides/style_guide.html) as practical.
+guide](http://docs.puppetlabs.com/guides/style_guide.html) as practical. It is not meant to validate syntax. Please use `puppet parser validate` for that.
 
 ## Installation
 
@@ -82,151 +81,6 @@ At the moment, the following tests have been implemented:
  * When using top-scope variables, including facts, Puppet modules should
    explicitly specify the empty namespace.
 
-## Fixing problems
-
-### right_to_left_relationship
-
-```
-WARNING: right-to-left (<-) relationship on line X
-```
-
-While right to left relationships are perfectly valid, it's highly recommended
-that you don't use them as most people think and read from left to right and
-this can lead to confusion.
-
-Bad:
-
-```
-Service['httpd'] <- Package['httpd']
-```
-
-Good:
-
-```
-Package['httpd'] -> Service['httpd']
-```
-
-### autoloader_layout
-
-```
-ERROR: mymodule::myclass not in autoload module layout on line X
-```
-
-Puppet attempts to autoload only the required manifests for the resources and
-classes specified in your manifests.  In order to do this, the autoloader
-expects your manifests to be laid out on disk in a particular format.  For
-example, when you use `mymodule::myclass` in your manifests, Puppet will
-attempt to read `<modulepath>/mymodule/manifests/myclass.pp`.  The only
-exception to this is when you reference `mymodule` itself (without any
-subclass/subtype) in which case it will read
-`<modulepath>/mymodule/manifests/init.pp`.
-
-### parameter_order
-
-```
-WARNING: optional parameter listed before required parameter on line X
-```
-
-In parameterised class and defined type definitions, parameters that are
-required should be listed before optional parameters (those with default
-values).
-
-Bad:
-
-```
-class foo($bar='baz', $gronk) {
-```
-
-Good:
-
-```
-class foo($gronk, $bar='baz') {
-```
-
-### inherits_across_namespaces
-
-Placeholder
-
-### nested_classes_or_defines
-
-Placeholder
-
-### variable_scope
-
-Placeholder
-
-### selector_inside_resource
-
-Placeholder
-
-### case_without_default
-
-Placeholder
-
-### unquoted_resource_title
-
-Placeholder
-
-### ensure_first_param
-
-Placeholder
-
-### unquoted_file_mode
-
-Placeholder
-
-### 4digit_file_mode
-
-Placeholder
-
-### ensure_not_symlink_target
-
-Placeholder
-
-### double_quoted_strings
-
-Placeholder
-
-### only_variable_string
-
-Placeholder
-
-### variables_not_enclosed
-
-Placeholder
-
-### single_quote_string_with_variables
-
-Placeholder
-
-### quoted_booleans
-
-Placeholder
-
-### variable_contains_dash
-
-Placeholder
-
-### hard_tabs
-
-Placeholder
-
-### trailing_whitespace
-
-Placeholder
-
-### 80chars
-
-Placeholder
-
-### 2sp_soft_tabs
-
-Placeholder
-
-### arrow_alignment
-
-Placeholder
-
 ## Disabling checks
 
 ### puppet-lint
@@ -254,7 +108,6 @@ For a list of all the flags just type:
 puppet-lint --help
 ```
 
-
 ### Rake task
 
 You can also disable checks when running puppet-lint through the supplied Rake

data/Rakefile

@@ -4,8 +4,3 @@ require 'rspec/core/rake_task'
 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

data/lib/puppet-lint.rb

@@ -1,23 +1,52 @@
+require 'set'
 require 'puppet-lint/version'
 require 'puppet-lint/lexer'
 require 'puppet-lint/configuration'
+require 'puppet-lint/data'
 require 'puppet-lint/checks'
 require 'puppet-lint/bin'
 require 'puppet-lint/monkeypatches'
 
 class PuppetLint::NoCodeError < StandardError; end
+class PuppetLint::NoFix < StandardError; end
 
+# Public: The public interface to puppet-lint.
 class PuppetLint
   # Public: Gets/Sets the String manifest code to be checked.
   attr_accessor :code
 
+  # Public: Gets the String manifest with the errors fixed.
   attr_reader :manifest
 
+  # Public: Returns an Array of Hashes describing the problems found in the
+  # manifest.
+  #
+  # Each Hash will contain *at least*:
+  #   :check   - The Symbol name of the check that generated the problem.
+  #   :kind    - The Symbol kind of the problem (:error, :warning, or
+  #              :fixed).
+  #   :line    - The Integer line number of the location of the problem in
+  #              the manifest.
+  #   :column  - The Integer column number of the location of the problem in
+  #              the manifest.
+  #   :message - The String message describing the problem that was found.
+  attr_reader :problems
+
+  # Public: Gets/Sets the String path to the manifest to be checked.
+  attr_accessor :path
+
+  # Public: Returns a Hash of linter statistics
+  #
+  #   :error   - An Integer count of errors found in the manifest.
+  #   :warning - An Integer count of warnings found in the manifest.
+  #   :fixed   - An Integer count of problems found in the manifest that were
+  #              automatically fixed.
+  attr_reader :statistics
+
   # Public: Initialise a new PuppetLint object.
   def initialize
     @code = nil
-    @statistics = {:error => 0, :warning => 0, :fixed => 0}
-    @fileinfo = {:path => ''}
+    @statistics = {:error => 0, :warning => 0, :fixed => 0, :ignored => 0}
     @manifest = ''
   end
 
@@ -41,9 +70,7 @@ class PuppetLint
   # Returns nothing.
   def file=(path)
     if File.exist? path
-      @fileinfo[:path] = path
-      @fileinfo[:fullpath] = File.expand_path(path)
-      @fileinfo[:filename] = File.basename(path)
+      @path = path
       @code = File.read(path)
     end
   end
@@ -56,7 +83,7 @@ class PuppetLint
   def log_format
     if configuration.log_format == ''
       ## recreate previous old log format as far as thats possible.
-      format = '%{KIND}: %{message} on line %{linenumber}'
+      format = '%{KIND}: %{message} on line %{line}'
       if configuration.with_filename
         format.prepend '%{path} - '
       end
@@ -73,22 +100,22 @@ class PuppetLint
   def format_message(message)
     format = log_format
     puts format % message
+    if message[:kind] == :ignored && !message[:reason].nil?
+      puts "  #{message[:reason]}"
+    end
   end
 
   # Internal: Print out the line of the manifest on which the problem was found
   # as well as a marker pointing to the location on the line.
   #
   # message - A Hash containing all the information about a problem.
-  # linter  - The PuppetLint::Checks object that was used to test the manifest.
   #
   # Returns nothing.
-  def print_context(message, linter)
-    # XXX: I don't really like the way this has been implemented (passing the
-    # linter object down through layers of functions.  Refactor me!
+  def print_context(message)
     return if message[:check] == 'documentation'
     return if message[:kind] == :fixed
-    line = linter.manifest_lines[message[:linenumber] - 1]
-    offset = line.index(/\S/)
+    line = PuppetLint::Data.manifest_lines[message[:line] - 1]
+    offset = line.index(/\S/) || 1
     puts "\n  #{line.strip}"
     printf "%#{message[:column] + 2 - offset}s\n\n", '^'
   end
@@ -97,20 +124,18 @@ class PuppetLint
   #
   # problems - An Array of problem Hashes as returned by
   #            PuppetLint::Checks#run.
-  # linter   - The PuppetLint::Checks object that was used to test the
-  #            manifest.
   #
   # Returns nothing.
-  def report(problems, linter)
+  def report(problems)
     problems.each do |message|
-      @statistics[message[:kind]] += 1
+      next if message[:kind] == :ignored && !PuppetLint.configuration.show_ignored
 
-      message.merge!(@fileinfo) {|key, v1, v2| v1 }
       message[:KIND] = message[:kind].to_s.upcase
+      message[:linenumber] = message[:line]
 
       if message[:kind] == :fixed || [message[:kind], :all].include?(configuration.error_level)
         format_message message
-        print_context(message, linter) if configuration.with_context
+        print_context(message) if configuration.with_context
       end
     end
   end
@@ -140,11 +165,40 @@ class PuppetLint
     end
 
     linter = PuppetLint::Checks.new
-    problems = linter.run(@fileinfo, @code)
+    @problems = linter.run(@path, @code)
+    @problems.each { |problem| @statistics[problem[:kind]] += 1 }
 
     @manifest = linter.manifest if PuppetLint.configuration.fix
+  end
+
+  # Public: Print any problems that were found out to stdout.
+  #
+  # Returns nothing.
+  def print_problems
+    report @problems
+  end
 
-    report problems, linter
+  # Public: Define a new check.
+  #
+  # name  - A unique name for the check as a Symbol.
+  # block - The check logic. This must contain a `check` method and optionally
+  #         a `fix` method.
+  #
+  # Returns nothing.
+  #
+  # Examples
+  #
+  #   PuppetLint.new_check(:foo) do
+  #     def check
+  #     end
+  #   end
+  def self.new_check(name, &block)
+    class_name = name.to_s.split('_').map(&:capitalize).join
+    klass = PuppetLint.const_set("Check#{class_name}", Class.new(PuppetLint::CheckPlugin))
+    klass.const_set('NAME', name)
+    klass.class_exec(&block)
+    PuppetLint.configuration.add_check(name, klass)
+    PuppetLint::Data.ignore_overrides[name] ||= {}
   end
 end
 

data/lib/puppet-lint/bin.rb

@@ -1,10 +1,16 @@
-require 'optparse'
+require 'puppet-lint/optparser'
 
+# Internal: The logic of the puppet-lint bin script, contained in a class for
+# ease of testing.
 class PuppetLint::Bin
   # Public: Initialise a new PuppetLint::Bin.
   #
   # args - An Array of command line argument Strings to be passed to the option
   #        parser.
+  #
+  # Examples
+  #
+  #   PuppetLint::Bin.new(ARGV).run
   def initialize(args)
     @args = args
   end
@@ -13,88 +19,7 @@ class PuppetLint::Bin
   #
   # Returns an Integer exit code to be passed back to the shell.
   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-context', 'Show where in the manifest the problem is') do
-        PuppetLint.configuration.with_context = true
-      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("-l", '--load FILE', 'Load a file containing custom puppet-lint checks.') do |f|
-        load f
-      end
-
-      opts.on('-f', '--fix', 'Attempt to automatically fix errors') do
-        PuppetLint.configuration.fix = 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('/etc/puppet-lint.rc')
-
-      if ENV['HOME']
-        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
-      end
-
-      opts.load('.puppet-lint.rc')
-      if opts.load('.puppet-lintrc')
-        $stderr.puts 'Depreciated: Read .puppet-lintrc instead of .puppet-lint.rc'
-      end
-    end
+    opts = PuppetLint::OptParser.build
 
     begin
       opts.parse!(@args)
@@ -104,6 +29,11 @@ class PuppetLint::Bin
       return 1
     end
 
+    if PuppetLint.configuration.display_version
+      puts "puppet-lint #{PuppetLint::VERSION}"
+      return 0
+    end
+
     if @args[0].nil?
       puts "puppet-lint: no file specified"
       puts "puppet-lint: try 'puppet-lint --help' for more information"
@@ -118,18 +48,23 @@ class PuppetLint::Bin
         path = @args
       end
 
+      if path.length > 1
+        PuppetLint.configuration.with_filename = true
+      end
+
       return_val = 0
       path.each do |f|
         l = PuppetLint.new
         l.file = f
         l.run
+        l.print_problems
         if l.errors? or (l.warnings? and PuppetLint.configuration.fail_on_warnings)
           return_val = 1
         end
 
-        if PuppetLint.configuration.fix
+        if PuppetLint.configuration.fix && !l.problems.any? { |e| e[:check] == :syntax }
           File.open(f, 'w') do |fd|
-            fd.puts l.manifest
+            fd.write l.manifest
           end
         end
       end