puppet-lint-manifest_whitespace-check 0.1.16 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af72a48c82a227107871c1e7b83a3bec2a101aab3cef89bbd3d6ce426122334d
-  data.tar.gz: c7bc25b60155836000ec44971dd88832fafd413cac0e89107c49be5e86e804c1
+  metadata.gz: 73d348cb4f0a000a02c631f97562527a401f7e61f2954e31e8841c9095b32a8f
+  data.tar.gz: 7fbdd7c452078510f2ae545a93f492f3effd982775cfce706ed7d41219eaa282
 SHA512:
-  metadata.gz: 24961bb90cab1231db45ad634bf31444a276645d371401168956a436dd977e23166b19d5b1880e96d8ebfc64c3c53da68c4a65e92643a421094fae5a693ec2f0
-  data.tar.gz: c57d69810e67d335b597cb8257d627a07ac6c31fde14e37f64b8c05e4bb83fc750ca9e87699689211f299268ca287e89d76835259667d6b0876c3ed94f40b04e
+  metadata.gz: 1e5df8707c5cbbe5a05bac3b1f16542e1df5c02cc41f4ca5a4d2e97eda2508bb5aa25601bbce7e04a3f06c6803a96dbd69752cd43be33d6f7dd69f23ff1c54dc
+  data.tar.gz: c0c670b007c1456d68a59635e3e29da5ffbc9bdc0e3ff3c0cc1623766180665ef2180b3fff0b584b7ae9bee29243e618b92a7b9030880c3d965b090ac802a790

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

@@ -43,20 +43,22 @@ PuppetLint.new_check(:manifest_whitespace_class_name_single_space_after) do
       notify(
         :error,
         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,
+        line: name_token.line,
+        column: name_token.column,
+        token: name_token,
       )
     end
   end
 
   def fix(problem)
     token = problem[:token]
-    next_code_token = next_non_space_token(token.prev_token)
 
-    while token != next_code_token
-      remove_token(token)
-      token = token.next_token
+    next_token = token.next_token
+    next_code_token = next_non_space_token(token)
+
+    while next_token != next_code_token
+      remove_token(next_token)
+      next_token = next_token.next_token
     end
 
     add_token(tokens.index(next_code_token), new_single_space)

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

@@ -7,7 +7,7 @@ PuppetLint.new_check(:manifest_whitespace_opening_brace_before) do
       prev_code_token = prev_non_space_token(brace_token)
 
       next unless prev_token && prev_code_token
-      if %i[LBRACK LBRACE COLON COMMA COMMENT].include?(prev_code_token.type)
+      if %i[LPAREN LBRACK LBRACE COLON COMMA COMMENT].include?(prev_code_token.type)
         next
       end
       next unless tokens.index(prev_code_token) != tokens.index(brace_token) - 2 ||

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

@@ -9,7 +9,7 @@ def new_single_space
 end
 
 def after_bracket_tokens
-  %i[RBRACK RPAREN SEMIC COMMA COLON DOT NEWLINE DQMID DQPOST LBRACK]
+  %i[RBRACK RPAREN SEMIC COMMA COLON DOT NEWLINE DQMID DQPOST LBRACK HEREDOC_MID HEREDOC_POST]
 end
 
 def prev_non_space_token(token)

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

@@ -216,7 +216,7 @@ describe 'manifest_whitespace_arrows_single_space_after' do
       end
 
       it 'should detect a no problem' do
-        expect(problems).to have(0).problems
+        expect(problems).to be_empty
       end
     end
 
@@ -228,7 +228,7 @@ describe 'manifest_whitespace_arrows_single_space_after' do
       end
 
       it 'should detect a no problem' do
-        expect(problems).to have(0).problems
+        expect(problems).to be_empty
       end
     end
 
@@ -242,7 +242,7 @@ describe 'manifest_whitespace_arrows_single_space_after' do
       end
 
       it 'should detect a no problem' do
-        expect(problems).to have(0).problems
+        expect(problems).to be_empty
       end
     end
   end

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

