puppet-lint-class_alignment-check 0.3.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe4a55df13a00eb32e3dab657bc0d1dc1e2982851d3992ec1329210b2642ccc5
-  data.tar.gz: 0d227e2da3f0dfa710ee46a11c3a9bd0e6e4fbf05728e96b553ae28a018c305e
+  metadata.gz: 3dc0a012b0d80156eaad90609fb62d8f32d580d6acbc5f28e6981d71137fc301
+  data.tar.gz: 72378622329307ce0c0631caebec4fef365fe137b89581bfd01bae1e8bad9537
 SHA512:
-  metadata.gz: 4c33eb7910db84735f6baa86e020b604cdc272c18d726c7c53bb34b3995b6ca874fc5da985756df1f34f985cc80385f2477fe571756ff0c8da374ca0e1001de8
-  data.tar.gz: 9d3122d562637f655b4fdb251e59256c3a29a42b6affecf78d26d9618cacacd81d3ae698541d5fda6b0e1aa1350d71807bfbd87b5f55213d671bb7ba0f010a41
+  metadata.gz: f7750b39ff5ef57ec5fca519a77e1aa0a1b0def9d906814c4c6b2cf096229a8cde51bc75d796e174c4f351e3fe17f4a5baeb79b3649d468e255f88433d3691a2
+  data.tar.gz: 79e3897e36b000f944ebe5d90bbdd671215e2fe94d4a6956a3ddd258fbced0ec4ecd5c8bee7e94b9a69fbc1df88fff411b87872f74babce420f870fc3ac84339

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

@@ -8,8 +8,21 @@ def a_param?(token)
     false
   elsif token&.prev_code_token&.type == :FARROW
     false
-  elsif token&.type == :VARIABLE && !%i[DQPRE DQMID].include?(token.prev_code_token.type)
-    true
+  elsif %i[DQPRE DQMID].include?(token&.prev_code_token&.type)
+    false
+  elsif token&.type == :VARIABLE
+    count = 0
+    while token&.prev_token
+      token = token.prev_token
+      if %i[LPAREN LBRACK LBRACE].include?(token.type)
+        count += 1
+      elsif %i[RPAREN RBRACK RBRACE].include?(token.type)
+        count -= 1
+      elsif %i[DEFINE CLASS].include?(token.type)
+        break
+      end
+    end
+    true if count == 1
   end
 end
 

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

@@ -10,27 +10,51 @@ PuppetLint.new_check(:class_params_newline) do
   def check
     (class_indexes + defined_type_indexes).each do |item|
       tokens = item[:param_tokens]
+      next if tokens.nil?
 
-      first_param = tokens.index { |token| a_param?(token) }
-      last_param = tokens.rindex { |token| a_param?(token) }
-      next if first_param.nil?
-      next if last_param.nil?
-
-      # Skip if there's only 1 param
-      next if tokens[first_param] == tokens[last_param]
+      # Skip if line length < 80 chars
+      first_paren = tokens[0]&.prev_token_of(:LPAREN)
+      last_paren = tokens[-1]&.next_token_of(:RPAREN)
+      next if first_paren.nil?
+      next if last_paren.nil?
+      next if first_paren.line == last_paren.line && last_paren.column < 80
 
       tokens.each do |token|
+        if token == tokens[-1]
+          rparen = token.next_token_of(:RPAREN)
+
+          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
+          )
+        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
         end
 
+        # binding.break
         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,
@@ -43,28 +67,46 @@ PuppetLint.new_check(:class_params_newline) do
 
   def fix(problem)
     token = problem[:token]
-    case token&.prev_code_token&.type
-    when :TYPE
-      token = token.prev_code_token
-    when :RBRACK
-      count = 0
-      while token&.prev_code_token
+    if token.type == :VARIABLE
+      # Integer $db_port
+      if token&.prev_code_token&.type == :TYPE
         token = token.prev_code_token
-        case token.type
-        when :RBRACK
-          count += 1
-        when :LBRACK
-          count -= 1
-        end
 
