puppet-lint-param-docs 1.7.4 → 1.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9437e6614a01b679417bbf8df3866b6d7e20ed66fb98192c009af45c167610d
-  data.tar.gz: f719e9dd7a34e642b24a36ac71b34d8391cec7dd374df5c86fda33604a1340b2
+  metadata.gz: 26491f65ee561c24b8246bccf4793d451e967aa7b40796a1dfaef59cbf959de4
+  data.tar.gz: 74fb61891a78bf720e76ab591ecd18ee4f1ba16b8eb3e57ffac0e7739635d991
 SHA512:
-  metadata.gz: b89435c384da43d72d3c4bc1b2f7917c63d50f865f1dd002dda3a07093a89947bf84d0a2f2c0294ba9dd1dd1b896b6366d8c847c1bab8b598c02e72acb9e94ed
-  data.tar.gz: 545d57ef867a96e6fd4b7360dd688461c53537fdab4efcb8e0907771a73d13c5f4b6fc9aa18eda2b8ae02995346784af4d3f8d5658c9018c57bb63023f6b9e64
+  metadata.gz: 58c68e3b29fa294718ba1a43b86f8e9280c039fd94d422abd663f20f340e3fb6eede037b0a8df48553a5b1aaa179b537f82bd5c8499233c53c018e1aa7d5d647
+  data.tar.gz: 18ffb5c2dbdba005d56ead040efbdfbd0c5eec3142322338f1641e1847d62491cd71d817b4de67a417d2d1675aba2b3c5366f26867f6fc6734c564cd7733f8cb

data/README.md

@@ -1,5 +1,13 @@
 # puppet-lint parameter documentation check
 
