puppet-lint-param-docs 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bb4b94293827223c095b299cf276db411a10b2f
-  data.tar.gz: a7f61cd34c5d9488a002533c026d2dc9d2f3f7a3
+  metadata.gz: 4cf77c26f657156fad03044435a16d3dbe003717
+  data.tar.gz: fe657a095d1febeb3edc1312d634779c0c97c7ea
 SHA512:
-  metadata.gz: f0c8fa5a5f48d0e5f2d7141b809a2ad01ab00de3eda336891955e6a0e4027579937bbd815ebf31daea5b587282b420518220167983a57c78dee53542dcb8e4d9
-  data.tar.gz: 4a78705dc8c8b0aab3be9ba1dff093afe117804a76a60c74db1c2352c730ffd1d0379b8c31d7d8e6f0d35202e479889537e006162b05b494915816d9e7596507
+  metadata.gz: e4065e1c26034d49c04f471f3e4621cf615c397116d337a8d9108ce59b94e40ea6a4620bc1ed5e625cf3b0ba9066a3f18bbb023dfe7e6adc6a72b12f9ddfa4ef
+  data.tar.gz: 7e63d27aacb10ffb8f7c5964b712545a6c2eefb44e4bf9d8143be0ac510dcadde74f016f26b8d5dd786ab00eff002ec5645256b5dd3db99e88c6d9dad220529b

data/README.md

@@ -8,7 +8,7 @@ default behaviour is to throw an error when a parameter is undocumented.
 
 ## Installation
 
-To use this plugin, add the following like to the Gemfile in your Puppet code
+To use this plugin, add the following line to the Gemfile in your Puppet code
 base and run `bundle install`.
 
 ```ruby

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

@@ -7,7 +7,10 @@ PuppetLint.new_check(:parameter_documentation) do
       tokens[0..klass[:start]].reverse_each do |dtok|
         next if [:CLASS, :NEWLINE, :WHITESPACE, :INDENT].include?(dtok.type)
         if [:COMMENT, :MLCOMMENT, :SLASH_COMMENT].include?(dtok.type)
-          doc_params << $1 if dtok.value =~ /\A\s*\$([a-zA-Z0-9_]+)::/
+          if dtok.value =~ /\A\s*\[\*([a-zA-Z0-9_]+)\*\]/ or
+             dtok.value =~ /\A\s*\$([a-zA-Z0-9_]+)::/
+            doc_params << $1
+          end
         else
           break
         end

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

@@ -44,7 +44,7 @@ class foreman (
     end
   end
 
-  context 'class missing documentation for a parameter' do
+  context 'class missing documentation ($bar::) for a parameter' do
     let(:code) do
       <<-EOS.gsub(/^\s+/, '')
       # Example class
@@ -66,7 +66,29 @@ class foreman (
     end
   end
 
-  context 'class missing documentation for a second parameter' do
+  context 'class missing documentation ([*bar*]) for a parameter' do
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
+      # Example class
+      #
+      # === Parameters:
+      #
+      # [*bar*] example
+      #
+      class 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(msg % :foo).on_line(7).in_column(15)
+    end
+  end
+
+  context 'class missing documentation ($bar::) for a second parameter' do
     let(:code) do
       <<-EOS.gsub(/^\s+/, '')
       # Example class
@@ -89,7 +111,30 @@ class foreman (
     end
   end
 
-  context 'class with all parameters documented' do
+  context 'class missing documentation ([*bar*]) 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
+
+  context 'class with all parameters documented ($foo::)' do
     let(:code) do
       <<-EOS
       # Example class
@@ -107,6 +152,24 @@ class foreman (
     end
   end
 
+  context 'class with all parameters documented ([*foo*])' do
+    let(:code) do
+      <<-EOS
+      # Example class
+      #
+      # === Parameters:
+      #
+      # [*foo*] example
+      #
+      class 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 { }' }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-param-docs
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Dominic Cleal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-23 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint