java-checkstyle 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e339fa95b5ee175c07cf559479c5895eacc8ddf
-  data.tar.gz: a8e505970de9afb9051819568191d160bb57fb54
+  metadata.gz: ae4c1084ae89aff25bbdeb83f8f23ca5717df96a
+  data.tar.gz: 1a4587b7b160b6c276e55a6c73e88e41c9024a6b
 SHA512:
-  metadata.gz: 544ed8c52e58bf1950ee606da1df6623d68a08e1fc0bafea8cffa2620a7a5a488e89baa8e82889a6c4b54723b22affcfd956345d27cf55ade03eeb2c2d20d010
-  data.tar.gz: 2b0befcd3dffc6f711299134aa1bd00bd3373f0307e81dcefa405f08f06c9e2783417100911e8d7bc22be4e7764eb8737b0df763ef90d3cc62428edd75b40153
+  metadata.gz: af6fa8496cb1beff907c37d83b372019da561b5b384c6abb5d9aec2adeb5d93fa0c079e11f17f06bec047d378748b13f0ac5f64011f3b8005a74338da1c7f045
+  data.tar.gz: b4099e356de18a377c69882e250f6d4fddfbe4139365c9bb8349e74591e1b66bd083356e325c925612145a6535a1d8d9cd6b6c2d90f5a3beb3a9aa9ee49d32f6

data/Gemfile

@@ -7,4 +7,5 @@ gem 'crack'
 group :test do
   gem "codeclimate-test-reporter", require: nil
   gem 'rubocop', require: false
+  # gem 'byebug' not add as default it is not compatible with ruby 2 >= version
 end

data/README.md

@@ -1,8 +1,8 @@
 ## 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)
