puppet-lint-empty_trailing_lines 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63566c23dfbecc1869cfcc8c47df00154713d49c4509bfe2536a9b977223c8dd
+  data.tar.gz: '090fd98728a66866c1afe3eac21c51d2a6979ed6f09f988bfbb0118ff63a310e'
+SHA512:
+  metadata.gz: 0db2caeca0703fcd6160493af14944981041c026290f0ecdade43b6ec1e31513cc9b9d2572a1296d18de3925b435a9c30f50385714893ad3856d05551bcbff32
+  data.tar.gz: dcb7532bd161b635fc9ba8b838b1f0291bce76f320ac821a57d34bb14afc6c848ef319dd080f0b0d9bf491853e7bf6def760363c3ff2dfe32d3239b1a9648d4d

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (C) 2019 Garrett Honeycutt <code@garretthoneycutt.com>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,51 @@
+# puppet-lint-empty_trailing_lines
+
+This plugin will check to see if a manifest has trailing empty lines.
+
+
+## Installation
+
+
+### From the command line
+
+```sh
+gem install puppet-lint-empty_trailing_lines
+```
+
+### In a `Gemfile`
+
+```ruby
+gem 'puppet-lint-empty_trailing_lines', :require => false
+```
+
+## Checks
+
+This plugin provides a new check to `puppet-lint`.
+
+### What you have done
+
+```puppet
+  # There are two empty lines after the code has ended
+    file { '/foo':
+      ensure => 'file',
+    }
+  }
+
+
+```
+
+### What you should have done
+
+```puppet
+  # Not left empty lines at the end of the file
+    file { '/foo':
+      ensure => 'file',
+    }
+  }
+```
+
+### Disabling the check
+
+#### From the command line
+
+#### In your `Rakefile`

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

@@ -0,0 +1,20 @@
+PuppetLint.new_check(:empty_trailing_lines) do
+  def check
+    last_token = tokens.last
+
+    if [:NEWLINE, :WHITESPACE, :INDENT].include?(last_token.prev_token.type)
+      notify :warning, {
+        :message => 'too many empty lines at the end of the file',
+        :line    => last_token.prev_token.line,
+        :column  => manifest_lines.last.length,
+      }
+    end
+  end
+
+  def fix(problem)
+    remove_token(tokens.last.prev_token)
+    if tokens.last.prev_token.type == :NEWLINE && tokens.last.type == :NEWLINE
+      fix(problem)
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe 'empty_trailing_lines' do
+  let(:msg) { 'too many empty lines at the end of the file' }
+
+  context 'with fix disabled' do
+    context 'code ending with an extra newline' do
+      let(:code) { "foo\n\n\n'test'\n\n" }
+
+      it 'should detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(4).in_column(0)
+      end
+    end
+
+    context 'code ending with many extra newlines' do
+      let(:code) { "foo\n\n\n'test'\n\n\n\n" }
+
+      it 'should detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(6).in_column(0)
+      end
+    end
+
+    context 'code ending with a newline' do
+      let(:code) { "foo\n\n\n'test'\n" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+  end
+
+  context 'with fix enabled' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    context 'code ending with an extra newline' do
+      let(:code) { "foo\n\n\n'test'\n\n" }
+
+      it 'should only detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should fix the problem' do
+        expect(problems).to contain_fixed(msg).on_line(4).in_column(0)
+      end
+
+      it 'should add a newline to the end of the manifest' do
+        expect(manifest).to eq("foo\n\n\n'test'\n")
+      end
+    end
+
+    context 'code ending with many extra newlines' do
+      let(:code) { "foo\n\n\n'test'\n\n\n\n" }
+
+      it 'should only detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should fix the problem' do
+        expect(problems).to contain_fixed(msg).on_line(6).in_column(0)
+      end
+
+      it 'should add a newline to the end of the manifest' do
+        expect(manifest).to eq("foo\n\n\n'test'\n")
+      end
+    end
+
+    context 'code ending in a newline' do
+      let(:code) { "foo\n\n\n'test'\n" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+
+      it 'should not modify the manifest' do
+        expect(manifest).to eq(code)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'puppet-lint'
+
+PuppetLint::Plugins.load_spec_helper

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-empty_trailing_lines
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tailored Automation
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14.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-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: 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: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: "    Extends puppet-lint to ensure that your manifest files do not end
+  with extra empty lines\n"
+email: code@tailoredautomation.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/check_empty_trailing_lines.rb
+- spec/puppet-lint/plugins/check_empty_trailing_lines_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ghoneycutt/puppet-lint-empty_trailing_lines
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: puppet-lint empty_trailing_line check
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/check_empty_trailing_lines_spec.rb