puppet-lint-class_alignment-check 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0263490e2b13cd13ec0f9cb4e3d569d4a004aa11b6caa63b51c4c0b4cb2a405
-  data.tar.gz: aadc7259538098f01145ff841be78496c2ed04d9c799eb1a8d6d3a25d7df9ada
+  metadata.gz: 40fcbe1d19cc554f3b3a18fd44e8d252f8d4e7b39d5aea1ae14bb108b84d4ed5
+  data.tar.gz: 8909d0c354b917d2516ee7fd29078a2df9523a73b0e50d010eb6d36fb0fcff70
 SHA512:
-  metadata.gz: eb63b8f785be3ee853cab31c262c169acaeafd21100833e467c1ee8ae7cb4921aa8b877e42f8fe4a242dbca0b104c51637bbd9d62cdec9a2c1fc85d190451200
-  data.tar.gz: 49b6920703283013416902bfe3d28c0f57746127d2f20f07d21cd57aa29adc3bda5c6c12486c4639ab9a0997d0010007453e663ccf6fa4fd712eb3dda0e7e696
+  metadata.gz: aa23065a0ab5698aaef52a521279d871c68d594825fdf31cd1820b2e07fa4d7b427c205b2eb3004d79ad54c3a88b18c4ecc1190507ee02610bfa5aaa90e65799
+  data.tar.gz: f606316e9de223a83e1940daf2d5fca115eb6968116fbe7a5983ce43d7538dd368eb2b145becd227f6602260f58b57b5e9110c9cc2dbc6055d2789aa29b2d39c

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

@@ -3,92 +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
-    # 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
-
-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,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|
@@ -47,11 +39,10 @@ PuppetLint.new_check(:class_params_newline) do
 
         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
 
-        # 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})",
@@ -68,12 +59,13 @@ PuppetLint.new_check(:class_params_newline) do
   def fix(problem)
     token = problem[:token]
     if token.type == :VARIABLE
+      case token&.prev_code_token&.type
       # Integer $db_port
-      if token&.prev_code_token&.type == :TYPE
+      when :TYPE
         token = token.prev_code_token
 
       # Variant[Undef, Enum['UNSET'], Stdlib::Port] $db_port
-      elsif token&.prev_code_token&.type == :RBRACK
+      when :RBRACK
         count = 0
         while token&.prev_code_token
           token = token.prev_code_token

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-class_alignment-check
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  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