danger-checkstyle_reports 0.0.1.pre.rc01

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 751e1db74791e5488e74ba43fbbd4a4125e0a033
+  data.tar.gz: 8f8b9f24f81c02b16a65cf04d0d52674f7ac1970
+SHA512:
+  metadata.gz: 0dce91816516e76099b719e71f0523ef22184771f39da119812675ccdd74e6526969cf25d5456701f08f138bc018de06d8c2704cd4f9ac106948bf8d9f478a19
+  data.tar.gz: e6e89db45a1dc04bf055aff2b05e3b3b683ed1d926a84a28a319dd3d8053f610bd774f5e86a0db627bcb28742d1aaef07af678148a1b14309528abcd533e286a

data/.bundle/config

@@ -0,0 +1,3 @@
+---
+BUNDLE_PATH: "vendor/bundle"
+BUNDLE_CLEAN: "true"

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+pkg
+.idea/
+.yardoc
+**/vendor/bundle/
+*.gem

data/.rubocop.yml

@@ -0,0 +1,170 @@
+# Defaults can be found here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+# If you don't like these settings, just delete this file :)
+
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+    - 'tmp/**/*'
+  TargetRubyVersion: 2.3.7
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*'
+  Enabled: true
+
+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
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.7

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache:
+  directories:
+    - vendor/bundle
+
+rvm:
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
+
+script:
+  - bundle exec rake spec

data/Dangerfile.sample