@@ -73,7 +73,7 @@ describe 'manifest_whitespace_class_name_single_space_before' do
     end
 
     it 'should detect no problems' do
-      expect(problems).to have(0).problem
+      expect(problems).to be_empty
     end
   end
 end
@@ -91,7 +91,7 @@ describe 'manifest_whitespace_class_name_single_space_after' do
     end
 
     it 'should detect no problems' do
-      expect(problems).to have(0).problem
+      expect(problems).to be_empty
     end
   end
 
@@ -119,7 +119,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(7)
       end
     end
 
@@ -183,7 +183,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(24)
+        expect(problems).to contain_error(single_space_msg).on_line(6).in_column(7)
       end
     end
 
@@ -245,7 +245,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(7)
       end
     end
 
@@ -307,7 +307,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(7)
       end
     end
 
@@ -372,7 +372,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(7)
       end
     end
 
@@ -430,7 +430,7 @@ describe 'manifest_whitespace_class_name_single_space_after' do
     end
 
     it 'should detect no problem' do
-      expect(problems).to have(0).problems
+      expect(problems).to be_empty
     end
   end
 end

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

@@ -43,7 +43,7 @@ describe 'manifest_whitespace_closing_brace_before' do
     end
 
     it 'should detect no problems' do
-      expect(problems).to have(0).problem
+      expect(problems).to be_empty
     end
   end
 
@@ -59,7 +59,7 @@ describe 'manifest_whitespace_closing_brace_before' do
     end
 
     it 'should detect no problems' do
-      expect(problems).to have(0).problem
+      expect(problems).to be_empty
     end
   end
 
@@ -73,7 +73,7 @@ describe 'manifest_whitespace_closing_brace_before' do
     end
 
     it 'should detect no problems' do
-      expect(problems).to have(0).problem
+      expect(problems).to be_empty
     end
   end
 
@@ -413,7 +413,7 @@ describe 'manifest_whitespace_closing_brace_after' do
     end
 
     it 'should detect no problems' do
-      expect(problems).to have(0).problem
+      expect(problems).to be_empty
     end
   end
 

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

@@ -43,7 +43,7 @@ describe 'manifest_whitespace_closing_bracket_before' do
 
     context 'with fix disabled' do
       it 'should detect 0 problems' do
-        expect(problems).to have(0).problem
+        expect(problems).to be_empty
       end
     end
   end
@@ -163,7 +163,7 @@ describe 'manifest_whitespace_closing_bracket_after' do
     end
 
     it 'should detect no problems' do
-      expect(problems).to have(0).problem
+      expect(problems).to be_empty
     end
   end
 
@@ -179,7 +179,7 @@ describe 'manifest_whitespace_closing_bracket_after' do
     end
 
     it 'should detect no problems' do
-      expect(problems).to have(0).problem
+      expect(problems).to be_empty
     end
   end
 
@@ -302,4 +302,123 @@ describe 'manifest_whitespace_closing_bracket_after' do
       end
     end
   end
