puppet-lint 0.0.1 → 0.0.2

data/lib/puppet-lint.rb

@@ -2,12 +2,14 @@ require 'puppet-lint/plugin'
 require 'puppet-lint/plugins'
 
 class PuppetLint
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 
   attr_reader :code, :file
 
   def initialize
     @data = nil
+    @errors = 0
+    @warnings = 0
   end
 
   def file=(path)
@@ -20,11 +22,29 @@ class PuppetLint
     @data = value
   end
 
+  def report(kind, message)
+    if kind == :warnings
+      @warnings += 1
+      puts "WARNING: #{message}"
+    else
+      @errors += 1
+      puts "ERROR: #{message}"
+    end
+  end
+
+  def errors?
+    @errors != 0
+  end
+
+  def warnings?
+    @warnings != 0
+  end
+
   def run
     PuppetLint::CheckPlugin.repository.each do |plugin|
       problems = plugin.new.run(@data)
-      problems[:errors].each { |error| puts "ERROR: #{error}" }
-      problems[:warnings].each { |warning| puts "WARNING: #{warning}" }
+      problems[:errors].each { |error| report :errors, error }
+      problems[:warnings].each { |warning| report :warnings, warning }
     end
   end
 end

data/lib/puppet-lint/plugins.rb

@@ -4,3 +4,5 @@ class PuppetLint
 end
 
 require 'puppet-lint/plugins/check_strings'
+require 'puppet-lint/plugins/check_whitespace'
+require 'puppet-lint/plugins/check_resources'

data/lib/puppet-lint/plugins/check_resources.rb

@@ -0,0 +1,52 @@
+# Resources
+# http://docs.puppetlabs.com/guides/style_guide.html#resources
+
+class PuppetLint::Plugins::CheckResources < PuppetLint::CheckPlugin
+  def test(data)
+    line_no = 0
+    in_resource = true
+    first_attribute = false
+    data.split("\n").each do |line|
+      line_no += 1
+
+      if line.include? "{"
+        in_resource = true
+        first_attribute = true
+        line = line.slice(line.index('{')..-1)
+      end
+
+      if in_resource
+        # Resource titles SHOULD be quoted
+        line.scan(/[^'"]\s*:/) do |match|
+          unless line =~ /\$[\w:]+\s*:/
+            warn "unquoted resource title on line #{line_no}"
+          end
+        end
+
+        line.scan(/(\w+)\s*=>\s*([^\n,;]+)/) do |attr, value|
+          # Ensure SHOULD be the first attribute listed
+          if attr == 'ensure'
+            unless first_attribute
+              warn "ensure found on line #{line_no} but it's not the first attribute"
+            end
+          end
+
+          # File modes SHOULD be represented as a 4 digits instead of 3, to
+          # explicitly show that they are octal values.
+          if attr == 'mode'
+            unless value =~ /'\d{4}'/
+              warn "mode should be represented as a 4 digit octal value on line #{line_no}"
+            end
+          end
+
+          first_attribute = false
+        end
+        first_attribute = false
+      end
+
+      if line.include? "}"
+        in_resource = false
+      end
+    end
+  end
+end

data/lib/puppet-lint/plugins/check_whitespace.rb

@@ -0,0 +1,44 @@
+# Spacing, Identation & Whitespace
+# http://http://docs.puppetlabs.com/guides/style_guide.html#spacing-indentation--whitespace
+
+class PuppetLint::Plugins::CheckWhitespace < PuppetLint::CheckPlugin
+  def test(data)
+    line_no = 0
+    in_block = false
+    prefix_length = 0
+    data.split("\n").each do |line|
+      line_no += 1
+
+      # MUST NOT use literal tab characters
+      error "tab character found on line #{line_no}" if line.include? "\t"
+
+      # MUST NOT contain trailing white space
+      error "trailing whitespace found on line #{line_no}" if line.end_with? " "
+
+      # SHOULD NOT exceed an 80 character line width
+      warn "line #{line_no} has more than 80 characters" if line.length > 80
+
+      # MUST use two-space soft tabs
+      line.scan(/^ +/) do |prefix|
+        unless prefix.length % 2 == 0
+          error "two-space soft tabs not used on line #{line_no}"
+        end
+      end
+
+      # SHOULD align fat comma arrows (=>) within blocks of attributes
+      if line =~ /^( +\w+ +)=>/
+        if in_block
+          unless $1.length == prefix_length
+            warn "=> on line #{line_no} isn't aligned with the previous line"
+          end
+        else
+          prefix_length = $1.length
+          in_block = true
+        end
+      else
+        in_block = false
+        prefix_length = 0
+      end
+    end
+  end
+end

data/lib/tasks/puppet-lint.rake

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'puppet-lint'
+
+task :lint do
+  linter =  PuppetLint.new
+  Dir.glob('**/*.pp').each do |puppet_file|
+    puts "Evaluating #{puppet_file}"
+    linter.file = puppet_file
+    linter.run
+  end
+  fail if linter.errors?
+end

data/puppet-lint.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'puppet-lint'
-  s.version = '0.0.1'
+  s.version = '0.0.2'
   s.homepage = 'https://github.com/rodjek/puppet-lint/'
   s.summary = 'Ensure your Puppet manifests conform with the Puppetlabs style guide'
   s.description = 'Checks your Puppet manifests against the Puppetlabs
@@ -10,9 +10,12 @@ Gem::Specification.new do |s|
   s.files = [
     'bin/puppet-lint',
     'lib/puppet-lint/plugin.rb',
+    'lib/puppet-lint/plugins/check_resources.rb',
     'lib/puppet-lint/plugins/check_strings.rb',
+    'lib/puppet-lint/plugins/check_whitespace.rb',
     'lib/puppet-lint/plugins.rb',
     'lib/puppet-lint.rb',
+    'lib/tasks/puppet-lint.rake',
     'puppet-lint.gemspec',
     'README.md',
   ]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: puppet-lint
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Tim Sharpe
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-15 00:00:00 Z
+date: 2011-08-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -44,9 +44,12 @@ extra_rdoc_files: []
 files: 
 - bin/puppet-lint
 - lib/puppet-lint/plugin.rb
+- lib/puppet-lint/plugins/check_resources.rb
 - lib/puppet-lint/plugins/check_strings.rb
+- lib/puppet-lint/plugins/check_whitespace.rb
 - lib/puppet-lint/plugins.rb
 - lib/puppet-lint.rb
+- lib/tasks/puppet-lint.rake
 - puppet-lint.gemspec
 - README.md
 homepage: https://github.com/rodjek/puppet-lint/