puppet-lint-class_alignment-check 0.2.1 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18b240ab501b4b7b3df88cccc451fd7cf570b22b2bc5c70cf4495daac950e6d2
-  data.tar.gz: bf133208d3fa0499e5c1aa0cca581ff56d4e891f321a67f545ba2f38bb8ba636
+  metadata.gz: ebf0e96bee2765a17143585f49c445c388612b1563ac6ec54513ee39989013ef
+  data.tar.gz: 95d3539f4c25fd584610774c695394fb43b17ebb3881e0e73976f0a337eb6a57
 SHA512:
-  metadata.gz: 76cc6f189d4a0732fb5d881567054132a6e9f357008c69c8f389c35545c50e3f05a36a94b0b5771b0258c3a35fa3d79f777072af2118a476d9606ce30d45a27a
-  data.tar.gz: 5c1a7e5dac5d5ae57196e523e0a1d15c81d7831899b6d201b81d2f8ce7828567b4aa67a6abf2795c1d1a322ef794ed0e4362d0d138b9847c5e8ca3fe6d0550e7
+  metadata.gz: 374133ecbc4fa790491148cc2f62bbe630584891a10df2d3cffec9ce289b2b63ab8bdd6fcd43477735f25fe52e246535017af0f59d27b75f60bd9bf3714bff3c
+  data.tar.gz: d98666d602b2d846c5ad815d6f06b1dd15fa29ef7c896f6b507217d14e54f5536202aaef80127fc6b900b4ecd05b5183214641e55e45ae27a45dd7f28b0ba856

data/README.md

@@ -2,6 +2,7 @@
 
 [![License](https://img.shields.io/github/license/anhpt379/puppet-lint-class_alignment-check.svg)](https://github.com/anhpt379/puppet-lint-class_alignment-check/blob/master/LICENSE)
 [![Test](https://github.com/anhpt379/puppet-lint-class_alignment-check/actions/workflows/test.yml/badge.svg)](https://github.com/anhpt379/puppet-lint-class_alignment-check/actions/workflows/test.yml)
+[![Release](https://github.com/anhpt379/puppet-lint-class_alignment-check/actions/workflows/release.yml/badge.svg)](https://github.com/anhpt379/puppet-lint-class_alignment-check/actions/workflows/release.yml)
 [![codecov](https://codecov.io/gh/anhpt379/puppet-lint-class_alignment-check/branch/master/graph/badge.svg?token=2DI8JYJ8AZ)](https://codecov.io/gh/anhpt379/puppet-lint-class_alignment-check)
 [![RubyGem Version](https://img.shields.io/gem/v/puppet-lint-class_alignment-check.svg)](https://rubygems.org/gems/puppet-lint-class_alignment-check)
 [![RubyGem Downloads](https://img.shields.io/gem/dt/puppet-lint-class_alignment-check.svg)](https://rubygems.org/gems/puppet-lint-class_alignment-check)

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

@@ -0,0 +1,211 @@
+# Parameters to classes or defined types must be uniformly indented in two
+# spaces from the title. The equals sign should be aligned.
+#
+# 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_param_on_the_line?(token)
+  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 == :VARIABLE
+  end
+
+  origin == token
+end
+
+def the_one?(token, character)
+  case character
+  when '='
+    true if token.type == :EQUALS
+  when '$'
+    true if token.type == :VARIABLE && a_param?(token) && first_param_on_the_line?(token)
+  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)
+  # I intentionally didn't rename `arrow` to another name, to keep the code as
+  # similar as the original one, to easier to update in the future.
+  (class_indexes + defined_type_indexes).each do |res_idx|
+    arrow_column = [0]
+    level_idx = 0
+    level_tokens = []
+    param_column = [nil]
+    resource_tokens = res_idx[:param_tokens]
+    next if resource_tokens.nil?
+
+    resource_tokens.reject! do |token|
+      COMMENT_TYPES.include?(token.type)
+    end
+
+    # If this is a single line resource, skip it
+    first_arrow = resource_tokens.index { |r| the_one?(r, character) }
+    last_arrow = resource_tokens.rindex { |r| the_one?(r, character) }
+    next if first_arrow.nil?
+    next if last_arrow.nil?
+    next if resource_tokens[first_arrow].line == resource_tokens[last_arrow].line
+
+    resource_tokens.each do |token|
+      if the_one?(token, character)
+        param_token = get_prev_code_token(token, character)
+        param_token = token if param_token.nil?
+
+        param_length = param_token.to_manifest.length
+
+        param_column[level_idx] = param_token.column if param_column[level_idx].nil?
+
+        if (level_tokens[level_idx] ||= []).any? { |t| t.line == token.line }
+          this_arrow_column = param_column[level_idx] + param_length + 1
+        elsif character == '$' && param_token.type == :VARIABLE
+          this_arrow_column = param_token.column
+        else
+          this_arrow_column = param_token.column + param_token.to_manifest.length
+          this_arrow_column += 1 if param_token.type != :INDENT
+        end
+
+        arrow_column[level_idx] = this_arrow_column if arrow_column[level_idx] < this_arrow_column
+
+        (level_tokens[level_idx] ||= []) << token
+      elsif token == resource_tokens[0]
+        level_idx += 1
+        arrow_column << 0
+        level_tokens[level_idx] ||= []
+        param_column << nil
+      elsif token == resource_tokens[-1]
+        if (level_tokens[level_idx] ||= []).map(&:line).uniq.length > 1
+          level_tokens[level_idx].each do |arrow_tok|
+            next if arrow_tok.column == arrow_column[level_idx] || level_tokens[level_idx].size == 1
+
+            arrows_on_line = level_tokens[level_idx].select { |t| t.line == arrow_tok.line }
+            notify(
+              :warning,
+              message: "indentation of #{character} is not properly aligned (expected in column #{arrow_column[level_idx]}, but found it in column #{arrow_tok.column})",
+              line: arrow_tok.line,
+              column: arrow_tok.column,
+              token: arrow_tok,
+              arrow_column: arrow_column[level_idx],
+              newline: arrows_on_line.index(arrow_tok) != 0,
+              newline_indent: param_column[level_idx] - 1
+            )
+          end
+        end
+        arrow_column[level_idx] = 0
+        level_tokens[level_idx].clear
+        param_column[level_idx] = nil
+        level_idx -= 1
+      end
+    end
+  end
+end
+
+# This function is copied & modified from puppet-lint arrow_alignment fix
+# https://github.com/puppetlabs/puppet-lint/blob/020143b705b023946739eb44e7c7d99fcd087527/lib/puppet-lint/plugins/check_whitespace/arrow_alignment.rb#L94
+def fix_for(problem)
+  if problem[:newline]
+    index = tokens.index(problem[:token].prev_code_token.prev_token)
+
+    # insert newline
+    tokens.insert(index, PuppetLint::Lexer::Token.new(:NEWLINE, "\n", 0, 0))
+
+    # indent the parameter to the correct depth
+    problem[:token].prev_code_token.prev_token.type = :INDENT
+    problem[:token].prev_code_token.prev_token.value = ' ' * problem[:newline_indent]
+
+    end_param_idx = tokens.index(problem[:token].prev_code_token)
+    start_param_idx = tokens.index(problem[:token].prev_token_of(%i[INDENT NEWLINE]))
+    param_length = tokens[start_param_idx..end_param_idx].map do |r|
+                     r.to_manifest.length
+                   end.reduce(0) { |sum, x| sum + x } + 1
+    new_ws_len = problem[:arrow_column] - param_length
+  else
+    new_ws_len = if problem[:token].prev_token.type == :WHITESPACE
+                   problem[:token].prev_token.to_manifest.length
+                 else
+                   0
+                 end
+    new_ws_len += (problem[:arrow_column] - problem[:token].column)
+  end
+
+  if new_ws_len.negative?
+    raise PuppetLint::NoFix if problem[:token].prev_token.type != :INDENT
+
+    new_ws = problem[:token].prev_token.to_manifest[0...new_ws_len]
+    problem[:token].prev_token.value = new_ws
+  else
+    new_ws = ' ' * new_ws_len
+
+    if problem[:token].prev_token.type == :WHITESPACE
+      problem[:token].prev_token.value = new_ws
+    else
+      index = tokens.index(problem[:token].prev_token)
+      tokens.insert(index + 1, PuppetLint::Lexer::Token.new(:WHITESPACE, new_ws, 0, 0))
+    end
+  end
+end
+
+PuppetLint.new_check(:class_params_alignment) do
+  def check
+    check_for('$')
+  end
+
+  def fix(problem)
+    fix_for(problem)
+  end
+end
+
+PuppetLint.new_check(:class_equals_alignment) do
+  def check
+    check_for('=')
+  end
+
+  def fix(problem)
+    fix_for(problem)
+  end
+end

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

@@ -280,7 +280,7 @@ describe 'class_params_alignment' do
         <<-END
           class name (
             $aaa = function('foo', 'bar'),
-            $bbb = function('foo', 'bar'),
+              $bbb = function('foo', 'bar'),
             Boolean $key1 = false,
             Enum['never', 'allow', 'try', 'demand'] $key2,
           $materializer_version = $foo ? {
@@ -308,7 +308,7 @@ describe 'class_params_alignment' do
 
       it 'should fix 4 problems' do
         expect(problems).to contain_fixed(format(msg, 53, 13)).on_line(2).in_column(13)
-        expect(problems).to contain_fixed(format(msg, 53, 13)).on_line(3).in_column(13)
+        expect(problems).to contain_fixed(format(msg, 53, 15)).on_line(3).in_column(15)
         expect(problems).to contain_fixed(format(msg, 53, 21)).on_line(4).in_column(21)
         expect(problems).to contain_fixed(format(msg, 53, 11)).on_line(6).in_column(11)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-class_alignment-check
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.4
 platform: ruby
 authors:
 - Anh Pham
@@ -122,6 +122,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/puppet-lint/plugins/check_class_alignment.rb
 - spec/puppet-lint/plugins/check_class_equals_alignment_spec.rb
 - spec/puppet-lint/plugins/check_class_params_alignment_spec.rb
 - spec/spec_helper.rb