puppet-lint-class_alignment-check 0.2.2 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 353b9e1ee8377e4b5c9c123cb085c1938d8bc0aaac7e1530d1d4196335536bb9
-  data.tar.gz: fe8828f2dbf5c3564d9ac0f85c19600fb50f7ed4c97c4758c8464ca16e579524
+  metadata.gz: a097f4f616f220ca1061819f771b0e9553f89d91f2de912b271026d6a1be2640
+  data.tar.gz: 0db8265872341ec18239a51144d2ec7fd288f71488f1b5bf2174726c17bf279d
 SHA512:
-  metadata.gz: ee8c5781dd514939d0ee515e392fa7e697332b556cf4898ec99fe6eb71b5347c85a8f1de3b270688d821ebbf9ffe621a65da8c14958a89d19b5a828c4a0dc7b0
-  data.tar.gz: a27fcde6ff8fc088fa94bdacb8ac0e40c5b322039f31d7e797e50548c3714679793f3bd6d01df398973277f5a95373b59e0973fa3170d4716a0a08fff7af389d
+  metadata.gz: a5d927d414770af9512912b5ee24eeedfafbfb1987984f0ad5806e6950c1f9efc56ed542114bb1933eb9920f4fbc9367ef9f9233c2ec6c20ed170857e204010b
+  data.tar.gz: 2dfa0a335795a1d5b21a35b9e68a01fcc19a2ef77efaa50a91c2460e12a7cae7e3fde92d772aa4fbc7f285bafbf5ceb98b62a7c146eb6cd140d9a748cdc02b97

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

@@ -0,0 +1,195 @@
+# 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_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)
+  # 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)
+  raise PuppetLint::NoFix if problem[:newline]
+
+  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)
+
+  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_equals_alignment_spec.rb

@@ -241,13 +241,12 @@ describe 'class_equals_alignment' do
         END
       end
 
-      it 'should detect 2 problems' do
-        expect(problems).to have(2).problems
+      it 'should detect 1 problem' do
+        expect(problems).to have(1).problems
       end
 
-      it 'should create 2 warnings' do
+      it 'should create 1 warning' do
         expect(problems).to contain_warning(format(msg, 18, 16)).on_line(2).in_column(16)
-        expect(problems).to contain_warning(format(msg, 18, 29)).on_line(2).in_column(29)
       end
     end
   end
@@ -424,23 +423,21 @@ describe 'class_equals_alignment' do
       let(:fixed) do
         <<-END
           class test (
-            $a   = 'foo',
-            $bb  = 'bar',
+            $a   = 'foo', $bb = 'bar',
             $ccc = 'baz',
           ) {}
         END
       end
 
-      it 'should detect 2 problems' do
-        expect(problems).to have(2).problems
+      it 'should detect 1 problem' do
+        expect(problems).to have(1).problems
       end
 
-      it 'should fix 2 problems' do
+      it 'should fix 1 problem' do
         expect(problems).to contain_fixed(format(msg, 18, 16)).on_line(2).in_column(16)
-        expect(problems).to contain_fixed(format(msg, 18, 29)).on_line(2).in_column(29)
       end
 
-      it 'should move the extra param onto its own line and realign' do
+      it 'should not move the extra param onto its own line and realign' do
         expect(manifest).to eq(fixed)
       end
     end
@@ -458,24 +455,21 @@ describe 'class_equals_alignment' do
       let(:fixed) do
         <<-END
           class test (
-            $a     = 'foo',
-            $bbccc = 'bar',
-            $ccc   = 'baz',
+            $a   = 'foo', $bbccc = 'bar',
+            $ccc = 'baz',
           ) {}
         END
       end
 
-      it 'should detect 2 problems' do
-        expect(problems).to have(3).problems
+      it 'should detect 1 problem' do
+        expect(problems).to have(1).problems
       end
 
-      it 'should fix 2 problems' do
-        expect(problems).to contain_fixed(format(msg, 20, 16)).on_line(2).in_column(16)
-        expect(problems).to contain_fixed(format(msg, 20, 32)).on_line(2).in_column(32)
-        expect(problems).to contain_fixed(format(msg, 20, 18)).on_line(3).in_column(18)
+      it 'should fix 1 problem' do
+        expect(problems).to contain_fixed(format(msg, 18, 16)).on_line(2).in_column(16)
       end
 
-      it 'should move the extra param onto its own line and realign' do
+      it 'should not move the extra param onto its own line and realign' do
         expect(manifest).to eq(fixed)
       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.2
+  version: 0.2.5
 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