+
+  context 'inside heredoc' do
+    describe 'issue10 example' do
+      let(:code) do
+        <<~CODE
+          file { '/tmp/test':
+            ensure  => file,
+            owner   => 'root',
+            group   => 'root',
+            content => Sensitive(@("EOF")),
+            # hostname:port:database:username:password
+            127.0.0.1:5432:aos:${variable}:${hash['password']}
+            localhost:5432:aos:${variable}:${hash['password']}
+            | EOF
+          }
+        CODE
+      end
+
+      it 'should detect no problems' do
+        expect(problems).to be_empty
+      end
+    end
+
+    describe 'interpolated hash key in middle of line' do
+      let(:code) do
+        <<~CODE
+          $content = @("EOF")
+            somestring:${foo['bar']}:more
+            more stuff
+            | EOF
+          # more puppet code follows
+        CODE
+      end
+
+      it 'should detect no problems' do
+        expect(problems).to be_empty
+      end
+
+      context 'with unwanted whitespace' do
+        let(:code) do
+          <<~CODE
+            $content = @("EOF")
+              somestring:${foo['bar'] }:more
+              more stuff
+              | EOF
+            # more puppet code follows
+          CODE
+        end
+
+        it 'should detect 1 problem' do
+          expect(problems).to have(1).problem
+        end
+      end
+    end
+
+    describe 'interpolated hash key at end of line' do
+      let(:code) do
+        <<~CODE
+          $content = @("EOF")
+            somestring:${foo['bar']}
+            more stuff
+            | EOF
+          # more puppet code follows
+        CODE
+      end
+
+      it 'should detect no problems' do
+        expect(problems).to be_empty
+      end
+
+      context 'with unwanted whitespace' do
+        let(:code) do
+          <<~CODE
+            $content = @("EOF")
+              somestring:${foo['bar'] }
+              more stuff
+              | EOF
+            # more puppet code follows
+          CODE
+        end
+
+        it 'should detect 1 problem' do
+          expect(problems).to have(1).problem
+        end
+      end
+    end
+
+    describe 'interpolated hash key at end of heredoc' do
+      let(:code) do
+        <<~CODE
+          $content = @("EOF")
+            # Some random heredoc preamble
+            somestring:${foo['bar']}
+            | EOF
+          # more puppet code follows
+        CODE
+      end
+
+      it 'should detect no problems' do
+        expect(problems).to be_empty
+      end
+
+      context 'with unwanted whitespace' do
+        let(:code) do
+          <<~CODE
+            $content = @("EOF")
+              # Some random heredoc preamble
+              somestring:${foo['bar'] }
+              | EOF
+            # more puppet code follows
+          CODE
+        end
+
+        it 'should detect 1 problem' do
+          expect(problems).to have(1).problem
+        end
+      end
+    end
+  end
 end

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

@@ -18,7 +18,7 @@ describe 'manifest_whitespace_double_newline_end_of_file' do
     end
 
     it 'should not detect any problems' do
-      expect(problems).to have(0).problems
+      expect(problems).to be_empty
     end
   end
 

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

@@ -20,7 +20,7 @@ describe 'manifest_whitespace_newline_beginning_of_file' do
     end
 
     it 'should not detect any problems' do
-      expect(problems).to have(0).problems
+      expect(problems).to be_empty
     end
   end
 

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

@@ -15,7 +15,26 @@ describe 'manifest_whitespace_opening_brace_before' do
     end
 
     it 'should detect no problems' do
-      expect(problems).to have(0).problem
+      expect(problems).to be_empty
+    end
+  end
+
+  context 'inside a function' do
+    let(:code) do
+      <<~EOF
+        $my_var = lookup(
+          {
+            'name'          => 'my_module::my_var',
+            'merge'         => 'deep',
+            'value_type'    => Array[Hash],
+            'default_value' => [],
+          }
+        )
+      EOF
+    end
+
+    it 'should detect no problems' do
+      expect(problems).to be_empty
     end
   end
 
@@ -30,7 +49,47 @@ describe 'manifest_whitespace_opening_brace_before' do
     end
 
     it 'should detect no problems' do
-      expect(problems).to have(0).problem
+      expect(problems).to be_empty
+    end
+  end
+
+  context 'with class no spaces' do
+    let(:code) do
+      <<~EOF
+        class example{
+          # some generic comment
+        }
+      EOF
+    end
+
+    context 'with fix disabled' do
+      it 'should detect a problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_error(opening_brace_msg).on_line(1).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 add a space' do
+        expect(manifest).to eq(
+          <<~EOF,
+            class example {
+              # some generic comment
+            }
+          EOF
+        )
+      end
     end
   end
 
@@ -367,7 +426,7 @@ describe 'manifest_whitespace_opening_brace_before' do
 
     context 'with fix disabled' do
       it 'should detect a single problem' do
-        expect(problems).to have(0).problem
+        expect(problems).to be_empty
       end
     end
   end
@@ -406,7 +465,7 @@ describe 'manifest_whitespace_opening_brace_before' do
 
     context 'with fix disabled' do
       it 'should detect no problem' do
