puppet-lint-param-docs 1.7.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26491f65ee561c24b8246bccf4793d451e967aa7b40796a1dfaef59cbf959de4
-  data.tar.gz: 74fb61891a78bf720e76ab591ecd18ee4f1ba16b8eb3e57ffac0e7739635d991
+  metadata.gz: d2e5609d6315d0159a0cc595bcaea36fddb2e9df1323a49dee0ed53561c0dcb9
+  data.tar.gz: 7ef40b3020f49bda2bc7a15fdb3f8c4a0b1f46bff7dbb6719cfc7cb77e5f71ed
 SHA512:
-  metadata.gz: 58c68e3b29fa294718ba1a43b86f8e9280c039fd94d422abd663f20f340e3fb6eede037b0a8df48553a5b1aaa179b537f82bd5c8499233c53c018e1aa7d5d647
-  data.tar.gz: 18ffb5c2dbdba005d56ead040efbdfbd0c5eec3142322338f1641e1847d62491cd71d817b4de67a417d2d1675aba2b3c5366f26867f6fc6734c564cd7733f8cb
+  metadata.gz: 417d3b28eb4f28f5d5b43b136402055f4753e6b8e0b3645040870e60496e426639ef401df261747983160b278ff640c175f860f8f417f2ac0077eadacda478ea
+  data.tar.gz: 6120cef1c8ef2d620c4fe2f21c1acac9385a7f97b574f1d600498a9ed320b037ac7f23ec97a4aa2f7e4fb2acb1a410bab529f2e744bf3db258731cdc348fa957

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

@@ -1,7 +1,7 @@
 PuppetLint.new_check(:parameter_documentation) do
   def check
-    allowed_styles = PuppetLint.configuration.docs_allowed_styles || ['doc', 'kafo', 'strings']
-    allowed_styles = [ allowed_styles ].flatten
+    allowed_styles = PuppetLint.configuration.docs_allowed_styles || %w[doc kafo strings]
+    allowed_styles = [allowed_styles].flatten
 
     class_indexes.concat(defined_type_indexes).each do |idx|
       doc_params = {}
@@ -9,25 +9,26 @@ PuppetLint.new_check(:parameter_documentation) do
       doc_params_duplicates = Hash.new { |hash, key| hash[key] = [doc_params[key]] }
       is_private = false
       tokens[0..idx[:start]].reverse_each do |dtok|
-        next if [:CLASS, :DEFINE, :NEWLINE, :WHITESPACE, :INDENT].include?(dtok.type)
-        if dtok.type == :COMMENT
-          if dtok.value =~ /\A\s*@api +private\s*$/
-            is_private = true
-            next
-          end
+        next if %i[CLASS DEFINE NEWLINE WHITESPACE INDENT].include?(dtok.type)
 
-          style = detect_style(dtok)
-          # not a doc parameter if style has not been detected
-          next if style[0].nil?
-
-          parameter = style[2]
-          parameter = 'name/title' if idx[:type] == :DEFINE && ['name','title'].include?(parameter)
-          if doc_params.include? parameter
-            doc_params_duplicates[parameter] << dtok
-          else
-            doc_params[parameter] = dtok
-            doc_params_styles[parameter] = style[0]
-          end
+        next unless dtok.type == :COMMENT
+
+        if /\A\s*@api +private\s*$/.match?(dtok.value)
+          is_private = true
+          next
+        end
+
+        style = detect_style(dtok)
+        # not a doc parameter if style has not been detected
+        next if style[0].nil?
+
+        parameter = style[2]
+        parameter = 'name/title' if idx[:type] == :DEFINE && %w[name title].include?(parameter)
+        if doc_params.include? parameter
+          doc_params_duplicates[parameter] << dtok
+        else
+          doc_params[parameter] = dtok
+          doc_params_styles[parameter] = style[0]
         end
       end
 
@@ -36,11 +37,11 @@ PuppetLint.new_check(:parameter_documentation) do
       # warn about duplicates
       doc_params_duplicates.each do |parameter, tokens|
         tokens.each do |token|
