puppet-lint-param-docs 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b51934ae6df0b664bc963b8366a37b7e6ec3a4f
-  data.tar.gz: ad409a86b6778a747ea42cfa6ec1dc50172aba27
+  metadata.gz: 4bb4b94293827223c095b299cf276db411a10b2f
+  data.tar.gz: a7f61cd34c5d9488a002533c026d2dc9d2f3f7a3
 SHA512:
-  metadata.gz: 07878556ff5e6f8a738115afa9b274561114624c29a85ccb48061f21a50531667fc7ab0e3dcc6c67167e30851a41a681dcc2344826d02d865de6d3b5ec4ce1c1
-  data.tar.gz: c931d62386aa49bb75c57862c321d953b5e64823ebac846b48a9c088d5551a5eecd136c8fcda6dcd3a8fc64f769af8f545ccc30e3453a7cad90794bc9d41d67b
+  metadata.gz: f0c8fa5a5f48d0e5f2d7141b809a2ad01ab00de3eda336891955e6a0e4027579937bbd815ebf31daea5b587282b420518220167983a57c78dee53542dcb8e4d9
+  data.tar.gz: 4a78705dc8c8b0aab3be9ba1dff093afe117804a76a60c74db1c2352c730ffd1d0379b8c31d7d8e6f0d35202e479889537e006162b05b494915816d9e7596507

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

@@ -15,18 +15,18 @@ PuppetLint.new_check(:parameter_documentation) do
 
       params = []
       e = klass[:param_tokens].each
-      e.each do |ptok|
-        params << ptok if ptok.type == :VARIABLE
-        # skip to the next parameter to avoid finding default values of variables
-        begin
-          while true
-            ptok = e.next
-            break if ptok == :COMMA
+      begin
+        while (ptok = e.next)
+          if ptok.type == :VARIABLE
+            params << ptok
+            # skip to the next parameter to avoid finding default values of variables
+            while true
+              ptok = e.next
+              break if ptok.type == :COMMA
+            end
           end
-        rescue StopIteration
-          break
         end
-      end
+      rescue StopIteration; end
 
       params.each do |p|
         next if doc_params.include? p.value

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

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'parameter_documentation' do
-  let(:msg) { 'missing documentation for class parameter example::foo' }
+  let(:msg) { 'missing documentation for class parameter example::%s' }
 
   context 'class missing any documentation' do
     let(:code) { 'class example($foo) { }' }
@@ -11,7 +11,7 @@ describe 'parameter_documentation' do
     end
 
     it 'should create a warning' do
-      expect(problems).to contain_warning(msg).on_line(1).in_column(15)
+      expect(problems).to contain_warning(msg % :foo).on_line(1).in_column(15)
     end
   end
 
@@ -23,13 +23,30 @@ describe 'parameter_documentation' do
     end
 
     it 'should create a warning' do
-      expect(problems).to contain_warning(msg).on_line(1).in_column(15)
+      expect(problems).to contain_warning(msg % :foo).on_line(1).in_column(15)
     end
   end
 
-  context 'class missing documentation for a parameter' do
+  context 'class with many param defaults' do
     let(:code) do
       <<-EOS
+class 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 for a parameter' do
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
       # Example class
       #
       # === Parameters:
@@ -45,8 +62,30 @@ describe 'parameter_documentation' do
     end
 
     it 'should create a warning' do
-      # column looks wrong, maybe the parser's out
-      expect(problems).to contain_warning(msg).on_line(7).in_column(21)
+      expect(problems).to contain_warning(msg % :foo).on_line(7).in_column(15)
+    end
+  end
+
+  context 'class missing documentation for a second parameter' do
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
+      # Example class
+      #
+      # === Parameters:
+      #
+      # $bar:: example
+      #
+      class 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(msg % :foo).on_line(7).in_column(15)
+      expect(problems).to contain_warning(msg % :baz).on_line(7).in_column(27)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-param-docs
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Dominic Cleal