-        expect(problems).to have(0).problems
+        expect(problems).to be_empty
       end
     end
   end

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

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe 'manifest_whitespace_opening_bracket_before' do
   let(:opening_bracket_msg) { 'there should be a single space before an opening bracket' }
 
-  context 'with iterator' do
+  context 'with comment' do
     let(:code) do
       <<~EOF
         {
@@ -16,7 +16,7 @@ describe 'manifest_whitespace_opening_bracket_before' do
     end
 
     it 'should detect no problems' do
-      expect(problems).to have(0).problem
+      expect(problems).to be_empty
     end
   end
 
@@ -34,7 +34,25 @@ describe 'manifest_whitespace_opening_bracket_before' do
     end
 
     it 'should detect no problems' do
-      expect(problems).to have(0).problem
+      expect(problems).to be_empty
+    end
+  end
+
+  context 'with multiline iterator' do
+    let(:code) do
+      <<~EOF
+        include my::class
+
+        [
+          'a',
+          'b',
+        ].each |$i| { }
+      EOF
+    end
+
+    it 'should detect no problems' do
+      pending 'Fix the linter'
+      expect(problems).to be_empty
     end
   end
 
@@ -75,7 +93,7 @@ describe 'manifest_whitespace_opening_bracket_before' do
 
     context 'with fix disabled' do
       it 'should detect 0 problems' do
-        expect(problems).to have(0).problem
+        expect(problems).to be_empty
       end
     end
   end
@@ -211,7 +229,7 @@ describe 'manifest_whitespace_opening_bracket_before' do
 
     context 'with fix disabled' do
       it 'should detect a no problems' do
-        expect(problems).to have(0).problem
+        expect(problems).to be_empty
       end
     end
   end
@@ -252,7 +270,7 @@ describe 'manifest_whitespace_opening_bracket_before' do
 
     context 'with fix disabled' do
       it 'should detect a no problems' do
-        expect(problems).to have(0).problem
+        expect(problems).to be_empty
       end
     end
   end
@@ -273,7 +291,7 @@ describe 'manifest_whitespace_opening_bracket_after' do
     end
 
     it 'should detect no problems' do
-      expect(problems).to have(0).problem
+      expect(problems).to be_empty
     end
   end
 
@@ -407,7 +425,7 @@ describe 'manifest_whitespace_opening_bracket_after' do
 
     context 'with fix disabled' do
       it 'should detect 0 problems' do
-        expect(problems).to have(0).problem
+        expect(problems).to be_empty
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-manifest_whitespace-check
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.2.0
 platform: ruby
 authors:
 - Jo Vandeginste
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2022-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -149,7 +149,8 @@ files:
 homepage: https://github.com/kuleuven/puppet-lint-manifest_whitespace-check
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -165,21 +166,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: A puppet-lint check to validate whitespace in manifests
-test_files:
-- spec/spec_helper.rb
-- spec/puppet-lint/plugins/manifest_whitespace_opening_bracket_spec.rb
-- spec/puppet-lint/plugins/manifest_whitespace_class_inherits_spec.rb
-- spec/puppet-lint/plugins/manifest_whitespace_closing_bracket_spec.rb
-- spec/puppet-lint/plugins/manifest_whitespace_missing_newline_end_of_file_spec.rb
-- spec/puppet-lint/plugins/manifest_whitespace_newline_begin_of_file_spec.rb
-- spec/puppet-lint/plugins/manifest_whitespace_closing_brace_spec.rb
-- spec/puppet-lint/plugins/manifest_whitespace_class_header_spec.rb
-- spec/puppet-lint/plugins/manifest_whitespace_double_newline_end_of_file_spec.rb
-- spec/puppet-lint/plugins/manifest_whitespace_double_newline_spec.rb
-- spec/puppet-lint/plugins/manifest_whitespace_arrow_spaces_spec.rb
-- spec/puppet-lint/plugins/manifest_whitespace_opening_brace_spec.rb
+test_files: []