puppet-lint-manifest_whitespace-check 0.1.4 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82fd48a0b533bc6357b7e250f945f8ab3f0ba80625a19fa060fde543bf854dae
-  data.tar.gz: 5289f75f1e16b08fb0b18c6798326017625d6a9b71cb061e9f020e4267630a45
+  metadata.gz: deec283a984c69934edd2522701fd6e840fb15e5ebbaf5d836366e59a6f7d894
+  data.tar.gz: e4b9559d3d6f82ef25f362b1bcbf8d7e8268e2f54089398dfb22519f6529b289
 SHA512:
-  metadata.gz: 4ff960cc339885dfbfa62823058381bb609ca8de39f1047837f2882efb325e176251dcec6f9786907b5fa14145e4f8ad0dfea52e942eadc6909ebc1f8f8f3dd1
-  data.tar.gz: 9a4f2cd1929e5ca731efb25894730e0ec793d4f2ebc9f3a46baa045deb9d6891e092402afe42acdd8cb83e6cfa808d7033fdb515d60360a4be1a7452e83f54dd
+  metadata.gz: 4a49d305962a6ea8168b6deb0f3ec7baf47276d7c6aa56c3869f16f73ed3ade68c3ff63acea7a5ebdef71cab5388b67b5d5cfc898d2f2f2daaa3bb9d7867a4a2
+  data.tar.gz: 10217466afcdf5fcd832eb08a54d1031c1f88d417783bc77da4a035ee3dfa5cfacc020ee87bac0b030abe59d80f080f596ffa0c803cddaf73aa0f312a3ac7d1d

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

@@ -36,13 +36,13 @@ PuppetLint.new_check(:manifest_whitespace_class_name_single_space_after) do
       next unless name_token
 
       next_token = name_token.next_token
