java-checkstyle 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7195c535a4ffe35bc6059ad1dc13a1e326dfc94e
-  data.tar.gz: c8facc5e071412a45073591ed1aaf76f01d5cfe2
+  metadata.gz: 726ce64842d1a5659c871c86418aa4b0672a3e5c
+  data.tar.gz: 8c825774132b66642463a447e35027fe14a28d7d
 SHA512:
-  metadata.gz: 8e5184be4154f4a5db9f184c411f3c3492079b39be29ae7e167b5c0bdffc0f0416950015913537137ddda9e58a5ab1c837a305f8b24570751bd34a4e6fc35197
-  data.tar.gz: 953cb0b0c1c35b4499d7898273af8a1bc3a44dbe177d2611f4b4e8fb438c8d9a883ce9a6d558d50b5ae27f47f1276dd6b632183ffda2e5fc377a23afa5182746
+  metadata.gz: b28d57af8e812686bd780159407c651fe09f2a460d3779324ac87a5e7d2eb628250f3142996b2cc2b7f0d15c16712134d7aff2047b43250e743d1acfeb14a688
+  data.tar.gz: 80e93ca8085577907461404de4de41bfc369412cb15118f6a48d7139b71ecad1472983ff108b7200c759f6490a51e8614b75eff4c19b0041181f23dc7b44357b

data/DETAILED_TUTORIAL.md