-           notify :warning, {
-             :message => "Duplicate #{type_str(idx)} parameter documentation for #{idx[:name_token].value}::#{parameter}",
-             :line    => token.line,
-             :column  => token.column + token.value.match(/\A\s*(@param\s*)?/)[0].length + 1 # `+ 1` is to account for length of the `#` COMMENT token.
-           }
+          notify :warning, {
+            message: "Duplicate #{type_str(idx)} parameter documentation for #{idx[:name_token].value}::#{parameter}",
+            line: token.line,
+            column: token.column + token.value.match(/\A\s*(@param\s*)?/)[0].length + 1, # `+ 1` is to account for length of the `#` COMMENT token.
+          }
         end
       end
 
@@ -50,30 +51,30 @@ PuppetLint.new_check(:parameter_documentation) do
         next if params.find { |p| p.value == parameter }
 
         notify :warning, {
-          :message => "No matching #{type_str(idx)} parameter for documentation of #{idx[:name_token].value}::#{parameter}",
-          :line    => token.line,
-          :column  => token.column + token.value.match(/\A\s*(@param\s*)?/)[0].length + 1
+          message: "No matching #{type_str(idx)} parameter for documentation of #{idx[:name_token].value}::#{parameter}",
+          line: token.line,
+          column: token.column + token.value.match(/\A\s*(@param\s*)?/)[0].length + 1,
         }
       end
 
-      unless is_private
-        params.each do |p|
-          if doc_params.has_key? p.value
-            style = doc_params_styles[p.value] || 'unknown'
-            unless allowed_styles.include?(style)
-              notify :warning, {
-                :message => "invalid documentation style for #{type_str(idx)} parameter #{idx[:name_token].value}::#{p.value} (#{doc_params_styles[p.value]})",
-                :line    => p.line,
-                :column  => p.column,
-              }
-            end
-          else
+      next if is_private
+
+      params.each do |p|
+        if doc_params.has_key? p.value
+          style = doc_params_styles[p.value] || 'unknown'
+          unless allowed_styles.include?(style)
             notify :warning, {
-              :message => "missing documentation for #{type_str(idx)} parameter #{idx[:name_token].value}::#{p.value}",
-              :line    => p.line,
-              :column  => p.column,
+              message: "invalid documentation style for #{type_str(idx)} parameter #{idx[:name_token].value}::#{p.value} (#{doc_params_styles[p.value]})",
+              line: p.line,
+              column: p.column,
             }
           end
+        else
+          notify :warning, {
+            message: "missing documentation for #{type_str(idx)} parameter #{idx[:name_token].value}::#{p.value}",
+            line: p.line,
+            column: p.column,
+          }
         end
       end
     end
@@ -82,7 +83,7 @@ PuppetLint.new_check(:parameter_documentation) do
   private
 
   def type_str(idx)
-    idx[:type] == :CLASS ? "class" : "defined type"
+    idx[:type] == :CLASS ? 'class' : 'defined type'
   end
 
   def extract_params(idx)
@@ -92,20 +93,20 @@ PuppetLint.new_check(:parameter_documentation) do
     e = idx[:param_tokens].each
     begin
       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
-            case ptok.type
-            when :LPAREN, :LBRACK, :LBRACE
-              nesting += 1
-            when :RPAREN, :RBRACK, :RBRACE
-              nesting -= 1
-            when :COMMA
-              break unless nesting > 0
-            end
+        next unless ptok.type == :VARIABLE
+
+        params << ptok
+        nesting = 0
+        # skip to the next parameter to avoid finding default values of variables
+        while true
+          ptok = e.next
+          case ptok.type
+          when :LPAREN, :LBRACK, :LBRACE
+            nesting += 1
+          when :RPAREN, :RBRACK, :RBRACE
+            nesting -= 1
+          when :COMMA
+            break unless nesting > 0
           end
         end
       end
@@ -119,13 +120,13 @@ PuppetLint.new_check(:parameter_documentation) do
   def detect_style(dtok)
     style = nil
     case dtok.value
-    when %r{\A\s*\[\*([a-zA-Z0-9_]+)\*\]\s*(.*)\z}
+    when /\A\s*\[\*([a-zA-Z0-9_]+)\*\]\s*(.*)\z/
       style = 'doc'
-    when %r{\A\s*\$([a-zA-Z0-9_]+):: +(.*)\z}
+    when /\A\s*\$([a-zA-Z0-9_]+):: +(.*)\z/
       style = 'kafo'
-    when %r{\A\s*@param (?:\[.+\] )?([a-zA-Z0-9_]+)(?: +|$)(.*)\z}
+    when /\A\s*@param (?:\[.+\] )?([a-zA-Z0-9_]+)(?: +|$)(.*)\z/
       style = 'strings'
     end
