init

matthewstyler · matthewstyler · commit f8855069399c · 2023-12-20T22:29:31.000-05:00
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler" 
+    directory: "/"
+    schedule:
+      interval: "weekly"
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
+        with:
+          ruby-version: '2.7.0'
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake test
+      - name: Publish code coverage
+        uses: paambaati/codeclimate-action@v2.7.5
+        env:
+          CC_TEST_REPORTER_ID: ${{secrets.CLIMATE_REPORTER_ID}}
+        with:
+          coverageLocations: |
+            /home/runner/work/checkstyle-suppression-generator/checkstyle-suppression-generator/coverage/coverage.json:simplecov
+
+  lint:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
+        with:
+          ruby-version: '2.7.0'
+      - name: Install dependencies
+        run: bundle install
+      - name: Rubocop
+        run: rubocop
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+Gemfile.lock
+.irb_history
+errors.txt
+suppressions.xml
diff --git a/.irbrc b/.irbrc
@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+def require_all_files(directory)
+  Dir["#{directory}/**/*.rb"].sort.each { |file| require file }
+end
+
+# Require all files in the project_root directory and its subdirectories
+require_all_files(File.expand_path(__dir__))
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -0,0 +1,15 @@
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Exclude:
+    - 'test/**/*'
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+Metrics/MethodLength:
+  Exclude:
+    - 'test/**/*'
+Metrics/AbcSize:
+  Exclude:
+    - 'test/**/*'
diff --git a/.ruby-version b/.ruby-version
@@ -0,0 +1 @@
+2.7.0
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
diff --git a/LICENSE b/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.
diff --git a/README.md b/README.md
@@ -0,0 +1,2 @@
+# Checkstyle Suppression Generator
+
diff --git a/Rakefile b/Rakefile
@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'minitest/test_task'
+
+Minitest::TestTask.create(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.warning = false
+  t.test_prelude = %(require "test/test_helper") # simple cov is before framework
+  t.test_globs = ['test/**/*_test.rb']
+end
+
+task :irb do
+  exec 'irb -I lib'
+end
+
+task :lint do
+  exec 'rubocop -A'
+end
+
+task :test_and_lint do
+  Rake::Task['test'].invoke
+  Rake::Task['lint'].invoke
+end
diff --git a/bin/checkstyle-suppression-generator b/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
diff --git a/checkstyle-suppression-generator.gemspec b/checkstyle-suppression-generator.gemspec
@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name          = 'checkstyle-suppression-generator'
+  s.version       = '0.0.1'
+  s.summary       = 'Generate a Java checkstyle suppressions.xml file from a checkstyle:check output.'
+  s.description   = 'A gem that takes as input the output of a maven checkstyle plugin checkstyle:check goal and
+                    generates a suppressions.xml file'
+  s.authors       = ['Tyler Matthews (matthewstyler)']
+  s.email         = 'matthews.tyl@gmail.com'
+  s.files         = `git ls-files bin lib *.md LICENSE`.split("\n")
+  s.license       = 'MIT'
+  s.executables   = ['checkstyle-suppression-generator']
+  s.require_paths = ['lib']
+
+  s.required_ruby_version       = '>= 2.7.0'
+
+  s.homepage                    = 'https://github.com/matthewstyler/checkstyle-suppression-generator'
+  s.metadata['source_code_uri'] = 'https://github.com/matthewstyler/checkstyle-suppression-generator'
+  s.metadata['bug_tracker_uri'] = 'https://github.com/matthewstyler/checkstyle-suppression-generator/issues'
+
+  s.add_dependency 'tty-option', '~> 0.3.0'
+
+  s.add_development_dependency 'minitest', '~> 5.18'
+  s.add_development_dependency 'mocha', '~> 2.1.0'
+  s.add_development_dependency 'pry-byebug', '~> 3.10.1'
+  s.add_development_dependency 'rake', '~> 13.1.0'
+  s.add_development_dependency 'rubocop', '~> 1.58.0'
+  s.add_development_dependency 'simplecov', '~> 0.22.0'
+end
diff --git a/lib/CLI/command.rb b/lib/CLI/command.rb
@@ -0,0 +1,52 @@
+# 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 do
+      name 'checkstyle_output(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
+      puts params[:checkstyle_output]
+      puts params[:o]
+      SuppressionGenerator.new(params[:checkstyle_output], params[:o]).generate
+    end
+  end
+end
diff --git a/lib/checkstyle_output_reader.rb b/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
diff --git a/lib/checkstyle_output_token.rb b/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
diff --git a/lib/checkstyle_output_tokenizer.rb b/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
diff --git a/lib/suppression_generator.rb b/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
diff --git a/lib/suppression_writer.rb b/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
diff --git a/lib/suppressions_populator.rb b/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
diff --git a/test/CLI/command_test.rb b/test/CLI/command_test.rb
diff --git a/test/checkstyle_output_reader_test.rb b/test/checkstyle_output_reader_test.rb
diff --git a/test/checkstyle_output_token_test.rb b/test/checkstyle_output_token_test.rb
diff --git a/test/checkstyle_output_tokenizer_test.rb b/test/checkstyle_output_tokenizer_test.rb
diff --git a/test/suppression_generator_test.rb b/test/suppression_generator_test.rb
diff --git a/test/suppression_writer_test.rb b/test/suppression_writer_test.rb
diff --git a/test/suppressions_populator_test.rb b/test/suppressions_populator_test.rb
diff --git a/test/test_helper.rb b/test/test_helper.rb

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +# frozen_string_literal: true
++
 +source 'https://rubygems.org'
++
 +gemspec
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# Checkstyle Suppression Generator`
	`2`	`+`