puppet-lint-param-types 0.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 26acacc6412f383e06f34f5ccea0bbd06cb294ee
-  data.tar.gz: 4623def5816195954c9fff6989a6e007567236be
+SHA256:
+  metadata.gz: f2d799a0dda58fe97999a6d22914ec0b5d37a2902ccff7e80ec4513452b1534e
+  data.tar.gz: a1728dc506b46d9b0e4bdcef2cdceda1e8a93640e97833ef9ea15560312448c9
 SHA512:
-  metadata.gz: 62175cae22a41add32ca935a00aaeb14017fabbe724843523559642620d9c8c361a3a60cc31b5ee773bb2bc44dd1dfa2a8a4be812f58c90357d27f72be02477c
-  data.tar.gz: 7e789a73b47386476657605cae8e9d78da1bc5752f94b14986a4791b5f363a52cba36c2c149bf2fa5650920af8c3dfb44f735b14e0d9808d2571a0e36682ff6f
+  metadata.gz: 23f4277200c2c69abaaaa3869d020820bc7e5274756f2b3fbcb7aa944cd6c6d14e0b9a346008c4c6d20fe3fa73121d8148e2bb241fa8677f177e79f50a594b14
+  data.tar.gz: 208b3146566d922723d4488ede82413c8cb1b1fdcf9fc300a6c2ecadcbfef4e9635c222223825963bc49c78641c030a952f9e7444bea2c828095e0193464ab3e

data/README.md

@@ -1,5 +1,13 @@
 # puppet-lint-param-types
 
