puppet-lint-param_comment-check 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57edfb5e9c1716c1bfb583619d1a36bf57f7f4492af64f33a828dba5f4b1eec2
-  data.tar.gz: 3350c35a78495a1d4de4f25567af5da91cbed2601c25e3fe8e13e273e31e8f09
+  metadata.gz: bc1677e0675072c3a48173655360a1daca9c0539ff2a58bd4f71a7c05f38e37b
+  data.tar.gz: af924c9a20e1957f117538c80cc9a7fa3aa89dcdfafbb2d9b85b26990855e851
 SHA512:
-  metadata.gz: 0e58accb1fe706bb94f24ccbe8ed80f50aee634f942360f4b29c203a206c84a7196fc0bda9c882561f7d2b9420919d703fb7444a41ac47da9d3c4a998d54ae48
-  data.tar.gz: 10e7eef3b38f933c9f871e727d912c88e1fc76193158dd909c6c99e9d084dd585dce554dc5573d7eb206170b2d07c7fbe530a888903e3ca15446d9fbb29fbdd7
+  metadata.gz: 68b99e9b40064843a160dfd7e44d81962ed2ee4fd0246b5a623cedc1cb632b9cbbb97645ae3c8ac4caf2d9236fd694dbbccabf56d49a1b12074e8618e69f7e76
+  data.tar.gz: f466b51ef27e5bcd8edff95fb434706c04b00351b3d6616913d9a5ee3d91004fc8b15614c50a8deb1e9cbeb14b3c67d45acb4d6b061bd7e80bc556e2d4996adf

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

@@ -50,11 +50,11 @@ end
 def analyze_params(param_tokens) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
   params = []
   current_param = EMPTY_PARAM.dup
-  in_brackets = false
+  brackets = 0
   param_tokens.reject { |token| %i[WHITESPACE NEWLINE].include? token.type }.each do |token|
-    in_brackets = true if token.type == :LBRACK
-    in_brackets = false if token.type == :RBRACK
-    next if in_brackets
+    brackets += 1 if token.type == :LBRACK
+    brackets -= 1 if token.type == :RBRACK
+    next unless brackets.zero?
 
     current_param = analyze_param_token(token, current_param) unless token.type == :COMMA
     if token.type == :COMMA

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

@@ -53,6 +53,30 @@ describe 'param_comment' do
     end
   end
 
+  context 'valid code with complex type definition' do
+    let(:code) do
+      <<~CODE
+        # @summary
+        #   some class
+        #
+        # @param optional
+        #   Complicated
+        class my_class (
+            Optional[Hash[
+              String,
+              Struct[{
+                test => Optional[Boolean]
+              }]
+            ]] $optional = undef
+        ) {}
+      CODE
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
   context 'code with missing parameter comment' do
     let(:code) do
       <<~CODE
@@ -177,7 +201,7 @@ describe 'param_comment' do
     end
 
     it 'should create a warning' do
-      expect(problems).to contain_warning('Invalid param or hash option header')
+      expect(problems).to contain_warning('Invalid param or hash option header: @param mandatory A mandatory parameter')
                             .on_line(1)
                             .in_column(1)
     end
@@ -273,7 +297,7 @@ describe 'param_comment' do
 
     it 'should create a warning' do
       expect(problems).to contain_warning(
-                            'Invalid param or hash option header'
+                            'Invalid param or hash option header: @option mandatory [Boolean] :some_option An option'
                           )
                             .on_line(3)
                             .in_column(1)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-param_comment-check
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Dennis Ploeger