puppet-lint-class_alignment-check 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a097f4f616f220ca1061819f771b0e9553f89d91f2de912b271026d6a1be2640
-  data.tar.gz: 0db8265872341ec18239a51144d2ec7fd288f71488f1b5bf2174726c17bf279d
+  metadata.gz: fe4a55df13a00eb32e3dab657bc0d1dc1e2982851d3992ec1329210b2642ccc5
+  data.tar.gz: 0d227e2da3f0dfa710ee46a11c3a9bd0e6e4fbf05728e96b553ae28a018c305e
 SHA512:
-  metadata.gz: a5d927d414770af9512912b5ee24eeedfafbfb1987984f0ad5806e6950c1f9efc56ed542114bb1933eb9920f4fbc9367ef9f9233c2ec6c20ed170857e204010b
-  data.tar.gz: 2dfa0a335795a1d5b21a35b9e68a01fcc19a2ef77efaa50a91c2460e12a7cae7e3fde92d772aa4fbc7f285bafbf5ceb98b62a7c146eb6cd140d9a748cdc02b97
+  metadata.gz: 4c33eb7910db84735f6baa86e020b604cdc272c18d726c7c53bb34b3995b6ca874fc5da985756df1f34f985cc80385f2477fe571756ff0c8da374ca0e1001de8
+  data.tar.gz: 9d3122d562637f655b4fdb251e59256c3a29a42b6affecf78d26d9618cacacd81d3ae698541d5fda6b0e1aa1350d71807bfbd87b5f55213d671bb7ba0f010a41

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,70 @@
+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]
+
+      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|
+        next unless a_param?(token)
+
+        if token.prev_code_token == :LPAREN
+          next if token.line != token.prev_code_token.line
+        elsif token.line != prev_param_token(token).line
+          next
+        end
+
+        notify(
+          :warning,
+          message: "Parameter #{token.to_manifest} should have its own 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))
+
+    token.prev_token.value = ' ' * problem[:newline_indent] if %i[WHITESPACE INDENT].include?(token.prev_token.type)
+  end
+end

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

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe 'class_params_newline' do
+  let(:msg) { 'Parameter %s should have its own 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
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-class_alignment-check
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Anh Pham
@@ -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