puppet-lint-summary_comment-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 51143fea89148ee6cabc1ef187fb4b1d990d79b3285262e4d36b10756f4b68c1
+  data.tar.gz: 7a1513c2b5f67c8a0af47ae9197f09ba089978cf580a52df51110df7a50006c3
+SHA512:
+  metadata.gz: a09522cffa734867e1eddfa6013751586a835de2d0f394d48475ca6e1b6e7b8e89b05432d87d40b84a6d24370c19df3c7dca90198069137fceac62ab27dc07a1
+  data.tar.gz: cca5dd439858ca0d485a0968780528fcec4d3f1ad1863c0c1408afda27be9eae809a7445db9e4ed4881905294ba3b03db2df818ec3c31657a54835559f70108b

data/README.md

@@ -0,0 +1,16 @@
+# Puppet lint summary check
+
+This checks whether a class contains a valid header comment that starts with a summary like this:
+
+```
+# @summary
+#   This is a Puppet class
+
+class my_class {
+```
+
+## Usage
+
+To use the plugin, add the following line to the Gemfile:
+
+    gem 'puppet-lint-summary_comment-check'

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+PuppetLint.new_check(:summary_comment) do
+  def warn(message, line = 1)
+    notify :warning, { message: message, line: line, column: 1 }
+    false
+  end
+
+  def check_token_types
+    return warn('No header comment found') unless tokens[0].type == :COMMENT
+    return warn('No newline after summary', 2) unless tokens[1].type == :NEWLINE
+    return warn('No comment after summary', 2) unless tokens[2].type == :COMMENT
+
+    true
+  end
+
+  def check_tokens
+    return warn('Summary line contains summary text.') if tokens[0].value =~ / @summary./
+    return warn('Summary line not found') unless tokens[0].value == ' @summary'
+    return warn('No summary found', 2) unless tokens[2].value =~ /^ {3}./
+
+    true
+  end
+
+  def check
+    return warn('Not enough tokens') if tokens.length < 3
+
+    return unless check_token_types
+
+    return unless check_tokens
+  end
+end

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'summary_comment' do
+  context 'code containing the summary' do
+    let(:code) { "# @summary\n#   Test" }
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'empty code' do
+    let(:code) { '' }
+    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('Not enough tokens').on_line(1).in_column(1)
+    end
+  end
+
+  context 'code not containing a head comment' do
+    let(:code) { '\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('No header comment found').on_line(1).in_column(1)
+    end
+  end
+
+  context 'code not containing the summary' do
+    let(:code) { "# Test\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('Summary line not found').on_line(1).in_column(1)
+    end
+  end
+
+  context 'code containing the summary in the same line' do
+    let(:code) { "# @summary Test\n#" }
+
+    it 'should detect a single problems' do
+      expect(problems).to have(1).problems
+    end
+
+    it 'should create a warning' do
+      expect(problems).to contain_warning('Summary line contains summary text.')
+                            .on_line(1)
+                            .in_column(1)
+    end
+  end
+
+  context 'code only containing the summary comment' do
+    let(:code) { "# @summary\n\n" }
+
+    it 'should detect a single problems' do
+      expect(problems).to have(1).problems
+    end
+
+    it 'should create a warning' do
+      expect(problems).to contain_warning('No comment after summary').on_line(2).in_column(1)
+    end
+  end
+
+  context 'code containing the summary comment but no indented summary' do
+    let(:code) { "# @summary\n#" }
+
+    it 'should detect a single problems' do
+      expect(problems).to have(1).problems
+    end
+
+    it 'should create a warning' do
+      expect(problems).to contain_warning('No summary found').on_line(2).in_column(1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+SimpleCov.add_filter 'vendor'
+SimpleCov.start
+
+require 'puppet-lint'
+
+PuppetLint::Plugins.load_spec_helper

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-summary_comment-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dennis Ploeger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-05-24 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: 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: 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: 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: "    A puppet-lint plugin to check that manifest files contain a properly
+  formatted @summary comment.\n"
+email: develop@dieploegers.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/puppet-lint/plugins/check_summary_comment.rb
+- spec/puppet-lint/plugins/check_summary_comment_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dodevops/puppet-lint-summary_comment-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: A puppet-lint plugin to check the @summary comment.
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/check_summary_comment_spec.rb