puppet-lint-param-docs 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cf77c26f657156fad03044435a16d3dbe003717
-  data.tar.gz: fe657a095d1febeb3edc1312d634779c0c97c7ea
+  metadata.gz: ac9245ad58468d4c5d12ad908c1be44b419fbd6e
+  data.tar.gz: cebcc59f5a6d1600ba3ef2820f79d96309a8ff6f
 SHA512:
-  metadata.gz: e4065e1c26034d49c04f471f3e4621cf615c397116d337a8d9108ce59b94e40ea6a4620bc1ed5e625cf3b0ba9066a3f18bbb023dfe7e6adc6a72b12f9ddfa4ef
-  data.tar.gz: 7e63d27aacb10ffb8f7c5964b712545a6c2eefb44e4bf9d8143be0ac510dcadde74f016f26b8d5dd786ab00eff002ec5645256b5dd3db99e88c6d9dad220529b
+  metadata.gz: 0e3d0109f4e5223651116dbe771034ee026584b1a4d4c411bd2e16087f152326510f68bd1880e8e022f217bd54663d4ab107ed7446276bc833ce98e34b0df2e6
+  data.tar.gz: 4407de443fdff750b3b4049e5561d367f201e5a0d348baafdeeec10a416d42f6a68cf4d570893641d83865232edb8d76abb932794a77389ccef53b70c294c357

data/README.md

@@ -1,7 +1,7 @@
 # puppet-lint parameter documentation check
 