-    [ style, * $~ ]
+    [style, * $~]
   end
 end

data/lib/puppet-lint-param-docs/tasks.rb

@@ -12,7 +12,7 @@ module PuppetLintParamDocs
   class RakeTask < ::Rake::TaskLib
     include ::Rake::DSL if defined?(::Rake::DSL)
 
-    def define_selective(&task_block)
+    def define_selective
       PuppetLint::RakeTask.new(:lint_param_docs) do |config|
         config.fail_on_warnings = true
         config.disable_checks = (PuppetLint.configuration.checks - [:parameter_documentation])

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

@@ -9,11 +9,11 @@ describe 'parameter_documentation' do
   context 'class missing any documentation' do
     let(:code) { 'class example($foo) { }' }
 
-    it 'should detect a single problem' do
+    it 'detects a single problem' do
       expect(problems).to have(1).problem
     end
 
-    it 'should create a warning' do
+    it 'creates a warning' do
       expect(problems).to contain_warning(class_msg % :foo).on_line(1).in_column(15)
     end
   end
@@ -21,23 +21,23 @@ describe 'parameter_documentation' do
   context 'define missing any documentation' do
     let(:code) { 'define example($foo) { }' }
 
-    it 'should detect a single problem' do
+    it 'detects 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)
+    it 'creates a warning' do
+      expect(problems).to contain_warning(define_msg % :foo).on_line(1).in_column(16)
     end
   end
 
   context 'class with param defaults' do
     let(:code) { 'class example($foo = $example::params::foo) { }' }
 
-    it 'should detect a single problem' do
+    it 'detects a single problem' do
       expect(problems).to have(1).problem
     end
 
-    it 'should create a warning' do
+    it 'creates a warning' do
       expect(problems).to contain_warning(class_msg % :foo).on_line(1).in_column(15)
     end
   end
@@ -45,11 +45,11 @@ describe 'parameter_documentation' do
   context 'define with param defaults' do
     let(:code) { 'define example($foo = $example::params::foo) { }' }
 
-    it 'should detect a single problem' do
+    it 'detects a single problem' do
       expect(problems).to have(1).problem
     end
 
-    it 'should create a warning' do
+    it 'creates a warning' do
       expect(problems).to contain_warning(define_msg % :foo).on_line(1).in_column(16)
     end
   end
@@ -57,45 +57,45 @@ describe 'parameter_documentation' do
   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
+    it 'detects a single problem' do
       expect(problems).to have(1).problem
     end
 
-    it 'should create a warning' do
+    it 'creates 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
-class foreman (
-  $foreman_url            = $foreman::params::foreman_url,
-  $unattended             = $foreman::params::unattended,
-  $authentication         = $foreman::params::authentication,
-  $passenger              = $foreman::params::passenger,
-) {}
+      <<~EOS
+        class foreman (
+          $foreman_url            = $foreman::params::foreman_url,
+          $unattended             = $foreman::params::unattended,
+          $authentication         = $foreman::params::authentication,
+          $passenger              = $foreman::params::passenger,
+        ) {}
       EOS
     end
 
-    it 'should detect four problems' do
+    it 'detects four problems' do
       expect(problems).to have(4).problems
     end
   end
 
   context 'define with many param defaults' do
     let(:code) do
-      <<-EOS
-define foreman (
-  $foreman_url            = $foreman::params::foreman_url,
-  $unattended             = $foreman::params::unattended,
-  $authentication         = $foreman::params::authentication,
-  $passenger              = $foreman::params::passenger,
-) {}
+      <<~EOS
+        define foreman (
+          $foreman_url            = $foreman::params::foreman_url,
+          $unattended             = $foreman::params::unattended,
+          $authentication         = $foreman::params::authentication,
+          $passenger              = $foreman::params::passenger,
+        ) {}
       EOS
     end
 
-    it 'should detect four problems' do
+    it 'detects four problems' do
       expect(problems).to have(4).problems
     end
   end
