puppet-lint-manifest_whitespace-check 0.0.1 → 0.1.6

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+PuppetLint.new_check(:manifest_whitespace_opening_bracket_before) do
+  def check
+    tokens.select { |token| token.type == :LBRACK }.each do |bracket_token|
+      prev_token = bracket_token.prev_token
+      prev_code_token = prev_non_space_token(bracket_token)
+
+      next unless prev_token && prev_code_token
+      next if %i[LBRACK LBRACE COMMA SEMIC].include?(prev_code_token.type)
+      next unless %i[WHITESPACE NEWLINE INDENT].include?(prev_token.type)
+      next unless tokens.index(prev_code_token) != tokens.index(bracket_token) - 2 ||
+                  !is_single_space(prev_token)
+
+      notify(
+        :error,
+        message: 'there should be a single space before an opening bracket',
+        line: bracket_token.line,
+        column: bracket_token.column,
+        token: bracket_token,
+      )
+    end
+  end
+
+  def fix(problem)
+    token = problem[:token]
+    prev_token = token.prev_token
+    prev_code_token = prev_non_space_token(token)
+
+    while prev_code_token != prev_token
+      unless %i[WHITESPACE INDENT NEWLINE].include?(prev_token.type)
+        raise PuppetLint::NoFix
+      end
+
+      remove_token(prev_token)
+      prev_token = prev_token.prev_token
+    end
+
+    add_token(tokens.index(token), new_single_space)
+  end
+end
+
+PuppetLint.new_check(:manifest_whitespace_opening_bracket_after) do
+  def check
+    tokens.select { |token| token.type == :LBRACK }.each do |bracket_token|
+      next_token = bracket_token.next_token
+
+      next unless next_token
+      next unless %i[WHITESPACE NEWLINE INDENT].include?(next_token.type)
+
+      if next_token.type == :NEWLINE
+        next_token = next_token.next_token
+        next if next_token.type != :NEWLINE
+      end
+
+      notify(
+        :error,
+        message: 'there should be no whitespace or a single newline after an opening bracket',
+        line: next_token.line,
+        column: next_token.column,
+        token: next_token,
+      )
+    end
+  end
+
+  def fix(problem)
+    token = problem[:token]
+
+    if token.type == :WHITESPACE
+      remove_token(token)
+      return
+    end
+
+    while token.next_token.type == :NEWLINE || (token.next_token.type == :INDENT && token.next_token.next_token.type != :NEWLINE)
+      remove_token(token)
+      token = token.next_token
+    end
+  end
+end

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

@@ -7,3 +7,19 @@ end
 def new_single_space
   PuppetLint::Lexer::Token.new(:WHITESPACE, ' ', 0, 0)
 end
+
+def after_bracket_tokens
+  %i[RBRACE RBRACK RPAREN SEMIC COMMA COLON NEWLINE DQPOST LBRACK]
+end
+
+def prev_non_space_token(token)
+  while token = token.prev_token
+    return token unless %i[WHITESPACE INDENT NEWLINE].include?(token.type)
+  end
+end
+
+def next_non_space_token(token)
+  while token = token.next_token
+    return token unless %i[WHITESPACE INDENT NEWLINE].include?(token.type)
+  end
+end

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

@@ -69,9 +69,9 @@ describe 'manifest_whitespace_class_name_single_space_before' do
 end
 
 describe 'manifest_whitespace_class_name_single_space_after' do
-  let(:single_space_msg) { 'there should be a single space between the class or resource name and the first bracket' }
+  let(:single_space_msg) { 'there should be a single space between the class or resource name and the first brace' }
 
-  context 'with no spaces' do
+  context 'with parameters and no spaces' do
     let(:code) do
       <<~EOF
         # example
@@ -79,7 +79,9 @@ describe 'manifest_whitespace_class_name_single_space_after' do
         # Main class, includes all other classes.
         #
 
