checkstyle-suppression-generator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42e391eb667e9f0df93569f81c1b6b6f2cfb6b870ed541d794b95ec15f71feaa
+  data.tar.gz: 366c228d8a8d5a27cec451fe35e6a9d035f4bb03cf53e6f9a3d76cb42370d91e
+SHA512:
+  metadata.gz: 59c239fdf6265eee4930e9eccf4d96bafae357a4c461f1a74606338f876c4f4c50570bc5d546b6a0313e77e1d20a04cc7d222e4725edb845bd16c188b3fc9e4e
+  data.tar.gz: 588388ee5b9c58b34f2fc48c2695177ffc4bb85fd795122ee12ce8bf7d09b287d96db07383dc36cc8c4a395723de7cb0718877cd627d4603d7e6db39ab7abbd6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Tyler Matthews
+
+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,86 @@
+# Checkstyle Suppression Generator
+[![Gem Version](https://badge.fury.io/rb/checkstyle-suppression-generator.svg)](https://badge.fury.io/rb/checkstyle-suppression-generator)
+![CI Status](https://github.com/matthewstyler/ruby-perlin-2D-map-generator/actions/workflows/main.yml/badge.svg)
+![CodeQL](https://github.com/matthewstyler/checkstyle-suppression-generator/workflows/CodeQL/badge.svg)
+<a href="https://codeclimate.com/github/matthewstyler/checkstyle-suppression-generator/test_coverage"><img src="https://api.codeclimate.com/v1/badges/b63e2b943acbfd970fae/test_coverage" /></a>
+<a href="https://codeclimate.com/github/matthewstyler/checkstyle-suppression-generator/maintainability"><img src="https://api.codeclimate.com/v1/badges/b63e2b943acbfd970fae/maintainability" /></a>
+
+A gem that takes as input the output of a maven checkstyle plugin checkstyle:check goal and generates a suppressions.xml file.
+
+Example Input:
+```sh
+[INFO] Scanning for projects...
+[INFO] ------------------------------------------------------------------------
+[INFO] Reactor Build Order:
+[INFO] 
+[INFO] my-project                                                         [jar]
+[INFO]  ------------------< com.my-project:my-project >------------------
+[INFO] Building my-project 0.0.1-SNAPSHOT                          [1/1]
+[INFO]   from my-project/pom.xml
+[INFO] --------------------------------[ jar ]---------------------------------
+[INFO] 
+[INFO] --- checkstyle:3.3.0:check (default-cli) @ my-project ---
+[WARNING] src/main/java/com/test/DEF.java:[147,4] (coding) OverloadMethodsDeclarationOrder: All overloaded methods should be placed next to each other. Placing non-overloaded methods in between overloaded methods with the same type is a violation. Previous overloaded method located at line '119'.
+[WARNING] src/main/java/com/test/ABC.java:[26,11] (sizes) ParameterNumber: More than 7 parameters (found 9).
+[WARNING] src/main/java/com/test/ABC.java:[103,4] (coding) ReturnCount: Return count is 6 (max allowed for non-void methods/lambdas is 4).
+[WARNING] src/main/java/com/test/ABC.java:[103,4] (metrics) NPathComplexity: NPath Complexity is 720 (max allowed is 200).
+[INFO] ------------------------------------------------------------------------
+[INFO] Reactor Summary for my-project 0.0.1-SNAPSHOT:
+[INFO] 
+[INFO] my-project .................................. FAILURE [  1.957 s]
+[INFO] ------------------------------------------------------------------------
+[INFO] BUILD FAILURE
+[INFO] ------------------------------------------------------------------------
+[INFO] Total time:  2.841 s
+[INFO] Finished at: 2023-12-20T16:31:35-05:00
+[INFO] ------------------------------------------------------------------------
+[ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.3.0:check (default-cli) on project my-project: You have 4 Checkstyle violations. -> [Help 1]
+[ERROR] 
+[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
+[ERROR] Re-run Maven using the -X switch to enable full debug logging.
+[ERROR] 
+[ERROR] For more information about the errors and possible solutions, please read the following articles:
+[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoFailureException
+[ERROR] 
+[ERROR] After correcting the problems, you can resume the build with the command
+[ERROR]   mvn <args> -rf :my-project
+
+```
+
+Output:
+
+```xml
+<?xml version="1.0"?>
+<!DOCTYPE suppressions PUBLIC "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
+      "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+
+<suppressions>
+
+	<suppress checks="OverloadMethodsDeclarationOrder" files="src/main/java/com/test/DEF.java"/>
+	<suppress checks="ParameterNumber" files="src/main/java/com/test/ABC.java"/>
+	<suppress checks="ReturnCount" files="src/main/java/com/test/ABC.java"/>
+	<suppress checks="NPathComplexity" files="src/main/java/com/test/ABC.java"/>
+
+</suppressions>
+
+```
+
+
+## Command Line Usage
+```sh
+Usage: checkstyle-suppression-generator command [OPTIONS]
+       CHECKSTYLE_OUTPUT_FILE(STRING) [O=O]
+
+Generate a Java checkstyle suppressions.xml file from a checkstyle:check output.
+
+
+Arguments:
+  CHECKSTYLE_OUTPUT_FILE(STRING)  Output from checkstyle:check goal
+
+Keywords:
+  O=O  Name of the suppressions file to be generated (default
+       "suppressions.xml")
+
+Options:
+  -h, --help  Print usage
+```

data/bin/checkstyle-suppression-generator

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+require 'CLI/command'
+
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+CLI::Command.new.parse.run

data/lib/CLI/command.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'tty/option'
+require 'suppression_generator'
+
+module CLI
+  # Command line usage for the suppression generator
+  class Command
+    include TTY::Option
+
+    usage do
+      program 'checkstyle-suppression-generator'
+      desc 'Generate a Java checkstyle suppressions.xml file from a checkstyle:check output.'
+    end
+
+    argument :checkstyle_output_file do
+      name 'checkstyle_output_file(String)'
+      arity one
+      desc 'Output from checkstyle:check goal'
+    end
+
+    keyword :o do
+      default 'suppressions.xml'
+      arity one
+      desc 'Name of the suppressions file to be generated'
+    end
+
+    flag :help do
+      short '-h'
+      long '--help'
+      desc 'Print usage'
+    end
+
+    def run
+      if params[:help]
+        print help
+      elsif params.errors.any?
+        puts params.errors.summary
+      else
+        execute_command
+      end
+    end
+
+    private
+
+    def execute_command
+      SuppressionGenerator.new(params[:checkstyle_output_file], params[:o]).generate
+    end
+  end
+end

data/lib/checkstyle_output_reader.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Reads the checkstyle:check file
+class CheckstyleOutputReader
+  def initialize(filename)
+    @filename = filename
+  end
+
+  def read
+    File.read(@filename)
+  rescue Errno::ENOENT
+    raise ArgumentError, "File not found: #{@filename}"
+  end
+end

data/lib/checkstyle_output_token.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Data bag to capture fields used to generate suppressions from an offending checkstyle output line
+class CheckstyleOutputToken
+  attr_reader :severity, :file_name, :offense
+
+  def initialize(token_data)
+    @severity = token_data[1]
+    @file_name = token_data[2]
+    @offense = token_data[3]
+  end
+
+  def to_suppression
+    "\t<suppress checks=\"#{offense}\" files=\"#{file_name}\"/>"
+  end
+end

data/lib/checkstyle_output_tokenizer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'checkstyle_output_token'
+
+# Tokenizes each line of a given output string
+class CheckstyleOutputTokenizer
+  PATTERN = /\[(\w+)\]\s+(\S+\.java)(?:.*\)).(\w+):/.freeze
+
+  def initialize(checkstyle_output)
+    @checkstyle_output = checkstyle_output
+  end
+
+  def tokenize
+    @tokenize ||= @checkstyle_output.each_line.map do |line|
+      token_data = PATTERN.match(line)
+      CheckstyleOutputToken.new(token_data) if token_data
+    end.compact
+  end
+end

data/lib/suppression_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'checkstyle_output_reader'
+require 'checkstyle_output_tokenizer'
+require 'suppressions_populator'
+require 'suppression_writer'
+
+# Facade that manages the application input and output for suppression generation
+class SuppressionGenerator
+  def initialize(checkstyle_file_name, suppressions_file_name)
+    @checkstyle_file_name = checkstyle_file_name
+    @suppressions_file_name = suppressions_file_name
+  end
+
+  def generate
+    write_suppressions(SuppressionsPopulator.new(tokenize_checkstyle_output(read_checkstyle_file)).populate)
+  end
+
+  private
+
+  def write_suppressions(suppression_xml)
+    SuppressionWriter.new(@suppressions_file_name, suppression_xml).write
+  end
+
+  def read_checkstyle_file
+    CheckstyleOutputReader.new(@checkstyle_file_name).read
+  end
+
+  def tokenize_checkstyle_output(checkstyle_output)
+    CheckstyleOutputTokenizer.new(checkstyle_output).tokenize
+  end
+end

data/lib/suppression_writer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Writes the suppression xml to a given file name
+class SuppressionWriter
+  def initialize(file_name, suppression_xml)
+    @file_name = file_name
+    @suppression_xml = suppression_xml
+  end
+
+  def write
+    File.write(@file_name, @suppression_xml)
+  end
+end

data/lib/suppressions_populator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Populates a string with the suppression xml, given a list of tokens
+class SuppressionsPopulator
+  HEADER = <<~HEADER
+    <?xml version="1.0"?>
+    <!DOCTYPE suppressions PUBLIC "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
+          "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+
+    <suppressions>
+  HEADER
+
+  FOOTER = <<~FOOTER
+    </suppressions>
+  FOOTER
+
+  def initialize(tokens)
+    @tokens = tokens
+  end
+
+  def populate
+    "#{HEADER}\n#{@tokens.map(&:to_suppression).join("\n")}\n\n#{FOOTER}"
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: checkstyle-suppression-generator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tyler Matthews (matthewstyler)
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-option
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.18'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.58.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.58.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+description: |-
+  A gem that takes as input the output of a maven checkstyle plugin checkstyle:check goal and
+                      generates a suppressions.xml file
+email: matthews.tyl@gmail.com
+executables:
+- checkstyle-suppression-generator
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/checkstyle-suppression-generator
+- lib/CLI/command.rb
+- lib/checkstyle_output_reader.rb
+- lib/checkstyle_output_token.rb
+- lib/checkstyle_output_tokenizer.rb
+- lib/suppression_generator.rb
+- lib/suppression_writer.rb
+- lib/suppressions_populator.rb
+homepage: https://github.com/matthewstyler/checkstyle-suppression-generator
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/matthewstyler/checkstyle-suppression-generator
+  bug_tracker_uri: https://github.com/matthewstyler/checkstyle-suppression-generator/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Generate a Java checkstyle suppressions.xml file from a checkstyle:check
+  output.
+test_files: []