-Adds a new puppet-lint check to verify all class parameters have been
-documented.
+Adds a new puppet-lint check to verify all class and defined type parameters
+have been documented.
 
 Particularly useful with [kafo](https://github.com/theforeman/kafo), as its
 default behaviour is to throw an error when a parameter is undocumented.
@@ -23,9 +23,10 @@ This plugin provides a new check to `puppet-lint`.
 
 **--fix support: No**
 
-This check will raise a warning for any class parameters that don't have an
-RDoc description.
+This check will raise a warning for any class or defined type parameters that
+don't have an RDoc description.
 
 ```
 WARNING: missing documentation for class parameter foo::bar
+WARNING: missing documentation for defined type parameter foo::baz
 ```

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

@@ -1,11 +1,11 @@
 PuppetLint.new_check(:parameter_documentation) do
   def check
-    class_indexes.each do |klass|
-      next if klass[:param_tokens].nil?
+    class_indexes.concat(defined_type_indexes).each do |idx|
+      next if idx[:param_tokens].nil?
 
       doc_params = []
-      tokens[0..klass[:start]].reverse_each do |dtok|
-        next if [:CLASS, :NEWLINE, :WHITESPACE, :INDENT].include?(dtok.type)
+      tokens[0..idx[:start]].reverse_each do |dtok|
+        next if [:CLASS, :DEFINE, :NEWLINE, :WHITESPACE, :INDENT].include?(dtok.type)
         if [:COMMENT, :MLCOMMENT, :SLASH_COMMENT].include?(dtok.type)
           if dtok.value =~ /\A\s*\[\*([a-zA-Z0-9_]+)\*\]/ or
              dtok.value =~ /\A\s*\$([a-zA-Z0-9_]+)::/
@@ -17,7 +17,7 @@ PuppetLint.new_check(:parameter_documentation) do
       end
 
       params = []
-      e = klass[:param_tokens].each
+      e = idx[:param_tokens].each
       begin
         while (ptok = e.next)
           if ptok.type == :VARIABLE
@@ -33,8 +33,9 @@ PuppetLint.new_check(:parameter_documentation) do
 
       params.each do |p|
         next if doc_params.include? p.value
+        idx_type = idx[:type] == :CLASS ? "class" : "defined type"
         notify :warning, {
-          :message => "missing documentation for class parameter #{klass[:name_token].value}::#{p.value}",
+          :message => "missing documentation for #{idx_type} parameter #{idx[:name_token].value}::#{p.value}",
           :line    => p.line,
           :column  => p.column,
         }

data/spec/puppet-lint/plugins/check_parameter_documentation_spec.rb

@@ -1,7 +1,8 @@
 require 'spec_helper'
 
 describe 'parameter_documentation' do
-  let(:msg) { 'missing documentation for class parameter example::%s' }
+  let(:class_msg) { 'missing documentation for class parameter example::%s' }
+  let(:define_msg) { 'missing documentation for defined type parameter example::%s' }
 
   context 'class missing any documentation' do
     let(:code) { 'class example($foo) { }' }
@@ -11,7 +12,19 @@ describe 'parameter_documentation' do
     end
 
     it 'should create a warning' do
-      expect(problems).to contain_warning(msg % :foo).on_line(1).in_column(15)
+      expect(problems).to contain_warning(class_msg % :foo).on_line(1).in_column(15)
+    end
+  end
+
+  context 'define missing any documentation' do
+    let(:code) { 'define example($foo) { }' }
+
+    it 'should detect a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'should create a warning' do
+      expect(problems).to contain_warning(define_msg% :foo).on_line(1).in_column(16)
     end
   end
 
@@ -23,7 +36,19 @@ describe 'parameter_documentation' do
     end
 
     it 'should create a warning' do
-      expect(problems).to contain_warning(msg % :foo).on_line(1).in_column(15)
+      expect(problems).to contain_warning(class_msg % :foo).on_line(1).in_column(15)
+    end
+  end
+
+  context 'define with param defaults' do
+    let(:code) { 'define example($foo = $example::params::foo) { }' }
+
+    it 'should detect a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'should create a warning' do
+      expect(problems).to contain_warning(define_msg % :foo).on_line(1).in_column(16)
     end
   end
 
@@ -44,6 +69,23 @@ class foreman (
     end
   end
 
+  context 'define with many param defaults' do
+    let(:code) do
+      <<-EOS
+define foreman (
+  $foreman_url            = $foreman::params::foreman_url,
+  $unattended             = $foreman::params::unattended,
+  $authentication         = $foreman::params::authentication,
+  $passenger              = $foreman::params::passenger,
+) {}
+      EOS
+    end
+
+    it 'should detect four problems' do
+      expect(problems).to have(4).problems
+    end
+  end
+
   context 'class missing documentation ($bar::) for a parameter' do
     let(:code) do
       <<-EOS.gsub(/^\s+/, '')
@@ -62,7 +104,29 @@ class foreman (
     end
 
     it 'should create a warning' do
-      expect(problems).to contain_warning(msg % :foo).on_line(7).in_column(15)
+      expect(problems).to contain_warning(class_msg % :foo).on_line(7).in_column(15)
+    end
+  end
+
+  context 'define missing documentation ($bar::) for a parameter' do
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
+      # Example define
+      #
+      # === Parameters:
+      #
+      # $bar:: example
+      #
+      define example($foo, $bar) { }
+      EOS
+    end
+
+    it 'should detect a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'should create a warning' do
+      expect(problems).to contain_warning(define_msg % :foo).on_line(7).in_column(16)
     end
   end
 
@@ -84,7 +148,29 @@ class foreman (
     end
 
     it 'should create a warning' do
-      expect(problems).to contain_warning(msg % :foo).on_line(7).in_column(15)
+      expect(problems).to contain_warning(class_msg % :foo).on_line(7).in_column(15)
+    end
+  end
+
+  context 'define missing documentation ([*bar*]) for a parameter' do
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
+      # Example define
+      #
+      # === Parameters:
+      #
+      # [*bar*] example
+      #
+      define example($foo, $bar) { }
+      EOS
+    end
+
+    it 'should detect a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'should create a warning' do
+      expect(problems).to contain_warning(define_msg % :foo).on_line(7).in_column(16)
     end
   end
 
@@ -106,8 +192,31 @@ class foreman (
     end
 
     it 'should create two warnings' do
-      expect(problems).to contain_warning(msg % :foo).on_line(7).in_column(15)
-      expect(problems).to contain_warning(msg % :baz).on_line(7).in_column(27)
+      expect(problems).to contain_warning(class_msg % :foo).on_line(7).in_column(15)
+      expect(problems).to contain_warning(class_msg % :baz).on_line(7).in_column(27)
+    end
+  end
+
+  context 'define missing documentation ($bar::) for a second parameter' do
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
+      # Example define
+      #
+      # === Parameters:
+      #
+      # $bar:: example
+      #
+      define example($foo, $bar, $baz) { }
+      EOS
+    end
+
+    it 'should detect two problem' do
+      expect(problems).to have(2).problems
+    end
+
+    it 'should create two warnings' do
+      expect(problems).to contain_warning(define_msg % :foo).on_line(7).in_column(16)
+      expect(problems).to contain_warning(define_msg % :baz).on_line(7).in_column(28)
     end
   end
 
@@ -129,8 +238,31 @@ class foreman (
     end
 
     it 'should create two warnings' do
-      expect(problems).to contain_warning(msg % :foo).on_line(7).in_column(15)
-      expect(problems).to contain_warning(msg % :baz).on_line(7).in_column(27)
+      expect(problems).to contain_warning(class_msg % :foo).on_line(7).in_column(15)
+      expect(problems).to contain_warning(class_msg % :baz).on_line(7).in_column(27)
+    end
+  end
+
+  context 'define missing documentation ([*bar*]) for a second parameter' do
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
+      # Example define
+      #
+      # === Parameters:
+      #
+      # [*bar*] example
+      #
+      define example($foo, $bar, $baz) { }
+      EOS
+    end
+
+    it 'should detect two problem' do
+      expect(problems).to have(2).problems
+    end
+
+    it 'should create two warnings' do
+      expect(problems).to contain_warning(define_msg % :foo).on_line(7).in_column(16)
+      expect(problems).to contain_warning(define_msg % :baz).on_line(7).in_column(28)
     end
   end
 
@@ -152,6 +284,24 @@ class foreman (
     end
   end
 
+  context 'define with all parameters documented ($foo::)' do
+    let(:code) do
+      <<-EOS
+      # Example define
+      #
+      # === Parameters:
+      #
+      # $foo:: example
+      #
+      define example($foo) { }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
   context 'class with all parameters documented ([*foo*])' do
     let(:code) do
       <<-EOS
@@ -170,6 +320,24 @@ class foreman (
     end
   end
 
+  context 'define with all parameters documented ([*foo*])' do
+    let(:code) do
+      <<-EOS
+      # Example define
+      #
+      # === Parameters:
+      #
+      # [*foo*] example
+      #
+      define example($foo) { }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
   context 'class without parameters' do
     let(:code) { 'class example { }' }
 
@@ -178,6 +346,14 @@ class foreman (
     end
   end
 
+  context 'define without parameters' do
+    let(:code) { 'define example { }' }
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
   context 'class without parameters and a function call' do
     let(:code) { 'class example { a($foo::bar) }' }
 
@@ -185,4 +361,12 @@ class foreman (
       expect(problems).to have(0).problems
     end
   end
+
+  context 'define without parameters and a function call' do
+    let(:code) { 'define example { a($foo::bar) }' }
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-param-docs
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Dominic Cleal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-13 00:00:00.000000000 Z
+date: 2015-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -81,8 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: |2
-      A new check for puppet-lint that validates all class parameters are
-      documented.
+      A new check for puppet-lint that validates all parameters are documented.
 email: dcleal@redhat.com
 executables: []
 extensions: []
@@ -113,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: puppet-lint check to validate all parameters are documented