java-checkstyle-precommit 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f3fe79c21002849f9b84e4293fe51e891a993edb0f1644e5d767cab0a73767d
+  data.tar.gz: f765cecde7bba9ecb8e01562c6ac44b55b7664ae303fefa27fbbca356fd1c3a8
+SHA512:
+  metadata.gz: 9480d6b281ff399883223ad8e89c234c29fc75070e003bb8041c4cf2f22b60bc5cf7692f88b691a266d617e95b141e8a002d55407ba4aff805cd4521accfbbab
+  data.tar.gz: d7e68ee0e2bef54be64402bbab5e05c126c38f9c38f6322452ca102321a029f28f7eb735965767ac54a39162a73c4fa792f74b4363407f48dcf8b700026abb8d

data/lib/plugins/pre_commit/checks/checkstyle.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'pre-commit/checks/shell'
+require_relative '../message/extractor'
+require_relative '../message/formatter'
+require_relative '../support/path'
+
+module PreCommit
+  module Checks
+    ##
+    # Plugin implementation for pre-commit gem
+    #
+    # It provides a java checkstyle validation using checkstyle.jar
+    # for details see:
+    # lib/pre_commit/support/checkstyle
+    class Checkstyle < Shell
+      ##
+      # Function called after pre-commit execution
+      # this method receive the +staged_files+ from git
+      #
+      # @param [String] Standard git ouput with staged files
+      def call(staged_files)
+        staged_files = staged_files.grep(/\.java$/)
+        return if staged_files.empty?
+
+        output = execute(args(staged_files))
+        format(extract(output))
+      end
+
+      def self.description
+        'Runs Checkstyle linter for java code.'
+      end
+
+      private
+
+      def args(staged_files)
+        [
+          'java',
+          checkstyle_jar,
+          configuration_file,
+          staged_files,
+          output_format
+        ]
+      end
+
+      def checkstyle_jar
+        ['-jar', Support::Path.relative_to('checkstyle-6.11-all.jar')]
+      end
+
+      def configuration_file
+        config_file ? ['-c', config_file] : []
+      end
+
+      def output_format
+        ['-f', 'xml']
+      end
+
+      def alternate_config_file
+        Support::Path.relative_to('google_checks.xml')
+      end
+
+      def format(errors)
+        @formatter ||= PreCommit::Message::Formatter.new
+        @formatter.format errors
+      end
+
+      def extract(data)
+        @extractor ||= PreCommit::Message::Extractor.new
+        @extractor.extract data
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/domain/bad_file.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Domain
+  ##
+  # Represents a file with style errors.
+  #
+  class BadFile
+    attr_reader :name, :errors
+
+    ##
+    # Instanciate a default bad file.
+    #
+    # @param [String] The File name
+    # @param [Array] The errors
+    def initialize(name, errors)
+      @name = name
+      @errors = errors
+    end
+  end
+end

data/lib/plugins/pre_commit/domain/checkstyle.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Domain
+  ##
+  # Represents the Checkstyle
+  # @param [Array] of bad files
+  class Checkstyle
+    attr_reader :bad_files
+
+    def initialize(bad_files)
+      @bad_files = bad_files
+    end
+
+    ##
+    # A good checkstyle means no errors.
+    #
+    def good?
+      @bad_files.nil? || @bad_files.empty?
+    end
+
+    ##
+    # Factory for Checkstyle without errors
+    def self.good
+      Domain::Checkstyle.new(nil)
+    end
+  end
+end