@@ -0,0 +1,102 @@
+### Java - Pre-Commit Checkstyle
+
+## Detailed Installation Guide
+
+This is a detailed version to install this useful hook.
+
+# Let`s do it!
+
+First install and setup the check in pre-commit:
+### Pre-Commit Checkstyle
+Install the gem
+
+    $ gem install pre-commit
+
+### Install the Java-checkstyle gem
+
+Add this line to your application's Gemfile:
+
+    gem 'java-checkstyle'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install java-checkstyle
+
+Now your pre-commit hook has been installed.
+
+## Using in your project
+
+Create your project folder and start a git repository
+
+```bash
+mkdir awesome_project
+cd awesome_project
+git init
+```
+**Install the hook for this repository**
+
+Use the pre-commit command to generate a stub pre-commit hook
+```bash
+# Inside of your project with git
+pre-commit install
+```
+This creates a .git/hooks/pre-commit script which will check your git config and run checks that are enabled.
+
+**Enable the java checkstyle checks**
+
+``` bash
+pre-commit enable git checks checkstyle
+```
+
+OR
+
+``` bash
+pre-commit enable yaml checks checkstyle
+```
+
+Then the pre commmit has been configured! For this your repository.
+
+## Let`s test it!
+Create a new java code with some style errors see: [Google checkstyle guide](http://google.github.io/styleguide/javaguide.html)
+
+```java
+class HelloWorld
+{
+  public static void main(String[] args)
+  {
+    System.out.println("Hello World!");
+  }
+}
+```
+Then add it and try commit
+``` bash
+git add .
+git commit -m "Time's up, let's do this! Leeeeeeeeeeeeeroy Jjjjjjenkinsss!!"
+```
+
+Still don`t know our hero Leroy Jenkis? Oh man! see [here](https://www.youtube.com/watch?v=LkCNJRfSZBU)
+
+![My awesome change has been catch. Oh boy!](https://raw.githubusercontent.com/CristianOliveiraDaRosa/java-checkstyle/master/demo.png)
+
+---
+## Installing with RVM
+
+If you are using rvm you need to install pre-commit into the ```default``` gemset, because it does not use the ```current``` environment
+
+    $ rvm default do gem install pre-commit
+
+Alternatively you can configure pre-commit to use the ```current``` rvm gemset
+
+    $ git config pre-commit.ruby "rvm `rvm current` do ruby"
+
+More details about this part see on:
+[pre-commit](https://github.com/jish/pre-commit)
+
+## Authors:
+ - Allen Madsen (Original Version 0.0.1)
+ - Alex Rocha
+ - Cristian Oliveira

data/README.md

@@ -1,27 +1,39 @@
 ## Java - Pre-Commit Checkstyle
+[![Gem Version](https://badge.fury.io/rb/java-checkstyle.svg)](https://badge.fury.io/rb/java-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.
+Useful pre-commit hook for linting Java code. It uses as default [The Google Style Guide](https://google.github.io/styleguide/javaguide.html)
+
+It uses the famous [Checkstyle](http://checkstyle.sourceforge.net/) linter as a plugin for [pre-commit](https://github.com/jish/pre-commit).
+
+## Demo
+
+![My awesome change has been catch. Oh boy!](https://raw.githubusercontent.com/CristianOliveiraDaRosa/java-checkstyle/master/readmedemo.png)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+First install the gems.
+### Pre-Commit Checkstyle
 
-    gem 'pre-commit-checkstyle'
+    gem install pre-commit
 
-And then execute:
+### Java Checkstyle Plugin
 
-    $ bundle
+    gem install java-checkstyle
 
-Or install it yourself as:
+### Configuring
+Use the pre-commit command to generate a stub pre-commit hook.
+Inside folder of your git repo:
 
-    $ gem install pre-commit-checkstyle
+```bash
+pre-commit install
+```
 
-## Usage
+It will create a .git/hooks/pre-commit script which will check your git config and run checks that are enabled.
 
-Make sure the gem is installed and setup the check in [pre-commit](https://github.com/jish/pre-commit) with:
+### Enabling checks
 
 ``` bash
 pre-commit enable git checks checkstyle
@@ -33,14 +45,64 @@ OR
 pre-commit enable yaml checks checkstyle
 ```
 
+### Result
+Every time you try to commit some java code with style errors it will validate
+before.
+
+---
+#### Detailed version to install.
+Still don't work? Try the detailed version [here](https://github.com/CristianOliveiraDaRosa/java-checkstyle/blob/master/DETAILED_TUTORIAL.md)
+
+---
+
+## Installing with RVM
+
+If you are using rvm you need to install pre-commit into the ```default``` gemset, because it does not use the ```current``` environment
+
+    $ rvm default do gem install pre-commit
+
+Alternatively you can configure pre-commit to use the ```current``` rvm gemset
+
+    $ git config pre-commit.ruby "rvm `rvm current` do ruby"
+
+More details about this part see on:
+[pre-commit](https://github.com/jish/pre-commit)
+
+And your pre-commit hook has been configured.
+
+## Checkstyle Guide
+
+It uses as default [The Google Style Guide](https://google.github.io/styleguide/javaguide.html).
+
+## Tests
+Running tests with rspec
+
+Make sure you have been executed:
+```bash
+bundle install
+```
+Then run:
+
+```bash
+rspec
+```
+
 ## Contributing
 
-1. Fork it ( http://github.com/secondrotation/pre-commit-checkstyle/fork )
+1. Fork it
 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
 
+#### Codeclimate
+Before push, make sure you have been executed rubocop
+``` bash
+rubocop lib/*
+```
+
+*Pull request should have Unit Tests*
+
 ## Authors:
  - Allen Madsen (Original Version 0.0.1)
  - Alex Rocha

data/java-checkstyle.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency('pre-commit', '~> 0.16')
+  spec.add_dependency('pre-commit', '~> 0.26')
   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')
+  spec.add_development_dependency('rspec', '~> 3.3.0')
 end

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

@@ -25,6 +25,10 @@ module PreCommit
         format(extract(output))
       end
 
+      def self.description
+        'Runs Checkstyle linter for java code.'
+      end
+
       private
 
       def args(staged_files)
@@ -50,11 +54,7 @@ module PreCommit
       end
 
       def alternate_config_file
-        Support::Path.relative_to('sun_checks.xml')
-      end
-
-      def self.description
-        'Runs coffeelint to detect errors'
+        Support::Path.relative_to('google_checks.xml')
       end
 
       def format(errors)

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

@@ -8,7 +8,11 @@ module PreCommit
       #
       # @param [Hash] JSON errors details
       # @return [String] formatted output (may return nil)
+      # @raise ArgumentError when input is empty
+      #
       def format(errors)
+        throw ArgumentError.new if errors.nil? || errors.empty?
+
         files = errors['checkstyle']['file']
 
         return nil if files.empty?
@@ -19,10 +23,15 @@ module PreCommit
 
       private
 
+      def line(error)
+        "  line: #{error['line']}:#{error['column']}"\
+          " error: #{error['message']}\n"
+      end
+
       def format_errors(errors)
+        return line(errors) unless errors.is_a? Array
         errors.reduce('') do |out, error|
-          out + "  line: #{error['line']}:#{error['column']}"\
-            " error: #{error['message']}\n"
+          out + line(error)
         end
       end
 

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

@@ -11,6 +11,6 @@ module PreCommit
   #  Cristian Oliveira
   #  Alex Rocha
   module Checkstyle
-    VERSION = '0.0.2'
+    VERSION = '1.0.0'
   end
 end

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

@@ -24,8 +24,6 @@
 <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 -->

data/spec/fixtures/bad.java

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

data/spec/fixtures/bad2.java

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

data/spec/fixtures/good.java

@@ -1,20 +1,21 @@
 /**
  * Typical hello world example.
+ * It has a good style.
  */
-final class HelloWorld {
+final class Good {
   /**
    * Prevent class from being instantiated.
    *
-   * @throws AssertionError
+   * @throws AssertionError if some smart guy try.
    */
-  private HelloWorld() {
+  public Good() {
     throw new AssertionError("Instantiating utility class...");
   }
 
   /**
    * Prints Hello World!
    *
-   * @param args Command line arguments
+   * @param args Command line arguments.
    */
   public static void main(final String[] args) {
     System.out.println("Hello World!");

data/spec/fixtures/output_one_bad_file.log

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+  <checkstyle version="6.11">
+     <file name="/Users/cristianoliveira/work/java-checkstyle/spec/fixtures/bad.java">
+       <error line="1" severity="error" message="some error message" source="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck"/>
+       <error line="11" column= "1 " severity= "warning" message="some error message" source="com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck"/>
+    </file>
+  </checkstyle>
+Checkstyle ends with 4 errors.

data/spec/fixtures/output_two_bad_files.log

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+  <checkstyle version="6.11">
+     <file name="/Users/cristianoliveira/work/java-checkstyle/spec/fixtures/bad.java">
+       <error line="1" severity="error" message="some error message" source="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck"/>
+       <error line="11" column= "1 " severity= "warning" message="some error message" source="com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck"/>
+    </file>
+    <file name="/Users/cristianoliveira/work/java-checkstyle/spec/fixtures/bad2.java">
+       <error line="2 " column= "3 " severity= "error" message="some error message" source= "com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck "/>
+       <error line="2 " column= "27 " severity= "error" message="some error message" source= "com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck "/>
+    </file>
+  </checkstyle>
+Checkstyle ends with 4 errors.

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

@@ -10,7 +10,7 @@ describe PreCommit::Checks::Checkstyle do
   end
 
   it "succeeds for good code" do
-    files = [fixture_file('good.java')]
+    files = [fixture_file('Good.java')]
     expect(check.call(files)).to be_nil
   end
 
@@ -18,23 +18,20 @@ describe PreCommit::Checks::Checkstyle do
     file = fixture_file("bad.java")
 
     result = check.call([file])
-    
+
     expect(result).to include "File errors: #{file}"
     expect(result).to include "line: 1: error:"
-    expect(result).to include "line: 1:1 error:"
-    expect(result).to include "line: 2:3 error:"
-    expect(result).to include "line: 2:27 error:"
+    expect(result).to include "line: 1:7 error:"
   end
 
-
   it "should accept multiple fails" do
     # given
     file = fixture_file("bad.java")
     file2 = fixture_file("bad2.java")
-    
-    # when 
-    result = check.call([file, file2]) 
-    
+
+    # when
+    result = check.call([file, file2])
+
     # then
     expect(result).to include "File errors: #{file}"
     expect(result).to include "File errors: #{file2}"
@@ -42,12 +39,12 @@ describe PreCommit::Checks::Checkstyle do
 
   it "should accept custom checkstyle" do
     # given
-    files = [fixture_file('good.java')]
+    files = [fixture_file('bad.java')]
     custom_config = double(PreCommit::Configuration,
-                           get: fixture_file('google_checks.xml'))
+                           get: fixture_file('sun_checks.xml'))
     # when
     check.config = custom_config
     # then
-    expect(check.call(files)).to be_nil
+    expect(check.call(files)).to_not be_nil
   end
 end

data/spec/plugins/pre_commit/message/extractor_spec.rb

@@ -4,56 +4,90 @@ require 'plugins/pre_commit/message/extractor'
 # Tests for PreCommit::Message::Extractor
 describe PreCommit::Message::Extractor do
   let(:extractor) { PreCommit::Message::Extractor.new }
-  let(:output) {
-'<?xml version="1.0" encoding="UTF-8"?>
-  <checkstyle version="6.11">
-     <file name="/Users/cristianoliveira/work/java-checkstyle/spec/fixtures/bad.java">
-       <error line="1" severity="error" message="some error message" source="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck"/>
-       <error line="11" column= "1 " severity= "warning" message="some error message" source="com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck"/>
-    </file>
-    <file name="/Users/cristianoliveira/work/java-checkstyle/spec/fixtures/bad2.java">
-       <error line="2 " column= "3 " severity= "error" message="some error message" source= "com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck "/>
-       <error line="2 " column= "27 " severity= "error" message="some error message" source= "com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck "/>
-    </file>
-  </checkstyle>
-Checkstyle ends with 4 errors.' }
-  
-  it "should return empty file for nil output" do
-    output = nil
-    result = extractor.extract output
-
-    expect(result['checkstyle']['file']).to be_empty
-  end
 
-  it "should extract files" do
-    result = extractor.extract output
-    expect(result['checkstyle']['file'].size).to eq 2
+  context "empty output" do
+    it "should return empty file for nil output" do
+      result = extractor.extract nil
+      expect(result['checkstyle']['file']).to be_empty
+    end
+
+    it "should return empty file for empty output" do
+      result = extractor.extract ''
+      expect(result['checkstyle']['file']).to be_empty
+    end
   end
 
-  it "should extract errors" do
-    result = extractor.extract output
-    expect(result['checkstyle']['file'][0]['error'].size).to eq 2
+  context "has one bad file" do
+    # given
+    let(:output) { IO.read(fixture_file("output_one_bad_file.log")) }
+
+    it "should contain one single file" do
+      result = extractor.extract output
+      expect(result['checkstyle']['file']).to be_a Hash
+    end
+
+    it "should contain its errors" do
+      result = extractor.extract output
+      expect(result['checkstyle']['file']['error'].size).to eq 2
+    end
+
+    it "should extract error details" do
+      expected = [
+          {
+            "line"=>"1",
+            "severity"=>"error",
+            "message"=>"some error message",
+            "source"=>"com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck"
+          },
+          {
+            "line" => "11",
+            "column" => "1 ",
+            "severity" => "warning",
+            "message" => "some error message",
+            "source" => "com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck"
+          }
+      ]
+
+      result = extractor.extract output
+      errors = result['checkstyle']['file']['error']
+      expect(errors).to eq expected
+    end
   end
 
-  it "should extract error details" do
-    expected = [
-        {
-          "line"=>"1", 
-          "severity"=>"error", 
-          "message"=>"some error message", 
-          "source"=>"com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck"
-        },
-        {
-          "line" => "11",
-          "column" => "1 ",
-          "severity" => "warning", 
-          "message" => "some error message", 
-          "source" => "com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck"
-        }
-    ]
-
-    result = extractor.extract output
-    errors = result['checkstyle']['file'][0]['error']
-    expect(errors).to eq expected
+  context "has multiple bad files" do
+    let(:output) { IO.read(fixture_file("output_two_bad_files.log")) }
+
+    it "should extract multiple files" do
+      result = extractor.extract output
+      expect(result['checkstyle']['file']).to be_a Array
+    end
+
+    it "should extract their errors" do
+      result = extractor.extract output
+      expect(result['checkstyle']['file'][0]['error'].size).to eq 2
+      expect(result['checkstyle']['file'][1]['error'].size).to eq 2
+    end
+
+    it "should extract error details" do
+      expected = [
+          {
+            "line"=>"1",
+            "severity"=>"error",
+            "message"=>"some error message",
+            "source"=>"com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck"
+          },
+          {
+            "line" => "11",
+            "column" => "1 ",
+            "severity" => "warning",
+            "message" => "some error message",
+            "source" => "com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck"
+          }
+      ]
+
+      result = extractor.extract output
+      errors = result['checkstyle']['file'][0]['error']
+      expect(errors).to eq expected
+    end
   end
 end

data/spec/plugins/pre_commit/message/formatter_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'plugins/pre_commit/message/formatter'
+##
+# Tests for PreCommit::Message::Formatter
+describe PreCommit::Message::Formatter do
+  let(:formatter) { PreCommit::Message::Formatter.new }
+
+  context "When has empty input" do
+    it {expect{ formatter.format(nil) }.to raise_error(ArgumentError)}
+    it {expect{ formatter.format('') }.to raise_error(ArgumentError)}
+  end
+
+  context "When has no errors" do
+    let(:errors) { { 'checkstyle' => { 'file' => [] } } }
+    it { expect(formatter.format(errors)).to be_nil }
+  end
+
+  context "When has one file" do
+    let(:errors) do
+      { 'checkstyle' => {
+          'file' => {
+            'name' => '/some/path/file_name.java',
+            'error' => [{
+              "line"=>"1",
+              "column"=>"40",
+              "severity"=>"error",
+              "message"=>"some error message",
+              "source"=>"com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck"
+            }]
+          }
+        }
+      }
+    end
+
+    it{ expect(formatter.format(errors)).to include "File errors: /some/path/file_name.java"}
+    it{ expect(formatter.format(errors)).to include "  line: 1:40 error: some error message"}
+  end
+
+  context "When has more than one file" do
+    let(:errors) do
+      { 'checkstyle' => {
+          'file' => [
+            {
+              'name' => '/some/path/file_name.java',
+              'error' => [{
+                "line"=>"1",
+                "severity"=>"error",
+                "message"=>"some error message",
+                "source"=>"com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck"
+              }]
+            },
+            {
+              'name' => '/some/path/file_name2.java',
+              'error' => [{
+                "line"=>"11",
+                "column"=>"40",
+                "severity"=>"error",
+                "message"=>"some error message",
+                "source"=>"com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck"
+              }]
+            }
+          ]
+        }
+      }
+    end
+
+    it{ expect(formatter.format(errors)).to include "File errors: /some/path/file_name.java"}
+    it{ expect(formatter.format(errors)).to include "  line: 1: error: some error message"}
+    it{ expect(formatter.format(errors)).to include "File errors: /some/path/file_name2.java"}
+    it{ expect(formatter.format(errors)).to include "  line: 11:40 error: some error message"}
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: java-checkstyle
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Allen Madsen
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-11 00:00:00.000000000 Z
+date: 2015-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pre-commit
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.26'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.26'
 - !ruby/object:Gem::Dependency
   name: crack
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +80,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: 3.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: 3.3.0
 description: Checkstyle linter plugin for pre-commit. Useful for linting Java code.
 email:
 - blatyo@gmail.com
@@ -106,27 +100,30 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- DETAILED_TUTORIAL.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- demo.png
 - java-checkstyle.gemspec
 - lib/plugins/pre_commit/checks/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/pre-commit/support/checkstyle/checkstyle-5.7-all.jar
 - lib/pre-commit/support/checkstyle/checkstyle-6.11-all.jar
 - lib/pre-commit/support/checkstyle/google_checks.xml
-- lib/pre-commit/support/checkstyle/sun_checks.xml
+- readmedemo.png
 - spec/fixtures/bad.java
 - spec/fixtures/bad2.java
 - spec/fixtures/good.java
-- spec/fixtures/google_checks.xml
+- spec/fixtures/output_one_bad_file.log
+- spec/fixtures/output_two_bad_files.log
+- spec/fixtures/sun_checks.xml
 - spec/plugins/pre_commit/checks/checkstyle_spec.rb
 - spec/plugins/pre_commit/message/extractor_spec.rb
-- spec/plugins/pre_commit/output/formatter.rb
+- spec/plugins/pre_commit/message/formatter_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/CristianOliveiraDaRosa/java-checkstyle
 licenses:
@@ -148,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Checkstyle linter plugin for pre-commit
@@ -156,9 +153,10 @@ test_files:
 - spec/fixtures/bad.java
 - spec/fixtures/bad2.java
 - spec/fixtures/good.java
-- spec/fixtures/google_checks.xml
+- spec/fixtures/output_one_bad_file.log
+- spec/fixtures/output_two_bad_files.log
+- spec/fixtures/sun_checks.xml
 - spec/plugins/pre_commit/checks/checkstyle_spec.rb
 - spec/plugins/pre_commit/message/extractor_spec.rb
-- spec/plugins/pre_commit/output/formatter.rb
+- spec/plugins/pre_commit/message/formatter_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/spec/fixtures/google_checks.xml

@@ -1,206 +0,0 @@
-<?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>