java-checkstyle 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 726ce64842d1a5659c871c86418aa4b0672a3e5c
-  data.tar.gz: 8c825774132b66642463a447e35027fe14a28d7d
+  metadata.gz: 4e339fa95b5ee175c07cf559479c5895eacc8ddf
+  data.tar.gz: a8e505970de9afb9051819568191d160bb57fb54
 SHA512:
-  metadata.gz: b28d57af8e812686bd780159407c651fe09f2a460d3779324ac87a5e7d2eb628250f3142996b2cc2b7f0d15c16712134d7aff2047b43250e743d1acfeb14a688
-  data.tar.gz: 80e93ca8085577907461404de4de41bfc369412cb15118f6a48d7139b71ecad1472983ff108b7200c759f6490a51e8614b75eff4c19b0041181f23dc7b44357b
+  metadata.gz: 544ed8c52e58bf1950ee606da1df6623d68a08e1fc0bafea8cffa2620a7a5a488e89baa8e82889a6c4b54723b22affcfd956345d27cf55ade03eeb2c2d20d010
+  data.tar.gz: 2b0befcd3dffc6f711299134aa1bd00bd3373f0307e81dcefa405f08f06c9e2783417100911e8d7bc22be4e7764eb8737b0df763ef90d3cc62428edd75b40153

data/README.md

@@ -4,13 +4,15 @@
 [![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)
 
-Useful pre-commit hook for linting Java code. It uses as default [The Google Style Guide](https://google.github.io/styleguide/javaguide.html)
+Useful git pre-commit hook for linting Java code.
 
-It uses the famous [Checkstyle](http://checkstyle.sourceforge.net/) linter as a plugin for [pre-commit](https://github.com/jish/pre-commit).
+It uses as default [The Google Style Guide](https://google.github.io/styleguide/javaguide.html)
+and 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)
+[Don't you know who is Leeroy Jenkins?](https://www.youtube.com/watch?v=mLyOj_QD4a4)
 
 ## Installation
 
@@ -23,6 +25,9 @@ First install the gems.
 
     gem install java-checkstyle
 
+##### (optional) If you use RVM
+Take a look here [Install with RVM](https://github.com/jish/pre-commit#rvm)
+
 ### Configuring
 Use the pre-commit command to generate a stub pre-commit hook.
 Inside folder of your git repo:
@@ -47,7 +52,7 @@ pre-commit enable yaml checks checkstyle
 
 ### Result
 Every time you try to commit some java code with style errors it will validate
-before.
+for you ensuring that your code will be always awesome.
 
 ---
 #### Detailed version to install.
@@ -55,21 +60,6 @@ Still don't work? Try the detailed version [here](https://github.com/CristianOli
 
 ---
 
-## 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).

data/java-checkstyle.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'pre-commit/checkstyle/version'
+require './lib/plugins/pre-commit/checkstyle/version.rb'
 
 Gem::Specification.new do |spec|
   spec.name          = "java-checkstyle"

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

@@ -1,5 +1,5 @@
 ##
-# This a fork version of the original
+# This is a fork version of the original
 # checkstyle:
 # https://github.com/secondrotation/pre-commit-checkstyle
 #
@@ -10,7 +10,10 @@ module PreCommit
   #  Allen Madsen (Original Version 0.0.1)
   #  Cristian Oliveira
   #  Alex Rocha
+  #
+  # Main file: checks/checkstyle.rb
+
   module Checkstyle
-    VERSION = '1.0.0'
+    VERSION = '1.0.3'
   end
 end

data/lib/plugins/pre-commit/domain/bad_file.rb

@@ -0,0 +1,18 @@
+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,25 @@
+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,48 @@
+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 +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))
+
+        files = xml_data['checkstyle']['file']
+
+        Domain::Checkstyle.new(extract_bad_file(files))
+      end
+
+      private
+
+      def xml_content(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)) }
+      end
+
+      def create_bad_file(file)
+        Domain::BadFile.new(file['name'], extract_errors(file['error']))
+      end
+
+      def extract_errors(xml_errors)
+        return [] if xml_errors.nil? || xml_errors.empty?
+        return [xml_errors] unless xml_errors.is_a? Array
+
+        xml_errors
+      end
+    end
+  end
+end

data/lib/plugins/{pre_commit → pre-commit}/message/formatter.rb

@@ -10,37 +10,32 @@ module PreCommit
       # @return [String] formatted output (may return nil)
       # @raise ArgumentError when input is empty
       #
-      def format(errors)
-        throw ArgumentError.new if errors.nil? || errors.empty?
+      def format(checkstyle)
+        throw ArgumentError.new if checkstyle.nil?
+        return nil if checkstyle.good?
 
-        files = errors['checkstyle']['file']
-
-        return nil if files.empty?
-        return format_single(files) unless files.is_a? Array
-
-        format_multiple(files)
+        format_multiple(checkstyle.bad_files)
       end
 
       private
 
-      def line(error)
-        "  line: #{error['line']}:#{error['column']}"\
-          " error: #{error['message']}\n"
+      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)
-        return line(errors) unless errors.is_a? Array
         errors.reduce('') do |out, error|
           out + line(error)
         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) }
+      def line(error)
+        "  line: #{error['line']}:#{error['column']}"\
+          " error: #{error['message']}\n"
       end
     end
   end

data/lib/plugins/{pre_commit → pre-commit}/support/path.rb

