puppet-lint-manifest_whitespace-check 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3d91ac8fb2a3196f56aa2e30c76acdfa62f1b318
-  data.tar.gz: a8a98d0f46aada6c955650901e3fe9cdec2b565d
+SHA256:
+  metadata.gz: 6bdb4da2f82834a517b3f17c513548157e9b09e316dc1ef23ce29f0deabd0874
+  data.tar.gz: cfea1846383662116b388a3257708cf9e1c441c0c9eae86df6c4982442a062bc
 SHA512:
-  metadata.gz: f1bd0c7f396ce8307204b2fbb4b843cf570fecc32181a0c1ddf6095f60642f3518a072508d496d5b3af9fd84581180340736b1f212e41be3b64d3d9253807d1d
-  data.tar.gz: d3484a2404a91a7d558a1a8fb57c95e42f26abd43a8db0d5ba98cb6bdaefea39048b353cdf269dac72df4eeaca873759775117548d52c65c9c48088042798dcb
+  metadata.gz: 895dd3bc23d6deb63a6a1e9837dec0ae2ab735859ac50ecc6e5d93d1a594f5b6709a53f2b139e291e0ec82a27e1b71eaf158dd278ec2b773e671275e4ba0acff
+  data.tar.gz: 8c1fed89f0a3e49872288f298a36847b561a4a0aaacee85aa0b30673c3ac4aceb92a4e9ee59f32a00a88965f5d51a0cae7ee793a5fc287fa6a4613f26de620fc

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+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)
+      next unless name_token
+
+      next_token = inherits_token.next_token
+      next unless tokens.index(name_token) != tokens.index(inherits_token) + 2 ||
+                  !is_single_space(next_token)
+
+      notify(
+        :error,
+        message: 'there should be a single space between the inherits statement and the name',
+        line: next_token.line,
+        column: next_token.column,
+        token: next_token,
+      )
+    end
+  end
+
+  def fix(problem)
+    raise PuppetLint::NoFix if problem[:token].type != :WHITESPACE
+
+    problem[:token].value = ' '
+  end
+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)
+      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 ||
+                  !is_single_space(next_token)
+
+      notify(
+        :error,
+        message: 'there should be a single space between the class or resource name and the first bracket',
+        line: next_token.line,
+        column: next_token.column,
+        token: next_token,
+      )
+    end
+  end
+
+  def fix(problem)
+    token = problem[:token]
+    bracket_token = token.prev_token.next_token_of(%i[LPAREN LBRACE])
+
+    if token == bracket_token
+      add_token(tokens.index(bracket_token), new_single_space)
+      return
+    end
+
+    while token != bracket_token
+      unless %i[WHITESPACE INDENT NEWLINE].include?(token.type)
+        raise PuppetLint::NoFix
+      end
+
+      remove_token(token)
+      token = token.next_token
+    end
+
+    add_token(tokens.index(bracket_token), new_single_space)
+  end
+end

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

@@ -6,7 +6,7 @@ PuppetLint.new_check(:manifest_whitespace_class_opening_curly_brace) do
       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(:RPAREN)
+      prev_code_token = bracket_token.prev_token_of(%i[RPAREN NAME])
 
       next unless prev_code_token
       next unless tokens.index(prev_code_token) != tokens.index(bracket_token) - 2 ||
@@ -24,7 +24,7 @@ PuppetLint.new_check(:manifest_whitespace_class_opening_curly_brace) do
 
   def fix(problem)
     token = problem[:token]
-    prev_code_token = token.prev_token_of(:RPAREN).next_token
+    prev_code_token = token.prev_token_of(%i[RPAREN NAME]).next_token
 
     while token != prev_code_token
       unless %i[WHITESPACE INDENT NEWLINE].include?(prev_code_token.type)

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+PuppetLint.new_check(:manifest_whitespace_two_empty_lines) do
+  def check
+    tokens.select { |token| token.type == :NEWLINE }.each do |token|
+      prev_newline = token.prev_token_of(:NEWLINE)
+      next unless prev_newline
+
+      prev_newline = prev_newline.prev_token_of(:NEWLINE)
+      next unless prev_newline
+
+      good_to_go = true
+      tokens.index(prev_newline).upto(tokens.index(token)).each do |between_token_idx|
+        unless %i[NEWLINE WHITESPACE INDENT].include?(tokens[between_token_idx].type)
+          good_to_go = false
+          break
+        end
+      end
+      next unless good_to_go
+
+      notify(
+        :error,
+        message: 'there should be no two consecutive empty lines',
+        line: token.line,
+        column: token.column,
+        token: token,
+      )
+    end
+  end
+
+  def fix(problem)
+    token = problem[:token]
+    remove_token(token)
+  end
+end

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

