puppet-lint-manifest_whitespace-check 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bdb4da2f82834a517b3f17c513548157e9b09e316dc1ef23ce29f0deabd0874
-  data.tar.gz: cfea1846383662116b388a3257708cf9e1c441c0c9eae86df6c4982442a062bc
+  metadata.gz: d6c95fdd92713473387e0cb780ba993b73aac14c1b8a31ac3605cb211cb34413
+  data.tar.gz: 51b93e74f8b2ce71082873f4023efabc673fd8a6144710341695efdc80c102cc
 SHA512:
-  metadata.gz: 895dd3bc23d6deb63a6a1e9837dec0ae2ab735859ac50ecc6e5d93d1a594f5b6709a53f2b139e291e0ec82a27e1b71eaf158dd278ec2b773e671275e4ba0acff
-  data.tar.gz: 8c1fed89f0a3e49872288f298a36847b561a4a0aaacee85aa0b30673c3ac4aceb92a4e9ee59f32a00a88965f5d51a0cae7ee793a5fc287fa6a4613f26de620fc
+  metadata.gz: 1940d7236fab0350b6cf217c41a88228f50de795f8e68ca3b3d0da03289578fc83ffc4708c86d37ffd71f9c8b0b254be75121c6c311e43aef7d4acfc89950170
+  data.tar.gz: e5cb33fa8ee74bb757fcab7cb333090b3e9770e909274ce313a51e5e1a382c60799893235f8a40d31fac1b21cf9c39b6ba4479765f75bd92e0a2563dc9e47bf9

data/README.md

@@ -21,7 +21,7 @@ This plugin provides a number of new checks to `puppet-lint`.
 
 ### manifest_whitespace_class_opening_curly_brace
 
-> There should be a single space before the opening curly bracket of a class body.
+> There should be a single space before the opening curly brace of a class body.
 
 Good examples:
 
