puppet-lint-manifest_whitespace-check 0.0.1

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

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'manifest_whitespace_double_newline_end_of_file' do
+  context 'with good example' do
+    let(:code) do
+      <<~EOF
+        class example (
+
+
+
+        ) {
+
+
+        }
+      EOF
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  let(:single_newline_end_of_file_msg) { 'there should be a single newline at the end of a manifest' }
+
+  context 'with fix disabled' do
+    context 'with 1 empty line at the end of a manifest' do
+      let(:code) do
+        <<~EOF
+        class example {
+        }
+
+        EOF
+      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_error(single_newline_end_of_file_msg).on_line(3).in_column(1)
+      end
+    end
+
+    context 'with 3 empty lines at the end of a manifest' do
+      let(:code) do
+        <<~EOF
+        class example {
+        }
+
+
+
+        EOF
+      end
+
+      it 'should detect 3 problems' do
+        expect(problems).to have(3).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_error(single_newline_end_of_file_msg).on_line(3).in_column(1)
+        expect(problems).to contain_error(single_newline_end_of_file_msg).on_line(4).in_column(1)
+        expect(problems).to contain_error(single_newline_end_of_file_msg).on_line(5).in_column(1)
+      end
+    end
+  end
+
+  context 'with fix enabled' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    context 'with 1 empty line at the end of a manifest' do
+      let(:code) do
+        <<~EOF
+        class example {
+        }
+
+        EOF
+      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_newline_end_of_file_msg).on_line(3).in_column(1)
+      end
+
+      it 'should add the final newline' do
+        expect(manifest).to eq(
+          <<~EOF
+          class example {
+          }
+          EOF
+        )
+      end
+    end
+
+    context 'with 3 empty lines at the end of a manifest' do
+      let(:code) do
+        <<~EOF
+        class example {
+        }
+
+
+
+        EOF
+      end
+
+      it 'should detect 3 problems' do
+        expect(problems).to have(3).problem
+      end
+
+      it 'should fix the manifest' do
+        expect(problems).to contain_fixed(single_newline_end_of_file_msg).on_line(3).in_column(1)
+        expect(problems).to contain_fixed(single_newline_end_of_file_msg).on_line(4).in_column(1)
+        expect(problems).to contain_fixed(single_newline_end_of_file_msg).on_line(5).in_column(1)
+      end
+
+      it 'should add the final newline' do
+        expect(manifest).to eq(
+          <<~EOF
+          class example {
+          }
+          EOF
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'manifest_whitespace_missing_newline_end_of_file' do
+  let(:single_newline_end_of_file_msg) { 'there should be a single newline at the end of a manifest' }
+
+  context 'with fix disabled' do
+    context 'with no new line at the end of a manifest' do
+      let(:code) do
+        'class example { }'
+      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_error(single_newline_end_of_file_msg).on_line(1).in_column(17)
+      end
+    end
+  end
+
+  context 'with fix enabled' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    context 'with no new line at the end of a manifest' do
+      let(:code) do
+        'class example { }'
+      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_newline_end_of_file_msg).on_line(1).in_column(17)
+      end
+
+      it 'should add the final newline' do
+        expect(manifest).to eq("class example { }\n")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'manifest_whitespace_newline_beginning_of_file' do
+  let(:single_beginning_of_file_msg) { 'there should not be a newline at the beginning of a manifest' }
+
+  context 'with good example' do
+    let(:code) do
+      <<~EOF
+        class example (
+
+
+
+        ) {
+
+
+        }
+      EOF
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'with fix disabled' do
+    context 'with 1 empty line at the beginning of a manifest' do
+      let(:code) do
+        <<~EOF
+
+          class example {
+          }
+        EOF
+      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_error(single_beginning_of_file_msg).on_line(1).in_column(1)
+      end
+    end
+
+    context 'with 3 empty lines at the beginning of a manifest' do
+      let(:code) do
+        <<~EOF
+
+
+
+          class example {
+          }
+        EOF
+      end
+
+      it 'should detect 3 problems' do
+        expect(problems).to have(3).problem
+      end
+
+      it 'should create a error' do
+        expect(problems).to contain_error(single_beginning_of_file_msg).on_line(1).in_column(1)
+        expect(problems).to contain_error(single_beginning_of_file_msg).on_line(2).in_column(1)
+        expect(problems).to contain_error(single_beginning_of_file_msg).on_line(3).in_column(1)
+      end
+    end
+  end
+
+  context 'with fix enabled' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    context 'with 1 empty line at the beginning of a manifest' do
+      let(:code) do
+        <<~EOF
+
+          class example {
+          }
+        EOF
+      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_beginning_of_file_msg).on_line(1).in_column(1)
+      end
+
+      it 'should add the final newline' do
+        expect(manifest).to eq(
+          <<~EOF,
+            class example {
+            }
+          EOF
+        )
+      end
+    end
+
+    context 'with 3 empty lines at the beginning of a manifest' do
+      let(:code) do
+        <<~EOF
+
+
+
+          class example {
+          }
+        EOF
+      end
+
+      it 'should detect 3 problem' do
+        expect(problems).to have(3).problem
+      end
+
+      it 'should fix the manifest' do
+        expect(problems).to contain_fixed(single_beginning_of_file_msg).on_line(1).in_column(1)
+        expect(problems).to contain_fixed(single_beginning_of_file_msg).on_line(2).in_column(1)
+        expect(problems).to contain_fixed(single_beginning_of_file_msg).on_line(3).in_column(1)
+      end
+
+      it 'should add the final newline' do
+        expect(manifest).to eq(
+          <<~EOF,
+            class example {
+            }
+          EOF
+        )
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'puppet-lint'
+
+PuppetLint::Plugins.load_spec_helper

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-manifest_whitespace-check
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jo Vandeginste
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    A new check for puppet-lint that validates generic whitespace issues
+  in manifests.\n"
+email: jo.vandeginste@kuleuven.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/check_manifest_whitespace_arrow_spaces.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_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_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_newline_begin_of_file_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kuleuven/puppet-lint-manifest_whitespace-check
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A puppet-lint check to validate whitespace in manifests
+test_files:
+- 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_arrow_spaces_spec.rb
+- spec/puppet-lint/plugins/manifest_whitespace_newline_begin_of_file_spec.rb
+- spec/spec_helper.rb