@@ -556,4 +556,91 @@ describe 'manifest_whitespace_class_opening_curly_brace' do
       end
     end
   end
+
+  context 'with good inherits' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class example (
+          String $content,
+        ) inherits other::example {
+          class { 'example2':
+            param1 => 'value1',
+          }
+        }
+      EOF
+    end
+
+    context 'with fix disabled' do
+      it 'should detect no problem' do
+        expect(problems).to have(0).problems
+      end
+    end
+  end
+
+  context 'with bad inherits' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class example (
+          String $content,
+        ) 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(opening_curly_brace_same_line_msg).on_line(8).in_column(26)
+      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 missing space' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should add the space' do
+        expect(manifest).to eq(
+          <<~EOF,
+            # example
+            #
+            # Main class, includes all other classes.
+            #
+
+            class example (
+              String $content,
+            ) inherits other::example {
+              class { 'example2':
+                param1 => 'value1',
+              }
+            }
+          EOF
+        )
+      end
+    end
+  end
 end

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

@@ -0,0 +1,308 @@
+# 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
+
+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' }
+
+  context 'with no 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(38)
+      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 example inherits other::example {
+              class  { 'example2':
+                param1 => 'value1',
+              }
+            }
+          EOF
+        )
+      end
+    end
+  end
+
+  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(38)
+      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
+
+  context 'with newline' 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(38)
+      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 example inherits other::example {
+              class  { 'example2':
+                param1 => 'value1',
+              }
+            }
+          EOF
+        )
+      end
+    end
+  end
+
+  context 'with comment' do
+    let(:code) do
+      <<~EOF
+        # example
+        #
+        # Main class, includes all other classes.
+        #
+
+        class example inherits other::example # the class
+        {
+          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(38)
+      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(38)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'manifest_whitespace_two_empty_lines' do
+  let(:single_space_msg) { 'there should be no two consecutive empty lines' }
+
+  context 'with two spaces' do
+    let(:code) do
+      <<~EOF
+        class { 'example2':
+          param1 => 'value1',
+
+
+          param2 => 'value2',
+        }
+      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(4).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(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,
+            class { 'example2':
+              param1 => 'value1',
+
+              param2 => 'value2',
+            }
+          EOF
+        )
+      end
+    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.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Jo Vandeginste
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2020-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
@@ -31,89 +31,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-its
+  name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-collection_matchers
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rspec-collection_matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description: "    A new check for puppet-lint that validates generic whitespace issues
   in manifests.\n"
 email: jo.vandeginste@kuleuven.be
@@ -124,14 +124,18 @@ files:
 - LICENSE
 - README.md
 - lib/puppet-lint/plugins/check_manifest_whitespace_arrow_spaces.rb
+- lib/puppet-lint/plugins/check_manifest_whitespace_class_inherits_single_space.rb
 - lib/puppet-lint/plugins/check_manifest_whitespace_class_name_single_space.rb
 - lib/puppet-lint/plugins/check_manifest_whitespace_class_opening_curly_brace.rb
+- lib/puppet-lint/plugins/check_manifest_whitespace_empty_lines.rb
 - lib/puppet-lint/plugins/check_manifest_whitespace_newline_beginning_of_file.rb
 - lib/puppet-lint/plugins/check_manifest_whitespace_newline_end_of_file.rb
 - lib/puppet-lint/plugins/tools.rb
 - spec/puppet-lint/plugins/manifest_whitespace_arrow_spaces_spec.rb
 - spec/puppet-lint/plugins/manifest_whitespace_class_header_spec.rb
+- spec/puppet-lint/plugins/manifest_whitespace_class_inherits_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_missing_newline_end_of_file_spec.rb
 - spec/puppet-lint/plugins/manifest_whitespace_newline_begin_of_file_spec.rb
 - spec/spec_helper.rb
@@ -155,14 +159,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.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_class_inherits_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_class_header_spec.rb
 - spec/puppet-lint/plugins/manifest_whitespace_double_newline_end_of_file_spec.rb
-- spec/puppet-lint/plugins/manifest_whitespace_missing_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_newline_begin_of_file_spec.rb
-- spec/spec_helper.rb