puppet-lint-param-docs 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b7f8ef3f161f032261f4785f2ef368e89ad583295f8d1af9e25fc2daad26e15
-  data.tar.gz: ff99f8a6a3c9ceb061c6b8397e928ab5871fc2da91fffb0c296efe0f340a2575
+  metadata.gz: ca78318c1175f2885dcffee1d275f71edc78bb91a0624dc32e84fd949c03a841
+  data.tar.gz: d38343fa7170f7cdc1ae94c10aa3e809be6e61a30ce5f25d1c147e191782744f
 SHA512:
-  metadata.gz: dad82fe8054ea2433eb4bfa7d2c4a39401de66308e4c2f5027e9da3c39fbc93284e2c501b48a175469bbc3f61d1c950ee5beb5153f871084a5d3361c4d0175c9
-  data.tar.gz: e321066d4a8fc4661a923f0d1ab1e06e986a021462b7411c2b66eb5ab06d2087cdea4cb4ce39c16f480cf2ea8195c0bdbdc19e07272727eb0ba30130b726b4d7
+  metadata.gz: 6c960b3b0f25548ff75c5597ac10ed27164a1230db2ab223272ad43dae88c223ca1653ef2c8e9c0ae416c98a8f4a8ba139c1501d920e3d6cbd521b6a49f8c058
+  data.tar.gz: 7433e3dee1f9055b53332dd4b3d080e154d2be067f70fb9db1a98317f2bb3a217f4548ead7db47dba081cd7b11b1e2a9038c0163d27d2a00775d1d69c54c89c1

data/README.md

@@ -46,9 +46,25 @@ WARNING No matching class parameter for documentation of foo::bar
 
 ### Documentation styles
 
+By default, the check will allow all known documentation styles.
+You can, however, specify a list of accepted formats:
+
+```ruby
+# Limit to a single style
+PuppetLint.configuration.docs_allowed_styles = 'strings'
+# Limit to multiple styles
+PuppetLint.configuration.docs_allowed_styles = ['strings', 'doc']
+```
+
+It will raise a warning if the documentation style does not match.
+
+```
+WARNING: invalid documentation style for class parameter foo::bar (doc) on line 4
+```
+
 The check will accept any of the following styles:
 
