puppet-lint-param-docs 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14633dfc2336826ed35662bf1840e6ef992f0032146f2a932a988a42521b2006
-  data.tar.gz: 9f7a4139402ebe4d390f07b38ed5013e4f10b42bf3e793d8b6a4e05c170d25c6
+  metadata.gz: 7b7f8ef3f161f032261f4785f2ef368e89ad583295f8d1af9e25fc2daad26e15
+  data.tar.gz: ff99f8a6a3c9ceb061c6b8397e928ab5871fc2da91fffb0c296efe0f340a2575
 SHA512:
-  metadata.gz: 9c685fe25b7b03c9af645f2ff82ea4c86e3c820ce3343c16b4a8926be097a0e3fa4723910a7f5c71e555978101dc61a0739f6496abcae8eea2ca4296a8a3ec14
-  data.tar.gz: d696ad85c260c8956787f27a3af8b37a8b26526b57d789f005881ae89de538241fbaa7daca6ad03abd6e0576db71a306c1227f8b3cecb226dc4cd44d18a7927e
+  metadata.gz: dad82fe8054ea2433eb4bfa7d2c4a39401de66308e4c2f5027e9da3c39fbc93284e2c501b48a175469bbc3f61d1c950ee5beb5153f871084a5d3361c4d0175c9
+  data.tar.gz: e321066d4a8fc4661a923f0d1ab1e06e986a021462b7411c2b66eb5ab06d2087cdea4cb4ce39c16f480cf2ea8195c0bdbdc19e07272727eb0ba30130b726b4d7

data/README.md

@@ -19,18 +19,31 @@ gem 'puppet-lint-param-docs'
 
 This plugin provides a new check to `puppet-lint`.
 
-### parameter_documentation
+### parameter\_documentation
 
 **--fix support: No**
 
 This check will raise a warning for any class or defined type parameters that
-don't have an RDoc description.
+don't have a description.
 
 ```
 WARNING: missing documentation for class parameter foo::bar
 WARNING: missing documentation for defined type parameter foo::baz
 ```
 
+It will also raise warnings for parameters documented more than once.
+
+```
+WARNING Duplicate class parameter documentation for foo::bar on line 5
+WARNING Duplicate class parameter documentation for foo::bar on line 6
+```
+
+A warning will also be raised if you document a parameter that doesn't exist in the class or defined type.
+
+```
+WARNING No matching class parameter for documentation of foo::bar
+```
+
 ### Documentation styles
 
 The check will accept any of the following styles:
@@ -39,36 +52,42 @@ The check will accept any of the following styles:
 
 Used by [Puppet Strings](https://github.com/puppetlabs/puppetlabs-strings).
 
-    # Example class
-    #
-    # @param foo example
-    define example($foo) { }
+```puppet
+# @summary Example class
+#
+# @param foo example
+define example($foo) { }
+```
 
 #### Puppet Doc style
 
-Used by the [puppet-doc](https://docs.puppetlabs.com/puppet/latest/reference/man/doc.html)
-command, generally deprecated in favour of Puppet Strings.
-
-    # Example class
-    #
-    # === Parameters:
-    #
-    # [*foo*] example
-    #
-    class example($foo) { }
+Used by the [puppet-doc](https://puppet.com/docs/puppet/6.18/man/doc.html)
+command, deprecated in favour of Puppet Strings.
+
+```puppet
+# Example class
+#
+# === Parameters:
+#
+# [*foo*] example
+#
+class example($foo) { }
+```
 
 #### Kafo rdoc style
 
 Used in [kafo](https://github.com/theforeman/kafo#documentation) following an
 rdoc style.
 
-    # Example class
-    #
-    # === Parameters:
-    #
-    # $foo:: example
-    #
-    class example($foo) { }
+```puppet
+# Example class
+#
+# === Parameters:
+#
+# $foo:: example
+#
+class example($foo) { }
+```
 
 ### Selective rake task
 
@@ -83,7 +102,7 @@ helper to customise the lint rake task:
       config.pattern = ['manifests/init.pp', 'manifests/other/**/*.pp']
     end
 
-This would disable the parameter_documentation check by default, but then
+This would disable the parameter\_documentation check by default, but then
 defines a new rake task (which runs after `lint`) specifically for the files
 given in `config.pattern`.
 

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

@@ -1,17 +1,22 @@
 PuppetLint.new_check(:parameter_documentation) do
   def check
     class_indexes.concat(defined_type_indexes).each do |idx|
-      next if idx[:param_tokens].nil?
-
-      doc_params = []
+      doc_params = {}
+      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 [:COMMENT, :MLCOMMENT, :SLASH_COMMENT].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_]+)(?: +|$)/
-            doc_params << $1
+            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
           end
 
           is_private = true if dtok.value =~ /\A\s*@api +private\s*$/
@@ -20,40 +25,76 @@ PuppetLint.new_check(:parameter_documentation) do
         end
       end
 
-      next if is_private
-
-      params = []
-      e = idx[:param_tokens].each
-      begin
-        while (ptok = e.next)
-          if ptok.type == :VARIABLE
-            params << ptok
-            nesting = 0
-            # skip to the next parameter to avoid finding default values of variables
-            while true
-              ptok = e.next
-              case ptok.type
-              when :LPAREN
-                nesting += 1
-              when :RPAREN
-                nesting -= 1
-              when :COMMA
-                break unless nesting > 0
-              end
-            end
-          end
+      params = extract_params(idx)
+
+      # warn about duplicates
+      doc_params_duplicates.each do |parameter, tokens|
+        tokens.each do |token|
+           notify :warning, {
+             :message => "Duplicate #{type_str(idx)} parameter documentation for #{idx[:name_token].value}::#{parameter}",
+             :line    => token.line,
+             :column  => token.column + token.value.match(/\A\s*(@param\s*)?/)[0].length + 1 # `+ 1` is to account for length of the `#` COMMENT token.
+           }
         end
-      rescue StopIteration; end
+      end
+
+      # warn about documentation for parameters that don't exist
+      doc_params.each do |parameter, token|
+        next if parameter == 'name/title' && idx[:type] == :DEFINE
+        next if params.find { |p| p.value == parameter }
 
-      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 #{idx_type} parameter #{idx[:name_token].value}::#{p.value}",
-          :line    => p.line,
-          :column  => p.column,
+          :message => "No matching #{type_str(idx)} parameter for documentation of #{idx[:name_token].value}::#{parameter}",
+          :line    => token.line,
+          :column  => token.column + token.value.match(/\A\s*(@param\s*)?/)[0].length + 1
         }
       end
+
+      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,
+          }
+        end
+      end
     end
   end
