puppet-lint-class_alignment-check 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe4a55df13a00eb32e3dab657bc0d1dc1e2982851d3992ec1329210b2642ccc5
-  data.tar.gz: 0d227e2da3f0dfa710ee46a11c3a9bd0e6e4fbf05728e96b553ae28a018c305e
+  metadata.gz: e32258dfb55db44ee2f3f0a2057958463c3c5ea2bad429c9bc5d179b772d6a71
+  data.tar.gz: 40ddced7d67f62decc65e9e9b396d2e60b19508aecf40039524c7c635d38fd0f
 SHA512:
-  metadata.gz: 4c33eb7910db84735f6baa86e020b604cdc272c18d726c7c53bb34b3995b6ca874fc5da985756df1f34f985cc80385f2477fe571756ff0c8da374ca0e1001de8
-  data.tar.gz: 9d3122d562637f655b4fdb251e59256c3a29a42b6affecf78d26d9618cacacd81d3ae698541d5fda6b0e1aa1350d71807bfbd87b5f55213d671bb7ba0f010a41
+  metadata.gz: 3e6caecc7f1607637a851670b86f258e2e4da20f9c39d900aeb971216ffdade15d5d3e35d3b31094376dae4e57c3b6e5c6aa97da875d340f4dc0a9d63b795229
+  data.tar.gz: 4fc0dd184ce132b65f032a55bd2146cdc11ee8abb7b9457ef5d8dc0e6cd4d242dc88440e0c293da1c726d61bf122a646ffbb3ad5ab478d035a6e37358d8cbfa8

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

@@ -20,9 +20,37 @@ PuppetLint.new_check(:class_params_newline) do
       next if tokens[first_param] == tokens[last_param]
 
       tokens.each do |token|
+        if token == tokens[-1]
+          rparen = token
+          while rparen&.next_token
+            rparen = rparen.next_token
+            break if rparen.type == :RPAREN
+          end
+
+          last_code_token = token
+          while last_code_token&.prev_token
+            break unless %i[WHITESPACE INDENT NEWLINE].include?(last_code_token.type)
+
+            last_code_token = last_code_token.prev_token
+          end
+
+          next if rparen.line != last_code_token.line
+
+          notify(
+            :warning,
+            message: "`)` should be in a new line (expected in line #{token.line + 1}, but found it in line #{token.line})",
+            line: rparen.line,
+            column: rparen.column,
+            token: rparen,
+            newline: true,
+            newline_indent: item[:tokens][0].column - 1
+          )
+          break
+        end
+
         next unless a_param?(token)
 
-        if token.prev_code_token == :LPAREN
+        if token.prev_code_token.type == :LPAREN
           next if token.line != token.prev_code_token.line
         elsif token.line != prev_param_token(token).line
           next
@@ -30,7 +58,7 @@ PuppetLint.new_check(:class_params_newline) do
 
         notify(
           :warning,
-          message: "Parameter #{token.to_manifest} should have its own line (expected in line #{token.line + 1}, but found it in line #{token.line})",
+          message: "`#{token.to_manifest}` should be in a new line (expected in line #{token.line + 1}, but found it in line #{token.line})",
           line: token.line,
           column: token.column,
           token: token,
@@ -65,6 +93,13 @@ PuppetLint.new_check(:class_params_newline) do
     index = tokens.index(token.prev_code_token.next_token)
     tokens.insert(index, PuppetLint::Lexer::Token.new(:NEWLINE, "\n", 0, 0))
 
-    token.prev_token.value = ' ' * problem[:newline_indent] if %i[WHITESPACE INDENT].include?(token.prev_token.type)
+    # When there's no space at the beginning of the param
+    # e.g.  class foo($bar="aaa") {}
+    if token.prev_code_token.next_token == token
+      tokens.insert(index + 1, PuppetLint::Lexer::Token.new(:INDENT, ' ' * problem[:newline_indent], 0, 0))
+
+    elsif %i[WHITESPACE INDENT].include?(token.prev_token.type)
+      token.prev_token.value = ' ' * problem[:newline_indent]
+    end
   end
 end

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

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'class_params_newline' do
-  let(:msg) { 'Parameter %s should have its own line (expected in line %d, but found it in line %d)' }
+  let(:msg) { '`%s` should be in a new line (expected in line %d, but found it in line %d)' }
 
   context 'with fix disabled' do
     context 'tidy code' do
@@ -90,5 +90,51 @@ describe 'class_params_newline' do
         expect(manifest).to eq(fixed)
       end
     end
+
+    context 'in a single line' do
+      let(:code) do
+        <<-END
+          class foo ($foo = 1, $bar = $a) {}
+
+          class bar ($foo = 1, $bar = $a,) {}
+
+          class aaa ( $foo = 1, $bar = $a,) {}
+
+          class bbb ( $foo = 1, $bar = $a, ) {}
+
+          class ccc ($foo = 1) {}
+        END
+      end
+
+      let(:fixed) do
+        <<-END
+          class foo (
+            $foo = 1,
+            $bar = $a
+          ) {}
+
+          class bar (
+            $foo = 1,
+            $bar = $a,
+          ) {}
+
+          class aaa (
+            $foo = 1,
+            $bar = $a,
+          ) {}
+
+          class bbb (
+            $foo = 1,
+            $bar = $a,
+          ) {}
+
+          class ccc ($foo = 1) {}
+        END
+      end
+
+      it 'should fix the problems' do
+        expect(manifest).to eq(fixed)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-class_alignment-check
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Anh Pham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-08 00:00:00.000000000 Z
+date: 2022-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint