puppet-lint-class_alignment-check 0.2.5 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a097f4f616f220ca1061819f771b0e9553f89d91f2de912b271026d6a1be2640
-  data.tar.gz: 0db8265872341ec18239a51144d2ec7fd288f71488f1b5bf2174726c17bf279d
+  metadata.gz: d8c9035498fac5688a9587ff1b5eaaf15027974e85ac46c9745419b3cd309319
+  data.tar.gz: c0d6f86ab41d272eb2f2e1883ebd2f9502888a1ba21d592523c8038d1f0dc5a4
 SHA512:
-  metadata.gz: a5d927d414770af9512912b5ee24eeedfafbfb1987984f0ad5806e6950c1f9efc56ed542114bb1933eb9920f4fbc9367ef9f9233c2ec6c20ed170857e204010b
-  data.tar.gz: 2dfa0a335795a1d5b21a35b9e68a01fcc19a2ef77efaa50a91c2460e12a7cae7e3fde92d772aa4fbc7f285bafbf5ceb98b62a7c146eb6cd140d9a748cdc02b97
+  metadata.gz: b1bd3766aa9650219858800d4374434fba8fca275fe905d1734917ddcfb17fe1ff64efb33ffdeaa98ca48ff85feff8242fe45127c2460f6cd752e854d5c18952
+  data.tar.gz: 9d1e88aa315c31b44660589c183f6beca1399a84219a6f6f57ad741fb1eae633d4bd7c92e537c3b6b2c73767cbb0a3f70084040540cbb0681030272bdca5bee6

data/README.md

@@ -11,13 +11,26 @@ A puppet-lint plugin to check and fix class params/equals alignment.
 
 ## Usage
 
-This plugin provides 2 checks for puppet-lint:
+This plugin provides 3 checks for puppet-lint:
 
+- `class_params_newline`
 - `class_params_alignment`
 - `class_equals_alignment`
 
 It supports `--fix` flag.
 
+To properly reformat the code, run `puppet-lint --fix` like this:
+
+```bash
+$ puppet-lint --only-checks class_params_newline --fix .
+$ puppet-lint --only-checks class_params_alignment --fix .
+$ puppet-lint --only-checks class_equals_alignment --fix .
+
+# It's best to combine the above checks with `strict_indent` to fix all remaining issues
+$ puppet-lint --only-checks strict_indent --fix .
+
+```
+
 > Parameters to classes or defined types must be uniformly indented in two
 > spaces from the title. The equals sign should be aligned.
 >

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

@@ -0,0 +1,106 @@
+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]
+
+      tokens.each do |token|
+        if token == tokens[-1]
+          rparen = token
+          while rparen&.next_token
+            rparen = rparen.next_token
+            break if rparen.type == :RPAREN
+          end
+
+          last_code_token = token
+          while last_code_token&.prev_token
+            break unless %i[WHITESPACE INDENT NEWLINE].include?(last_code_token.type)
+
+            last_code_token = last_code_token.prev_token
+          end
+
+          next if rparen.line != last_code_token.line
+
+          notify(
+            :warning,
+            message: "`)` should be in a new line (expected in line #{token.line + 1}, but found it in line #{token.line})",
+            line: rparen.line,
+            column: rparen.column,
+            token: rparen,
+            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
+          next
+        end
+
+        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})",
+          line: token.line,
+          column: token.column,
+          token: token,
+          newline: true,
+          newline_indent: item[:tokens][0].column + 1
+        )
+      end
+    end
+  end
+
+  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
+        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
+
+    index = tokens.index(token.prev_code_token.next_token)
+    tokens.insert(index, PuppetLint::Lexer::Token.new(:NEWLINE, "\n", 0, 0))
+
+    # When there's no space at the beginning of the param
+    # e.g.  class foo($bar="aaa") {}
+    if token.prev_code_token.next_token == token
+      tokens.insert(index + 1, PuppetLint::Lexer::Token.new(:INDENT, ' ' * problem[:newline_indent], 0, 0))
+
+    elsif %i[WHITESPACE INDENT].include?(token.prev_token.type)
+      token.prev_token.value = ' ' * problem[:newline_indent]
+    end
+  end
+end

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

@@ -0,0 +1,144 @@
+require 'spec_helper'
+
+describe 'class_params_newline' do
+  let(:msg) { '`%s` should be in a new line (expected in line %d, but found it in line %d)' }
+
+  context 'with fix disabled' do
+    context 'tidy code' do
+      let(:code) do
+        <<-END
+          class bar(
+                                                        $someparam = 'somevalue',
+                                                        $another,
+            String                                      $nope,
+                                                        $foo,
+            Variant[Undef, Enum['UNSET'], Stdlib::Port] $db_port,
+            # $aaa,
+            String                                      $third     = 'meh',
+            Array[Int, Int]                             $asdf      = 'asdf',
+          ) { }
+        END
+      end
+
+      it 'should detect 0 problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'messy code' do
+      let(:code) do
+        <<-END
+          class bar(                                                        $someparam = 'somevalue',
+            $another, String $nope, $foo,
+            Variant[Undef, Enum['UNSET'], Stdlib::Port] $db_port,
+            # $aaa,
+            String                                              $third     = 'meh', Array[Int, Int] $asdf = 'asdf',
+          ) { }
+        END
+      end
+
+      it 'should detect 4 problems' do
+        expect(problems).to have(4).problems
+      end
+
+      it 'should create four warnings' do
+        expect(problems).to contain_warning(format(msg, '$someparam', 2, 1)).on_line(1).in_column(77)
+        expect(problems).to contain_warning(format(msg, '$nope', 3, 2)).on_line(2).in_column(30)
+        expect(problems).to contain_warning(format(msg, '$foo', 3, 2)).on_line(2).in_column(37)
+        expect(problems).to contain_warning(format(msg, '$asdf', 6, 5)).on_line(5).in_column(101)
+      end
+    end
+  end
+
+  context 'with fix enabled' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    context 'messy code' do
+      let(:code) do
+        <<-END
+          class bar(                                                        $someparam = 'somevalue',
+            $another, String $nope, $foo,
+            Variant[Undef, Enum['UNSET'], Stdlib::Port] $db_port,
+            # $aaa,
+            String                                              $third     = 'meh', Array[Int, Int] $asdf = 'asdf',
+          ) { }
+        END
+      end
+
+      let(:fixed) do
+        <<-END
+          class bar(
+            $someparam = 'somevalue',
+            $another,
+            String $nope,
+            $foo,
+            Variant[Undef, Enum['UNSET'], Stdlib::Port] $db_port,
+            # $aaa,
+            String                                              $third     = 'meh',
+            Array[Int, Int] $asdf = 'asdf',
+          ) { }
+        END
+      end
+
+      it 'should fix the problems' do
+        expect(manifest).to eq(fixed)
+      end
+    end
+
+    context 'in a single line' do
+      let(:code) do
+        <<-END
+          class foo ($foo = 1, $bar = $a) {}
+
+          class bar ($foo = 1, $bar = $a,) {}
+
+          class aaa ( $foo = 1, $bar = $a,) {}
+
+          class bbb ( $foo = 1, $bar = $a, ) {}
+
+          class ccc ($foo = 1) {}
+
+          class ddd {}
+        END
+      end
+
+      let(:fixed) do
+        <<-END
+          class foo (
+            $foo = 1,
+            $bar = $a
+          ) {}
+
+          class bar (
+            $foo = 1,
+            $bar = $a,
+          ) {}
+
+          class aaa (
+            $foo = 1,
+            $bar = $a,
+          ) {}
+
+          class bbb (
+            $foo = 1,
+            $bar = $a,
+          ) {}
+
+          class ccc ($foo = 1) {}
+
+          class ddd {}
+        END
+      end
+
+      it 'should fix the problems' do
+        expect(manifest).to eq(fixed)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-class_alignment-check
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.2
 platform: ruby
 authors:
 - Anh Pham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-08 00:00:00.000000000 Z
+date: 2022-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -123,8 +123,10 @@ files:
 - LICENSE
 - README.md
 - lib/puppet-lint/plugins/check_class_alignment.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
+- spec/puppet-lint/plugins/check_class_params_newline_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/anhpt379/puppet-lint-class_alignment-check
 licenses:
@@ -152,4 +154,5 @@ summary: A puppet-lint plugin to check & fix class params/equals alignment.
 test_files:
 - spec/puppet-lint/plugins/check_class_equals_alignment_spec.rb
 - spec/puppet-lint/plugins/check_class_params_alignment_spec.rb
+- spec/puppet-lint/plugins/check_class_params_newline_spec.rb
 - spec/spec_helper.rb