puppet-lint-class_alignment-check 0.3.2 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8c9035498fac5688a9587ff1b5eaaf15027974e85ac46c9745419b3cd309319
-  data.tar.gz: c0d6f86ab41d272eb2f2e1883ebd2f9502888a1ba21d592523c8038d1f0dc5a4
+  metadata.gz: 40fcbe1d19cc554f3b3a18fd44e8d252f8d4e7b39d5aea1ae14bb108b84d4ed5
+  data.tar.gz: 8909d0c354b917d2516ee7fd29078a2df9523a73b0e50d010eb6d36fb0fcff70
 SHA512:
-  metadata.gz: b1bd3766aa9650219858800d4374434fba8fca275fe905d1734917ddcfb17fe1ff64efb33ffdeaa98ca48ff85feff8242fe45127c2460f6cd752e854d5c18952
-  data.tar.gz: 9d1e88aa315c31b44660589c183f6beca1399a84219a6f6f57ad741fb1eae633d4bd7c92e537c3b6b2c73767cbb0a3f70084040540cbb0681030272bdca5bee6
+  metadata.gz: aa23065a0ab5698aaef52a521279d871c68d594825fdf31cd1820b2e07fa4d7b427c205b2eb3004d79ad54c3a88b18c4ecc1190507ee02610bfa5aaa90e65799
+  data.tar.gz: f606316e9de223a83e1940daf2d5fca115eb6968116fbe7a5983ce43d7538dd368eb2b145becd227f6602260f58b57b5e9110c9cc2dbc6055d2789aa29b2d39c

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

@@ -3,71 +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 token&.type == :VARIABLE && !%i[DQPRE DQMID].include?(token.prev_code_token.type)
-    true
-  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,89 @@
+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
+    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
+
+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_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,32 +1,19 @@
-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|
       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
@@ -46,14 +33,13 @@ PuppetLint.new_check(:class_params_newline) do
             newline: true,
             newline_indent: item[:tokens][0].column - 1
           )
-          break
         end
 
         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
+        elsif token.line != get_prev_param_token(token).line
           next
         end
 
@@ -72,26 +58,38 @@ 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
+      case token&.prev_code_token&.type
+      # Integer $db_port
+      when :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
+      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 = 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,44 +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.2
+  version: 0.3.5
 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