-      brace_token = name_token.next_token_of(%i[LPAREN LBRACE])
-      next unless tokens.index(name_token) != tokens.index(brace_token) - 2 ||
+      next_code_token = next_non_space_token(name_token)
+      next unless tokens.index(name_token) != tokens.index(next_code_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 brace',
+        message: 'there should be a single space between the class or resource name and the next item',
         line: next_token.line,
         column: next_token.column,
         token: next_token,
@@ -52,22 +52,13 @@ PuppetLint.new_check(:manifest_whitespace_class_name_single_space_after) do
 
   def fix(problem)
     token = problem[:token]
-    brace_token = token.prev_token.next_token_of(%i[LPAREN LBRACE])
-
-    if token == brace_token
-      add_token(tokens.index(brace_token), new_single_space)
-      return
-    end
-
-    while token != brace_token
-      unless %i[WHITESPACE INDENT NEWLINE].include?(token.type)
-        raise PuppetLint::NoFix
-      end
+    next_code_token = next_non_space_token(token.prev_token)
 
+    while token != next_code_token
       remove_token(token)
       token = token.next_token
     end
 
-    add_token(tokens.index(brace_token), new_single_space)
+    add_token(tokens.index(next_code_token), new_single_space)
   end
 end

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

@@ -4,12 +4,12 @@ PuppetLint.new_check(:manifest_whitespace_closing_brace_before) do
   def check
     tokens.select { |token| token.type == :RBRACE }.each do |brace_token|
       prev_token = brace_token.prev_token
-      prev_code_token = brace_token.prev_code_token
+      prev_code_token = prev_non_space_token(brace_token)
 
       next unless prev_token && prev_code_token
-      next if %i[LBRACE RBRACK RBRACE].include?(prev_token.type)
+      next if %i[LBRACE].include?(prev_token.type)
 
-      unless %i[LBRACE RBRACK RBRACE].include?(prev_code_token.type)
+      unless %i[LBRACE].include?(prev_code_token.type)
         if is_single_space(prev_token) && tokens.index(prev_code_token) == tokens.index(brace_token) - 2
           next
         end
@@ -66,7 +66,7 @@ PuppetLint.new_check(:manifest_whitespace_closing_brace_after) do
       next if after_bracket_tokens.include?(next_token.type)
 
       if next_token.type == :WHITESPACE
-        next_code_token = brace_token.next_code_token
+        next_code_token = next_non_space_token(brace_token)
         next unless next_code_token
         next unless after_bracket_tokens.include?(next_code_token.type)
       end

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

@@ -6,7 +6,7 @@ PuppetLint.new_check(:manifest_whitespace_closing_bracket_before) do
       prev_token = bracket_token.prev_token
       next unless prev_token
 
-      prev_code_token = bracket_token.prev_code_token
+      prev_code_token = prev_non_space_token(bracket_token)
       next unless prev_code_token
 
       next unless %i[NEWLINE INDENT WHITESPACE].include?(prev_token.type)
@@ -56,7 +56,7 @@ PuppetLint.new_check(:manifest_whitespace_closing_bracket_after) do
       next if after_bracket_tokens.include?(next_token.type)
 
       if next_token.type == :WHITESPACE
-        next_code_token = bracket_token.next_code_token
+        next_code_token = next_non_space_token(bracket_token)
         next unless next_code_token
         next unless after_bracket_tokens.include?(next_code_token.type)
       end

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

@@ -4,10 +4,12 @@ PuppetLint.new_check(:manifest_whitespace_opening_brace_before) do
   def check
     tokens.select { |token| token.type == :LBRACE }.each do |brace_token|
       prev_token = brace_token.prev_token
-      prev_code_token = brace_token.prev_code_token
+      prev_code_token = prev_non_space_token(brace_token)
 
       next unless prev_token && prev_code_token
-      next if %i[LBRACK LBRACE COMMA].include?(prev_code_token.type)
+      if %i[LBRACK LBRACE COLON COMMA COMMENT].include?(prev_code_token.type)
+        next
+      end
       next unless tokens.index(prev_code_token) != tokens.index(brace_token) - 2 ||
                   !is_single_space(prev_token)
 
@@ -24,7 +26,7 @@ PuppetLint.new_check(:manifest_whitespace_opening_brace_before) do
   def fix(problem)
     token = problem[:token]
     prev_token = token.prev_token
-    prev_code_token = token.prev_code_token
+    prev_code_token = prev_non_space_token(token)
 
     while prev_code_token != prev_token
       unless %i[WHITESPACE INDENT NEWLINE].include?(prev_token.type)

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

@@ -4,7 +4,7 @@ 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 = bracket_token.prev_code_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)
@@ -25,7 +25,7 @@ PuppetLint.new_check(:manifest_whitespace_opening_bracket_before) do
   def fix(problem)
     token = problem[:token]
     prev_token = token.prev_token
-    prev_code_token = token.prev_code_token
+    prev_code_token = prev_non_space_token(token)
 
     while prev_code_token != prev_token
       unless %i[WHITESPACE INDENT NEWLINE].include?(prev_token.type)

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

@@ -9,5 +9,17 @@ def new_single_space
 end
 
 def after_bracket_tokens