@@ -0,0 +1,3 @@
+checkstyle_reports.inline_comment = true
+checkstyle_reports.report('checkstyle-results.xml', modified_files_only: true)
+

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in danger-apkstats.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,136 @@
+PATH
+  remote: .
+  specs:
+    danger-checkstyle_reports (0.0.1)
+      danger-plugin-api (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    claide (1.0.2)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.2)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (5.6.7)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (~> 0.9)
+      faraday-http-cache (~> 1.0)
+      git (~> 1.5)
+      kramdown (~> 1.5)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.3)
+    faraday (0.15.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (1.3.1)
+      faraday (~> 0.8)
+    ffi (1.9.25)
+    formatador (0.2.5)
+    git (1.5.0)
+    guard (2.14.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)
+    jaro_winkler (1.5.1)
+    kramdown (1.17.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    multipart-post (2.0.0)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.12.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.58.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    shellany (0.0.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (0.20.0)
+    unicode-display_width (1.4.0)
+    yard (0.9.15)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  danger-checkstyle_reports!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  rubocop
+  yard
+
+BUNDLED WITH
+   1.16.1

data/Guardfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# 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) 2018 Jumpei Matsuda <jmatsu.drm@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,30 @@
+[![Build Status](https://travis-ci.com/jmatsu/danger-checkstyle_reports.svg?branch=master)](https://travis-ci.com/jmatsu/danger-checkstyle_reports) [![Gem Version](https://badge.fury.io/rb/danger-checkstyle_reports.svg)](https://badge.fury.io/rb/danger-checkstyle_reports)
+
+# danger-checkstyle_reports
+
+This is a plugin of [Danger](https://github.com/danger/danger) for Android projects.
+This reports checkstyle results.
+
+## Installation
+
+`gem install danger-checkstyle_reports`
+
+## Usage
+
+`checkstyle_reports` namespace is available under Dangerfile.
+    
+### Report errors
+
+```
+# If you'd like inlining comments
+checkstyle_reports.inline_comment = true
+checkstyle_reports.report(/path/to/xml)
+```
+
+## 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,25 @@
+# frozen_string_literal: true
+
+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_reports.gemspec

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "checkstyle_reports/gem_version.rb"
+
+Gem::Specification.new do |spec|
+  spec.name          = "danger-checkstyle_reports"
+  spec.version       = CheckstyleReports::VERSION
+  spec.authors       = ["Jumpei Matsuda"]
+  spec.email         = ["jmatsu.drm@gmail.com"]
+  spec.description   = "To report checkstyle results via danger."
+  spec.summary       = "This is a danger plugin to report checkstyle results."
+  spec.homepage      = "https://github.com/jmatsu/danger-checkstyle_reports"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files | grep -v 'fixture/'`.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"
+
+  # 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"
+  spec.add_development_dependency "yard"
+
+  # 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_reports/entity/found_error.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module CheckstyleReports::Entity
+  class FoundError
+    # A detected line number
+    #
+    # @return [Fixnum]
+    attr_reader :line_number
+
+    # A detected column
+    # Optionality depends on 'source'
+    #
+    # @return [Fixnum, nil]
+    attr_reader :column_number
+
+    # A severity of this error
+    #
+    # @return [String]
+    attr_reader :severity
+
+    # An error message
+    #
+    # @return [String]
+    attr_reader :html_unescaped_message
+
+    # A name of a detector
+    #
+    # @return [String]
+    attr_reader :source # String
+
+    def initialize(node)
+      raise "Wrong node was passed. expected error but #{node.name}" if node.name != "error"
+
+      attributes = node.attributes
+
+      @line_number = attributes["line"].to_i
+      @column_number = attributes["column"]&.to_i
+      @severity = attributes["severity"]
+      @html_unescaped_message = attributes["message"] # unescape implicitly
+      @source = attributes["source"]
+    end
+  end
+end

data/lib/checkstyle_reports/entity/found_file.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module CheckstyleReports::Entity
+  class FoundFile
+    # A absolute path to this file
+    #
+    # @return [String]
+    attr_reader :path
+
+    # A relative path to this file
+    #
+    # @return [String]
+    attr_reader :relative_path
+
+    # Errors which were detected in this file
+    #
+    # @return [Array<FoundError>]
+    attr_reader :errors
+
+    def initialize(node, prefix:)
+      raise "Wrong node was passed. expected file but #{node.name}" if node.name != "file"
+
+      if prefix.end_with?(file_separator)
+        @prefix = prefix
+      else
+        @prefix = prefix + file_separator
+      end
+
+      name = node.attributes["name"]
+
+      if Pathname.new(name).absolute?
+        raise "Bad prefix was found for #{name}. #{@prefix} was a prefix." unless name.start_with?(@prefix)
+
+        # Use delete_prefix when min support version becomes ruby 2.5
+        @relative_path = name[@prefix.length, name.length - @prefix.length]
+      else
+        @relative_path = name
+      end
+
+      @path = @prefix + @relative_path
+
+      @path = node.attributes["name"]
+      @errors = []
+
+      node.elements.each("error") { |n| @errors << FoundError.new(n) }
+    end
+
+    private
+
+    def file_separator
+      File::ALT_SEPARATOR || File::SEPARATOR
+    end
+  end
+end

data/lib/checkstyle_reports/gem_version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CheckstyleReports
+  VERSION = "0.0.1-rc01"
+end

data/lib/checkstyle_reports/lib/severity.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CheckstyleReports
+  class Severity
+    VALUES = %i(ignore info warning error).freeze
+
+    def initialize(base)
+      @base = base&.to_sym
+    end
+
+    def <=(other)
+      return if @base.nil?
+      return true if other.nil?
+
+      VALUES.index(@base) <= VALUES.index(other.to_sym)
+    end
+  end
+end

data/lib/checkstyle_reports/plugin.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "rexml/document"
+
+require_relative "gem_version"
+
+require_relative "lib/severity"
+
+require_relative "entity/found_error"
+require_relative "entity/found_file"
+
+module Danger
+  # Comment checkstyle reports.
+  #
+  # You need to specify the project root. You don't need do it if it is same with git's top-level path.
+  #
+  #         checkstyle_reports.root_path=/path/to/project
+  #
+  # @example Report errors whose files have been modified (By default)
+  #
+  #         checkstyle_reports.report("app/build/checkstyle/checkstyle.xml"[, modified_files_only: true])
+  #
+  # @example Report all errors in app/build/checkstyle/checkstyle.xml
+  #
+  #         checkstyle_reports.report("app/build/checkstyle/checkstyle.xml", modified_files_only: false)
+  #
+  # @see  Jumpei Matsuda/danger-checkstyle_reports
+  # @tags android, checkstyle
+  #
+  class DangerCheckstyleReports < Plugin
+    REPORT_METHODS = %i(message warn fail).freeze
+
+    # *Optional*
+    # An absolute path to a root.
+    # To comment errors to VCS, this needs to know relative path of files from the root.
+    #
+    # @return [String] the root path of git repository by default.
+    attr_accessor :root_path
+
+    # *Optional*
+    # Create inline comment if true.
+    #
+    # @return [Boolean] true by default
+    attr_accessor :inline_comment
+
+    # *Optional*
+    # minimum severity to be reported (inclusive)
+    #
+    # @return [String, Symbol] error by default
+    attr_accessor :min_severity
+
+    # *Optional*
+    # Set report method
+    #
+    # @return [String, Symbol] error by default
+    attr_accessor :report_method
+
+    # The array of files which include at least one error
+    #
+    # @return [Array<String>] a collection of relative paths
+    attr_reader :reported_files
+
+    # Report errors based on the given xml file if needed
+    #
+    # @param [String] xml_file which contains checkstyle results to be reported
+    # @param [Boolean] modified_files_only which is a flag to filter out non-modified files
+    # @return [void] void
+    def report(xml_file, modified_files_only: true)
+      raise "File path must not be empty" if xml_file.empty?
+      raise "File not found" unless File.exist?(xml_file)
+
+      @min_severity = (min_severity || :error).to_sym
+      @report_method = (report_method || :fail).to_sym
+
+      raise "Unknown severity found" unless CheckstyleReports::Severity::VALUES.include?(min_severity)
+      raise "Unknown report method" unless REPORT_METHODS.include?(report_method)
+
+      files = parse_xml(xml_file, modified_files_only)
+
+      @reported_files = files.map(&:relative_path)
+
+      do_comment(files, modified_files_only) unless files.empty?
+    end
+
+    private
+
+    # Parse the given xml file and apply filters if needed
+    #
+    # @param [String] file_path which is a check-style xml file
+    # @param [Boolean] modified_files_only a flag to determine to apply modified files-only filter
+    # @return [Array<FoundFile>] filtered files
+    def parse_xml(file_path, modified_files_only)
+      prefix = root_path || `git rev-parse --show-toplevel`.chomp
+
+      files = []
+
+      REXML::Document.new(File.read(file_path)).root.elements.each("file") do |f|
+        files << CheckstyleReports::Entity::FoundFile.new(f, prefix: prefix)
+      end
+
+      if modified_files_only
+        files.select! { |f| git.modified_files.include?(f.relative_path) }
+      end
+
+      files.reject! { |f| f.errors.empty? }
+      files
+    end
+
+    # Comment errors based on the given xml file to VCS
+    #
+    # @param [Array<FoundFile>] files which contains checkstyle results to be reported
+    # @param [Boolean] modified_files_only inherit the doc
+    # @return [void] void
+    def do_comment(files, modified_files_only)
+      base_severity = CheckstyleReports::Severity.new(min_severity)
+
+      files.each do |f|
+        f.errors.each do |e|
+          # check severity
+          next unless base_severity <= e.severity
+
+          if inline_comment && (modified_files_only || git.modified_files.include?(f.relative_path))
+            self.public_send(report_method, e.html_unescaped_message, file: f.relative_path, line: e.line_number)
+          else
+            self.public_send(report_method, "#{f.relative_path} : #{e.html_unescaped_message} at #{e.line_number}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/danger_checkstyle_reports.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "checkstyle_reports/gem_version"

data/lib/danger_plugin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "checkstyle_reports/plugin"

data/spec/checkstyle_reports_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require File.expand_path("spec_helper", __dir__)
+
+module Danger
+  describe Danger::DangerCheckstyleReports do
+    it "should be a plugin" do
+      expect(Danger::DangerCheckstyleReports.new(nil)).to be_a Danger::Plugin
+    end
+
+    #
+    # You should test your custom attributes and methods here
+    #
+    describe "with Dangerfile" do
+      before do
+        @dangerfile = testing_dangerfile
+        @my_plugin = @dangerfile.checkstyle_reports
+
+        # mock the PR data
+        # you can then use this, eg. github.pr_author, later in the spec
+        json = File.read(fixture_path + "github_pr.json")
+        allow(@my_plugin.github).to receive(:pr_json).and_return(json)
+      end
+    end
+  end
+end

data/spec/entity/found_error_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative "../spec_helper"
+
+module CheckstyleReports::Entity
+  ERROR_NODE_SAMPLE_1 = <<NODE
+<error
+  line="144"
+  column="108"
+  severity="error"
+  message="&apos;+&apos; should be on a new line."
+  source="com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck"
+/>
+NODE
+
+  ERROR_NODE_SAMPLE_2 = <<NODE
+<error
+  line="296"
+  severity="error"
+  message="Line has trailing spaces."
+  source="com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck"
+/>
+NODE
+
+  describe CheckstyleReports::Entity::FoundError do
+    let(:error) { FoundError.new(REXML::Document.new(node).root) }
+
+    context "sample1" do
+      let(:node) { ERROR_NODE_SAMPLE_1 }
+
+      it "should read it successfully" do
+        expect(error.line_number).to eq(144)
+        expect(error.column_number).to eq(108)
+        expect(error.severity).to eq("error")
+        expect(error.html_unescaped_message).to eq("'+' should be on a new line.")
+        expect(error.source).to eq("com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck")
+      end
+    end
+
+    context "sample2" do
+      let(:node) { ERROR_NODE_SAMPLE_2 }
+
+      it "should read it successfully" do
+        expect(error.line_number).to eq(296)
+        expect(error.column_number).to be_nil
+        expect(error.severity).to eq("error")
+        expect(error.html_unescaped_message).to eq("Line has trailing spaces.")
+        expect(error.source).to eq("com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck")
+      end
+    end
+  end
+end

data/spec/entity/found_file_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "../spec_helper"
+
+module CheckstyleReports::Entity
+  FILE_NODE_SAMPLE_1 = <<NODE
+<file
+  name="/Users/jmatsu/Workspace/sample/src/main/java/io/github/jmatsu/Sample.java" >
+  #{ERROR_NODE_SAMPLE_1}
+</file>
+NODE
+
+  FILE_NODE_SAMPLE_2 = <<NODE
+<file
+  name="/Users/jmatsu/Workspace/sample/src/test/java/io/github/jmatsu/Sample2.java" >
+  #{ERROR_NODE_SAMPLE_1}
+  #{ERROR_NODE_SAMPLE_2}
+</file>
+NODE
+
+  FILE_NODE_SAMPLE_EMPTY = <<NODE
+<file
+  name="/Users/jmatsu/Workspace/sample/src/main/java/io/github/jmatsu/Sample.java" />
+NODE
+
+  describe CheckstyleReports::Entity::FoundFile do
+    let(:file) { FoundFile.new(REXML::Document.new(node).root, prefix: "/Users/jmatsu/Workspace/sample") }
+
+    context "sample1" do
+      let(:node) { FILE_NODE_SAMPLE_1 }
+
+      it "should read it successfully" do
+        expect(file.path).to eq("/Users/jmatsu/Workspace/sample/src/main/java/io/github/jmatsu/Sample.java")
+        expect(file.errors.size).to eq(1)
+        expect(file.relative_path).to eq("src/main/java/io/github/jmatsu/Sample.java")
+      end
+    end
+
+    context "sample2" do
+      let(:node) { FILE_NODE_SAMPLE_2 }
+
+      it "should read it successfully" do
+        expect(file.path).to eq("/Users/jmatsu/Workspace/sample/src/test/java/io/github/jmatsu/Sample2.java")
+        expect(file.errors.size).to eq(2)
+        expect(file.relative_path).to eq("src/test/java/io/github/jmatsu/Sample2.java")
+      end
+    end
+
+    context "sample empty" do
+      let(:node) { FILE_NODE_SAMPLE_EMPTY }
+
+      it "should read it successfully" do
+        expect(file.path).to eq("/Users/jmatsu/Workspace/sample/src/main/java/io/github/jmatsu/Sample.java")
+        expect(file.errors.size).to eq(0)
+        expect(file.relative_path).to eq("src/main/java/io/github/jmatsu/Sample.java")
+      end
+    end
+  end
+end

data/spec/lib/severity_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "../spec_helper"
+
+module CheckstyleReports
+  describe CheckstyleReports::Severity do
+    let(:data) do
+      [
+        [:ignore, :ignore, true],
+        [:ignore,  :info,    true],
+        [:ignore,  :warning, true],
+        [:ignore,  :error,   true],
+        [:info,    :ignore,  false],
+        [:info,    :info,    true],
+        [:info,    :warning, true],
+        [:info,    :error,   true],
+        [:warning, :ignore,  false],
+        [:warning, :info,    false],
+        [:warning, :warning, true],
+        [:warning, :error,   true],
+        [:error,   :ignore,  false],
+        [:error,   :info,    false],
+        [:error,   :warning, false],
+        [:error,   :error,   true],
+      ]
+    end
+
+    context "<=" do
+      it do
+        data.each do |d|
+          base, other, expected = d
+
+          severity = CheckstyleReports::Severity.new(base)
+
+          expect(severity <= other).to eq(expected)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "pathname"
+ROOT = Pathname.new(File.expand_path("..", __dir__))
+$:.unshift((ROOT + "lib").to_s)
+$:.unshift((ROOT + "spec").to_s)
+
+def fixture_path
+  "#{(ROOT + 'fixture')}/"
+end
+
+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,214 @@
+--- !ruby/object:Gem::Specification
+name: danger-checkstyle_reports
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre.rc01
+platform: ruby
+authors:
+- Jumpei Matsuda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-09 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: 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: 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: To report checkstyle results via danger.
+email:
+- jmatsu.drm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bundle/config"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Dangerfile.sample
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-checkstyle_reports.gemspec
+- lib/checkstyle_reports/entity/found_error.rb
+- lib/checkstyle_reports/entity/found_file.rb
+- lib/checkstyle_reports/gem_version.rb
+- lib/checkstyle_reports/lib/severity.rb
+- lib/checkstyle_reports/plugin.rb
+- lib/danger_checkstyle_reports.rb
+- lib/danger_plugin.rb
+- spec/checkstyle_reports_spec.rb
+- spec/entity/found_error_spec.rb
+- spec/entity/found_file_spec.rb
+- spec/lib/severity_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jmatsu/danger-checkstyle_reports
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: This is a danger plugin to report checkstyle results.
+test_files:
+- spec/checkstyle_reports_spec.rb
+- spec/entity/found_error_spec.rb
+- spec/entity/found_file_spec.rb
+- spec/lib/severity_spec.rb
+- spec/spec_helper.rb