-        break if count.zero?
+      # Variant[Undef, Enum['UNSET'], Stdlib::Port] $db_port
+      elsif token&.prev_code_token&.type == :RBRACK
+        count = 0
+        while token&.prev_code_token
+          token = token.prev_code_token
+          case token.type
+          when :RBRACK
+            count += 1
+          when :LBRACK
+            count -= 1
+          end
+
+          break if count.zero?
+        end
+        token = token.prev_code_token
       end
-      token = token.prev_code_token
     end
 
-    index = tokens.index(token.prev_code_token.next_token)
+    last_non_whitespace_token = token.prev_token
+    while last_non_whitespace_token&.prev_token
+      break unless %i[WHITESPACE INDENT NEWLINE].include?(last_non_whitespace_token.type)
+
+      last_non_whitespace_token = last_non_whitespace_token.prev_token
+    end
+
+    index = tokens.index(last_non_whitespace_token) + 1
     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,134 @@ 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 foo ($foo = 1, $bar = $a, $foo = 1, $bar = $a, $foo = 1, $bar = $a) {}
+
+          class bar ($foo = 1, $bar = $a,) {}
+          class bar ($foo = 1, $bar = $a, $foo = 1, $bar = $a, $foo = 1, $bar = $a,) {}
+
+          class aaa ( $foo = 1, $bar = $a,) {}
+          class aaa ( $foo = 1, $bar = $a, $foo = 1, $bar = $a, $foo = 1, $bar = $a,) {}
+
+          class bbb ( $foo = 1, $bar = $a, ) {}
+          class bbb ( $foo = 1, $bar = $a, $foo = 1, $bar = $a, $foo = 1, $bar = $a, ) {}
+
+          class ccc ($foo = 1) {}
+
+          class ddd {}
+
+          class eee (
+            $foo = 1,
+            $workers = max($::processorcount, 1),
+            $database_path = $aaa,) inherits sap_zabbix::params { }
+          { }
+
+          class fff ($foo, $bar=[], $foo, $bar=[], $foo, $bar=[], $listen_ips = [$::ipaddress]) {}
+
+          define ggg ($foo, $bar=[]) {}
+
+          define long_ggg ($foo, $bar=[], $foo, $bar=[], $foo, $bar=[], $foo, $bar=[]) {}
+
+          define asdf ($prefix, $pattern, $expire, $port, $prefix, $pattern, $expire, $port) { }
+        END
+      end
+
+      let(:fixed) do
+        <<-END
+          class foo ($foo = 1, $bar = $a) {}
+          class foo (
+            $foo = 1,
+            $bar = $a,
+            $foo = 1,
+            $bar = $a,
+            $foo = 1,
+            $bar = $a
+          ) {}
+
+          class bar ($foo = 1, $bar = $a,) {}
+          class bar (
+            $foo = 1,
+            $bar = $a,
+            $foo = 1,
+            $bar = $a,
+            $foo = 1,
+            $bar = $a,
+          ) {}
+
+          class aaa ( $foo = 1, $bar = $a,) {}
+          class aaa (
+            $foo = 1,
+            $bar = $a,
+            $foo = 1,
+            $bar = $a,
+            $foo = 1,
+            $bar = $a,
+          ) {}
+
+          class bbb ( $foo = 1, $bar = $a, ) {}
+          class bbb (
+            $foo = 1,
+            $bar = $a,
+            $foo = 1,
+            $bar = $a,
+            $foo = 1,
+            $bar = $a,
+          ) {}
+
+          class ccc ($foo = 1) {}
+
+          class ddd {}
+
+          class eee (
+            $foo = 1,
+            $workers = max($::processorcount, 1),
+            $database_path = $aaa,
+          ) inherits sap_zabbix::params { }
+          { }
+
+          class fff (
+            $foo,
+            $bar=[],
+            $foo,
+            $bar=[],
+            $foo,
+            $bar=[],
+            $listen_ips = [$::ipaddress]
+          ) {}
+
+          define ggg ($foo, $bar=[]) {}
+
+          define long_ggg (
+            $foo,
+            $bar=[],
+            $foo,
+            $bar=[],
+            $foo,
+            $bar=[],
+            $foo,
+            $bar=[]
+          ) {}
+
+          define asdf (
+            $prefix,
+            $pattern,
+            $expire,
+            $port,
+            $prefix,
+            $pattern,
+            $expire,
+            $port
+          ) { }
+        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.3
 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