puppet-lint 0.3.2 → 0.4.0.pre1

data/.gitignore

@@ -1,6 +1,8 @@
 *.gem
 .bundle/
 .rbenv-version
+.ruby-version
 Gemfile.lock
 vendor/gems
 coverage/
+*.swp

data/Gemfile

@@ -2,6 +2,5 @@ source :rubygems
 
 gem 'rake'
 gem 'rspec'
-gem 'rdoc'
 gem 'ruby-prof'
 gem 'rcov', :platform => :ruby_18

data/README.md

@@ -55,6 +55,8 @@ At the moment, the following tests have been implemented:
 ### Resources
 
  * All resource titles should be quoted.
+   * An exception has been made for resource titles that consist of only
+     a variable standing by itself.
  * If a resource declaration includes an `ensure` attribute, it should be the
    first attribute specified.
  * Symbolic links should be declared by using an ensure value of `link` and
@@ -240,7 +242,7 @@ puppet-lint --no-80chars-check /path/to/my/manifest.pp
 puppet-lint will also check for a `.puppet-lint.rc` file in the current
 directory and your home directory and read in flags from there, so if you
 wanted to always skip the hard tab character check, you could create
-`~./puppet-lint.rc` containing
+`~/.puppet-lint.rc` containing
 
 ```
 --no-hard_tabs-check

data/Rakefile

@@ -2,7 +2,6 @@ require 'rake'
 require 'rspec/core/rake_task'
 
 task :default => :test
-#task :default => [:test, :rdoc]
 
 RSpec::Core::RakeTask.new(:test)
 
@@ -10,21 +9,3 @@ 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
-  require 'rdoc/task'
-  RDoc::Task.new(:rdoc) do |rdoc|
-    rdoc.main = "README.md"
-    rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
-    rdoc.options << "--all"
-  end
-else
-  require 'rake/rdoctask'
-  Rake::RDocTask.new(:rdoc) do |rdoc|
-    rdoc.main = "README.md"
-    rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
-    rdoc.options << "--all"
-  end
-end

data/lib/puppet-lint.rb

@@ -1,102 +1,58 @@
 require 'puppet-lint/version'
 require 'puppet-lint/lexer'
 require 'puppet-lint/configuration'
-require 'puppet-lint/plugin'
+require 'puppet-lint/checks'
 require 'puppet-lint/bin'
-
-unless String.respond_to?('prepend')
-  class String
-    def prepend(lead)
-      self.replace "#{lead}#{self}"
-    end
-  end
-end
-
-# If we are using an older ruby version, we back-port the basic functionality
-# we need for formatting output: 'somestring' % <hash>
-begin
-  if ('%{test}' % {:test => 'replaced'} == 'replaced')
-    # If this works, we are all good to go.
-  end
-rescue
-  # If the test failed (threw a error), monkeypatch String.
-  # Most of this code came from http://www.ruby-forum.com/topic/144310 but was
-  # simplified for our use.
-
-  # Basic implementation of 'string' % { } like we need it. needs work.
-  class String
-    Percent = instance_method '%' unless defined? Percent
-    def % *a, &b
-      a.flatten!
-
-      string = case a.last
-      when Hash
-        expand a.pop
-      else
-        self
-      end
-
-      if a.empty?
-        string
-      else
-        Percent.bind(string).call(a, &b)
-      end
-
-    end
-    def expand! vars = {}
-      loop do
-        changed = false
-        vars.each do |var, value|
-          var = var.to_s
-          var.gsub! %r/[^a-zA-Z0-9_]/, ''
-          [
-            %r/\%\{#{ var }\}/,
-          ].each do |pat|
-            changed = gsub! pat, "#{ value }"
-          end
-        end
-        break unless changed
-      end
-      self
-    end
-    def expand opts = {}
-      dup.expand! opts
-    end
-  end
-end
+require 'puppet-lint/monkeypatches'
 
 class PuppetLint::NoCodeError < StandardError; end
 
 class PuppetLint
-  attr_reader :data
+  # Public: Gets/Sets the String manifest code to be checked.
+  attr_accessor :code
+
+  attr_reader :manifest
 
+  # Public: Initialise a new PuppetLint object.
   def initialize
-    @data = nil
-    @statistics = {:error => 0, :warning => 0}
+    @code = nil
+    @statistics = {:error => 0, :warning => 0, :fixed => 0}
     @fileinfo = {:path => ''}
+    @manifest = ''
   end
 
+  # Public: Access PuppetLint's configuration from outside the class.
+  #
+  # Returns a PuppetLint::Configuration object.
   def self.configuration
     @configuration ||= PuppetLint::Configuration.new
   end
 
+  # Public: Access PuppetLint's configuration from inside the class.
+  #
+  # Returns a PuppetLint::Configuration object.
   def configuration
     self.class.configuration
   end
 
+  # Public: Set the path of the manifest file to be tested and read the
+  # contents of the file.
+  #
+  # Returns nothing.
   def file=(path)
     if File.exist? path
       @fileinfo[:path] = path
       @fileinfo[:fullpath] = File.expand_path(path)
       @fileinfo[:filename] = File.basename(path)
-      @data = File.read(path)
+      @code = File.read(path)
     end
   end
 
-  def code=(value)
-    @data = value
-  end
-
+  # Internal: Retrieve the format string to be used when writing problems to
+  # STDOUT.  If the user has not specified a custom log format, build one for
+  # them.
+  #
+  # Returns a format String to be used with String#%.
   def log_format
     if configuration.log_format == ''
       ## recreate previous old log format as far as thats possible.
@@ -109,50 +65,85 @@ class PuppetLint
     return configuration.log_format
   end
 
+  # Internal: Format a problem message and print it to STDOUT.
+  #
+  # message - A Hash containing all the information about a problem.
+  #
+  # Returns nothing.
   def format_message(message)
     format = log_format
     puts format % message
   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!
     return if message[:check] == 'documentation'
+    return if message[:kind] == :fixed
     line = linter.manifest_lines[message[:linenumber] - 1]
     offset = line.index(/\S/)
     puts "\n  #{line.strip}"
     printf "%#{message[:column] + 2 - offset}s\n\n", '^'
   end
 
+  # Internal: Print the reported problems with a manifest to stdout.
+  #
+  # 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)
     problems.each do |message|
       @statistics[message[:kind]] += 1
-      ## Add some default attributes.
+
       message.merge!(@fileinfo) {|key, v1, v2| v1 }
       message[:KIND] = message[:kind].to_s.upcase
 
-      if configuration.error_level == message[:kind] or configuration.error_level == :all
+      if message[:kind] == :fixed || [message[:kind], :all].include?(configuration.error_level)
         format_message message
         print_context(message, linter) if configuration.with_context
       end
     end
   end
 
+  # Public: Determine if PuppetLint found any errors in the manifest.
+  #
+  # Returns true if errors were found, otherwise returns false.
   def errors?
     @statistics[:error] != 0
   end
 
+  # Public: Determine if PuppetLint found any warnings in the manifest.
+  #
+  # Returns true if warnings were found, otherwise returns false.
   def warnings?
     @statistics[:warning] != 0
   end
 
+  # Public: Run the loaded manifest code through the lint checks and print the
+  # results of the checks to stdout.
+  #
+  # Returns nothing.
+  # Raises PuppetLint::NoCodeError if no manifest code has been loaded.
   def run
-    if @data.nil?
+    if @code.nil?
       raise PuppetLint::NoCodeError
     end
 
     linter = PuppetLint::Checks.new
-    problems = linter.run(@fileinfo, @data)
+    problems = linter.run(@fileinfo, @code)
+
+    @manifest = linter.manifest if PuppetLint.configuration.fix
+
     report problems, linter
   end
 end

data/lib/puppet-lint/bin.rb

@@ -1,10 +1,17 @@
 require 'optparse'
 
 class PuppetLint::Bin
+  # Public: Initialise a new PuppetLint::Bin.
+  #
+  # args - An Array of command line argument Strings to be passed to the option
+  #        parser.
   def initialize(args)
     @args = args
   end
 
+  # Public: Run puppet-lint as a command line tool.
+  #
+  # Returns an Integer exit code to be passed back to the shell.
   def run
     help = <<-EOHELP
     Puppet-lint
@@ -41,6 +48,14 @@ class PuppetLint::Bin
         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:",
@@ -111,6 +126,12 @@ class PuppetLint::Bin
         if l.errors? or (l.warnings? and PuppetLint.configuration.fail_on_warnings)
           return_val = 1
         end
+
+        if PuppetLint.configuration.fix
+          File.open(f, 'w') do |fd|
+            fd.puts l.manifest
+          end
+        end
       end
       return return_val
 

data/lib/puppet-lint/checkplugin.rb

@@ -0,0 +1,22 @@
+class PuppetLint::CheckPlugin
+  # Public: Define a new lint check.
+  #
+  # name - The String name of the check.
+  # b    - The Block implementation of the check.
+  #
+  # Returns nothing.
+  def self.check(name, &b)
+    PuppetLint.configuration.add_check(name, &b)
+  end
+
+  # Public: Define a new check helper method.
+  #
+  # name - The String name of the helper.
+  # b    - The Block implementation of the helper.
+  #
+  # Returns nothing.
+  def self.helper(name, &b)
+    PuppetLint.configuration.add_helper(name, &b)
+  end
+end
+

data/lib/puppet-lint/{plugin.rb → checks.rb}

@@ -1,7 +1,14 @@
+require 'puppet-lint/checkplugin'
+
 class PuppetLint::Checks
+  # Public: Get an Array of problem Hashes.
   attr_reader :problems
-  attr_reader :manifest_lines
 
+  # Public: Get an Array of PuppetLint::Lexer::Token objects.
+  attr_reader :tokens
+
+  # Public: Initialise a new PuppetLint::Checks object and prepare the check
+  # methods.
   def initialize
     @problems = []
     @default_info = {:check => 'unknown', :linenumber => 0, :column => 0}
@@ -10,30 +17,39 @@ class PuppetLint::Checks
       method = PuppetLint.configuration.check_method[check]
       self.class.send(:define_method, "lint_check_#{check}", &method)
     end
+
+    PuppetLint.configuration.helpers.each do |helper|
+      method = PuppetLint.configuration.helper_method[helper]
+      self.class.send(:define_method, helper, &method)
+    end
   end
 
-  #     notify(kind, message_hash)    #=> nil
-  #
-  # Adds the message to the problems array.
-  # The _kind_ gets added to the _message_hash_ by setting the key :_kind_.
-  # Typically, the _message_hash_ should contain following keys:
-  # <i>message</i>::     which contains a string value describing the problem
-  # <i>linenumber</i>::  which contains the line number on which the problem occurs.
-  # Besides the :_kind_ value that is being set, some other key/values are also
-  # added. Typically, this is
-  # <i>check</i>::      which contains the name of the check that is being executed.
-  # <i>linenumber</i>:: which defaults to 0 if the message does not already contain one.
+  # Public: Add a message to the problems array.
   #
-  #     notify :warning, :message => "Something happened", :linenumber => 4
-  #     => {:kind=>:warning, :message=>"Something happened", :linenumber=>4, :check=>'unknown'}
+  # kind    - The kind of problem as a Symbol (:warning, :error).
+  # problem - A Hash containing the attributes of the problem.
+  #   :message    - The String message describing the problem.
+  #   :linenumber - The Integer line number of the location of the problem.
+  #   :check      - The String name of the check that the problem came from.
+  #   :column     - The Integer column number of the location of the problem.
   #
-  def notify(kind, message_hash)
-    message_hash[:kind] = kind
-    message_hash.merge!(@default_info) {|key, v1, v2| v1 }
-    @problems << message_hash
-    message_hash
+  # Returns nothing.
+  def notify(kind, problem)
+    problem[:kind] = kind
+    problem.merge!(@default_info) {|key, v1, v2| v1 }
+    @problems << problem
   end
 
+  # Internal: Tokenise the manifest code and prepare it for checking.
+  #
+  # fileinfo - A Hash containing the following:
+  #   :fullpath - The expanded path to the file as a String.
+  #   :filename - The name of the file as a String.
+  #   :path     - The original path to the file as passed to puppet-lint as
+  #               a String.
+  # data     - The String manifest code to be checked.
+  #
+  # Returns nothing.
   def load_data(fileinfo, data)
     lexer = PuppetLint::Lexer.new
     begin
@@ -50,6 +66,16 @@ class PuppetLint::Checks
     @data = data
   end
 
+  # Internal: Run the lint checks over the manifest code.
+  #
+  # fileinfo - A Hash containing the following:
+  #   :fullpath - The expanded path to the file as a String.
+  #   :filename - The name of the file as a String.
+  #   :path     - The original path to the file as passed to puppet-lint as
+  #               a String.
+  # data     - The String manifest code to be checked.
+  #
+  # Returns an Array of problem Hashes.
   def run(fileinfo, data)
     load_data(fileinfo, data)
 
@@ -61,6 +87,9 @@ class PuppetLint::Checks
     @problems
   end
 
+  # Internal: Get a list of checks that have not been disabled.
+  #
+  # Returns an Array of String check names.
   def enabled_checks
     @enabled_checks ||= Proc.new do
       self.public_methods.select { |method|
@@ -73,14 +102,16 @@ class PuppetLint::Checks
     end.call
   end
 
-  def tokens
-    @tokens
-  end
-
+  # Public: Get the full expanded path to the file being checked.
+  #
+  # Returns a String path.
   def fullpath
     @fileinfo[:fullpath]
   end
 
+  # Public: Retrieve a list of tokens that represent resource titles.
+  #
+  # Returns an Array of PuppetLint::Lexer::Token objects.
   def title_tokens
     @title_tokens ||= Proc.new do
       result = []
@@ -107,7 +138,7 @@ class PuppetLint::Checks
     end.call
   end
 
-  # Internal: Calculate the positions of all resource declarations within the
+  # Public: Calculate the positions of all resource declarations within the
   # tokenised manifest.  These positions only point to the content of the
   # resource declaration, they do not include resource types or
   # titles/namevars.
@@ -146,7 +177,7 @@ class PuppetLint::Checks
     end.call
   end
 
-  # Internal: Calculate the positions of all class definitions within the
+  # Public: Calculate the positions of all class definitions within the
   # tokenised manifest.
   #
   # Returns an Array of Hashes, each containing:
@@ -185,7 +216,7 @@ class PuppetLint::Checks
     end.call
   end
 
-  # Internal: Calculate the positions of all defined type definitions within
+  # Public: Calculate the positions of all defined type definitions within
   # the tokenised manifest.
   #
   # Returns an Array of Hashes, each containing:
@@ -222,18 +253,22 @@ class PuppetLint::Checks
     end.call
   end
 
+  # Public: Retrieves a list of token types that are considered to be
+  # formatting tokens (ie whitespace, newlines, etc).
+  #
+  # Returns an Array of Symbols.
   def formatting_tokens
     @formatting_tokens ||= PuppetLint::Lexer::FORMATTING_TOKENS
   end
 
+  # Public: Access the lines of the manifest that is being checked.
+  #
+  # Returns an Array of Strings.
   def manifest_lines
     @manifest_lines ||= @data.split("\n")
   end
-end
 
-class PuppetLint::CheckPlugin
-  def self.check(name, &b)
-    PuppetLint.configuration.add_check(name, &b)
+  def manifest
+    tokens.map { |t| t.to_manifest }.join('')
   end
 end
-