puppet-lint-param-docs 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 97c4532b41c68c3cce6c7566a28900e66e90dc70
-  data.tar.gz: c5ee842a8e1f28935b51a9ab6ce5bcf0ec007f41
+SHA256:
+  metadata.gz: 8f8b9401c298a02b66324e5ef2db75b5e1e498d19a0a64e0e4d05208003da40b
+  data.tar.gz: 0ddfcd5cf79cbd88e60b59c5645e636e60092efcf305fe5c71ecc73d3580ca84
 SHA512:
-  metadata.gz: cb9ae66d054669c78ff450c5efb0856e40238dca4335274069d4a3d70f078e7839d5a095cda3640a5abd0762180cacdcf6c87b7f21e3c36b57136796cab75981
-  data.tar.gz: 6dc412254ab70459f4ee0cb49b71f128f76e7710b154bb4930525bf8e36a47e8177211aabdcf091d5389ec9e697f268e9cc70641c99ac11ccf3e02a8ed27f83f
+  metadata.gz: 50e90eccc7fd99371a2d59d125b0e6483f2b0a2b002f018339d81320aee9b44b89627b5c1178e710341c8cb2ca31d4893bda414e53a0b5b2530d83476726676f
+  data.tar.gz: c1038644ed09895de383ed28d87e5041afd3fd7efc665f3dabf58c53aa89f9b2fc51f54e9ae5d35b725b71ac75d8fea1c1bc84c47b6610cfe7bb48c0639ed198

data/README.md

@@ -86,3 +86,6 @@ helper to customise the lint rake task:
 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`.
+
+The [Puppet Strings](#puppet_strings) `@api private` directive can also be used
+to disable checks on that file.

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

@@ -4,6 +4,7 @@ PuppetLint.new_check(:parameter_documentation) do
       next if idx[:param_tokens].nil?
 
       doc_params = []
+      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)
@@ -12,11 +13,15 @@ PuppetLint.new_check(:parameter_documentation) do
              dtok.value =~ /\A\s*@param (?:\[.+\] )?([a-zA-Z0-9_]+)(?: +|$)/
             doc_params << $1
           end
+
+          is_private = true if dtok.value =~ /\A\s*@api +private\s*$/
         else
           break
         end
       end
 
+      next if is_private
+
       params = []
       e = idx[:param_tokens].each
       begin

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

@@ -149,6 +149,27 @@ define foreman (
     end
   end
 
+  context 'private class missing documentation (@param bar) for a parameter' do
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
+      # Example class
+      #
+      # @api private
+      #
+      # @param bar example
+      class example($foo, $bar) { }
+      EOS
+    end
+
+    it 'should detect no single problems' do
+      expect(problems).to have(0).problems
+    end
+
+    it 'should not create a warning' do
+      expect(problems).not_to contain_info(class_msg % :foo)
+    end
+  end
+
   context 'define missing documentation (@param bar) for a parameter' do
     let(:code) do
       <<-EOS.gsub(/^\s+/, '')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-param-docs
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-29 00:00:00.000000000 Z
+date: 2019-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -86,8 +86,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |2
-      A new check for puppet-lint that validates all parameters are documented.
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    A new check for puppet-lint that validates all parameters are documented.\n"
 email: voxpupuli@groups.io
 executables: []
 extensions: []
@@ -119,11 +132,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: puppet-lint check to validate all parameters are documented
 test_files:
-- spec/puppet-lint/plugins/check_parameter_documentation_spec.rb
 - spec/spec_helper.rb
+- spec/puppet-lint/plugins/check_parameter_documentation_spec.rb