-#### Puppet Strings
+#### Puppet Strings: `strings`
 
 Used by [Puppet Strings](https://github.com/puppetlabs/puppetlabs-strings).
 
@@ -59,7 +75,7 @@ Used by [Puppet Strings](https://github.com/puppetlabs/puppetlabs-strings).
 define example($foo) { }
 ```
 
-#### Puppet Doc style
+#### Puppet Doc style: `doc`
 
 Used by the [puppet-doc](https://puppet.com/docs/puppet/6.18/man/doc.html)
 command, deprecated in favour of Puppet Strings.
@@ -74,7 +90,7 @@ command, deprecated in favour of Puppet Strings.
 class example($foo) { }
 ```
 
-#### Kafo rdoc style
+#### Kafo rdoc style: `kafo`
 
 Used in [kafo](https://github.com/theforeman/kafo#documentation) following an
 rdoc style.

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

@@ -1,27 +1,33 @@
 PuppetLint.new_check(:parameter_documentation) do
   def check
+    allowed_styles = PuppetLint.configuration.docs_allowed_styles || ['doc', 'kafo', 'strings']
+    allowed_styles = [ allowed_styles ].flatten
+
     class_indexes.concat(defined_type_indexes).each do |idx|
       doc_params = {}
+      doc_params_styles = {}
       doc_params_duplicates = Hash.new { |hash, key| hash[key] = [doc_params[key]] }
       is_private = false
       tokens[0..idx[:start]].reverse_each do |dtok|
         next if [:CLASS, :DEFINE, :NEWLINE, :WHITESPACE, :INDENT].include?(dtok.type)
         if dtok.type == :COMMENT
-          if dtok.value =~ /\A\s*\[\*([a-zA-Z0-9_]+)\*\]/ or
-             dtok.value =~ /\A\s*\$([a-zA-Z0-9_]+):: +/ or
-             dtok.value =~ /\A\s*@param (?:\[.+\] )?([a-zA-Z0-9_]+)(?: +|$)/
-            parameter = $1
-            parameter = 'name/title' if idx[:type] == :DEFINE && ['name','title'].include?(parameter)
-            if doc_params.include? parameter
-              doc_params_duplicates[parameter] << dtok
-            else
-              doc_params[parameter] = dtok
-            end
+          if dtok.value =~ /\A\s*@api +private\s*$/
+            is_private = true
+            next
           end
 
-          is_private = true if dtok.value =~ /\A\s*@api +private\s*$/
-        else
-          break
+          style = detect_style(dtok)
+          # not a doc parameter if style has not been detected
+          next if style[0].nil?
+
+          parameter = style[2]
+          parameter = 'name/title' if idx[:type] == :DEFINE && ['name','title'].include?(parameter)
+          if doc_params.include? parameter
+            doc_params_duplicates[parameter] << dtok
+          else
+            doc_params[parameter] = dtok
+            doc_params_styles[parameter] = style[0]
+          end
         end
       end
 
@@ -52,12 +58,22 @@ PuppetLint.new_check(:parameter_documentation) do
 
       unless is_private
         params.each do |p|
-          next if doc_params.has_key? p.value
-          notify :warning, {
-            :message => "missing documentation for #{type_str(idx)} parameter #{idx[:name_token].value}::#{p.value}",
-            :line    => p.line,
-            :column  => p.column,
-          }
+          if doc_params.has_key? p.value
+            style = doc_params_styles[p.value] || 'unknown'
+            unless allowed_styles.include?(style)
+              notify :warning, {
+                :message => "invalid documentation style for #{type_str(idx)} parameter #{idx[:name_token].value}::#{p.value} (#{doc_params_styles[p.value]})",
+                :line    => p.line,
+                :column  => p.column,
+              }
+            end
+          else
+            notify :warning, {
+              :message => "missing documentation for #{type_str(idx)} parameter #{idx[:name_token].value}::#{p.value}",
+              :line    => p.line,
+              :column  => p.column,
+            }
+          end
         end
       end
     end
@@ -97,4 +113,19 @@ PuppetLint.new_check(:parameter_documentation) do
 
     params
   end
+
+  # returns an array [<detected_style>, <complete match>, <param name>, <same-line-docs>]
+  # [nil, nil] if this is not a parameter.
+  def detect_style(dtok)
+    style = nil
+    case dtok.value
+    when %r{\A\s*\[\*([a-zA-Z0-9_]+)\*\]\s*(.*)\z}
+      style = 'doc'
+    when %r{\A\s*\$([a-zA-Z0-9_]+):: +(.*)\z}
+      style = 'kafo'
+    when %r{\A\s*@param (?:\[.+\] )?([a-zA-Z0-9_]+)(?: +|$)(.*)\z}
+      style = 'strings'
+    end
+    [ style, * $~ ]
+  end
 end

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

@@ -3,6 +3,8 @@ require 'spec_helper'
 describe 'parameter_documentation' do
   let(:class_msg) { 'missing documentation for class parameter example::%s' }
   let(:define_msg) { 'missing documentation for defined type parameter example::%s' }
+  let(:class_style_msg) { 'invalid documentation style for class parameter example::%s (%s)' }
+  let(:define_style_msg) { 'invalid documentation style for defined type parameter example::%s (%s)' }
 
   context 'class missing any documentation' do
     let(:code) { 'class example($foo) { }' }
@@ -355,6 +357,62 @@ define foreman (
     end
   end
 
+  context 'check style' do
+    let(:code) do
+      <<-EOS
+      # Example mixed style class
+      #
+      # Parameters:
+      #
+      # $foo:: example
+      #
+      # [*bar*] example
+      #
+      # @param foobar example
+      #
+      class example($foo, $bar, $foobar) { }
+      EOS
+    end
+
+    context 'detect all styles' do
+      before do
+        PuppetLint.configuration.docs_allowed_styles = ['noexist']
+      end
+      after do
+        PuppetLint.configuration.docs_allowed_styles = false
+      end
+
+      it 'should detect three problems' do
+        expect(problems).to have(3).problems
+      end
+
+      it 'should create three problems' do
+        expect(problems).to contain_warning(class_style_msg % [:foo, 'kafo']).on_line(11).in_column(21)
+        expect(problems).to contain_warning(class_style_msg % [:bar, 'doc']).on_line(11).in_column(27)
+        expect(problems).to contain_warning(class_style_msg % [:foobar, 'strings']).on_line(11).in_column(33)
+      end
+    end
+
+    context 'use configured style' do
+      before do
+        PuppetLint.configuration.docs_allowed_styles = 'strings'
+      end
+      after do
+        PuppetLint.configuration.docs_allowed_styles = nil
+      end
+
+      it 'should detect two problems' do
+        expect(problems).to have(2).problems
+      end
+
+      it 'should create three problems' do
+        expect(problems).to contain_warning(class_style_msg % [:foo, 'kafo']).on_line(11).in_column(21)
+        expect(problems).to contain_warning(class_style_msg % [:bar, 'doc']).on_line(11).in_column(27)
+      end
+    end
+  end
+
+
   context 'define with all parameters documented ($foo::)' do
     let(:code) do
       <<-EOS

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-param-docs
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2021-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: puppet-lint check to validate all parameters are documented