puppet-lint-class_alignment-check 0.3.1 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e32258dfb55db44ee2f3f0a2057958463c3c5ea2bad429c9bc5d179b772d6a71
-  data.tar.gz: 40ddced7d67f62decc65e9e9b396d2e60b19508aecf40039524c7c635d38fd0f
+  metadata.gz: d0263490e2b13cd13ec0f9cb4e3d569d4a004aa11b6caa63b51c4c0b4cb2a405
+  data.tar.gz: aadc7259538098f01145ff841be78496c2ed04d9c799eb1a8d6d3a25d7df9ada
 SHA512:
-  metadata.gz: 3e6caecc7f1607637a851670b86f258e2e4da20f9c39d900aeb971216ffdade15d5d3e35d3b31094376dae4e57c3b6e5c6aa97da875d340f4dc0a9d63b795229
-  data.tar.gz: 4fc0dd184ce132b65f032a55bd2146cdc11ee8abb7b9457ef5d8dc0e6cd4d242dc88440e0c293da1c726d61bf122a646ffbb3ad5ab478d035a6e37358d8cbfa8
+  metadata.gz: eb63b8f785be3ee853cab31c262c169acaeafd21100833e467c1ee8ae7cb4921aa8b877e42f8fe4a242dbca0b104c51637bbd9d62cdec9a2c1fc85d190451200
+  data.tar.gz: 49b6920703283013416902bfe3d28c0f57746127d2f20f07d21cd57aa29adc3bda5c6c12486c4639ab9a0997d0010007453e663ccf6fa4fd712eb3dda0e7e696

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

@@ -8,8 +8,29 @@ 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
+    # first var in the class
+    if token&.prev_token_of(:CLASS)&.next_token_of(:LPAREN)&.next_token_of(:VARIABLE) == token
+      return true
+    elsif token&.prev_token_of(:DEFINE)&.next_token_of(:LPAREN)&.next_token_of(:VARIABLE) == token
+      return true
+    end
+
+    count = 0
+    while token&.prev_token
+      token = token.prev_token
+      return false if token.type == :EQUALS
+
+      if %i[RPAREN RBRACK RBRACE].include?(token.type)
+        count += 1
+      elsif %i[LPAREN LBRACK LBRACE].include?(token.type)
+        count -= 1
+      end
+
+      return true if count.zero? && token.type == :COMMA
+    end
   end
 end
 

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

@@ -10,22 +10,18 @@ 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
-          while rparen&.next_token
-            rparen = rparen.next_token
-            break if rparen.type == :RPAREN
-          end
+          rparen = token.next_token_of(:RPAREN)
 
           last_code_token = token
           while last_code_token&.prev_token
@@ -45,7 +41,6 @@ PuppetLint.new_check(:class_params_newline) do
             newline: true,
             newline_indent: item[:tokens][0].column - 1
           )
-          break
         end
 
         next unless a_param?(token)
@@ -56,6 +51,7 @@ PuppetLint.new_check(:class_params_newline) do
           next
         end
 
+        # binding.break
         notify(
           :warning,
           message: "`#{token.to_manifest}` should be in a new line (expected in line #{token.line + 1}, but found it in line #{token.line})",
@@ -71,26 +67,37 @@ 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))
 
     # When there's no space at the beginning of the param

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

@@ -95,40 +95,136 @@ describe 'class_params_newline' 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) { }
+
+          define asdf ($prefix, $pattern, $expire, $port, $prefix, $pattern=$a and $b, $epe=-$foo, $port=!$foo) { }
         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
+          ) { }
+
+          define asdf (
+            $prefix,
+            $pattern,
+            $expire,
+            $port,
+            $prefix,
+            $pattern=$a and $b,
+            $epe=-$foo,
+            $port=!$foo
+          ) { }
         END
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-class_alignment-check
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.4
 platform: ruby
 authors:
 - Anh Pham