puppet-lint-param-docs 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9c071b35fbded596e9cc62dbd7c632eb5ef0e55
-  data.tar.gz: c8cc121248dd81d35397897d22bec9813f3085f0
+  metadata.gz: 97c4532b41c68c3cce6c7566a28900e66e90dc70
+  data.tar.gz: c5ee842a8e1f28935b51a9ab6ce5bcf0ec007f41
 SHA512:
-  metadata.gz: 8d69ff35bfbf3523499a5f2ff00daedd515c9552fe746f39e72d40e42ad804b2067bf40f60a2aedeeabfca15c49bf3c9359b858e15387a8ebd15d0cd61ca5261
-  data.tar.gz: fb201326d0298f9b8e4193b0754d1a362273ea59da66d92f21fffbc9441d9c0c38fbae17d0bb3b9031de6345f77dccf4b369abe016e71dea238ff837453ffe3c
+  metadata.gz: cb9ae66d054669c78ff450c5efb0856e40238dca4335274069d4a3d70f078e7839d5a095cda3640a5abd0762180cacdcf6c87b7f21e3c36b57136796cab75981
+  data.tar.gz: 6dc412254ab70459f4ee0cb49b71f128f76e7710b154bb4930525bf8e36a47e8177211aabdcf091d5389ec9e697f268e9cc70641c99ac11ccf3e02a8ed27f83f

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

@@ -9,7 +9,7 @@ PuppetLint.new_check(:parameter_documentation) do
         if [:COMMENT, :MLCOMMENT, :SLASH_COMMENT].include?(dtok.type)
           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_]+) +/
+             dtok.value =~ /\A\s*@param (?:\[.+\] )?([a-zA-Z0-9_]+)(?: +|$)/
             doc_params << $1
           end
         else

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

@@ -376,6 +376,52 @@ define foreman (
     end
   end
 
+  context 'class with all parameters documented (@param)' do
+    let(:code) do
+      <<-EOS
+      # Example class
+      #
+      # === Parameters:
+      #
+      # @param foo example
+      # @param [Integer] bar example
+      # @param baz
+      #   example
+      # @param [Integer] qux
+      #   example
+      #
+      class example($foo, $bar, $baz, $qux) { }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'define with all parameters documented (@param)' do
+    let(:code) do
+      <<-EOS
+      # Example define
+      #
+      # === Parameters:
+      #
+      # @param foo example
+      # @param [Integer] bar example
+      # @param baz
+      #   example
+      # @param [Integer] qux
+      #   example
+      #
+      define example($foo, $bar, $baz, $qux) { }
+      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,94 +1,94 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-param-docs
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
-- Dominic Cleal
+- Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-22 00:00:00.000000000 Z
+date: 2017-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec-collection_matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   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: |2
       A new check for puppet-lint that validates all parameters are documented.
-email: dcleal@redhat.com
+email: voxpupuli@groups.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -100,7 +100,7 @@ files:
 - lib/puppet-lint/plugins/check_parameter_documentation.rb
 - spec/puppet-lint/plugins/check_parameter_documentation_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/domcleal/puppet-lint-param-docs
+homepage: https://github.com/voxpupuli/puppet-lint-param-docs
 licenses:
 - MIT
 metadata: {}
@@ -110,17 +110,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: puppet-lint check to validate all parameters are documented