-  %i[RBRACE RBRACK RPAREN SEMIC COMMA COLON NEWLINE DQPOST]
+  %i[RBRACE RBRACK RPAREN SEMIC COMMA COLON NEWLINE DQMID 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

@@ -66,10 +66,34 @@ describe 'manifest_whitespace_class_name_single_space_before' do
       end
     end
   end
+
+  context 'with inherits' do
+    let(:code) do
+      'class example inherits otherexample {'
+    end
+
+    it 'should detect no problems' do
+      expect(problems).to have(0).problem
+    end
+  end
 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 brace' }
+  let(:single_space_msg) { 'there should be a single space between the class or resource name and the next item' }
+
+  context 'with inherits' do
+    let(:code) do
+      <<~EOF
+        class example inherits otherexample {
+          assert_private()
+        }
+      EOF
+    end
+
+    it 'should detect no problems' do
+      expect(problems).to have(0).problem
+    end
+  end
 
   context 'with parameters and no spaces' do
     let(:code) do
@@ -405,32 +429,8 @@ describe 'manifest_whitespace_class_name_single_space_after' do
       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 not fix the manifest' do
-        expect(problems).to contain_error(single_space_msg).on_line(6).in_column(14)
-      end
+    it 'should detect no problem' do
+      expect(problems).to have(0).problems
     end
   end
 end

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

@@ -5,6 +5,32 @@ require 'spec_helper'
 describe 'manifest_whitespace_closing_brace_before' do
   let(:closing_brace_msg) { 'there should be a bracket or a single newline before a closing brace' }
 
+  context 'with nested hash' do
+    let(:code) do
+      <<~EOF
+        Hash $instances  = { 'localhost' => { 'url' => 'http://localhost/mod_status?auto' } },
+      EOF
+    end
+
+    it 'should detect no problems' do
+      expect(problems).to have(0).problem
+    end
+  end
+
+  context 'with comment only' do
+    let(:code) do
+      <<~EOF
+        $value7 = {
+          # nothing
+        }
+      EOF
+    end
+
+    it 'should detect no problems' do
+      expect(problems).to have(0).problem
+    end
+  end
+
   context 'with no spaces' do
     let(:code) do
       <<~EOF
@@ -30,6 +56,9 @@ describe 'manifest_whitespace_closing_brace_before' do
           $value5 = []
           $value6 = {}
           $value7 = "x${server_facts['environment']}y"
+          $value8 = {
+            # nothing
+          }
 
           if someothercondition { include ::otherclass}
           if somecondition {
@@ -91,6 +120,9 @@ describe 'manifest_whitespace_closing_brace_before' do
               $value5 = []
               $value6 = {}
               $value7 = "x${server_facts['environment']}y"
+              $value8 = {
+                # nothing
+              }
 
               if someothercondition { include ::otherclass }
               if somecondition {

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

@@ -5,6 +5,35 @@ require 'spec_helper'
 describe 'manifest_whitespace_opening_brace_before' do
   let(:opening_brace_msg) { 'there should be a single space before an opening brace' }
 
+  context 'with comment only' do
+    let(:code) do
+      <<~EOF
+        $value7 = {
+          # nothing
+        }
+      EOF
+    end
+
+    it 'should detect no problems' do
+      expect(problems).to have(0).problem
+    end
+  end
+
+  context 'with cases' do
+    let(:code) do
+      <<~EOF
+        case $facts['kernel'] {
+          'OpenBSD': { $has_wordexp = false }
+          default:   { $has_wordexp = true }
+        }
+      EOF
+    end
+
+    it 'should detect no problems' do
+      expect(problems).to have(0).problem
+    end
+  end
+
   context 'with no spaces' do
     let(:code) do
       <<~EOF
@@ -29,6 +58,9 @@ describe 'manifest_whitespace_opening_brace_before' do
           $value4 = ['somekey']
           $value5 = []
           $value6 = {}
+          $value7 = {
+            # nothing
+          }
 
           if somecondition{
             class{ 'example2':
@@ -91,6 +123,9 @@ describe 'manifest_whitespace_opening_brace_before' do
               $value4 = ['somekey']
               $value5 = []
               $value6 = {}
+              $value7 = {
+                # nothing
+              }
 
               if somecondition {
                 class { 'example2':
@@ -332,29 +367,7 @@ describe 'manifest_whitespace_opening_brace_before' do
 
     context 'with fix disabled' do
       it 'should detect a single problem' do
-        expect(problems).to have(2).problem
-      end
-
-      it 'should create a error' do
-        expect(problems).to contain_error(opening_brace_msg).on_line(9).in_column(1)
-      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(2).problem
-      end
-
-      it 'should not fix the manifest' do
-        expect(problems).to contain_error(opening_brace_msg).on_line(9).in_column(1)
+        expect(problems).to have(0).problem
       end
     end
   end
@@ -516,6 +529,9 @@ describe 'manifest_whitespace_opening_brace_after' do
           $value4 = ['somekey']
           $value5 = []
           $value6 = {}
+          $value7 = {
+            # nothing
+          }
 
           if somecondition {
             class {  'example2':
@@ -578,6 +594,9 @@ describe 'manifest_whitespace_opening_brace_after' do
               $value4 = ['somekey']
               $value5 = []
               $value6 = {}
+              $value7 = {
+                # nothing
+              }
 
               if somecondition {
                 class { 'example2':

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-manifest_whitespace-check
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.9
 platform: ruby
 authors:
 - Jo Vandeginste
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint