puppet-lint-class_alignment-check 0.3.3 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dc0a012b0d80156eaad90609fb62d8f32d580d6acbc5f28e6981d71137fc301
-  data.tar.gz: 72378622329307ce0c0631caebec4fef365fe137b89581bfd01bae1e8bad9537
+  metadata.gz: 4cfe3bc16f68ebdeb6b63a01f2bdefdba07052baa618e1090b25c23ea133a1b6
+  data.tar.gz: b75630c6a6c37634f011ad13fe6147bf3c12753780a5f417ba074bbc1a05aedb
 SHA512:
-  metadata.gz: f7750b39ff5ef57ec5fca519a77e1aa0a1b0def9d906814c4c6b2cf096229a8cde51bc75d796e174c4f351e3fe17f4a5baeb79b3649d468e255f88433d3691a2
-  data.tar.gz: 79e3897e36b000f944ebe5d90bbdd671215e2fe94d4a6956a3ddd258fbced0ec4ecd5c8bee7e94b9a69fbc1df88fff411b87872f74babce420f870fc3ac84339
+  metadata.gz: 465e680a7fc27debc8fbd2243ed8c68deae99d405ba5e82cc42aef2716f9865b198120f756cd815149b1fc43309a784b08e4662d2a49407a70d49b048ea2adf7
+  data.tar.gz: 467601075b7fd04ccee1b490809ff719f3a8129141a9afe03c93f2744b412cba0a8fcc6b2c54aeedc12358586d608ca0653cd6bcfa8929ccca8423192e1f482a

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

@@ -3,84 +3,6 @@
 #
 # https://puppet.com/docs/puppet/7/style_guide.html#style_guide_classes-param-indentation-alignment
 
-def a_param?(token)
-  if token&.prev_code_token&.type == :EQUALS
-    false
-  elsif token&.prev_code_token&.type == :FARROW
-    false
-  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
-
-def first_on_the_line?(token, type)
-  origin = token
-  while token&.prev_token
-    token = token.prev_token
-
-    break if token.type == :NEWLINE
-  end
-
-  while token&.next_token
-    token = token.next_token
-
-    break if token.type == type
-  end
-
-  origin == token
-end
-
-def the_one?(token, character)
-  case character
-  when '='
-    true if token.type == :EQUALS && first_on_the_line?(token, :EQUALS)
-  when '$'
-    true if a_param?(token) && first_on_the_line?(token, :VARIABLE)
-  end
-end
-
-def get_the_first_param(token)
-  while token&.prev_code_token
-    token = token.prev_code_token
-    break if token.type == :CLASS
-  end
-
-  while token&.next_code_token
-    token = token.next_code_token
-    return token if token.type == :VARIABLE
-  end
-end
-
-def get_prev_code_token(token, character)
-  case character
-  when '='
-    token.prev_code_token
-  when '$'
-    if token.prev_code_token
-      if %i[CLASSREF RBRACK].include?(token.prev_code_token.type)
-        token.prev_code_token
-      elsif token.prev_code_token.type == :LPAREN
-        token
-      elsif token.prev_code_token.type == :COMMA
-        get_the_first_param(token)
-      end
-    end
-  end
-end
-
 # This function is copied & modified from puppet-lint arrow_alignment check
 # https://github.com/puppetlabs/puppet-lint/blob/020143b705b023946739eb44e7c7d99fcd087527/lib/puppet-lint/plugins/check_whitespace/arrow_alignment.rb#L8
 def check_for(character)

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

@@ -0,0 +1,128 @@
+def a_param?(token)
+  if token&.prev_code_token&.type == :EQUALS
+    false
+  elsif token&.prev_code_token&.type == :FARROW
+    false
+  elsif %i[DQPRE DQMID].include?(token&.prev_code_token&.type)
+    false
+  elsif token&.type == :VARIABLE
+    # first var in the class
+    return true if token&.prev_token_of(:CLASS)&.next_token_of(:LPAREN)&.next_token_of(:VARIABLE) == token
+    return true if token&.prev_token_of(:DEFINE)&.next_token_of(:LPAREN)&.next_token_of(:VARIABLE) == token
+
+    count = 0
+    saw_a_comma = false
+    while token&.prev_token
+      token = token.prev_token
+
+      saw_a_comma = true if token.type == :COMMA
+
+      return false if token.type == :EQUALS && count == 0 && saw_a_comma == false
+
+      if %i[RPAREN RBRACK RBRACE].include?(token.type)
+        count -= 1
+      elsif %i[LPAREN LBRACK LBRACE].include?(token.type)
+        count += 1
+      end
+
+      break if %i[CLASS DEFINE].include?(token.type)
+    end
+
+    true if count == 1
+  end
+end
+
+def first_on_the_line?(token, type)
+  origin = token
+  while token&.prev_token
+    token = token.prev_token
+
+    break if token.type == :NEWLINE
+  end
+
+  while token&.next_token
+    token = token.next_token
+
+    break if token.type == type
+  end
+
+  origin == token
+end
+
+def the_one?(token, character)
+  case character
+  when '='
+    true if token.type == :EQUALS && first_on_the_line?(token, :EQUALS)
+  when '$'
+    true if a_param?(token) && first_on_the_line?(token, :VARIABLE)
+  end
+end
+
+def get_the_first_param(token)
+  while token&.prev_code_token
+    token = token.prev_code_token
+    break if token.type == :CLASS
+  end
+
+  while token&.next_code_token
+    token = token.next_code_token
+    return token if token.type == :VARIABLE
+  end
+end
+
+def get_prev_code_token(token, character)
+  case character
+  when '='
+    token.prev_code_token
+  when '$'
+    if token.prev_code_token
+      if %i[CLASSREF RBRACK].include?(token.prev_code_token.type)
+        token.prev_code_token
+      elsif token.prev_code_token.type == :LPAREN
+        token
+      elsif token.prev_code_token.type == :COMMA
+        get_the_first_param(token)
+      end
+    end
+  end
+end
+
+def get_param_start_token(token)
+  return nil unless a_param?(token)
+
+  case token&.prev_code_token&.type
+
+  # Integer $db_port
+  when :TYPE
+    token.prev_code_token
+
+  when :CLASSREF
+    token.prev_code_token
+
+  # Variant[Undef, Enum['UNSET'], Stdlib::Port] $db_port
+  when :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.prev_code_token
+
+  else
+    token
+  end
+end
+
+def get_prev_param_token(token)
+  while token&.prev_code_token
+    token = token.prev_code_token
+    return token if a_param?(token)
+  end
+end

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

@@ -1,11 +1,3 @@
-def prev_param_token(token)
-  while token&.prev_code_token
-    token = token.prev_code_token
-    break if a_param?(token)
-  end
-  token
-end
-
 PuppetLint.new_check(:class_params_newline) do
   def check
     (class_indexes + defined_type_indexes).each do |item|
@@ -45,13 +37,12 @@ PuppetLint.new_check(:class_params_newline) do
 
         next unless a_param?(token)
 
-        if token.prev_code_token.type == :LPAREN
-          next if token.line != token.prev_code_token.line
-        elsif token.line != prev_param_token(token).line
+        if get_param_start_token(token)&.prev_code_token.type == :LPAREN
+          next if token.line != get_param_start_token(token).prev_code_token.line
+        elsif token.line != get_prev_param_token(token)&.line
           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})",
@@ -67,28 +58,7 @@ PuppetLint.new_check(:class_params_newline) do
 
   def fix(problem)
     token = problem[:token]
-    if token.type == :VARIABLE
-      # Integer $db_port
-      if token&.prev_code_token&.type == :TYPE
-        token = token.prev_code_token
-
-      # 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
-    end
+    token = get_param_start_token(token) if token.type == :VARIABLE
 
     last_non_whitespace_token = token.prev_token
     while last_non_whitespace_token&.prev_token

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

@@ -101,7 +101,7 @@ describe 'class_params_newline' do
           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 aaa ( Integer $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, ) {}
@@ -123,6 +123,17 @@ describe 'class_params_newline' do
           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) { }
+
+          class aaa (
+            $aaa = func('bbb', $ccc), $bar = $a, $foo = 1, $bar = $a,
+          ) {}
+
+          class name (
+            Boolean             $foo,
+            Optional[String[1]] $bar,
+          ) { }
         END
       end
 
@@ -150,7 +161,7 @@ describe 'class_params_newline' do
 
           class aaa ( $foo = 1, $bar = $a,) {}
           class aaa (
-            $foo = 1,
+            Integer $foo = 1,
             $bar = $a,
             $foo = 1,
             $bar = $a,
@@ -212,6 +223,29 @@ describe 'class_params_newline' do
             $expire,
             $port
           ) { }
+
+          define asdf (
+            $prefix,
+            $pattern,
+            $expire,
+            $port,
+            $prefix,
+            $pattern=$a and $b,
+            $epe=-$foo,
+            $port=!$foo
+          ) { }
+
+          class aaa (
+            $aaa = func('bbb', $ccc),
+            $bar = $a,
+            $foo = 1,
+            $bar = $a,
+          ) {}
+
+          class name (
+            Boolean             $foo,
+            Optional[String[1]] $bar,
+          ) { }
         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.3
+  version: 0.3.6
 platform: ruby
 authors:
 - Anh Pham
@@ -123,6 +123,7 @@ files:
 - LICENSE
 - README.md
 - lib/puppet-lint/plugins/check_class_alignment.rb
+- lib/puppet-lint/plugins/check_class_helper.rb
 - lib/puppet-lint/plugins/check_class_params_newline.rb
 - spec/puppet-lint/plugins/check_class_equals_alignment_spec.rb
 - spec/puppet-lint/plugins/check_class_params_alignment_spec.rb