pre-commit-checkstyle 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTNhMDBkMGE2MDM1YTA0ZTYyYjY1ZjQ2ZGVjMmMwY2M1ZjkyODMyZQ==
+  data.tar.gz: !binary |-
+    NmRkMTEzNDY1NWYzODlmNGQ1Y2VkYzhjNDRlZWQ0M2Q3YTkzMTZjZA==
+SHA512:
+  metadata.gz: !binary |-
+    OTQzN2I2NmQ3NzkxNGUzY2M4MmFjNzllYjNkODIxMjlkNTA3YjdkMmQ4ZTI4
+    YWFmZWMyNDgxNjk3MGE1ODc2ZTJiYTMxMGQyYWI5Y2IyNzM0MDRiYTJhMDMx
+    OWQ1MTMwY2ExZmQ0ZWRiZjc1NDk4MGYwMWI4ZTM4NGNmMTY5OTk=
+  data.tar.gz: !binary |-
+    Y2M3NDcwMDMxZmY4NTcwODY1NGM4YTE4YjUwYTVmYTFkMjBlMjZhN2RmZjQw
+    OTkxYzVhMDBiOWEwM2FkMGEyMGM0OWUwNjEwMDkwOWRkZDg2NDA4NGMzMDVi
+    YjU0ZjIwNzk4OTQ0YjU2MGI5NGZmNTE3NjAxODJiYTk0ODYzNTA=

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,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pre-commit-checkstyle.gemspec
+gemspec
+
+gem 'pry-debugger', platforms: :mri

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,41 @@
+# PreCommit::Checkstyle
+
+[![Build Status](https://travis-ci.org/secondrotation/pre-commit-checkstyle.svg?branch=master)](https://travis-ci.org/secondrotation/pre-commit-checkstyle)
+
+[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

data/Rakefile

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

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

@@ -0,0 +1,36 @@
+require 'pre-commit/checks/shell'
+
+module PreCommit
+  module Checks
+    class Checkstyle < Shell
+      def call(staged_files)
+        staged_files = staged_files.grep(/\.java$/)
+        return if staged_files.empty?
+
+        args = (jar_flag + config_file_flag + staged_files).join(' ')
+
+        execute("java #{args}")
+      end
+
+      def jar_flag
+        ['-jar', support_path('checkstyle-5.7-all.jar')]
+      end
+
+      def support_path(file)
+        File.expand_path("../../../../pre-commit/support/checkstyle/#{file}", __FILE__)
+      end
+
+      def config_file_flag
+        config_file ? ['-c', config_file] : []
+      end
+
+      def alternate_config_file
+        support_path('sun_checks.xml')
+      end
+
+      def self.description
+        'Runs coffeelint to detect errors'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module PreCommit
+  module Checkstyle
+    VERSION = "0.0.1"
+  end
+end

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

@@ -0,0 +1,177 @@
+<?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 sun coding conventions from:
+
+    - the Java Language Specification at
+      http://java.sun.com/docs/books/jls/second_edition/html/index.html
+
+    - the Sun Code Conventions at http://java.sun.com/docs/codeconv/
+
+    - the Javadoc guidelines at
+      http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
+
+    - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html
+
+    - some best practices
+
+  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.
+
+  Finally, it is worth reading the documentation.
+
+-->
+
+<module name="Checker">
+    <!--
+        If you set the basedir property below, then all reported file
+        names will be relative to the specified directory. See
+        http://checkstyle.sourceforge.net/5.x/config.html#Checker
+
+        <property name="basedir" value="${basedir}"/>
+    -->
+
+    <!-- Checks that a package-info.java file exists for each package.     -->
+    <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
+    <!-- <module name="JavadocPackage"/> -->
+
+    <!-- Checks whether files end with a new line.                        -->
+    <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
+    <module name="NewlineAtEndOfFile"/>
+
+    <!-- Checks that property files contain the same keys.         -->
+    <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
+    <module name="Translation"/>
+
+    <!-- Checks for Size Violations.                    -->
+    <!-- See http://checkstyle.sf.net/config_sizes.html -->
+    <module name="FileLength"/>
+
+    <!-- Checks for whitespace                               -->
+    <!-- See http://checkstyle.sf.net/config_whitespace.html -->
+    <module name="FileTabCharacter"/>
+
+    <!-- Miscellaneous other checks.                   -->
+    <!-- See http://checkstyle.sf.net/config_misc.html -->
+    <module name="RegexpSingleline">
+       <property name="format" value="\s+$"/>
+       <property name="minimum" value="0"/>
+       <property name="maximum" value="0"/>
+       <property name="message" value="Line has trailing spaces."/>
+    </module>
+
+    <!-- Checks for Headers                                -->
+    <!-- See http://checkstyle.sf.net/config_header.html   -->
+    <!-- <module name="Header"> -->
+    <!--   <property name="headerFile" value="${checkstyle.header.file}"/> -->
+    <!--   <property name="fileExtensions" value="java"/> -->
+    <!-- </module> -->
+
+    <module name="TreeWalker">
+
+        <!-- Checks for Javadoc comments.                     -->
+        <!-- See http://checkstyle.sf.net/config_javadoc.html -->
+        <module name="JavadocMethod"/>
+        <module name="JavadocType"/>
+        <module name="JavadocVariable"/>
+        <module name="JavadocStyle"/>
+
+
+        <!-- Checks for Naming Conventions.                  -->
+        <!-- See http://checkstyle.sf.net/config_naming.html -->
+        <module name="ConstantName"/>
+        <module name="LocalFinalVariableName"/>
+        <module name="LocalVariableName"/>
+        <module name="MemberName"/>
+        <module name="MethodName"/>
+        <module name="PackageName"/>
+        <module name="ParameterName"/>
+        <module name="StaticVariableName"/>
+        <module name="TypeName"/>
+
+
+        <!-- Checks for imports                              -->
+        <!-- See http://checkstyle.sf.net/config_import.html -->
+        <module name="AvoidStarImport"/>
+        <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
+        <module name="RedundantImport"/>
+        <module name="UnusedImports"/>
+
+
+        <!-- Checks for Size Violations.                    -->
+        <!-- See http://checkstyle.sf.net/config_sizes.html -->
+        <module name="LineLength"/>
+        <module name="MethodLength"/>
+        <module name="ParameterNumber"/>
+
+
+        <!-- Checks for whitespace                               -->
+        <!-- See http://checkstyle.sf.net/config_whitespace.html -->
+        <module name="EmptyForIteratorPad"/>
+        <module name="GenericWhitespace"/>
+        <module name="MethodParamPad"/>
+        <module name="NoWhitespaceAfter"/>
+        <module name="NoWhitespaceBefore"/>
+        <module name="OperatorWrap"/>
+        <module name="ParenPad"/>
+        <module name="TypecastParenPad"/>
+        <module name="WhitespaceAfter"/>
+        <module name="WhitespaceAround"/>
+
+
+        <!-- Modifier Checks                                    -->
+        <!-- See http://checkstyle.sf.net/config_modifiers.html -->
+        <module name="ModifierOrder"/>
+        <module name="RedundantModifier"/>
+
+
+        <!-- Checks for blocks. You know, those {}'s         -->
+        <!-- See http://checkstyle.sf.net/config_blocks.html -->
+        <module name="AvoidNestedBlocks"/>
+        <module name="EmptyBlock"/>
+        <module name="LeftCurly"/>
+        <module name="NeedBraces"/>
+        <module name="RightCurly"/>
+
+
+        <!-- Checks for common coding problems               -->
+        <!-- See http://checkstyle.sf.net/config_coding.html -->
+        <module name="AvoidInlineConditionals"/>
+        <module name="EmptyStatement"/>
+        <module name="EqualsHashCode"/>
+        <module name="HiddenField"/>
+        <module name="IllegalInstantiation"/>
+        <module name="InnerAssignment"/>
+        <module name="MagicNumber"/>
+        <module name="MissingSwitchDefault"/>
+        <module name="RedundantThrows"/>
+        <module name="SimplifyBooleanExpression"/>
+        <module name="SimplifyBooleanReturn"/>
+
+        <!-- Checks for class design                         -->
+        <!-- See http://checkstyle.sf.net/config_design.html -->
+        <module name="DesignForExtension"/>
+        <module name="FinalClass"/>
+        <module name="HideUtilityClassConstructor"/>
+        <module name="InterfaceIsType"/>
+        <module name="VisibilityModifier"/>
+
+
+        <!-- Miscellaneous other checks.                   -->
+        <!-- See http://checkstyle.sf.net/config_misc.html -->
+        <module name="ArrayTypeStyle"/>
+        <module name="FinalParameters"/>
+        <module name="TodoComment"/>
+        <module name="UpperEll"/>
+
+    </module>
+
+</module>

data/pre-commit-checkstyle.gemspec

@@ -0,0 +1,26 @@
+# 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          = "pre-commit-checkstyle"
+  spec.version       = PreCommit::Checkstyle::VERSION
+  spec.authors       = ["Allen Madsen"]
+  spec.email         = ["blatyo@gmail.com"]
+  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/secondrotation/pre-commit-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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/fixtures/bad.java

@@ -0,0 +1,5 @@
+class HelloWorld {
+  public static void main(String[] args) {
+    System.out.println("Hello World!");
+  }
+}

data/spec/fixtures/good.java

@@ -0,0 +1,22 @@
+/**
+ * Typical hello world example.
+ */
+final class HelloWorld {
+  /**
+   * Prevent class from being instantiated.
+   *
+   * @throws AssertionError
+   */
+  private HelloWorld() {
+    throw new AssertionError("Instantiating utility class...");
+  }
+
+  /**
+   * Prints Hello World!
+   *
+   * @param args Command line arguments
+   */
+  public static void main(final String[] args) {
+    System.out.println("Hello World!");
+  }
+}

data/spec/plugins/pre_commit/checks/checkstyle_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'plugins/pre_commit/checks/checkstyle'
+
+describe PreCommit::Checks::Checkstyle do
+  let(:config) {double(PreCommit::Configuration, get: '')}
+  let(:check) {PreCommit::Checks::Checkstyle.new(nil, config, [])}
+
+  it "succeds if nothing changed" do
+    expect(check.call([])).to be_nil
+  end
+
+  it "succeeds for good code" do
+    files = [fixture_file('good.java')]
+    expect(check.call(files)).to be_nil
+  end
+
+  it "fails for bad formatted code" do
+    file = fixture_file("bad.java")
+    expect(check.call([file])).to eq <<-ERROR
+Starting audit...
+#{file}:1: Missing a Javadoc comment.
+#{file}:1:1: Utility classes should not have a public or default constructor.
+#{file}:2:3: Missing a Javadoc comment.
+#{file}:2:27: Parameter args should be final.
+Audit done.
+ERROR
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'pre-commit'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+def fixture_file(file)
+  File.expand_path("../fixtures/#{file}", __FILE__)
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: pre-commit-checkstyle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Allen Madsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-16 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.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Checkstyle linter plugin for pre-commit. Useful for linting Java code.
+email:
+- blatyo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/plugins/pre_commit/checks/checkstyle.rb
+- lib/pre-commit/checkstyle/version.rb
+- lib/pre-commit/support/checkstyle/checkstyle-5.7-all.jar
+- lib/pre-commit/support/checkstyle/sun_checks.xml
+- pre-commit-checkstyle.gemspec
+- spec/fixtures/bad.java
+- spec/fixtures/good.java
+- spec/plugins/pre_commit/checks/checkstyle_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/secondrotation/pre-commit-checkstyle
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Checkstyle linter plugin for pre-commit
+test_files:
+- spec/fixtures/bad.java
+- spec/fixtures/good.java
+- spec/plugins/pre_commit/checks/checkstyle_spec.rb
+- spec/spec_helper.rb