data/lib/plugins/pre_commit/message/extractor.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'crack'
+require_relative '../domain/checkstyle'
+require_relative '../domain/bad_file'
+
+module PreCommit
+  module Message
+    ##
+    # Responsible for extract error messages from terminal output
+    class Extractor
+      ##
+      # Extract data from a XML formatted +terminal_output+
+      #
+      # @param terminal_output [String] XML formatted terminal ouput
+      # @return [Domain::Checkstyle] The checkstyle
+      def extract(terminal_output)
+        if blank?(terminal_output) ||
+           blank?(xml_content_of(terminal_output))
+          return Domain::Checkstyle.good
+        end
+
+        xml_data = Crack::XML.parse(xml_content_of(terminal_output))
+        files = xml_data['checkstyle']['file']
+
+        Domain::Checkstyle.new(extract_bad_file(files))
+      end
+
+      private
+
+      def xml_content_of(raw_output)
+        raw_output[/<(.*)>/m]
+      end
+
+      def extract_bad_file(xml_files)
+        return [bad_file(xml_files)] unless xml_files.is_a? Array
+        xml_files.map { |e| bad_file(e) }
+      end
+
+      def bad_file(file)
+        Domain::BadFile.new(file['name'], extract_errors(file))
+      end
+
+      def extract_errors(file)
+        return [] if blank? file['error']
+        return [file['error']] unless file['error'].is_a? Array
+        file['error']
+      end
+
+      def blank?(value)
+        value.nil? || value.empty?
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/message/formatter.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module PreCommit
+  module Message
+    ##
+    # Responsible for format a given output
+    class Formatter
+      ##
+      # Format output for a given +errors+ details
+      #
+      # @param checkstyle [Domain::Checkstyle] Checkstyle details
+      # @return [String] formatted output or nil when has no errors
+      # @raise ArgumentError when input is empty
+      #
+      def format(checkstyle)
+        throw ArgumentError.new if checkstyle.nil?
+        return nil if checkstyle.good?
+
+        format_multiple(checkstyle.bad_files)
+      end
+
+      private
+
+      def format_multiple(files)
+        files.reduce('') { |a, e| a + format_single(e) }
+      end
+
+      def format_single(bad_file)
+        "File errors: #{bad_file.name} \n" + format_errors(bad_file.errors)
+      end
+
+      def format_errors(errors)
+        errors.reduce('') { |a, e| a + line(e) }
+      end
+
+      def line(error)
+        "  line: #{error['line']}:#{error['column']}"\
+          " error: #{error['message']}\n"
+      end
+    end
+  end
+end

data/lib/plugins/pre_commit/support/path.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Support
+  ##
+  # Responsible for provide relative paths to support files
+  # Files located under: /lib/plugin/pre_commit/support/checkstyle*
+  module Path
+    ##
+    # Return support path relative to a given +file+
+    #
+    # @param file [String] file name
+    # @return [String] formatted path
+    def self.relative_to(file)
+      File.expand_path(
+        "../../../../resources/checkstyle/#{file}",
+        __FILE__
+      )
+    end
+  end
+end

data/lib/pre_commit/checkstyle/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+##
+# This is a fork version of the original
+# checkstyle:
+# https://github.com/secondrotation/pre-commit-checkstyle
+#
+module PreCommit
+  # Main file: checks/checkstyle.rb
+  module Checkstyle
+    VERSION = '1.0.0'
+  end
+end

data/lib/resources/checkstyle/google_checks.xml

@@ -0,0 +1,44 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+          "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
+          "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
+
+<module name = "Checker">
+    <property name="charset" value="UTF-8"/>
+
+    <property name="fileExtensions" value="java, properties, xml"/>
+    <!-- Checks for whitespace                               -->
+    <!-- See http://checkstyle.sf.net/config_whitespace.html -->
+        <module name="FileTabCharacter">
+            <property name="eachLine" value="true"/>
+        </module>
+
+    <module name="TreeWalker">
+
+        <module name="NeedBraces"/>
+        <module name="WhitespaceAround">
+            <property name="allowEmptyConstructors" value="true"/>
+            <property name="allowEmptyMethods" value="true"/>
+            <property name="allowEmptyTypes" value="true"/>
+            <property name="allowEmptyLoops" value="true"/>
+            <message key="ws.notFollowed"
+             value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
+             <message key="ws.notPreceded"
+             value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
+        </module>
+        <module name="EmptyLineSeparator">
+            <property name="allowNoEmptyLineBetweenFields" value="true"/>
+        </module>
+        <module name="Indentation">
+            <property name="basicOffset" value="2"/>
+            <property name="braceAdjustment" value="0"/>
+            <property name="caseIndent" value="2"/>
+            <property name="throwsIndent" value="4"/>
+            <property name="lineWrappingIndentation" value="4"/>
+            <property name="arrayInitIndent" value="2"/>
+        </module>
+        <module name="EmptyCatchBlock">
+            <property name="exceptionVariableName" value="expected"/>
+        </module>
+    </module>
+</module>

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: java-checkstyle-precommit
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aravind Selvamani
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pre-commit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.26'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.26'
+- !ruby/object:Gem::Dependency
+  name: crack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+description: Checkstyle linter plugin for pre-commit. Useful for linting Java code.
+email:
+- aaravind281096@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/plugins/pre_commit/checks/checkstyle.rb
+- lib/plugins/pre_commit/domain/bad_file.rb
+- lib/plugins/pre_commit/domain/checkstyle.rb
+- lib/plugins/pre_commit/message/extractor.rb
+- lib/plugins/pre_commit/message/formatter.rb
+- lib/plugins/pre_commit/support/path.rb
+- lib/pre_commit/checkstyle/version.rb
+- lib/resources/checkstyle/checkstyle-6.11-all.jar
+- lib/resources/checkstyle/google_checks.xml
+homepage:
+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.9
+signing_key:
+specification_version: 4
+summary: Checkstyle linter plugin for pre-commit
+test_files: []