puppet-lint-last_comment_line-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21d7fe92204d70fe6c9289ad484c611703ceeba987166dad7ecdbb3f1354dd22
+  data.tar.gz: 3c1010fde6d7bff5825866d3c1f4acc62c8662e80f2df7b62b02dea21da91822
+SHA512:
+  metadata.gz: 614f669f67aad42691e7bacf30e6d5088984294541c9deeb2d1f8a2ced2600ff8d62c685ca2bc6e349ed5d9e86a82dd6f236fc781b700df5e770db3313bafcd7
+  data.tar.gz: ea5208aecef5be7bef341698f840a03c17b130179bc04a8ce13475e258df8f1fea75f6420ad7e0dce65f6505aa797bf4e86d0e6141db9a9651fd2751b15106f8

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 DO! DevOps
+
+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,27 @@
+# Puppet lint last comment line check
+
+This checks whether the last line in a class comment is an empty line
+
+```
+# @param mandatory
+#   A mandatory parameter
+# @option mandatory [String] hashkey
+#   A key of the hash "mandatory" named "hashkey".
+#
+# @param withdefault
+#   A parameter with a default value
+#
+# @param optional
+#   An optional parameter
+#
+class my_class {
+    Hash $mandatory,
+    Boolean $withdefault = false,
+    Optional[String] $optional = undef,
+```
+
+## Usage
+
+To use the plugin, add the following line to the Gemfile:
+
+    gem 'puppet-lint-last_comment_line-check'

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+PuppetLint.new_check(:last_empty_line_comment) do
+  def warn(message, line = 1)
+    notify :warning, { message: message, line: line, column: 1 }
+    false
+  end
+
+  # Find the header comments for a class or a defined type
+  #
+  # @param tokens The list of all tokens
+  # @param token_start The index of the token to start from upwards
+  # @return The head comments
+  def get_comments(tokens, token_start)
+    comments = []
+    token_pointer = token_start - 1
+    while token_pointer >= 0
+      break unless %i[COMMENT NEWLINE].include? tokens[token_pointer].type
+
+      comments.append(tokens[token_pointer])
+      token_pointer -= 1
+    end
+    comments.reject { |comment| comment.type == :NEWLINE }.reverse
+  end
+
+  # Check class or defined type indexes
+  def check_indexes(indexes)
+    indexes.each do |index|
+      comments = get_comments(tokens, index[:start])
+      warn('Last line is not an empty comment') unless comments.last.value =~ /^\s*$/
+    end
+    true
+  end
+
+  # Run the check
+  def check
+    return unless check_indexes(class_indexes)
+
+    nil unless check_indexes(defined_type_indexes)
+  end
+end

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

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe 'last_empty_line_comment' do
+  context 'valid code' do
+    let(:code) do
+      <<~CODE
+        # @summary
+        #   some class
+        #
+        # @param mandatory
+        #   A mandatory parameter
+        #   with two lines
+        #
+        # @param withdefault
+        #   A parameter with a default value
+        #
+        #   A two paragraph description
+        #
+        # @param optional
+        #   An optional parameter
+        #
+        class my_class (
+            String $mandatory,
+            Boolean $withdefault = false,
+            Optional[String] $optional = undef
+        ) {}
+      CODE
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context "missing last empty line" do
+    let(:code) do
+      <<~CODE
+        # @summary
+        #   some class
+        #
+        # @param mandatory
+        #   A mandatory parameter
+        #   with two lines
+        #
+        # @param withdefault
+        #   A parameter with a default value
+        #
+        #   A two paragraph description
+        #
+        # @param optional
+        #   An optional parameter
+        class my_class (
+            String $mandatory,
+            Boolean $withdefault = false,
+            Optional[String] $optional = undef
+        ) {}
+      CODE
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(1).problems
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-last_comment_line-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dennis Ploeger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-09-05 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.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'
+- !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
+  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'
+description: "    An opinionated puppet lint check for checking if the last line of
+  a comment is blank.\n"
+email: develop@dieploegers.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/check_last_empty_line_comment.rb
+- spec/puppet-lint/plugins/check_last_empty_line_comment_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dodevops/puppet-lint-last_comment_line-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.1
+signing_key: 
+specification_version: 4
+summary: An opinionated puppet lint check for checking if the last line of a comment
+  is blank
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/check_last_empty_line_comment_spec.rb