+
+  private
+
+  def type_str(idx)
+    idx[:type] == :CLASS ? "class" : "defined type"
+  end
+
+  def extract_params(idx)
+    params = []
+    return params if idx[:param_tokens].nil?
+
+    e = idx[:param_tokens].each
+    begin
+      while (ptok = e.next)
+        if ptok.type == :VARIABLE
+          params << ptok
+          nesting = 0
+          # skip to the next parameter to avoid finding default values of variables
+          while true
+            ptok = e.next
+            case ptok.type
+            when :LPAREN
+              nesting += 1
+            when :RPAREN
+              nesting -= 1
+            when :COMMA
+              break unless nesting > 0
+            end
+          end
+        end
+      end
+    rescue StopIteration; end
+
+    params
+  end
 end

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

@@ -544,4 +544,315 @@ define foreman (
       expect(problems).to contain_warning(class_msg % :foo).on_line(7).in_column(15)
     end
   end
+
+  describe 'Duplicated documentation' do
+    let(:class_msg) { 'Duplicate class parameter documentation for example::%s' }
+    let(:define_msg) { 'Duplicate defined type parameter documentation for example::%s' }
+
+    context 'class with parameters documented twice (@param)' do
+      let(:code) do
+        <<-EOS.gsub(/^\s+/, '')
+      # @summary Example class
+      #
+      # @param bar
+      #   example
+      # @param foo example
+      # @param bar Duplicate/conflicting docs
+      #
+      class example($foo, $bar) { }
+        EOS
+      end
+
+      it 'should detect two problems' do
+        expect(problems).to have(2).problem
+      end
+
+      it 'should create a warning on line 3' do
+        expect(problems).to contain_warning(class_msg % :bar).on_line(3).in_column(10)
+      end
+
+      it 'should create a warning on line 6' do
+        expect(problems).to contain_warning(class_msg % :bar).on_line(6).in_column(10)
+      end
+    end
+
+    context 'define with parameters documented twice (@param)' do
+      let(:code) do
+        <<-EOS.gsub(/^\s+/, '')
+      # @summary Example define
+      #
+      # @param bar
+      #   example
+      # @param foo example
+      # @param bar Duplicate/conflicting docs
+      #
+      define example($foo, $bar) { }
+        EOS
+      end
+
+      it 'should detect two problems' do
+        expect(problems).to have(2).problem
+      end
+
+      it 'should create a warning on line 3' do
+        expect(problems).to contain_warning(define_msg % :bar).on_line(3).in_column(10)
+      end
+
+      it 'should create a warning on line 6' do
+        expect(problems).to contain_warning(define_msg % :bar).on_line(6).in_column(10)
+      end
+    end
+
+    context 'class with parameters documented 3 times (@param)' do
+      let(:code) do
+        <<-EOS.gsub(/^\s+/, '')
+      # @summary Example class
+      #
+      # @param bar
+      #   example
+      # @param foo example
+      # @param bar Duplicate/conflicting docs
+      #
+      # @param bar
+      #   example
+      #
+      class example($foo, $bar) { }
+        EOS
+      end
+
+      it 'should detect three problems' do
+        expect(problems).to have(3).problem
+      end
+
+      it 'should create a warning on line 3' do
+        expect(problems).to contain_warning(class_msg % :bar).on_line(3).in_column(10)
+      end
+
+      it 'should create a warning on line 6' do
+        expect(problems).to contain_warning(class_msg % :bar).on_line(6).in_column(10)
+      end
+
+      it 'should create a warning on line 8' do
+        expect(problems).to contain_warning(class_msg % :bar).on_line(8).in_column(10)
+      end
+    end
+
+    context 'private class with parameters documented twice (@param)' do
+      let(:code) do
+        <<-EOS.gsub(/^\s+/, '')
+      # @summary Example class
+      #
+      # @param bar docs
+      # @param bar Duplicate/conflicting docs
+      #
+      # @api private
+      class example($bar) { }
+        EOS
+      end
+
+      it 'should detect two problems' do
+        expect(problems).to have(2).problem
+      end
+
+      it 'should create a warning on line 3' do
+        expect(problems).to contain_warning(class_msg % :bar).on_line(3).in_column(10)
+      end
+
+      it 'should create a warning on line 4' do
+        expect(problems).to contain_warning(class_msg % :bar).on_line(4).in_column(10)
+      end
+    end
+
+    context 'class with parameters documented twice ([*bar*])' do
+      let(:code) do
+        <<-EOS.gsub(/^\s+/, '')
+      # @summary Example class
+      #
+      # @param bar
+      #   example
+      # @param foo example
+      # [*bar*] Duplicate/conflicting docs
+      #
+      class example($foo, $bar) { }
+        EOS
+      end
+
+      it 'should detect two problems' do
+        expect(problems).to have(2).problem
+      end
+
+      it 'should create a warning on line 3' do
+        expect(problems).to contain_warning(class_msg % :bar).on_line(3).in_column(10)
+      end
+
+      it 'should create a warning on line 6' do
+        expect(problems).to contain_warning(class_msg % :bar).on_line(6).in_column(3)
+      end
+    end
+  end
+
+  context 'class with documentation for parameters that don\'t exist' do
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
+      # @summary Example class
+      #
+      # @param foo
+      class example { }
+      EOS
+    end
+
+    it 'should detect a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'should create a warning on line 3' do
+      expect(problems).to contain_warning('No matching class parameter for documentation of example::foo').on_line(3).in_column(10)
+    end
+  end
+
+  context 'private class with documentation for parameters that don\'t exist' do
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
+      # @summary Example class
+      #
+      # @param foo
+      #   Example docs
+      #
+      # @api private
+      class example { }
+      EOS
+    end
+
+    it 'should detect a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'should create a warning on line 3' do
+      expect(problems).to contain_warning('No matching class parameter for documentation of example::foo').on_line(3).in_column(10)
+    end
+  end
+
+  context 'define with documentation for parameters that don\'t exist' do
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
+      # @summary Example define
+      #
+      # @param bar Docs for bar
+      # @param foo
+      #   Docs for foo
+      #
+      # @api private
+      define example::example(String[1] $bar) { }
+      EOS
+    end
+
+    it 'should detect a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'should create a warning on line 4' do
+      expect(problems).to contain_warning('No matching defined type parameter for documentation of example::example::foo').on_line(4).in_column(10)
+    end
+  end
+
+  context 'define with documentation for parameter `name`' do
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
+      # @summary Example define
+      #
+      # @param name
+      #   Docs for the $name
+      # @param bar Docs for bar
+      define example::example(String[1] $bar) { }
+    EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'class with documentation for parameter `name`' do
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
+      # @summary Example class
+      #
+      # @param name
+      #   Invalid docs
+      class example { }
+    EOS
+    end
+
+    it 'should detect a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'should create a warning on line 3' do
+      expect(problems).to contain_warning('No matching class parameter for documentation of example::name').on_line(3).in_column(10)
+    end
+  end
+
+  context 'define with documentation for parameter `title`' do
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
+      # @summary Example define
+      #
+      # @param title
+      #   Docs for the $title
+      # @param bar Docs for bar
+      define example::example(String[1] $bar) { }
+    EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'class with documentation for parameter `title`' do
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
+      # @summary Example class
+      #
+      # @param title
+      #   Invalid docs
+      class example { }
+    EOS
+    end
+
+    it 'should detect a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'should create a warning on line 3' do
+      expect(problems).to contain_warning('No matching class parameter for documentation of example::title').on_line(3).in_column(10)
+    end
+  end
+
+  context 'define with documentation for both `title` and `name`' do
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
+      # @summary Example define
+      #
+      # @param title
+      #   Docs for the $title
+      # @param name
+      #   Docs for the $name
+      # @param bar Docs for bar
+      define example(String[1] $bar) { }
+    EOS
+    end
+
+    it 'should detect two problems' do
+      expect(problems).to have(2).problems
+    end
+
+    it 'should create a warning on line 3' do
+      expect(problems).to contain_warning('Duplicate defined type parameter documentation for example::name/title').on_line(3).in_column(10)
+    end
+
+    it 'should create a warning on line 5' do
+      expect(problems).to contain_warning('Duplicate defined type parameter documentation for example::name/title').on_line(5).in_column(10)
+    end
+  end
 end

metadata

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