+[![License](https://img.shields.io/github/license/voxpupuli/puppet-lint-param-types.svg)](https://github.com/voxpupuli/puppet-lint-param-types/blob/master/LICENSE)
+[![Test](https://github.com/voxpupuli/puppet-lint-param-types/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/puppet-lint-param-types/actions/workflows/test.yml)
+[![Release](https://github.com/voxpupuli/puppet-lint-param-types/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/puppet-lint-param-types/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/puppet-lint-param-types.svg)](https://rubygems.org/gems/puppet-lint-param-types)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/puppet-lint-param-types.svg)](https://rubygems.org/gems/puppet-lint-param-types)
+[![Coverage Status](https://coveralls.io/repos/github/voxpupuli/puppet-lint-param-types/badge.svg?branch=master)](https://coveralls.io/github/voxpupuli/puppet-lint-param-types?branch=master)
+[![Donated by Camptocamp](https://img.shields.io/badge/donated%20by-camptocamp-fb7047.svg)](#transfer-notice)
+
 This plugin validates that all class and defined type parameter are typed.
 
 ## Installation
@@ -53,3 +61,25 @@ class foo (
 ## References
 
 https://puppet.com/docs/puppet/latest/lang_data_type.html
+
+## Transfer Notice
+
+This plugin was originally authored by [hostnet.nl](https://www.hostnet.nl/).
+The maintainer preferred that Vox Pupuli take ownership of the gem for future improvement and maintenance.
+Existing pull requests and issues were transferred over, please fork and continue to contribute here instead of hostnet.
+
+Previously: https://github.com/hostnet/puppet-lint-param-types
+
+## 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 config --local path .vendor && bundle install --with release`
+* 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_types.rb

@@ -2,6 +2,7 @@ PuppetLint.new_check(:parameter_types) do
   def check
     (class_indexes + defined_type_indexes).each do |idx|
       next if idx[:param_tokens].nil?
+
       # https://github.com/puppetlabs/puppet-specifications/blob/master/language/catalog_expressions.md
       # Each individual parameter in the parameter list must start with
       # either a datatype or a variable name, so testing whether the parameter is typed
@@ -10,7 +11,7 @@ PuppetLint.new_check(:parameter_types) do
       paren_stack = []
       data_stack = []
       idx[:param_tokens].each do |token|
-        next if [ :NEWLINE, :WHITESPACE, :INDENT, :COMMENT, :MLCOMMENT, :SLASH_COMMENT].include?(token.type)
+        next if %i[NEWLINE WHITESPACE INDENT COMMENT MLCOMMENT SLASH_COMMENT].include?(token.type)
 
         case state
         when :ST_BEGIN
@@ -20,9 +21,9 @@ PuppetLint.new_check(:parameter_types) do
             state = :ST_SKIP_TYPE
           elsif token.type == :VARIABLE
             notify :warning, {
-              :message => "missing datatype for parameter #{idx[:name_token].value}::#{token.value}",
-              :line    => token.line,
-              :column  => token.column
+              message: "missing datatype for parameter #{idx[:name_token].value}::#{token.value}",
+              line: token.line,
+              column: token.column,
             }
             state = :ST_SKIP
           end
@@ -39,13 +40,11 @@ PuppetLint.new_check(:parameter_types) do
             data_stack.pop
           elsif token.type == :COMMA && data_stack.empty? && paren_stack.empty?
             state = :ST_BEGIN
-        end
+          end
         # Datatypes cannot have variables so when a variable is found it must be
         # end of the data type
         when :ST_SKIP_TYPE
-          if token.type == :VARIABLE
-            state = :ST_SKIP
-          end
+          state = :ST_SKIP if token.type == :VARIABLE
         end
       end
     end

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

@@ -3,16 +3,19 @@ require 'spec_helper'
 describe 'parameter_types' do
   let(:msg) { 'missing datatype for parameter spec::%s' }
 
-  [ 'class', 'define' ].each do | rt |
+  %w[class define].each do |rt|
     context "#{rt} without parameters" do
       let(:code) { 'class spec() {}' }
-      it 'should not be a problem' do
+
+      it 'is not a problem' do
         expect(problems).to have(0).problem
       end
     end
+
     context "simple #{rt} without type" do
       let(:code) { 'class spec($foo) { }' }
-      it 'should be a problem' do
+
+      it 'is a problem' do
         expect(problems).to have(1).problem
         expect(problems).to contain_warning(msg % :foo).on_line(1)
       end
@@ -20,121 +23,132 @@ describe 'parameter_types' do
 
     context "#{rt} with many params without type" do
       let(:code) do
-        <<-EOL
-class spec (
-  $attr1,
-  $attr2,
-  $attr3
-) { }
+        <<~EOL
+          class spec (
+            $attr1,
+            $attr2,
+            $attr3
+          ) { }
         EOL
       end
-      it 'should be a problem' do
+
+      it 'is a problem' do
         expect(problems).to have(3).problem
       end
     end
+
     context "#{rt} with many params without type on one line" do
       let(:code) { 'class spec ($attr1, $attr2, $attr3 ) { }' }
-      it 'should be a problem' do
+
+      it 'is a problem' do
         expect(problems).to have(3).problem
       end
     end
+
     context "#{rt} with many params and defaults without type" do
       let(:code) do
-        <<-EOL
-class spec (
-  $attr0,
-  $attr1 = 1,
-  $attr2 = $attr1,
-  $attr3 = [ 'array', 'with', 'entries'],
-  $attr4 = { 'key' => 'value' }
-  $attr5 = {
-    'key' => 'value',
-    'key2' => [
-      'val1',
-      'val2',
-    ],
- },
-) { }
+        <<~EOL
+          class spec (
+            $attr0,
+            $attr1 = 1,
+            $attr2 = $attr1,
+            $attr3 = [ 'array', 'with', 'entries'],
+            $attr4 = { 'key' => 'value' }
+            $attr5 = {
+              'key' => 'value',
+              'key2' => [
+                'val1',
+                'val2',
+              ],
+           },
+          ) { }
         EOL
       end
-      it 'should be a problem' do
+
+      it 'is a problem' do
         expect(problems).to have(5).problem
       end
     end
 
     context "#{rt} with some attributes typed" do
       let(:code) do
-        <<-EOL
-class spec (
-  Integer $attr1,
-  String  $attr2 = 'foo',
-  $attr3 = undef,
-  $attr4 = { 'key' => 'value' }
-  Array[Struct[{
-    name       => String[1],
-    source_url => String[1],
-    delete     => Optional[Boolean],
-    exclude    => Optional[Variant[String,Array[String]]],
-    include    => Optional[Variant[String,Array[String]]],
-    sync_hour  => Optional[String],
-  }]]             $repos = [],
-  Hash $attr5 = {
-    'key' => 'value',
-    'key2' => [
-      'val1',
-      'val2',
-    ],
- },
-) { }
+        <<~EOL
+          class spec (
+            Integer $attr1,
+            String  $attr2 = 'foo',
+            $attr3 = undef,
+            $attr4 = { 'key' => 'value' }
+            Array[Struct[{
+              name       => String[1],
+              source_url => String[1],
+              delete     => Optional[Boolean],
+              exclude    => Optional[Variant[String,Array[String]]],
+              include    => Optional[Variant[String,Array[String]]],
+              sync_hour  => Optional[String],
+            }]]             $repos = [],
+            Hash $attr5 = {
+              'key' => 'value',
+              'key2' => [
+                'val1',
+                'val2',
+              ],
+           },
+          ) { }
         EOL
       end
-      it 'should be a problem' do
+
+      it 'is a problem' do
         expect(problems).to have(2).problem
       end
     end
+
     context "#{rt} with some attributes typed on one line" do
       let(:code) { 'class spec(Integer $attr1, $attr2 = 5, Variant[String,Integer] $attr 3, $attr4 = [1,2]) { }' }
-      it 'should be a problem' do
+
+      it 'is a problem' do
         expect(problems).to have(2).problem
       end
     end
 
     context "#{rt} with all attributes typed" do
       let(:code) do
-        <<-EOL
-class spec (
-  Integer $attr1,
-  String  $attr2 = 'foo',
-  Optional[String] $attr3 = undef,
-  Optional[Variant[Integer,Array[String] $attr4 = undef,
-  Stdlib::MyType $attr5 = undef,
-) { }
+        <<~EOL
+          class spec (
+            Integer $attr1,
+            String  $attr2 = 'foo',
+            Optional[String] $attr3 = undef,
+            Optional[Variant[Integer,Array[String] $attr4 = undef,
+            Stdlib::MyType $attr5 = undef,
+          ) { }
         EOL
       end
-      it 'should not be a problem' do
+
+      it 'is not a problem' do
         expect(problems).to have(0).problem
       end
     end
+
     context "#{rt} with all attributes typed complex" do
       let(:code) do
-        <<-EOL
-class spec (
-  Integer $attr1,
-  String  $attr2 = 'foo',
-  Optional[String] $attr3 = undef,
-  Optional[Variant[Integer,Array[String] $attr4,
-  Array[Struct[{
-    name       => String[1],
-    source_url => String[1],
-    delete     => Optional[Boolean],
-    exclude    => Optional[Variant[String,Array[String]]],
-    include    => Optional[Variant[String,Array[String]]],
-    sync_hour  => Optional[String],
-  }]]             $repos = [],
-) { }
+        <<~EOL
+          class spec (
+            Integer $attr1,
+            String  $attr2 = 'foo',
+            Optional[String] $attr3 = undef,
+            Optional[Variant[Integer,Array[String] $attr4,
+            Array[Struct[{
+              name       => String[1],
+              source_url => String[1],
+              delete     => Optional[Boolean],
+              exclude    => Optional[Variant[String,Array[String]]],
+              include    => Optional[Variant[String,Array[String]]],
+              sync_hour  => Optional[String],
+            }]]             $repos = [],
+          ) { }
         EOL
       end
-      it 'should not be a problem' do
+
+      it 'is not a problem' do
         expect(problems).to have(0).problem
       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-types
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 2.0.0
 platform: ruby
 authors:
-- Hostnet
+- Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-05 00:00:00.000000000 Z
+date: 2023-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -16,79 +16,23 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '3'
     - - "<"
       - !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 that all parameters are typed.
-email: opensource@hostnet.nl
+        version: '5'
+description: "    A new check for puppet-lint that validates that all parameters are
+  typed.\n"
+email: voxpupuli@groups.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -110,18 +54,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: puppet-lint check that validates that all parameters are typed
-test_files:
-- spec/puppet-lint/plugins/check_parameter_types_spec.rb
-- spec/spec_helper.rb
+test_files: []