-        class example{
+        class myclass(
+          $param1,
+        ) {
           class  { 'example2':
             param1 => 'value1',
           }
@@ -122,7 +124,9 @@ describe 'manifest_whitespace_class_name_single_space_after' do
             # Main class, includes all other classes.
             #
 
-            class example {
+            class myclass (
+              $param1,
+            ) {
               class  { 'example2':
                 param1 => 'value1',
               }
@@ -133,7 +137,7 @@ describe 'manifest_whitespace_class_name_single_space_after' do
     end
   end
 
-  context 'with two spaces' do
+  context 'with scope and no spaces' do
     let(:code) do
       <<~EOF
         # example
@@ -141,7 +145,7 @@ describe 'manifest_whitespace_class_name_single_space_after' do
         # Main class, includes all other classes.
         #
 
-        class example  {
+        class mymodule::example{
           class  { 'example2':
             param1 => 'value1',
           }
@@ -155,7 +159,7 @@ describe 'manifest_whitespace_class_name_single_space_after' do
       end
 
       it 'should create a error' do
-        expect(problems).to contain_error(single_space_msg).on_line(6).in_column(14)
+        expect(problems).to contain_error(single_space_msg).on_line(6).in_column(24)
       end
     end
 
@@ -176,7 +180,7 @@ describe 'manifest_whitespace_class_name_single_space_after' do
         expect(problems).to contain_fixed(single_space_msg)
       end
 
-      it 'should fix the space' do
+      it 'should fix the newline' do
         expect(manifest).to eq(
           <<~EOF,
             # example
@@ -184,7 +188,7 @@ describe 'manifest_whitespace_class_name_single_space_after' do
             # Main class, includes all other classes.
             #
 
-            class example {
+            class mymodule::example {
               class  { 'example2':
                 param1 => 'value1',
               }
@@ -195,7 +199,7 @@ describe 'manifest_whitespace_class_name_single_space_after' do
     end
   end
 
-  context 'with newline' do
+  context 'with no spaces' do
     let(:code) do
       <<~EOF
         # example
@@ -203,10 +207,7 @@ describe 'manifest_whitespace_class_name_single_space_after' do
         # Main class, includes all other classes.
         #
 
-        class example
-
-
-          {
+        class example{
           class  { 'example2':
             param1 => 'value1',
           }
@@ -260,7 +261,7 @@ describe 'manifest_whitespace_class_name_single_space_after' do
     end
   end
 
-  context 'with comment' do
+  context 'with two spaces' do
     let(:code) do
       <<~EOF
         # example
@@ -268,8 +269,7 @@ describe 'manifest_whitespace_class_name_single_space_after' do
         # Main class, includes all other classes.
         #
 
-        class example # the class
-        {
+        class example  {
           class  { 'example2':
             param1 => 'value1',
           }
@@ -300,62 +300,11 @@ describe 'manifest_whitespace_class_name_single_space_after' do
         expect(problems).to have(1).problem
       end
 
-      it 'should not fix the manifest' do
-        expect(problems).to contain_error(single_space_msg).on_line(6).in_column(14)
-      end
-    end
-  end
-end
-
-describe 'manifest_whitespace_class_opening_curly_brace' do
-  let(:opening_curly_brace_same_line_msg) { 'there should be a single space before the opening curly bracket of a class body' }
-
-  context 'with no spaces' do
-    let(:code) do
-      <<~EOF
-        # example
-        #
-        # Main class, includes all other classes.
-        #
-
-        class example (
-          String $content,
-        ){
-          class { 'example2':
-            param1 => 'value1',
-          }
-        }
-      EOF
-    end
-
-    context 'with fix disabled' do
-      it 'should detect a single problem' do
-        expect(problems).to have(1).problem
-      end
-
-      it 'should create a error' do
-        expect(problems).to contain_error(opening_curly_brace_same_line_msg).on_line(8).in_column(2)
-      end
-    end
-
-    context 'with fix enabled' do
-      before do
-        PuppetLint.configuration.fix = true
-      end
-
-      after do
-        PuppetLint.configuration.fix = false
-      end
-
-      it 'should detect a single problem' do
-        expect(problems).to have(1).problem
-      end
-
-      it 'should create a error' do
-        expect(problems).to contain_fixed(opening_curly_brace_same_line_msg)
+      it 'should fix the manifest' do
+        expect(problems).to contain_fixed(single_space_msg)
       end
 
-      it 'should add a space' do
+      it 'should fix the space' do
         expect(manifest).to eq(
           <<~EOF,
             # example
@@ -363,10 +312,8 @@ describe 'manifest_whitespace_class_opening_curly_brace' do
             # Main class, includes all other classes.
             #
 
-            class example (
-              String $content,
-            ) {
-              class { 'example2':
+            class example {
+              class  { 'example2':
                 param1 => 'value1',
               }
             }
@@ -376,7 +323,7 @@ describe 'manifest_whitespace_class_opening_curly_brace' do
     end
   end
 
-  context 'with two spaces' do
+  context 'with newline' do
     let(:code) do
       <<~EOF
         # example
@@ -384,77 +331,11 @@ describe 'manifest_whitespace_class_opening_curly_brace' do
         # Main class, includes all other classes.
         #
 
-        class example (
-          String $content,
-        )  {
-          class { 'example2':
-            param1 => 'value1',
-          }
-        }
-      EOF
-    end
-
-    context 'with fix disabled' do
-      it 'should detect a single problem' do
-        expect(problems).to have(1).problem
-      end
-
-      it 'should create a error' do
-        expect(problems).to contain_error(opening_curly_brace_same_line_msg).on_line(8).in_column(4)
-      end
-    end
-
-    context 'with fix enabled' do
-      before do
-        PuppetLint.configuration.fix = true
-      end
-
-      after do
-        PuppetLint.configuration.fix = false
-      end
-
-      it 'should detect a single problem' do
-        expect(problems).to have(1).problem
-      end
-
-      it 'should create a error' do
-        expect(problems).to contain_fixed(opening_curly_brace_same_line_msg)
-      end
-
-      it 'should remove a space' do
-        expect(manifest).to eq(
-          <<~EOF,
-            # example
-            #
-            # Main class, includes all other classes.
-            #
-
-            class example (
-              String $content,
-            ) {
-              class { 'example2':
-                param1 => 'value1',
-              }
-            }
-          EOF
-        )
-      end
-    end
-  end
+        class example
 
-  context 'with newline' do
-    let(:code) do
-      <<~EOF
-        # example
-        #
-        # Main class, includes all other classes.
-        #
 
-        class example (
-          String $content,
-        )
-        {
-          class { 'example2':
+          {
+          class  { 'example2':
             param1 => 'value1',
           }
         }
@@ -467,7 +348,7 @@ describe 'manifest_whitespace_class_opening_curly_brace' do
       end
 
       it 'should create a error' do
-        expect(problems).to contain_error(opening_curly_brace_same_line_msg).on_line(9).in_column(1)
+        expect(problems).to contain_error(single_space_msg).on_line(6).in_column(14)
       end
     end
 
@@ -484,8 +365,8 @@ describe 'manifest_whitespace_class_opening_curly_brace' do
         expect(problems).to have(1).problem
       end
 
-      it 'should create a error' do
-        expect(problems).to contain_fixed(opening_curly_brace_same_line_msg)
+      it 'should fix the manifest' do
+        expect(problems).to contain_fixed(single_space_msg)
       end
 
       it 'should fix the newline' do
@@ -496,10 +377,8 @@ describe 'manifest_whitespace_class_opening_curly_brace' do
             # Main class, includes all other classes.
             #
 
-            class example (
-              String $content,
-            ) {
-              class { 'example2':
+            class example {
+              class  { 'example2':
                 param1 => 'value1',
               }
             }
@@ -517,11 +396,9 @@ describe 'manifest_whitespace_class_opening_curly_brace' do
         # Main class, includes all other classes.
         #
 
-        class example (
-          String $content,
-        ) # the class
+        class example # the class
         {
-          class { 'example2':
+          class  { 'example2':
             param1 => 'value1',
           }
         }
@@ -534,7 +411,7 @@ describe 'manifest_whitespace_class_opening_curly_brace' do
       end
 
       it 'should create a error' do
-        expect(problems).to contain_error(opening_curly_brace_same_line_msg).on_line(9).in_column(1)
+        expect(problems).to contain_error(single_space_msg).on_line(6).in_column(14)
       end
     end
 
@@ -552,7 +429,7 @@ describe 'manifest_whitespace_class_opening_curly_brace' do
       end
 
       it 'should not fix the manifest' do
-        expect(problems).to contain_error(opening_curly_brace_same_line_msg).on_line(9).in_column(1)
+        expect(problems).to contain_error(single_space_msg).on_line(6).in_column(14)
       end
     end
   end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'manifest_whitespace_inherits_name_single_space_before' do
+  let(:single_space_msg) { 'there should be a single space between the inherits statement and the name' }
+
+  context 'with two spaces' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class example inherits  other::example {
+          class { 'example2':
+            param1 => 'value1',
+          }
+        }
+      EOF
+    end
+
+    context 'with fix disabled' do
+      it 'should detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_error(single_space_msg).on_line(6).in_column(23)
+      end
+    end
+
+    context 'with fix enabled' do
+      before do
+        PuppetLint.configuration.fix = true
+      end
+
+      after do
+        PuppetLint.configuration.fix = false
+      end
+
+      it 'should detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should fix the manifest' do
+        expect(problems).to contain_fixed(single_space_msg)
+      end
+
+      it 'should fix the space' do
+        expect(manifest).to eq(
+          <<~EOF,
+            # example
+            #
+            # Main class, includes all other classes.
+            #
+
+            class example inherits other::example {
+              class { 'example2':
+                param1 => 'value1',
+              }
+            }
+          EOF
+        )
+      end
+    end
+  end
+end