@@ -113,11 +113,11 @@ define foreman (
       EOS
     end
 
-    it 'should detect a single problem' do
+    it 'detects a single problem' do
       expect(problems).to have(1).problem
     end
 
-    it 'should create a warning' do
+    it 'creates a warning' do
       expect(problems).to contain_warning(class_msg % :foo).on_line(7).in_column(15)
     end
   end
@@ -135,11 +135,11 @@ define foreman (
       EOS
     end
 
-    it 'should detect a single problem' do
+    it 'detects a single problem' do
       expect(problems).to have(1).problem
     end
 
-    it 'should create a warning' do
+    it 'creates a warning' do
       expect(problems).to contain_warning(define_msg % :foo).on_line(7).in_column(16)
     end
   end
@@ -154,11 +154,11 @@ define foreman (
       EOS
     end
 
-    it 'should detect a single problem' do
+    it 'detects a single problem' do
       expect(problems).to have(1).problem
     end
 
-    it 'should create a warning' do
+    it 'creates a warning' do
       expect(problems).to contain_warning(class_msg % :foo).on_line(4).in_column(15)
     end
   end
@@ -175,11 +175,11 @@ define foreman (
       EOS
     end
 
-    it 'should detect no single problems' do
+    it 'detects no single problems' do
       expect(problems).to have(0).problems
     end
 
-    it 'should not create a warning' do
+    it 'does not create a warning' do
       expect(problems).not_to contain_info(class_msg % :foo)
     end
   end
@@ -194,11 +194,11 @@ define foreman (
       EOS
     end
 
-    it 'should detect a single problem' do
+    it 'detects a single problem' do
       expect(problems).to have(1).problem
     end
 
-    it 'should create a warning' do
+    it 'creates a warning' do
       expect(problems).to contain_warning(define_msg % :foo).on_line(4).in_column(16)
     end
   end
@@ -216,11 +216,11 @@ define foreman (
       EOS
     end
 
-    it 'should detect a single problem' do
+    it 'detects a single problem' do
       expect(problems).to have(1).problem
     end
 
-    it 'should create a warning' do
+    it 'creates a warning' do
       expect(problems).to contain_warning(class_msg % :foo).on_line(7).in_column(15)
     end
   end
@@ -238,11 +238,11 @@ define foreman (
       EOS
     end
 
-    it 'should detect a single problem' do
+    it 'detects a single problem' do
       expect(problems).to have(1).problem
     end
 
-    it 'should create a warning' do
+    it 'creates a warning' do
       expect(problems).to contain_warning(define_msg % :foo).on_line(7).in_column(16)
     end
   end
@@ -260,11 +260,11 @@ define foreman (
       EOS
     end
 
-    it 'should detect two problem' do
+    it 'detects two problem' do
       expect(problems).to have(2).problems
     end
 
-    it 'should create two warnings' do
+    it 'creates two warnings' do
       expect(problems).to contain_warning(class_msg % :foo).on_line(7).in_column(15)
       expect(problems).to contain_warning(class_msg % :baz).on_line(7).in_column(27)
     end
@@ -283,11 +283,11 @@ define foreman (
       EOS
     end
 
-    it 'should detect two problem' do
+    it 'detects two problem' do
       expect(problems).to have(2).problems
     end
 
-    it 'should create two warnings' do
+    it 'creates two warnings' do
       expect(problems).to contain_warning(define_msg % :foo).on_line(7).in_column(16)
       expect(problems).to contain_warning(define_msg % :baz).on_line(7).in_column(28)
     end
@@ -306,11 +306,11 @@ define foreman (
       EOS
     end
 
-    it 'should detect two problem' do
+    it 'detects two problem' do
       expect(problems).to have(2).problems
     end
 
-    it 'should create two warnings' do
+    it 'creates two warnings' do
       expect(problems).to contain_warning(class_msg % :foo).on_line(7).in_column(15)
       expect(problems).to contain_warning(class_msg % :baz).on_line(7).in_column(27)
     end
@@ -329,11 +329,11 @@ define foreman (
       EOS
     end
 
-    it 'should detect two problem' do
+    it 'detects two problem' do
       expect(problems).to have(2).problems
     end
 
-    it 'should create two warnings' do
+    it 'creates two warnings' do
       expect(problems).to contain_warning(define_msg % :foo).on_line(7).in_column(16)
       expect(problems).to contain_warning(define_msg % :baz).on_line(7).in_column(28)
     end
@@ -352,7 +352,7 @@ define foreman (
       EOS
     end
 
-    it 'should not detect any problems' do
+    it 'does not detect any problems' do
       expect(problems).to have(0).problems
     end
   end
@@ -378,18 +378,19 @@ define foreman (
       before do
         PuppetLint.configuration.docs_allowed_styles = ['noexist']
       end
+
       after do
         PuppetLint.configuration.docs_allowed_styles = false
       end
 
-      it 'should detect three problems' do
+      it 'detects three problems' do
         expect(problems).to have(3).problems
       end
 
-      it 'should create three problems' do
-        expect(problems).to contain_warning(class_style_msg % [:foo, 'kafo']).on_line(11).in_column(21)
-        expect(problems).to contain_warning(class_style_msg % [:bar, 'doc']).on_line(11).in_column(27)
-        expect(problems).to contain_warning(class_style_msg % [:foobar, 'strings']).on_line(11).in_column(33)
+      it 'creates three problems' do
+        expect(problems).to contain_warning(format(class_style_msg, :foo, 'kafo')).on_line(11).in_column(21)
+        expect(problems).to contain_warning(format(class_style_msg, :bar, 'doc')).on_line(11).in_column(27)
+        expect(problems).to contain_warning(format(class_style_msg, :foobar, 'strings')).on_line(11).in_column(33)
       end
     end
 
@@ -397,22 +398,22 @@ define foreman (
       before do
         PuppetLint.configuration.docs_allowed_styles = 'strings'
       end
+
       after do
         PuppetLint.configuration.docs_allowed_styles = nil
       end
 
-      it 'should detect two problems' do
+      it 'detects two problems' do
         expect(problems).to have(2).problems
       end
 
-      it 'should create three problems' do
-        expect(problems).to contain_warning(class_style_msg % [:foo, 'kafo']).on_line(11).in_column(21)
-        expect(problems).to contain_warning(class_style_msg % [:bar, 'doc']).on_line(11).in_column(27)
+      it 'creates three problems' do
+        expect(problems).to contain_warning(format(class_style_msg, :foo, 'kafo')).on_line(11).in_column(21)
+        expect(problems).to contain_warning(format(class_style_msg, :bar, 'doc')).on_line(11).in_column(27)
       end
     end
   end
 
-
   context 'define with all parameters documented ($foo::)' do
     let(:code) do
       <<-EOS
@@ -426,7 +427,7 @@ define foreman (
       EOS
     end
 
-    it 'should not detect any problems' do
+    it 'does not detect any problems' do
       expect(problems).to have(0).problems
     end
   end
@@ -444,7 +445,7 @@ define foreman (
       EOS
     end
 
-    it 'should not detect any problems' do
+    it 'does not detect any problems' do
       expect(problems).to have(0).problems
     end
   end
@@ -462,7 +463,7 @@ define foreman (
       EOS
     end
 
-    it 'should not detect any problems' do
+    it 'does not detect any problems' do
       expect(problems).to have(0).problems
     end
   end
@@ -485,7 +486,7 @@ define foreman (
       EOS
     end
 
-    it 'should not detect any problems' do
+    it 'does not detect any problems' do
       expect(problems).to have(0).problems
     end
   end
@@ -508,7 +509,7 @@ define foreman (
       EOS
     end
 
-    it 'should not detect any problems' do
+    it 'does not detect any problems' do
       expect(problems).to have(0).problems
     end
   end
@@ -524,7 +525,7 @@ define foreman (
       EOS
     end
 
-    it 'should not detect any problems' do
+    it 'does not detect any problems' do
       expect(problems).to have(0).problems
     end
   end
@@ -544,7 +545,7 @@ define foreman (
       EOS
     end
 
-    it 'should not detect any problems' do
+    it 'does not detect any problems' do
       expect(problems).to have(0).problems
     end
   end
@@ -552,7 +553,7 @@ define foreman (
   context 'class without parameters' do
     let(:code) { 'class example { }' }
 
-    it 'should not detect any problems' do
+    it 'does not detect any problems' do
       expect(problems).to have(0).problems
     end
   end
@@ -560,7 +561,7 @@ define foreman (
   context 'define without parameters' do
     let(:code) { 'define example { }' }
 
-    it 'should not detect any problems' do
+    it 'does not detect any problems' do
       expect(problems).to have(0).problems
     end
   end
@@ -568,7 +569,7 @@ define foreman (
   context 'class without parameters and a function call' do
     let(:code) { 'class example { a($foo::bar) }' }
 
-    it 'should not detect any problems' do
+    it 'does not detect any problems' do
       expect(problems).to have(0).problems
     end
   end
@@ -576,7 +577,7 @@ define foreman (
   context 'define without parameters and a function call' do
     let(:code) { 'define example { a($foo::bar) }' }
 
-    it 'should not detect any problems' do
+    it 'does not detect any problems' do
       expect(problems).to have(0).problems
     end
   end
@@ -594,11 +595,11 @@ define foreman (
       EOS
     end
 
-    it 'should detect a single problem' do
+    it 'detects a single problem' do
       expect(problems).to have(1).problem
     end
 
-    it 'should create a warning' do
+    it 'creates a warning' do
       expect(problems).to contain_warning(class_msg % :foo).on_line(7).in_column(15)
     end
   end
@@ -621,15 +622,15 @@ define foreman (
         EOS
       end
 
-      it 'should detect two problems' do
+      it 'detects two problems' do
         expect(problems).to have(2).problem
       end
 
-      it 'should create a warning on line 3' do
+      it 'creates a warning on line 3' do
         expect(problems).to contain_warning(class_msg % :bar).on_line(3).in_column(10)
       end
 
-      it 'should create a warning on line 6' do
+      it 'creates a warning on line 6' do
         expect(problems).to contain_warning(class_msg % :bar).on_line(6).in_column(10)
       end
     end
@@ -648,15 +649,15 @@ define foreman (
         EOS
       end
 
-      it 'should detect two problems' do
+      it 'detects two problems' do
         expect(problems).to have(2).problem
       end
 
-      it 'should create a warning on line 3' do
+      it 'creates a warning on line 3' do
         expect(problems).to contain_warning(define_msg % :bar).on_line(3).in_column(10)
       end
 
-      it 'should create a warning on line 6' do
+      it 'creates a warning on line 6' do
         expect(problems).to contain_warning(define_msg % :bar).on_line(6).in_column(10)
       end
     end
@@ -678,19 +679,19 @@ define foreman (
         EOS
       end
 
-      it 'should detect three problems' do
+      it 'detects three problems' do
         expect(problems).to have(3).problem
       end
 
-      it 'should create a warning on line 3' do
+      it 'creates a warning on line 3' do
         expect(problems).to contain_warning(class_msg % :bar).on_line(3).in_column(10)
       end
 
-      it 'should create a warning on line 6' do
+      it 'creates a warning on line 6' do
         expect(problems).to contain_warning(class_msg % :bar).on_line(6).in_column(10)
       end
 
-      it 'should create a warning on line 8' do
+      it 'creates a warning on line 8' do
         expect(problems).to contain_warning(class_msg % :bar).on_line(8).in_column(10)
       end
     end
@@ -708,15 +709,15 @@ define foreman (
         EOS
       end
 
-      it 'should detect two problems' do
+      it 'detects two problems' do
         expect(problems).to have(2).problem
       end
 
-      it 'should create a warning on line 3' do
+      it 'creates a warning on line 3' do
         expect(problems).to contain_warning(class_msg % :bar).on_line(3).in_column(10)
       end
 
-      it 'should create a warning on line 4' do
+      it 'creates a warning on line 4' do
         expect(problems).to contain_warning(class_msg % :bar).on_line(4).in_column(10)
       end
     end
@@ -735,15 +736,15 @@ define foreman (
         EOS
       end
 
-      it 'should detect two problems' do
+      it 'detects two problems' do
         expect(problems).to have(2).problem
       end
 
-      it 'should create a warning on line 3' do
+      it 'creates a warning on line 3' do
         expect(problems).to contain_warning(class_msg % :bar).on_line(3).in_column(10)
       end
 
-      it 'should create a warning on line 6' do
+      it 'creates a warning on line 6' do
         expect(problems).to contain_warning(class_msg % :bar).on_line(6).in_column(3)
       end
     end
@@ -759,11 +760,11 @@ define foreman (
       EOS
     end
 
-    it 'should detect a single problem' do
+    it 'detects a single problem' do
       expect(problems).to have(1).problem
     end
 
-    it 'should create a warning on line 3' do
+    it 'creates a warning on line 3' do
       expect(problems).to contain_warning('No matching class parameter for documentation of example::foo').on_line(3).in_column(10)
     end
   end
@@ -781,11 +782,11 @@ define foreman (
       EOS
     end
 
-    it 'should detect a single problem' do
+    it 'detects a single problem' do
       expect(problems).to have(1).problem
     end
 
-    it 'should create a warning on line 3' do
+    it 'creates a warning on line 3' do
       expect(problems).to contain_warning('No matching class parameter for documentation of example::foo').on_line(3).in_column(10)
     end
   end
@@ -804,11 +805,11 @@ define foreman (
       EOS
     end
 
-    it 'should detect a single problem' do
+    it 'detects a single problem' do
       expect(problems).to have(1).problem
     end
 
-    it 'should create a warning on line 4' do
+    it 'creates a warning on line 4' do
       expect(problems).to contain_warning('No matching defined type parameter for documentation of example::example::foo').on_line(4).in_column(10)
     end
   end
@@ -822,10 +823,10 @@ define foreman (
       #   Docs for the $name
       # @param bar Docs for bar
       define example::example(String[1] $bar) { }
-    EOS
+      EOS
     end
 
-    it 'should not detect any problems' do
+    it 'does not detect any problems' do
       expect(problems).to have(0).problems
     end
   end
@@ -838,14 +839,14 @@ define foreman (
       # @param name
       #   Invalid docs
       class example { }
-    EOS
+      EOS
     end
 
-    it 'should detect a single problem' do
+    it 'detects a single problem' do
       expect(problems).to have(1).problem
     end
 
-    it 'should create a warning on line 3' do
+    it 'creates a warning on line 3' do
       expect(problems).to contain_warning('No matching class parameter for documentation of example::name').on_line(3).in_column(10)
     end
   end
@@ -859,10 +860,10 @@ define foreman (
       #   Docs for the $title
       # @param bar Docs for bar
       define example::example(String[1] $bar) { }
-    EOS
+      EOS
     end
 
-    it 'should not detect any problems' do
+    it 'does not detect any problems' do
       expect(problems).to have(0).problems
     end
   end
@@ -875,14 +876,14 @@ define foreman (
       # @param title
       #   Invalid docs
       class example { }
-    EOS
+      EOS
     end
 
-    it 'should detect a single problem' do
+    it 'detects a single problem' do
       expect(problems).to have(1).problem
     end
 
-    it 'should create a warning on line 3' do
+    it 'creates a warning on line 3' do
       expect(problems).to contain_warning('No matching class parameter for documentation of example::title').on_line(3).in_column(10)
     end
   end
@@ -898,18 +899,18 @@ define foreman (
       #   Docs for the $name
       # @param bar Docs for bar
       define example(String[1] $bar) { }
-    EOS
+      EOS
     end
 
-    it 'should detect two problems' do
+    it 'detects two problems' do
       expect(problems).to have(2).problems
     end
 
-    it 'should create a warning on line 3' do
+    it 'creates a warning on line 3' do
       expect(problems).to contain_warning('Duplicate defined type parameter documentation for example::name/title').on_line(3).in_column(10)
     end
 
-    it 'should create a warning on line 5' do
+    it 'creates a warning on line 5' do
       expect(problems).to contain_warning('Duplicate defined type parameter documentation for example::name/title').on_line(5).in_column(10)
     end
   end
@@ -951,7 +952,7 @@ define foreman (
       EOS
     end
 
-    it 'should not detect any problems' do
+    it 'does not detect any problems' do
       expect(problems).to have(0).problems
     end
   end
@@ -1001,7 +1002,7 @@ define foreman (
       EOS
     end
 
-    it 'should not detect any problems' do
+    it 'does not detect any problems' do
       puts problems
       expect(problems).to have(0).problems
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-param-docs
 version: !ruby/object:Gem::Version
-  version: 1.7.6
+  version: 2.0.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-29 00:00:00.000000000 Z
+date: 2023-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -16,104 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.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: '4.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'
-- !ruby/object:Gem::Dependency
-  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:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 description: "    A new check for puppet-lint that validates all parameters are documented.\n"
 email: voxpupuli@groups.io
 executables: []
@@ -122,9 +38,9 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- lib/puppet-lint-param-docs.rb
 - lib/puppet-lint-param-docs/tasks.rb
 - lib/puppet-lint/plugins/check_parameter_documentation.rb
+- lib/puppet_lint_param_docs.rb
 - spec/puppet-lint/plugins/check_parameter_documentation_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/voxpupuli/puppet-lint-param-docs
@@ -139,7 +55,7 @@ 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:
   - - ">="
@@ -150,6 +66,4 @@ rubygems_version: 3.2.33
 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
+test_files: []