puppet-lint-empty_lines_around_body-check 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a3918100de439e4488287e6e8ceceb008c8551552f002a352283a066e0f92136
+  data.tar.gz: c92f887b662c319c004a9f503dc630b2c030a9185e6e4c8953504ba21c81b9f5
+SHA512:
+  metadata.gz: 9e4acde0a48ba50818efa1d1cdc761b6d8e48cc713df7dd99098a6729fb1ff29ad1c8ca5457a07cefa1815ee03515549d97db11eb2ade5cef78ce6f5f120629e
+  data.tar.gz: 125fa606bb796cca0421de836af6769a1083cd1ad70f771df1c5c48ca160d514feae4df1d27f6ae99a74dfed82c7e39870f351df1a132b11227354653e09c0f9

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2020] [Christian Bartolomäus]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+puppet-lint-empty_lines_around_body-check
+=========================================
+
+A puppet-lint plugin to check for empty lines around bodies of
+* classes and defined types
+* conditional blocks (if/elsif/else, unless, case, selectors, ...)
+
+## Installation
+
+### From the command line
+
+```shell
+$ gem install puppet-lint-empty_lines_around_body-check
+```
+
+## Checks
+
+#### What you have done
+
+There is an empty line either after the opening curly brace that starts a block or before the closing curly brace that ends a block.
+
+```puppet
+if $foo == 'bar' {
+
+  ## some stuff
+
+}
+```
+
+```puppet
+class foo::config {
+
+  ## some stuff
+
+}
+```
+
+```puppet
+case $facts['os']['name'] {
+
+  'Solaris': { include role::solaris }
+  default:   { include role::generic }
+
+}
+```
+
+#### What you should have done
+
+The indentation suffices to signal the start end end of a block, so blocks shouldn't have leading or trailing empty lines.
+
+```puppet
+if $foo == 'bar' {
+  ## some stuff
+}
+```
+
+```puppet
+class foo::config {
+  ## some stuff
+}
+```
+
+```puppet
+case $facts['os']['name'] {
+  'Solaris': { include role::solaris }
+  default:   { include role::generic }
+}
+```
+
+#### Disabling the check
+
+To disable this check, you can add `--no-empty_lines_around_block-check' to your puppet-lint command line.
+
+```
+$ puppet-lint --no-empty_lines_around_block-check /path/to/file.pp
+```
+
+## Acknowledgments
+
+This plugin for `puppet-lint` has been written owing to the very nice [tutorial for writing puppet-lint checks](http://puppet-lint.com/developer/tutorial/).

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/BlockLength
+PuppetLint.new_check(:empty_lines_around_body) do
+  # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+  def check
+    checked_block_tokens = %i[IF ELSIF ELSE UNLESS CASE CLASS DEFINE NODE]
+    checked_blocks = {}
+
+    depth = 0
+    tokens.each_index do |token_idx|
+      if checked_block_tokens.include?(tokens[token_idx].type)
+        checked_blocks[depth] = { :start => token_idx }
+      end
+
+      if tokens[token_idx].type == :LBRACE
+        depth += 1
+        unless checked_blocks[depth - 1].nil?
+          idx_with_problem = idx_2nd_nl(token_idx)
+          unless idx_with_problem == -1
+            block_type = tokens[checked_blocks[depth - 1][:start]].type.downcase
+            notify(
+              :warning,
+              :message => "empty line at start of #{block_type} block",
+              :line    => tokens[idx_with_problem].line,
+              :column  => tokens[idx_with_problem].column
+            )
+          end
+        end
+      elsif tokens[token_idx].type == :RBRACE
+        unless checked_blocks[depth - 1].nil?
+          idx_with_problem = idx_prec_2nd_nl(token_idx)
+          unless idx_with_problem == -1
+            block_type = tokens[checked_blocks[depth - 1][:start]].type.downcase
+            notify(
+              :warning,
+              :message => "empty line at end of #{block_type} block",
+              :line    => tokens[idx_with_problem].line,
+              :column  => tokens[idx_with_problem].column
+            )
+          end
+          checked_blocks.delete(depth)
+        end
+        depth -= 1
+      end
+    end
+  end
+  # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+  # rubocop:disable Metrics/MethodLength
+  def idx_2nd_nl(start_idx)
+    seen_newlines = 0
+    tokens[(start_idx + 1)..-1].each_index do |idx_in_block|
+      idx_abs = idx_in_block + start_idx + 1
+      if tokens[idx_abs].type == :NEWLINE
+        seen_newlines += 1
+        return idx_abs if seen_newlines > 1
+      elsif %i[WHITESPACE INDENT].include? tokens[idx_abs].type
+        next
+      else
+        break
+      end
+    end
+    -1
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  # rubocop:disable Metrics/MethodLength
+  def idx_prec_2nd_nl(start_idx)
+    seen_newlines = 0
+    idx_last_nl = -1
+    (start_idx - 1).downto(0).each do |idx_abs|
+      if tokens[idx_abs].type == :NEWLINE
+        seen_newlines += 1
+        return idx_last_nl if seen_newlines > 1
+
+        idx_last_nl = idx_abs
+      elsif %i[WHITESPACE INDENT].include? tokens[idx_abs].type
+        next
+      else
+        break
+      end
+    end
+    -1
+  end
+  # rubocop:enable Metrics/MethodLength
+end
+# rubocop:enable Metrics/BlockLength

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+# rubocop:disable Metrics/BlockLength
+describe 'empty_lines_around_body' do
+  ## if block
+  context 'with fix disabled' do
+    let(:msg) { 'empty line at start of if block' }
+
+    ## neither leading nor trailing empty line
+    context 'neither leading nor trailing empty line in if block' do
+      let(:code) { "if $foo == 'bar' {\n  include role::foo\n}\n" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    ## leading empty line
+    context 'empty line after opening curly of if block' do
+      let(:code) { "if $foo == 'bar' {\n  \n  include role::foo\n}\n" }
+
+      it 'should detect a single problem' do
+        expect(problems).to have(1).problems
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(2).in_column(3)
+      end
+    end
+  end
+
+  context 'with fix disabled' do
+    let(:msg) { 'empty line at end of if block' }
+
+    ## trailing empty line
+    context 'empty line before closing curly of if block' do
+      let(:code) { "if $foo == 'bar' {\n  include role::foo\n  \n}\n" }
+
+      it 'should detect a single problem' do
+        expect(problems).to have(1).problems
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(3).in_column(3)
+      end
+    end
+  end
+
+  ## class block
+  context 'with fix disabled' do
+    let(:msg) { 'empty line at start of class block' }
+
+    ## neither leading nor trailing empty line
+    context 'neither leading nor trailing empty line in class block' do
+      let(:code) { "class foo {\n  include role::bar\n}\n" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    ## leading empty line
+    context 'empty line after opening curly of if block' do
+      let(:code) { "class foo {\n  \n  include role::bar\n}\n" }
+
+      it 'should detect a single problem' do
+        expect(problems).to have(1).problems
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(2).in_column(3)
+      end
+    end
+  end
+
+  context 'with fix disabled' do
+    let(:msg) { 'empty line at end of class block' }
+
+    ## trailing empty line
+    context 'empty line before closing curly of class block' do
+      let(:code) { "class foo {\n  include role::bar\n  \n}\n" }
+
+      it 'should detect a single problem' do
+        expect(problems).to have(1).problems
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(3).in_column(3)
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/BlockLength

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-empty_lines_around_body-check
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Christian Bartolomäus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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: rspec-json_expectations
+  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: simplecov
+  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 puppet-lint plugin to check for empty lines around the body of
+  blocks.\n"
+email: use_v6@aglaz.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/check_empty_lines_around_body.rb
+- spec/puppet-lint/plugins/check_empty_lines_around_body_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/usev6/puppet-lint-empty_lines_around_body-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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A puppet-lint plugin to check for empty lines around the body of blocks.
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/check_empty_lines_around_body_spec.rb