+[![Build Status](https://travis-ci.org/cristianoliveira/java-checkstyle.svg)](https://travis-ci.org/CristianOliveiraDaRosa/java-checkstyle)
+[![Code Climate](https://codeclimate.com/github/cristianoliveira/java-checkstyle/badges/gpa.svg)](https://codeclimate.com/github/cristianoliveira/java-checkstyle)
+[![Test Coverage](https://codeclimate.com/github/cristianoliveira/java-checkstyle/badges/coverage.svg)](https://codeclimate.com/github/cristianoliveira/java-checkstyle/coverage)
 
 Useful git pre-commit hook for linting Java code.
 
@@ -11,17 +11,17 @@ and the famous [Checkstyle](http://checkstyle.sourceforge.net/) linter as a plug
 
 ## Demo
 
-![My awesome change has been catch. Oh boy!](https://raw.githubusercontent.com/CristianOliveiraDaRosa/java-checkstyle/master/readmedemo.png)
+![My awesome change has been catch. Oh boy!](https://raw.githubusercontent.com/cristianoliveira/java-checkstyle/master/readmedemo.png)
 [Don't you know who is Leeroy Jenkins?](https://www.youtube.com/watch?v=mLyOj_QD4a4)
 
 ## Installation
 
 First install the gems.
-### Pre-Commit Checkstyle
+#### Pre-Commit Checkstyle
 
     gem install pre-commit
 
-### Java Checkstyle Plugin
+#### Java Checkstyle Plugin
 
     gem install java-checkstyle
 
@@ -38,25 +38,19 @@ pre-commit install
 
 It will create a .git/hooks/pre-commit script which will check your git config and run checks that are enabled.
 
-### Enabling checks
+#### Enabling checks
 
 ``` bash
 pre-commit enable git checks checkstyle
 ```
 
-OR
-
-``` bash
-pre-commit enable yaml checks checkstyle
-```
-
 ### Result
 Every time you try to commit some java code with style errors it will validate
 for you ensuring that your code will be always awesome.
 
 ---
 #### Detailed version to install.
-Still don't work? Try the detailed version [here](https://github.com/CristianOliveiraDaRosa/java-checkstyle/blob/master/DETAILED_TUTORIAL.md)
+Still don't work? Try the detailed version [here](https://github.com/cristianoliveira/java-checkstyle/blob/master/DETAILED_TUTORIAL.md)
 
 ---
 

data/foo.java

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

data/java-checkstyle.gemspec

@@ -1,16 +1,16 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require './lib/plugins/pre-commit/checkstyle/version.rb'
+require './lib/pre-commit/checkstyle/version.rb'
 
 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.email         = ["blatyo@gmail.com", "contato@cristianoliveira.com.br", "alex.rochas@yahoo.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.homepage      = "https://github.com/CristianOliveira/java-checkstyle"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency("bundler", "~> 1.5")
   spec.add_development_dependency("rake", '~> 10.4', '>= 10.4.2')
   spec.add_development_dependency('rspec', '~> 3.3.0')
+  spec.add_development_dependency('rubocop', '~> 0.34.2')
 end

data/lib/plugins/pre-commit/message/extractor.rb

@@ -8,14 +8,17 @@ module PreCommit
     # Responsible for extract error messages from terminal output
     class Extractor
       ##
-      # Extract data from a XML formatted +output+
+      # Extract data from a XML formatted +terminal_output+
       #
-      # @param output [String] Xml formatted ouput
-      # @return [Hash]
-      def extract(output)
-        return Domain::Checkstyle.good if output.nil? || output.empty?
-        xml_data = Crack::XML.parse(xml_content(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))
@@ -23,25 +26,27 @@ module PreCommit
 
       private
 
-      def xml_content(raw_output)
+      def xml_content_of(raw_output)
         raw_output[/<(.*)>/m]
       end
 
       def extract_bad_file(xml_files)
-        return [create_bad_file(xml_files)] unless xml_files.is_a? Array
-
-        xml_files.reduce([]) { |a, e| a.push(create_bad_file(e)) }
+        return [bad_file(xml_files)] unless xml_files.is_a? Array
+        xml_files.map { |e| bad_file(e) }
       end
 
-      def create_bad_file(file)
-        Domain::BadFile.new(file['name'], extract_errors(file['error']))
+      def bad_file(file)
+        Domain::BadFile.new(file['name'], extract_errors(file))
       end
 
-      def extract_errors(xml_errors)
-        return [] if xml_errors.nil? || xml_errors.empty?
-        return [xml_errors] unless xml_errors.is_a? Array
+      def extract_errors(file)
+        return [] if blank? file['error']
+        return [file['error']] unless file['error'].is_a? Array
+        file['error']
+      end
 
-        xml_errors
+      def blank?(value)
+        value.nil? || value.empty?
       end
     end
   end

data/lib/plugins/pre-commit/message/formatter.rb

@@ -6,8 +6,8 @@ module PreCommit
       ##
       # Format output for a given +errors+ details
       #
-      # @param [Hash] JSON errors details
-      # @return [String] formatted output (may return nil)
+      # @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)
@@ -28,9 +28,7 @@ module PreCommit
       end
 
       def format_errors(errors)
-        errors.reduce('') do |out, error|
-          out + line(error)
-        end
+        errors.reduce('') { |a, e| a + line(e) }
       end
 
       def line(error)

data/lib/{plugins/pre-commit → pre-commit}/checkstyle/version.rb

@@ -12,8 +12,7 @@ module PreCommit
   #  Alex Rocha
   #
   # Main file: checks/checkstyle.rb
-
   module Checkstyle
-    VERSION = '1.0.3'
+    VERSION = '1.0.4'
   end
 end

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

@@ -39,12 +39,11 @@ describe PreCommit::Checks::Checkstyle do
 
   it "should accept custom checkstyle" do
     # given
+    ENV["CHECKSTYLE_CONFIG"] = "sun_checks.xml"
     files = [fixture_file('bad.java')]
-    custom_config = double(PreCommit::Configuration,
-                           get: fixture_file('sun_checks.xml'))
     # when
-    check.config = custom_config
+    result = check.call(files)
     # then
-    expect(check.call(files)).to_not be_nil
+    expect(result).to_not be_nil
   end
 end

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

@@ -10,15 +10,13 @@ describe PreCommit::Message::Extractor do
 
   context "When nil output" do
     it "should be good" do
-      result = extractor.extract nil
-      expect(result).to be_good
+      expect( extractor.extract(nil) ).to be_good
     end
   end
 
   context "When empty output" do
     it "should be good" do
-      result = extractor.extract ''
-      expect(result).to be_good
+      expect( extractor.extract('') ).to be_good
     end
   end
 
@@ -26,23 +24,25 @@ describe PreCommit::Message::Extractor do
     # given
     let(:output) { IO.read(fixture_file("output_one_bad_file.log")) }
 
+    # when
+    before { @checkstyle = extractor.extract(output) }
+
+    # then
     it "should not be good" do
-      result = extractor.extract output
-      expect(result).to_not be_good
+      expect( @checkstyle ).to_not be_good
     end
 
     it "should contain one single file" do
-      result = extractor.extract output
-      expect(result.bad_files).to be_a Array
+      expect( @checkstyle.bad_files ).to be_a Array
     end
 
     it "should contain its errors" do
-      result = extractor.extract output
-      expect(result.bad_files[0].errors.size).to eq 2
+      expect( @checkstyle.bad_files[0].errors.size ).to be 2
     end
 
     it "should extract error details" do
-      expected = [
+      expect( @checkstyle.bad_files[0].errors ).to eq(
+        [
           {
             "line"=>"1",
             "severity"=>"error",
@@ -56,35 +56,34 @@ describe PreCommit::Message::Extractor do
             "message" => "some error message",
             "source" => "com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck"
           }
-      ]
-
-      result = extractor.extract output
-      errors = result.bad_files[0].errors
-      expect(errors).to eq expected
+        ]
+      )
     end
   end
 
   context "When has multiple bad files" do
+    # given
     let(:output) { IO.read(fixture_file("output_two_bad_files.log")) }
 
+    # when
+    before { @checkstyle = extractor.extract output }
+
+    # then
     it "should not be good" do
-      result = extractor.extract output
-      expect(result).to_not be_good
+      expect( @checkstyle ).to_not be_good
     end
 
     it "should extract multiple files" do
-      result = extractor.extract output
-      expect(result.bad_files).to be_a Array
+      expect( @checkstyle.bad_files ).to be_a Array
     end
 
     it "should extract their errors" do
-      result = extractor.extract output
-      expect(result.bad_files[0].errors.size).to eq 2
-      expect(result.bad_files[1].errors.size).to eq 2
+      expect( @checkstyle.bad_files[0].errors.size ).to be 2
+      expect( @checkstyle.bad_files[1].errors.size ).to be 2
     end
 
     it "should extract error details" do
-      expected = [
+      expect( @checkstyle.bad_files[0].errors ).to eq ([
           {
             "line"=>"1",
             "severity"=>"error",
@@ -98,11 +97,7 @@ describe PreCommit::Message::Extractor do
             "message" => "some error message",
             "source" => "com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck"
           }
-      ]
-
-      result = extractor.extract output
-
-      expect(result.bad_files[0].errors).to eq expected
+      ])
     end
   end
 end

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

@@ -27,7 +27,6 @@ describe PreCommit::Message::Formatter do
       "message"=>"some error message",
       "source"=>"com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck"
     }])
-
   }
 
   context "When has empty input" do
@@ -42,8 +41,10 @@ describe PreCommit::Message::Formatter do
   context "When has one file" do
     let(:errors) { Domain::Checkstyle.new( [ file_error ] ) }
 
-    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"}
+    before { @formatted_output = formatter.format(errors)}
+
+    it{ expect( @formatted_output ).to include "File errors: /some/path/file_name.java"}
+    it{ expect( @formatted_output ).to include "  line: 1: error: some error message"}
   end
 
   context "When has more than one file" do
@@ -51,9 +52,11 @@ describe PreCommit::Message::Formatter do
       Domain::Checkstyle.new( [ file_error, file_error_2 ] )
     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"}
+    before { @formatted_output = formatter.format(errors) }
+
+    it{ expect( @formatted_output ).to include "File errors: /some/path/file_name.java"}
+    it{ expect( @formatted_output ).to include "  line: 1: error: some error message"}
+    it{ expect( @formatted_output ).to include "File errors: /some/path/file_name2.java"}
+    it{ expect( @formatted_output ).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: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Allen Madsen
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-13 00:00:00.000000000 Z
+date: 2017-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pre-commit
@@ -88,10 +88,25 @@ dependencies:
     - - "~>"
       - !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.34.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.34.2
 description: Checkstyle linter plugin for pre-commit. Useful for linting Java code.
 email:
 - blatyo@gmail.com
 - contato@cristianoliveira.com.br
+- alex.rochas@yahoo.com.br
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -106,14 +121,15 @@ files:
 - README.md
 - Rakefile
 - demo.png
+- foo.java
 - java-checkstyle.gemspec
 - lib/plugins/pre-commit/checks/checkstyle.rb
-- lib/plugins/pre-commit/checkstyle/version.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
 - readmedemo.png
@@ -127,7 +143,7 @@ files:
 - spec/plugins/pre_commit/message/extractor_spec.rb
 - spec/plugins/pre_commit/message/formatter_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/CristianOliveiraDaRosa/java-checkstyle
+homepage: https://github.com/CristianOliveira/java-checkstyle
 licenses:
 - MIT
 metadata: {}
@@ -147,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Checkstyle linter plugin for pre-commit
@@ -162,4 +178,3 @@ test_files:
 - spec/plugins/pre_commit/message/extractor_spec.rb
 - spec/plugins/pre_commit/message/formatter_spec.rb
 - spec/spec_helper.rb
-has_rdoc: