danger-checkstyle_formatter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2fa439c0c2eacb8943b28f8620970be83bf74702710da4c22f39100af3cb9174
+  data.tar.gz: b08d08d063db89ddf5dd2c52f0fda97f14cb9e16e9c5b8f5dd0ee8b59a95f6f2
+SHA512:
+  metadata.gz: 75f20cc610cc65ba1e82a085d7fc53b03b2f1a7dc45529b3aea381e832d18046ec211aa24c3633443acd8c5bdf54219cb42e36f3713d04e46cc724205eaff9cb
+  data.tar.gz: 6321330dd3d017ea3f604ad3f347b4be18467065d7af96ad054e1edbfb982500b0894e68b7226dfa40e2c65cd145f540d5a4b26dbaba7637345a4ea6f4c01058

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+pkg
+.idea/
+.yardoc
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/

data/.rubocop.yml

@@ -0,0 +1,150 @@
+# Defaults can be found here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+AllCops:
+  TargetRubyVersion: 2.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+# kind_of? is a good way to check a type
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+# It's better to be more explicit about the type
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+# specs sometimes have useless assignments, which is fine
+Lint/UselessAssignment:
+  Exclude:
+    - '**/spec/**/*'
+
+# We could potentially enable the 2 below:
+Layout/IndentHash:
+  Enabled: false
+
+Layout/AlignHash:
+  Enabled: false
+
+# HoundCI doesn't like this rule
+Layout/DotPosition:
+  Enabled: false
+
+# We allow !! as it's an easy way to convert ot boolean
+Style/DoubleNegation:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# We want to allow class Fastlane::Class
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 60
+
+# The %w might be confusing for new users
+Style/WordArray:
+  MinSize: 19
+
+# raise and fail are both okay
+Style/SignalException:
+  Enabled: false
+
+# Better too much 'return' than one missing
+Style/RedundantReturn:
+  Enabled: false
+
+# Having if in the same line might not always be good
+Style/IfUnlessModifier:
+  Enabled: false
+
+# and and or is okay
+Style/AndOr:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 350
+
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 370
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Sometimes it's easier to read without guards
+Style/GuardClause:
+  Enabled: false
+
+# something = if something_else
+# that's confusing
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Better to have too much self than missing a self
+Style/RedundantSelf:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 60
+
+# We're not there yet
+Style/Documentation:
+  Enabled: false
+
+# Adds complexity
+Style/IfInsideElse:
+  Enabled: false
+
+# danger specific
+
+Style/BlockComments:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# FIXME: 25
+Metrics/BlockLength:
+  Max: 345
+  Exclude:
+    - "**/*_spec.rb"
+
+Style/MixinGrouping:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Layout/IndentHeredoc:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%":  ()
+    "%i": ()
+    "%q": ()
+    "%Q": ()
+    "%r": "{}"
+    "%s": ()
+    "%w": ()
+    "%W": ()
+    "%x": ()
+
+Security/YAMLLoad:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.2.7
+  - 2.3.3
+  - 2.4.1
+
+script:
+    - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in danger-checkstyle_formatter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,148 @@
+PATH
+  remote: .
+  specs:
+    danger-checkstyle_formatter (0.0.1)
+      danger-plugin-api (~> 1.0)
+      ox (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    claide (1.0.3)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.3)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (8.0.5)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (>= 0.9.0, < 2.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.4.4)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    ffi (1.13.1)
+    formatador (0.2.5)
+    git (1.7.0)
+      rchardet (~> 1.8)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    kramdown (2.3.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.18.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    ox (2.13.4)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rchardet (1.8.0)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.90.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.4.0)
+      parser (>= 2.7.1.4)
+    ruby-progressbar (1.10.1)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    shellany (0.0.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (1.0.1)
+    unicode-display_width (1.7.0)
+    yard (0.9.25)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  danger-checkstyle_formatter!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  rubocop (~> 0.52)
+  yard (~> 0.9.11)
+
+BUNDLED WITH
+   1.16.1

data/Guardfile

@@ -0,0 +1,19 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 noboru-i <ishikura.noboru@gmail.com>
+
+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,31 @@
+[![Build Status](https://travis-ci.org/noboru-i/danger-checkstyle_format.svg?branch=master)](https://travis-ci.org/noboru-i/danger-checkstyle_format)
+
+# danger-checkstyle_formatter
+
+Danger plugin for checkstyle formatted xml file.
+
+## Installation
+
+    $ gem install danger-checkstyle_formatter
+
+## Usage
+
+<blockquote>Parse the XML file, and let the plugin do your reporting
+  <pre>
+checkstyle_format.base_path = Dir.pwd
+checkstyle_format.report 'app/build/reports/checkstyle/checkstyle.xml'</pre>
+</blockquote>
+
+<blockquote>Parse the XML text, and let the plugin do your reporting
+  <pre>
+checkstyle_format.base_path = Dir.pwd
+checkstyle_format.report_by_text '<?xml ...'</pre>
+</blockquote>
+
+## Development
+
+1. Clone this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake spec` to run the tests.
+4. Use `bundle exec guard` to automatically have tests run as you make changes.
+5. Make your changes.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task['specs'].invoke
+  Rake::Task['rubocop'].invoke
+  Rake::Task['spec_docs'].invoke
+end
+
+desc 'Run RuboCop on the lib/specs directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+end
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :spec_docs do
+  sh 'bundle exec danger plugins lint'
+end

data/danger-checkstyle_format.gemspec

@@ -0,0 +1,50 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'checkstyle_formatter/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-checkstyle_formatter'
+  spec.version       = CheckstyleFormatter::VERSION
+  spec.authors       = ['noboru-i', 'Sergio Fierro']
+  spec.email         = ['ishikura.noboru@gmail.com']
+  spec.description   = %q{Danger plugin for checkstyle formatted xml file.}
+  spec.summary       = %q{Danger plugin for checkstyle formatted xml file.}
+  spec.homepage      = 'https://github.com/SergioFierro/danger-checkstyle_format'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency 'danger-plugin-api', '~> 1.0'
+  spec.add_runtime_dependency 'ox', '~> 2.0'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  # Linting code and docs
+  spec.add_development_dependency "rubocop", "~> 0.52"
+  spec.add_development_dependency "yard", "~> 0.9.11"
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency 'listen', '3.0.7'
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency 'pry'
+end

data/lib/checkstyle_format/gem_version.rb

@@ -0,0 +1,3 @@
+module CheckstyleFormatter
+  VERSION = "0.0.1"
+end

data/lib/checkstyle_format/plugin.rb

@@ -0,0 +1,80 @@
+require_relative "checkstyle_error"
+
+module Danger
+  # Danger plugin for checkstyle formatted xml file.
+  #
+  # @example Parse the XML file, and let the plugin do your reporting
+  #
+  #          checkstyle_format.base_path = Dir.pwd
+  #          checkstyle_format.report 'app/build/reports/checkstyle/checkstyle.xml'
+  #
+  # @example Parse the XML text, and let the plugin do your reporting
+  #
+  #          checkstyle_format.base_path = Dir.pwd
+  #          checkstyle_format.report_by_text '<?xml ...'
+  #
+  # @see  noboru-i/danger-checkstyle_format
+  # @tags lint, reporting
+  #
+  class DangerCheckstyleFormatter < Plugin
+    # Base path of `name` attributes in `file` tag.
+    # Defaults to nil.
+    # @return [String]
+    attr_accessor :base_path
+
+    # Report checkstyle warnings
+    #
+    # @return   [void]
+    def report(file, inline_mode = true)
+      raise "Please specify file name." if file.empty?
+      raise "No checkstyle file was found at #{file}" unless File.exist? file
+      errors = parse(File.read(file))
+
+      send_comment(errors, inline_mode)
+    end
+
+    # Report checkstyle warnings by XML text
+    #
+    # @return   [void]
+    def report_by_text(text, inline_mode = true)
+      raise "Please specify xml text." if text.empty?
+      errors = parse(text)
+
+      send_comment(errors, inline_mode)
+    end
+
+    private
+
+    def parse(text)
+      require "ox"
+
+      doc = Ox.parse(text)
+      present_elements = doc.nodes.first.nodes.reject do |test|
+        test.nodes.empty?
+      end
+      base_path_suffix = @base_path.end_with?("/") ? "" : "/"
+      base_path = @base_path + base_path_suffix
+      elements = present_elements.flat_map do |parent|
+        parent.nodes.map do |child|
+          CheckstyleError.generate(child, parent, base_path)
+        end
+      end
+
+      elements
+    end
+
+    def send_comment(errors, inline_mode)
+      if inline_mode
+        send_inline_comment(errors)
+      else
+        raise "not implemented." # TODO: not implemented.
+      end
+    end
+
+    def send_inline_comment(errors)
+      errors.each do |error|
+        fail(error.message, file: error.file_name, line: error.line)
+      end
+    end
+  end
+end

data/lib/checkstyle_formatter/checkstyle_error.rb

@@ -0,0 +1,12 @@
+CheckstyleError = Struct.new(:file_name, :line, :column, :severity, :message, :source) do
+  def self.generate(node, parent_node, base_path)
+    CheckstyleError.new(
+      parent_node[:name].sub(/^#{base_path}/, ""),
+      node[:line].to_i,
+      node[:column].nil? ? nil : node[:column].to_i,
+      node[:severity],
+      node[:message],
+      node[:source]
+    )
+  end
+end

data/lib/checkstyle_formatter/gem_version.rb

@@ -0,0 +1,3 @@
+module CheckstyleFormatter
+  VERSION = "0.0.1"
+end

data/lib/checkstyle_formatter/plugin.rb

@@ -0,0 +1,80 @@
+require_relative "checkstyle_error"
+
+module Danger
+  # Danger plugin for checkstyle formatted xml file.
+  #
+  # @example Parse the XML file, and let the plugin do your reporting
+  #
+  #          checkstyle_format.base_path = Dir.pwd
+  #          checkstyle_format.report 'app/build/reports/checkstyle/checkstyle.xml'
+  #
+  # @example Parse the XML text, and let the plugin do your reporting
+  #
+  #          checkstyle_format.base_path = Dir.pwd
+  #          checkstyle_format.report_by_text '<?xml ...'
+  #
+  # @see  noboru-i/danger-checkstyle_format
+  # @tags lint, reporting
+  #
+  class DangerCheckstyleFormatter < Plugin
+    # Base path of `name` attributes in `file` tag.
+    # Defaults to nil.
+    # @return [String]
+    attr_accessor :base_path
+
+    # Report checkstyle warnings
+    #
+    # @return   [void]
+    def report(file, inline_mode = true)
+      raise "Please specify file name." if file.empty?
+      raise "No checkstyle file was found at #{file}" unless File.exist? file
+      errors = parse(File.read(file))
+
+      send_comment(errors, inline_mode)
+    end
+
+    # Report checkstyle warnings by XML text
+    #
+    # @return   [void]
+    def report_by_text(text, inline_mode = true)
+      raise "Please specify xml text." if text.empty?
+      errors = parse(text)
+
+      send_comment(errors, inline_mode)
+    end
+
+    private
+
+    def parse(text)
+      require "ox"
+
+      doc = Ox.parse(text)
+      present_elements = doc.nodes.first.nodes.reject do |test|
+        test.nodes.empty?
+      end
+      base_path_suffix = @base_path.end_with?("/") ? "" : "/"
+      base_path = @base_path + base_path_suffix
+      elements = present_elements.flat_map do |parent|
+        parent.nodes.map do |child|
+          CheckstyleError.generate(child, parent, base_path)
+        end
+      end
+
+      elements
+    end
+
+    def send_comment(errors, inline_mode)
+      if inline_mode
+        send_inline_comment(errors)
+      else
+        raise "not implemented." # TODO: not implemented.
+      end
+    end
+
+    def send_inline_comment(errors)
+      errors.each do |error|
+        fail(error.message, file: error.file_name, line: error.line)
+      end
+    end
+  end
+end

data/lib/danger_checkstyle_format.rb

@@ -0,0 +1 @@
+require "checkstyle_formatter/gem_version"

data/lib/danger_plugin.rb

@@ -0,0 +1 @@
+require "checkstyle_formatter/plugin"

data/spec/checkstyle_format_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+module Danger
+  describe Danger::DangerCheckstyleFormatter do
+    it "should be a plugin" do
+      expect(Danger::DangerCheckstyleFormatter.new(nil)).to be_a Danger::Plugin
+    end
+
+    describe "with Dangerfile" do
+      before do
+        @dangerfile = testing_dangerfile
+        @checkstyle_formatter = @dangerfile.checkstyle_formatter
+      end
+
+      describe ".send_inline_comment" do
+        it "calls certain argument" do
+          errors = [
+            CheckstyleError.new("XXX.java", 1, nil, "error", "test message1.", "source"),
+            CheckstyleError.new("YYY.java", 2, nil, "error", "test message2.", "source")
+          ]
+          @checkstyle_formatter.send(:send_inline_comment, errors)
+          expect(@checkstyle_formatter.status_report[:warnings]).to eq(["test message1.", "test message2."])
+          expect(@checkstyle_formatter.violation_report[:warnings][0]).to eq(Violation.new("test message1.", false, "XXX.java", 1))
+          expect(@checkstyle_formatter.violation_report[:warnings][1]).to eq(Violation.new("test message2.", false, "YYY.java", 2))
+        end
+      end
+
+      describe ".parse" do
+        subject(:errors) do
+          @checkstyle_formatter.base_path = "/path/to"
+          @checkstyle_formatter.send(:parse, File.read("spec/fixtures/checkstyle.xml"))
+        end
+        it "have 4 items" do
+          expect(errors.size).to be 4
+        end
+
+        it "is mapped CheckstyleError about index is 0" do
+          expect(errors[0].file_name).to eq("XXX.java")
+          expect(errors[0].line).to eq(0)
+          expect(errors[0].column).to be_nil
+          expect(errors[0].severity).to eq("error")
+          expect(errors[0].message).to eq("File does not end with a newline.")
+          expect(errors[0].source).to eq("com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck")
+        end
+
+        it "is mapped CheckstyleError about index is 2" do
+          expect(errors[2].file_name).to eq("YYY.java")
+          expect(errors[2].line).to eq(12)
+          expect(errors[2].column).to eq(13)
+          expect(errors[2].severity).to eq("error")
+          expect(errors[2].message).to eq("Name 'enableOcr' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'.")
+          expect(errors[2].source).to eq("com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck")
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/checkstyle.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<checkstyle version="5.9">
+<file name="/path/to/XXX.java">
+<error line="0" severity="error" message="File does not end with a newline." source="com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck"/>
+</file>
+<file name="/path/to/YYY.java">
+<error line="9" severity="error" message="interfaces should describe a type and hence have methods." source="com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck"/>
+<error line="12" column="13" severity="error" message="Name &apos;enableOcr&apos; must match pattern &apos;^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$&apos;." source="com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck"/>
+<error line="15" column="12" severity="error" message="Name &apos;selectedLanguage&apos; must match pattern &apos;^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$&apos;." source="com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck"/>
+</file>
+<file name="/path/to/ZZZ.java">
+</file>
+</checkstyle>

data/spec/spec_helper.rb

@@ -0,0 +1,65 @@
+require "pathname"
+ROOT = Pathname.new(File.expand_path("../../", __FILE__))
+$:.unshift((ROOT + "lib").to_s)
+$:.unshift((ROOT + "spec").to_s)
+
+require "bundler/setup"
+require "pry"
+
+require "rspec"
+require "danger"
+
+if `git remote -v` == ""
+  puts "You cannot run tests without setting a local git remote on this repo"
+  puts "It's a weird side-effect of Danger's internals."
+  exit(0)
+end
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace "bundler"
+  config.color = true
+  config.tty = true
+end
+
+require "danger_plugin"
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, "")
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    "HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
+    "TRAVIS_PULL_REQUEST" => "800",
+    "TRAVIS_REPO_SLUG" => "artsy/eigen",
+    "TRAVIS_COMMIT_RANGE" => "759adcbd0d8f...13c4dc8bb61d",
+    "DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: danger-checkstyle_formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- noboru-i
+- Sergio Fierro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Danger plugin for checkstyle formatted xml file.
+email:
+- ishikura.noboru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-checkstyle_format.gemspec
+- lib/checkstyle_format/gem_version.rb
+- lib/checkstyle_format/plugin.rb
+- lib/checkstyle_formatter/checkstyle_error.rb
+- lib/checkstyle_formatter/gem_version.rb
+- lib/checkstyle_formatter/plugin.rb
+- lib/danger_checkstyle_format.rb
+- lib/danger_plugin.rb
+- spec/checkstyle_format_spec.rb
+- spec/fixtures/checkstyle.xml
+- spec/spec_helper.rb
+homepage: https://github.com/SergioFierro/danger-checkstyle_format
+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: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Danger plugin for checkstyle formatted xml file.
+test_files:
+- spec/checkstyle_format_spec.rb
+- spec/fixtures/checkstyle.xml
+- spec/spec_helper.rb