@@ -113,7 +113,7 @@ class  myclass (
 
 ### manifest_whitespace_class_name_single_space_after
 
-> There should be a single space between the class or resource name and the first bracket.
+> There should be a single space between the class or resource name and the first brace.
 
 Good examples:
 

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

@@ -3,7 +3,7 @@
 PuppetLint.new_check(:manifest_whitespace_inherits_name_single_space_before) do
   def check
     tokens.select { |token| token.type == :INHERITS }.each do |inherits_token|
-      name_token = inherits_token.next_token_of(:NAME)
+      name_token = inherits_token.next_token_of(%i[NAME FUNCTION_NAME])
       next unless name_token
 
       next_token = inherits_token.next_token
@@ -30,17 +30,17 @@ end
 PuppetLint.new_check(:manifest_whitespace_inherits_name_single_space_after) do
   def check
     tokens.select { |token| token.type == :INHERITS }.each do |inherits_token|
-      name_token = inherits_token.next_token_of(:NAME)
+      name_token = inherits_token.next_token_of(%i[NAME FUNCTION_NAME])
       next unless name_token
 
       next_token = name_token.next_token
-      bracket_token = name_token.next_token_of(%i[LPAREN LBRACE])
-      next unless tokens.index(name_token) != tokens.index(bracket_token) - 2 ||
+      brace_token = name_token.next_token_of(%i[LPAREN LBRACE])
+      next unless tokens.index(name_token) != tokens.index(brace_token) - 2 ||
                   !is_single_space(next_token)
 
       notify(
         :error,
-        message: 'there should be a single space between the class or resource name and the first bracket',
+        message: 'there should be a single space between the class or resource name and the first brace',
         line: next_token.line,
         column: next_token.column,
         token: next_token,
@@ -50,14 +50,14 @@ PuppetLint.new_check(:manifest_whitespace_inherits_name_single_space_after) do
 
   def fix(problem)
     token = problem[:token]
-    bracket_token = token.prev_token.next_token_of(%i[LPAREN LBRACE])
+    brace_token = token.prev_token.next_token_of(%i[LPAREN LBRACE])
 
-    if token == bracket_token
-      add_token(tokens.index(bracket_token), new_single_space)
+    if token == brace_token
+      add_token(tokens.index(brace_token), new_single_space)
       return
     end
 
-    while token != bracket_token
+    while token != brace_token
       unless %i[WHITESPACE INDENT NEWLINE].include?(token.type)
         raise PuppetLint::NoFix
       end
@@ -66,6 +66,6 @@ PuppetLint.new_check(:manifest_whitespace_inherits_name_single_space_after) do
       token = token.next_token
     end
 
-    add_token(tokens.index(bracket_token), new_single_space)
+    add_token(tokens.index(brace_token), new_single_space)
   end
 end

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

@@ -4,7 +4,7 @@ PuppetLint.new_check(:manifest_whitespace_class_name_single_space_before) do
   def check
     (class_indexes + defined_type_indexes).each do |class_idx|
       class_token = class_idx[:tokens].first
-      name_token = class_token.next_token_of(:NAME)
+      name_token = class_token.next_token_of(%i[NAME FUNCTION_NAME])
       next unless name_token
 
       next_token = class_token.next_token
@@ -32,17 +32,17 @@ PuppetLint.new_check(:manifest_whitespace_class_name_single_space_after) do
   def check
     (class_indexes + defined_type_indexes).each do |class_idx|
       class_token = class_idx[:tokens].first
-      name_token = class_token.next_token_of(:NAME)
+      name_token = class_token.next_token_of(%i[NAME FUNCTION_NAME])
       next unless name_token
 
       next_token = name_token.next_token
-      bracket_token = name_token.next_token_of(%i[LPAREN LBRACE])
-      next unless tokens.index(name_token) != tokens.index(bracket_token) - 2 ||
+      brace_token = name_token.next_token_of(%i[LPAREN LBRACE])
+      next unless tokens.index(name_token) != tokens.index(brace_token) - 2 ||
                   !is_single_space(next_token)
 
       notify(
         :error,
-        message: 'there should be a single space between the class or resource name and the first bracket',
+        message: 'there should be a single space between the class or resource name and the first brace',
         line: next_token.line,
         column: next_token.column,
         token: next_token,
@@ -52,14 +52,14 @@ PuppetLint.new_check(:manifest_whitespace_class_name_single_space_after) do
 
   def fix(problem)
     token = problem[:token]
-    bracket_token = token.prev_token.next_token_of(%i[LPAREN LBRACE])
+    brace_token = token.prev_token.next_token_of(%i[LPAREN LBRACE])
 
-    if token == bracket_token
-      add_token(tokens.index(bracket_token), new_single_space)
+    if token == brace_token
+      add_token(tokens.index(brace_token), new_single_space)
       return
     end
 
-    while token != bracket_token
+    while token != brace_token
       unless %i[WHITESPACE INDENT NEWLINE].include?(token.type)
         raise PuppetLint::NoFix
       end
@@ -68,6 +68,6 @@ PuppetLint.new_check(:manifest_whitespace_class_name_single_space_after) do
       token = token.next_token
     end
 
-    add_token(tokens.index(bracket_token), new_single_space)
+    add_token(tokens.index(brace_token), new_single_space)
   end
 end

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

@@ -4,27 +4,27 @@ PuppetLint.new_check(:manifest_whitespace_class_opening_curly_brace) do
   def check
     (class_indexes + defined_type_indexes).each do |class_idx|
       class_token = class_idx[:tokens].first
-      bracket_token = class_token.next_token_of(:LBRACE)
-      prev_token = bracket_token.prev_token
-      prev_code_token = bracket_token.prev_token_of(%i[RPAREN NAME])
+      brace_token = class_token.next_token_of(:LBRACE)
+      prev_token = brace_token.prev_token
+      prev_code_token = brace_token.prev_token_of(%i[RPAREN NAME FUNCTION_NAME])
 
       next unless prev_code_token
-      next unless tokens.index(prev_code_token) != tokens.index(bracket_token) - 2 ||
+      next unless tokens.index(prev_code_token) != tokens.index(brace_token) - 2 ||
                   !is_single_space(prev_token)
 
       notify(
         :error,
-        message: 'there should be a single space before the opening curly bracket of a class body',
-        line: bracket_token.line,
-        column: bracket_token.column,
-        token: bracket_token,
+        message: 'there should be a single space before the opening curly brace of a class body',
+        line: brace_token.line,
+        column: brace_token.column,
+        token: brace_token,
       )
     end
   end
 
   def fix(problem)
     token = problem[:token]
-    prev_code_token = token.prev_token_of(%i[RPAREN NAME]).next_token
+    prev_code_token = token.prev_token_of(%i[RPAREN NAME FUNCTION_NAME]).next_token
 
     while token != prev_code_token
       unless %i[WHITESPACE INDENT NEWLINE].include?(prev_code_token.type)

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

@@ -69,7 +69,135 @@ 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 parameters and no spaces' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class myclass(
+          $param1,
+        ) {
+          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(14)
+      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 newline' do
+        expect(manifest).to eq(
+          <<~EOF,
+            # example
+            #
+            # Main class, includes all other classes.
+            #
+
+            class myclass (
+              $param1,
+            ) {
+              class  { 'example2':
+                param1 => 'value1',
+              }
+            }
+          EOF
+        )
+      end
+    end
+  end
+
+  context 'with scope and no spaces' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class mymodule::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(24)
+      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 newline' do
+        expect(manifest).to eq(
+          <<~EOF,
+            # example
+            #
+            # Main class, includes all other classes.
+            #
+
+            class mymodule::example {
+              class  { 'example2':
+                param1 => 'value1',
+              }
+            }
+          EOF
+        )
+      end
+    end
+  end
 
   context 'with no spaces' do
     let(:code) do
@@ -308,7 +436,7 @@ describe 'manifest_whitespace_class_name_single_space_after' do
 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' }
+  let(:opening_curly_brace_same_line_msg) { 'there should be a single space before the opening curly brace of a class body' }
 
   context 'with no spaces' do
     let(:code) do

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

@@ -69,7 +69,7 @@ describe 'manifest_whitespace_inherits_name_single_space_before' do
 end
 
 describe 'manifest_whitespace_inherits_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
     let(:code) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-manifest_whitespace-check
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Jo Vandeginste