+[![License](https://img.shields.io/github/license/voxpupuli/puppet-lint-trailing_comma-check.svg)](https://github.com/voxpupuli/puppet-lint-trailing_comma-check/blob/master/LICENSE)
+[![Test](https://github.com/voxpupuli/puppet-lint-param-docs/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/puppet-lint-param-docs/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/voxpupuli/puppet-lint-param-docs/branch/master/graph/badge.svg?token=Mypkl78hvK)](https://codecov.io/gh/voxpupuli/puppet-lint-param-docs)
+[![Release](https://github.com/voxpupuli/puppet-lint-param-docs/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/puppet-lint-param-docs/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/puppet-lint-param-docs.svg)](https://rubygems.org/gems/puppet-lint-param-docs)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/puppet-lint-param-docs.svg)](https://rubygems.org/gems/puppet-lint-param-docs)
+[![Donated by Dominic Cleal](https://img.shields.io/badge/donated%20by-Dominic%20Cleal-fb7047.svg)](#transfer-notice)
+
 Adds a new puppet-lint check to verify all class and defined type parameters
 have been documented.
 
@@ -15,6 +23,21 @@ base and run `bundle install`.
 gem 'puppet-lint-param-docs'
 ```
 
+This gem is not only available on rubygems, but also as [GitHub Package](https://github.com/voxpupuli/puppet-lint-param-docs/packages/)
+You can install it from GitHub like this:
+
+```
+$ gem install puppet-lint-param-docs --source "https://rubygems.pkg.github.com/voxpupuli"
+```
+
+Or in a Gemfile:
+
+```
+source "https://rubygems.pkg.github.com/voxpupuli" do
+  gem "puppet-lint-param-docs", "1.7.4"
+end
+```
+
 ## Usage
 
 This plugin provides a new check to `puppet-lint`.
@@ -124,3 +147,25 @@ given in `config.pattern`.
 
 The [Puppet Strings](#puppet_strings) `@api private` directive can also be used
 to disable checks on that file.
+
+## Transfer Notice
+
+This plugin was originally authored by [Dominic Cleal](https://github.com/domcleal).
+The maintainer preferred that Puppet Community take ownership of the module for future improvement and maintenance.
+Existing pull requests and issues were transferred over, please fork and continue to contribute here.
+
+Previously: https://github.com/domcleal/puppet-lint-absolute_classname-check
+
+## License
+
+This gem is licensed under the MIT license.
+
+## Release information
+
+To make a new release, please do:
+* update the version in the gemspec file
+* Install gems with `bundle install --with release --path .vendor`
+* generate the changelog with `bundle exec rake changelog`
+* Check if the new version matches the closed issues/PRs in the changelog
+* Create a PR with it
+* After it got merged, push a tag. GitHub actions will do the actual release to rubygems and GitHub Packages

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

@@ -99,9 +99,9 @@ PuppetLint.new_check(:parameter_documentation) do
           while true
             ptok = e.next
             case ptok.type
-            when :LPAREN
+            when :LPAREN, :LBRACK, :LBRACE
               nesting += 1
-            when :RPAREN
+            when :RPAREN, :RBRACK, :RBRACE
               nesting -= 1
             when :COMMA
               break unless nesting > 0

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

@@ -913,4 +913,97 @@ define foreman (
       expect(problems).to contain_warning('Duplicate defined type parameter documentation for example::name/title').on_line(5).in_column(10)
     end
   end
+
+  context 'class with array defaults containing variables' do
+    # Example taken from https://github.com/voxpupuli/puppet-lint-param-docs/issues/30
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
+      # @summary example class
+      #
+      # @param parameter_1
+      # @param parameter_2
+      # @param parameter_3
+      # @param parameter_4
+      # @param parameter_5
+      # @param parameter_6
+      # @param parameter_7
+      # @param parameter_8
+      #
+      class example (
+        Array $parameter_1 = $variable1,
+        Array $parameter_2 = [ $variable2, ],
+        Array $parameter_3 = [ $variable3, 'string1', ],
+        Array $parameter_4 = [
+          $variable4,
+          'string1',
+        ],
+        Array $parameter_5 = [ $variable5, $variable6, 'string1', ],
+        Array $parameter_6 = [ $variable7, 'string1', $variable8, ],
+        Array $parameter_7 = [ 'string1', $variable9, ],
+        Array $parameter_8 = [
+          'string1',
+          $variable10,
+          'string2',
+        ],
+      ) {
+        # foo
+      }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'class with hash defaults containing variables' do
+    # Example taken from https://github.com/voxpupuli/puppet-lint-param-docs/issues/49
+    let(:code) do
+      <<-EOS.gsub(/^\s+/, '')
+      # @summary example class
+      #
+      # @param parameter_1
+      # @param parameter_2
+      # @param parameter_3
+      # @param parameter_4
+      # @param parameter_5
+      # @param parameter_6
+      # @param parameter_7
+      # @param parameter_8
+      # @param parameter_9
+      # @param parameter_10
+      # @param parameter_11
+      # @param parameter_12
+      #
+      class example (
+        Hash $parameter_1 = $variable1,
+        Hash $parameter_2 = { $variable2, },
+        Hash $parameter_3 = { $variable3, 'string1', },
+        Hash $parameter_4 = {
+          $variable4,
+          'string1',
+        },
+        Hash $parameter_5 = { $variable5, $variable6, 'string1', },
+        Hash $parameter_6 = { $variable7, 'string1', $variable8, },
+        Hash $parameter_7 = { 'string1', $variable9, },
+        Hash $parameter_8 = {
+          'string1',
+          $variable10,
+          'string2',
+        },
+        Hash $parameter_9 = [ { 'string1', $variable11, } ],
+        Hash $parameter_10 = [ { 'string1', $variable12, }, { 'string1', $variable13, } ],
+        Hash $parameter_11 = { [ 'string1', $variable14, ] },
+        Hash $parameter_12 = [ 'string1' => $variable15, 'string2' => $variable16, ],
+      ) {
+        # foo
+      }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      puts problems
+      expect(problems).to have(0).problems
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,29 @@
+# frozen_string_literal: true
+
+begin
+  require 'simplecov'
+  require 'simplecov-console'
+  require 'codecov'
+rescue LoadError
+else
+  SimpleCov.start do
+    track_files 'lib/**/*.rb'
+
+    add_filter '/spec'
+
+    enable_coverage :branch
+
+    # do not track vendored files
+    add_filter '/vendor'
+    add_filter '/.vendor'
+  end
+
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::Console,
+    SimpleCov::Formatter::Codecov,
+  ]
+end
+
 require 'puppet-lint'
 
 PuppetLint::Plugins.load_spec_helper

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-param-docs
 version: !ruby/object:Gem::Version
-  version: 1.7.4
+  version: 1.7.6
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-06 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -19,7 +19,7 @@ dependencies:
         version: '1.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '1.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -87,7 +87,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: simplecov-console
+  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'
+- !ruby/object:Gem::Dependency
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -132,10 +146,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: puppet-lint check to validate all parameters are documented
 test_files:
-- spec/spec_helper.rb
 - spec/puppet-lint/plugins/check_parameter_documentation_spec.rb
+- spec/spec_helper.rb