@@ -10,7 +10,7 @@ module Support
     # @return [String] formatted path
     def self.relative_to(file)
       File.expand_path(
-        "../../../../pre-commit/support/checkstyle/#{file}",
+        "../../../../resources/checkstyle/#{file}",
         __FILE__
       )
     end

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

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'plugins/pre_commit/checks/checkstyle'
+require 'plugins/pre-commit/checks/checkstyle'
 
 describe PreCommit::Checks::Checkstyle do
   let(:config) {double(PreCommit::Configuration, get: '')}

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

@@ -1,34 +1,44 @@
 require 'spec_helper'
-require 'plugins/pre_commit/message/extractor'
+require 'plugins/pre-commit/message/extractor'
+require 'plugins/pre-commit/domain/checkstyle'
+require 'plugins/pre-commit/domain/bad_file'
+
 ##
 # Tests for PreCommit::Message::Extractor
 describe PreCommit::Message::Extractor do
   let(:extractor) { PreCommit::Message::Extractor.new }
 
-  context "empty output" do
-    it "should return empty file for nil output" do
+  context "When nil output" do
+    it "should be good" do
       result = extractor.extract nil
-      expect(result['checkstyle']['file']).to be_empty
+      expect(result).to be_good
     end
+  end
 
-    it "should return empty file for empty output" do
+  context "When empty output" do
+    it "should be good" do
       result = extractor.extract ''
-      expect(result['checkstyle']['file']).to be_empty
+      expect(result).to be_good
     end
   end
 
-  context "has one bad file" do
+  context "When has one bad file" do
     # given
     let(:output) { IO.read(fixture_file("output_one_bad_file.log")) }
 
+    it "should not be good" do
+      result = extractor.extract output
+      expect(result).to_not be_good
+    end
+
     it "should contain one single file" do
       result = extractor.extract output
-      expect(result['checkstyle']['file']).to be_a Hash
+      expect(result.bad_files).to be_a Array
     end
 
     it "should contain its errors" do
       result = extractor.extract output
-      expect(result['checkstyle']['file']['error'].size).to eq 2
+      expect(result.bad_files[0].errors.size).to eq 2
     end
 
     it "should extract error details" do
@@ -49,23 +59,28 @@ describe PreCommit::Message::Extractor do
       ]
 
       result = extractor.extract output
-      errors = result['checkstyle']['file']['error']
+      errors = result.bad_files[0].errors
       expect(errors).to eq expected
     end
   end
 
-  context "has multiple bad files" do
+  context "When has multiple bad files" do
     let(:output) { IO.read(fixture_file("output_two_bad_files.log")) }
 
+    it "should not be good" do
+      result = extractor.extract output
+      expect(result).to_not be_good
+    end
+
     it "should extract multiple files" do
       result = extractor.extract output
-      expect(result['checkstyle']['file']).to be_a Array
+      expect(result.bad_files).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
+      expect(result.bad_files[0].errors.size).to eq 2
+      expect(result.bad_files[1].errors.size).to eq 2
     end
 
     it "should extract error details" do
@@ -86,8 +101,8 @@ describe PreCommit::Message::Extractor do
       ]
 
       result = extractor.extract output
-      errors = result['checkstyle']['file'][0]['error']
-      expect(errors).to eq expected
+
+      expect(result.bad_files[0].errors).to eq expected
     end
   end
 end

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

@@ -1,67 +1,54 @@
 require 'spec_helper'
-require 'plugins/pre_commit/message/formatter'
+require 'plugins/pre-commit/message/formatter'
+require 'plugins/pre-commit/domain/checkstyle'
+require 'plugins/pre-commit/domain/bad_file'
+
 ##
 # Tests for PreCommit::Message::Formatter
 describe PreCommit::Message::Formatter do
   let(:formatter) { PreCommit::Message::Formatter.new }
 
+  let(:file_error) {
+    Domain::BadFile.new('/some/path/file_name.java',
+    [{
+      "line"=>"1",
+      "severity"=>"error",
+      "message"=>"some error message",
+      "source"=>"com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck"
+    }])
+  }
+
+  let(:file_error_2) {
+    Domain::BadFile.new('/some/path/file_name2.java',
+    [{
+      "line"=>"11",
+      "column"=>"40",
+      "severity"=>"error",
+      "message"=>"some error message",
+      "source"=>"com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck"
+    }])
+
+  }
+
   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 }
+    let(:good) { Domain::Checkstyle.good }
+    it { expect(formatter.format(good)).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
+    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:40 error: some error message"}
+    it{ expect(formatter.format(errors)).to include "  line: 1: 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"
-              }]
-            }
-          ]
-        }
-      }
+      Domain::Checkstyle.new( [ file_error, file_error_2 ] )
     end
 
     it{ expect(formatter.format(errors)).to include "File errors: /some/path/file_name.java"}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: java-checkstyle
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Allen Madsen
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-12 00:00:00.000000000 Z
+date: 2015-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pre-commit
@@ -107,13 +107,15 @@ files:
 - 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-6.11-all.jar
-- lib/pre-commit/support/checkstyle/google_checks.xml
+- 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/resources/checkstyle/checkstyle-6.11-all.jar
+- lib/resources/checkstyle/google_checks.xml
 - readmedemo.png
 - spec/fixtures/bad.java
 - spec/fixtures/bad2.java
@@ -145,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Checkstyle linter plugin for pre-commit
@@ -160,3 +162,4 @@ test_files:
 - spec/plugins/pre_commit/message/extractor_spec.rb
 - spec/plugins/pre_commit/message/formatter_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

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

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