puppet-lint-param-docs 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f8b9401c298a02b66324e5ef2db75b5e1e498d19a0a64e0e4d05208003da40b
-  data.tar.gz: 0ddfcd5cf79cbd88e60b59c5645e636e60092efcf305fe5c71ecc73d3580ca84
+  metadata.gz: 14633dfc2336826ed35662bf1840e6ef992f0032146f2a932a988a42521b2006
+  data.tar.gz: 9f7a4139402ebe4d390f07b38ed5013e4f10b42bf3e793d8b6a4e05c170d25c6
 SHA512:
-  metadata.gz: 50e90eccc7fd99371a2d59d125b0e6483f2b0a2b002f018339d81320aee9b44b89627b5c1178e710341c8cb2ca31d4893bda414e53a0b5b2530d83476726676f
-  data.tar.gz: c1038644ed09895de383ed28d87e5041afd3fd7efc665f3dabf58c53aa89f9b2fc51f54e9ae5d35b725b71ac75d8fea1c1bc84c47b6610cfe7bb48c0639ed198
+  metadata.gz: 9c685fe25b7b03c9af645f2ff82ea4c86e3c820ce3343c16b4a8926be097a0e3fa4723910a7f5c71e555978101dc61a0739f6496abcae8eea2ca4296a8a3ec14
+  data.tar.gz: d696ad85c260c8956787f27a3af8b37a8b26526b57d789f005881ae89de538241fbaa7daca6ad03abd6e0576db71a306c1227f8b3cecb226dc4cd44d18a7927e

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

@@ -28,10 +28,18 @@ PuppetLint.new_check(:parameter_documentation) do
         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
-              break if ptok.type == :COMMA
+              case ptok.type
+              when :LPAREN
+                nesting += 1
+              when :RPAREN
+                nesting -= 1
+              when :COMMA
+                break unless nesting > 0
+              end
             end
           end
         end

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

@@ -52,6 +52,18 @@ describe 'parameter_documentation' do
     end
   end
 
+  context 'define with param defaults using a function' do
+    let(:code) { 'define example($foo = min(8, $facts["processors"]["count"])) { }' }
+
+    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(define_msg % :foo).on_line(1).in_column(16)
+    end
+  end
+
   context 'class with many param defaults' do
     let(:code) do
       <<-EOS
@@ -443,6 +455,42 @@ define foreman (
     end
   end
 
+  context 'define with all parameters documented with defaults (@param)' do
+    let(:code) do
+      <<-EOS
+      # Example define
+      #
+      # @param foo example
+      #
+      define example($foo = $facts['networking']['fqdn']) { }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'define with all parameters documented with defaults using functions (@param)' do
+    let(:code) do
+      <<-EOS
+      # Example define
+      #
+      # @param foo example
+      # @param multiple test nested function calls
+      #
+      define example(
+        $foo = min(8, $facts['processors']['count']),
+        $multiple = min(8, max(2, $facts['processors']['count'])),
+      ) { }
+      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.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-11 00:00:00.000000000 Z
+date: 2020-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -132,7 +132,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: puppet-lint check to validate all parameters are documented