java-checkstyle 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7195c535a4ffe35bc6059ad1dc13a1e326dfc94e
+  data.tar.gz: c8facc5e071412a45073591ed1aaf76f01d5cfe2
+SHA512:
+  metadata.gz: 8e5184be4154f4a5db9f184c411f3c3492079b39be29ae7e167b5c0bdffc0f0416950015913537137ddda9e58a5ab1c837a305f8b24570751bd34a4e6fc35197
+  data.tar.gz: 953cb0b0c1c35b4499d7898273af8a1bc3a44dbe177d2611f4b4e8fb438c8d9a883ce9a6d558d50b5ae27f47f1276dd6b632183ffda2e5fc377a23afa5182746

data/.codeclimate.yml

@@ -0,0 +1,2 @@
+languages:
+  Ruby: true

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.2.0
+  - jruby-19mode
+
+script:
+  - rake
+  - bundle exec rubocop lib/*

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pre-commit-checkstyle.gemspec
+gemspec
+gem 'crack'
+
+group :test do
+  gem "codeclimate-test-reporter", require: nil
+  gem 'rubocop', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Allen Madsen
+
+MIT License
+
+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,47 @@
+## Java - Pre-Commit Checkstyle
+[![Build Status](https://travis-ci.org/CristianOliveiraDaRosa/java-checkstyle.svg?branch=dev)](https://travis-ci.org/CristianOliveiraDaRosa/java-checkstyle)
+[![Code Climate](https://codeclimate.com/github/CristianOliveiraDaRosa/java-checkstyle/badges/gpa.svg)](https://codeclimate.com/github/CristianOliveiraDaRosa/java-checkstyle)
+[![Test Coverage](https://codeclimate.com/github/CristianOliveiraDaRosa/java-checkstyle/badges/coverage.svg)](https://codeclimate.com/github/CristianOliveiraDaRosa/java-checkstyle/coverage)
+
+[Checkstyle](http://checkstyle.sourceforge.net/) linter plugin for [pre-commit](https://github.com/jish/pre-commit). Useful for linting Java code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pre-commit-checkstyle'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pre-commit-checkstyle
+
+## Usage
+
+Make sure the gem is installed and setup the check in [pre-commit](https://github.com/jish/pre-commit) with:
+
+``` bash
+pre-commit enable git checks checkstyle
+```
+
+OR
+
+``` bash
+pre-commit enable yaml checks checkstyle
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/secondrotation/pre-commit-checkstyle/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Authors:
+ - Allen Madsen (Original Version 0.0.1)
+ - Alex Rocha
+ - Cristian Oliveira

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/java-checkstyle.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pre-commit/checkstyle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "java-checkstyle"
+  spec.version       = PreCommit::Checkstyle::VERSION
+  spec.authors       = ["Allen Madsen", "Cristian Oliveira", "Alex Rocha"]
+  spec.email         = ["blatyo@gmail.com", "contato@cristianoliveira.com.br"]
+  spec.summary       = %q{Checkstyle linter plugin for pre-commit}
+  spec.description   = %q{Checkstyle linter plugin for pre-commit. Useful for linting Java code.}
+  spec.homepage      = "https://github.com/CristianOliveiraDaRosa/java-checkstyle"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency('pre-commit', '~> 0.16')
+  spec.add_dependency('crack', '~> 0.4.2')
+
+  spec.add_development_dependency("bundler", "~> 1.5")
+  spec.add_development_dependency("rake", '~> 10.4', '>= 10.4.2')
+  spec.add_development_dependency("rspec", '~> 3.3', '>= 3.3.2')
+end

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

@@ -0,0 +1,71 @@
+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
+
+      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('sun_checks.xml')
+      end
+
+      def self.description
+        'Runs coffeelint to detect errors'
+      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/message/extractor.rb

@@ -0,0 +1,27 @@
+require 'crack'
+
+module PreCommit
+  module Message
+    ##
+    # Responsible for extract error messages from terminal output
+    class Extractor
+      EMPTY = { 'checkstyle' => { 'file' => [] } }
+
+      ##
+      # Extract data from a XML formatted +output+
+      #
+      # @param output [String] Xml formatted ouput
+      # @return [Hash]
+      def extract(output)
+        return EMPTY if output.nil? || output.empty?
+        Crack::XML.parse(xml_content(output))
+      end
+
+      private
+
+      def xml_content(raw_output)
+        raw_output[/<(.*)>/m]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module PreCommit
+  module Message
+    ##
+    # Responsible for format a given output
+    class Formatter
+      ##
+      # Format output for a given +errors+ details
+      #
+      # @param [Hash] JSON errors details
+      # @return [String] formatted output (may return nil)
+      def format(errors)
+        files = errors['checkstyle']['file']
+
+        return nil if files.empty?
+        return format_single(files) unless files.is_a? Array
+
+        format_multiple(files)
+      end
+
+      private
+
+      def format_errors(errors)
+        errors.reduce('') do |out, error|
+          out + "  line: #{error['line']}:#{error['column']}"\
+            " error: #{error['message']}\n"
+        end
+      end
+
+      def format_single(file)
+        "File errors: #{file['name']} \n" + format_errors(file['error'])
+      end
+
+      def format_multiple(files)
+        files.reduce('') { |a, e| a + format_single(e) }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+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(
+        "../../../../pre-commit/support/checkstyle/#{file}",
+        __FILE__
+      )
+    end
+  end
+end

data/lib/pre-commit/checkstyle/version.rb

@@ -0,0 +1,16 @@
+##
+# This a fork version of the original
+# checkstyle:
+# https://github.com/secondrotation/pre-commit-checkstyle
+#
+module PreCommit
+  ##
+  # CheckStyle Version
+  # Authors:
+  #  Allen Madsen (Original Version 0.0.1)
+  #  Cristian Oliveira
+  #  Alex Rocha
+  module Checkstyle
+    VERSION = '0.0.2'
+  end
+end

data/lib/pre-commit/support/checkstyle/google_checks.xml

@@ -0,0 +1,206 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+          "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
+          "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
+
+<!--
+
+    Checkstyle configuration that checks the Google coding conventions from:
+
+    -  Google Java Style
+       https://google-styleguide.googlecode.com/svn-history/r130/trunk/javaguide.html
+
+    Checkstyle is very configurable. Be sure to read the documentation at
+    http://checkstyle.sf.net (or in your downloaded distribution).
+
+    Most Checks are configurable, be sure to consult the documentation.
+
+    To completely disable a check, just comment it out or delete it from the file.
+
+    Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
+
+ -->
+
+<module name = "Checker">
+    <property name="charset" value="UTF-8"/>
+
+    <property name="severity" value="warning"/>
+
+    <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="OuterTypeFilename"/>
+        <module name="IllegalTokenText">
+            <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
+            <property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
+            <property name="message" value="Avoid using corresponding octal or Unicode escape."/>
+        </module>
+        <module name="AvoidEscapedUnicodeCharacters">
+            <property name="allowEscapesForControlCharacters" value="true"/>
+            <property name="allowByTailComment" value="true"/>
+            <property name="allowNonPrintableEscapes" value="true"/>
+        </module>
+        <module name="LineLength">
+            <property name="max" value="100"/>
+            <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
+        </module>
+        <module name="AvoidStarImport"/>
+        <module name="OneTopLevelClass"/>
+        <module name="NoLineWrap"/>
+        <module name="EmptyBlock">
+            <property name="option" value="TEXT"/>
+            <property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
+        </module>
+        <module name="NeedBraces"/>
+        <module name="LeftCurly">
+            <property name="maxLineLength" value="100"/>
+        </module>
+        <module name="RightCurly"/>
+        <module name="RightCurly">
+            <property name="option" value="alone"/>
+            <property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/>
+        </module>
+        <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="OneStatementPerLine"/>
+        <module name="MultipleVariableDeclarations"/>
+        <module name="ArrayTypeStyle"/>
+        <module name="MissingSwitchDefault"/>
+        <module name="FallThrough"/>
+        <module name="UpperEll"/>
+        <module name="ModifierOrder"/>
+        <module name="EmptyLineSeparator">
+            <property name="allowNoEmptyLineBetweenFields" value="true"/>
+        </module>
+        <module name="SeparatorWrap">
+            <property name="tokens" value="DOT"/>
+            <property name="option" value="nl"/>
+        </module>
+        <module name="SeparatorWrap">
+            <property name="tokens" value="COMMA"/>
+            <property name="option" value="EOL"/>
+        </module>
+        <module name="PackageName">
+            <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
+            <message key="name.invalidPattern"
+             value="Package name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="TypeName">
+            <message key="name.invalidPattern"
+             value="Type name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="MemberName">
+            <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
+            <message key="name.invalidPattern"
+             value="Member name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="ParameterName">
+            <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
+            <message key="name.invalidPattern"
+             value="Parameter name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="LocalVariableName">
+            <property name="tokens" value="VARIABLE_DEF"/>
+            <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
+            <property name="allowOneCharVarInForLoop" value="true"/>
+            <message key="name.invalidPattern"
+             value="Local variable name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="ClassTypeParameterName">
+            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
+            <message key="name.invalidPattern"
+             value="Class type name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="MethodTypeParameterName">
+            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
+            <message key="name.invalidPattern"
+             value="Method type name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="NoFinalizer"/>
+        <module name="GenericWhitespace">
+            <message key="ws.followed"
+             value="GenericWhitespace ''{0}'' is followed by whitespace."/>
+             <message key="ws.preceded"
+             value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
+             <message key="ws.illegalFollow"
+             value="GenericWhitespace ''{0}'' should followed by whitespace."/>
+             <message key="ws.notPreceded"
+             value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
+        </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="AbbreviationAsWordInName">
+            <property name="ignoreFinal" value="false"/>
+            <property name="allowedAbbreviationLength" value="1"/>
+        </module>
+        <module name="OverloadMethodsDeclarationOrder"/>
+        <module name="VariableDeclarationUsageDistance"/>
+        <module name="CustomImportOrder">
+            <property name="specialImportsRegExp" value="com.google"/>
+            <property name="sortImportsInGroupAlphabetically" value="true"/>
+            <property name="customImportOrderRules" value="STATIC###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE"/>
+        </module>
+        <module name="MethodParamPad"/>
+        <module name="OperatorWrap">
+            <property name="option" value="NL"/>
+            <property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR "/>
+        </module>
+        <module name="AnnotationLocation">
+            <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
+        </module>
+        <module name="AnnotationLocation">
+            <property name="tokens" value="VARIABLE_DEF"/>
+            <property name="allowSamelineMultipleAnnotations" value="true"/>
+        </module>
+        <module name="NonEmptyAtclauseDescription"/>
+        <module name="JavadocTagContinuationIndentation"/>
+        <module name="SummaryJavadocCheck">
+            <property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
+        </module>
+        <module name="JavadocParagraph"/>
+        <module name="AtclauseOrder">
+            <property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
+            <property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
+        </module>
+        <module name="JavadocMethod">
+            <property name="scope" value="public"/>
+            <property name="allowMissingParamTags" value="true"/>
+            <property name="allowMissingThrowsTags" value="true"/>
+            <property name="allowMissingReturnTag" value="true"/>
+            <property name="minLineCount" value="2"/>
+            <property name="allowedAnnotations" value="Override, Test"/>
+            <property name="allowThrowsTagsForSubclasses" value="true"/>
+        </module>
+        <module name="MethodName">
+            <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
+            <message key="name.invalidPattern"
+             value="Method name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="SingleLineJavadoc">
+            <property name="ignoreInlineTags" value="false"/>
+        </module>
+        <module name="EmptyCatchBlock">
+            <property name="exceptionVariableName" value="expected"/>
+        </module>
+        <module name="CommentsIndentation"/>
+    </module>
+</module>