pronto-checkstyle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df42054679cdde689063004e950bc05babf55f2e946abe78a79e968c6e0b6d44
+  data.tar.gz: 6ab6338278afdda321c5aba6b74fa9997a95341dc2471f7e00a41887ff02f36a
+SHA512:
+  metadata.gz: a5397af82fe336f4336fdcbc61c36ab55881bf25c5b964cf68eb8cb04e6c484576a9fd8a3b740afdbc4ccc2e5d3f40b27aa27250eadbd72d053664cc729945e1
+  data.tar.gz: 75d806268d7c73d3e06c2baf3b1ef033cff091c7d40df6062484bbb9b0f76100f334e2328b487b4239f2fe2743464f4b365c3b31be2b0a0f9464a604aa5f2945

data/.gitignore

@@ -0,0 +1,60 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+### https://raw.github.com/github/gitignore/18654b47c86bef38add5cd091ec2dac7d6e6e37b/Global/Emacs.gitignore
+
+# -*- mode: gitignore; -*-
+*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+*.elc
+auto-save-list
+tramp
+.\#*
+
+# Org-mode
+.org-id-locations
+*_archive
+
+# flymake-mode
+*_flymake.*
+
+# eshell files
+/eshell/history
+/eshell/lastdir
+
+# elpa packages
+/elpa/
+
+# reftex files
+*.rel
+
+# AUCTeX auto folder
+/auto/
+
+# cask packages
+.cask/
+dist/
+
+# Flycheck
+flycheck_*.el
+
+# server auth directory
+/server/
+
+# projectiles files
+.projectile
+
+# directory configuration
+.dir-locals.el
+
+# network security
+/network-security.data

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install:
+  - gem update --system
+  - gem install bundler

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at seikichi@kmc.gr.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pronto-checkstyle.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Seiichi KONDO
+
+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,47 @@
+# Pronto::Checkstyle
+
+[![Gem Version](https://badge.fury.io/rb/pronto-checkstyle.svg)](http://badge.fury.io/rb/pronto-checkstyle)
+[![Build Status](https://travis-ci.org/seikichi/pronto-checkstyle.svg?branch=master)](https://travis-ci.org/seikichi/pronto-checkstyle)
+[![Coverage Status](https://coveralls.io/repos/seikichi/pronto-checkstyle/badge.svg?branch=master&service=github)](https://coveralls.io/github/seikichi/pronto-checkstyle?branch=master)
+
+[Pronto](https://github.com/mmozuras/pronto) runner for [checkstyle](http://checkstyle.sourceforge.net/).
+
+## Configuration
+
+You need to specify location of checkstyle reports by passing `PRONTO_CHECKSTYLE_REPORTS_DIR` env variable e.g:
+
+```bash
+PRONTO_CHECKSTYLE_REPORTS_DIR=build/reports/checkstyle/ pronto run --index
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pronto-checkstyle'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pronto-checkstyle
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake test` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/seikichi/pronto-checkstyle.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pronto/checkstyle'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pronto/checkstyle.rb

@@ -0,0 +1,71 @@
+require 'pronto'
+require 'rexml/document'
+
+module Pronto
+  class Checkstyle < Runner
+    def run
+      return [] unless @patches
+
+      @patches
+        .select(&method(:valid_patch?))
+        .flat_map(&method(:inspect))
+        .compact
+    end
+
+    private
+
+    Offence = Struct.new(:path, :line, :message)
+
+    def checkstyle_reports_dir
+      ENV['PRONTO_CHECKSTYLE_REPORTS_DIR'] || (raise 'Please set `PRONT_CHECKSTYLE_REPORTS_DIR` to use pronto-checkstyle')
+    end
+
+    def valid_patch?(patch)
+      patch.additions > 0
+    end
+
+    def inspect(patch)
+      offences = checkstyle_offences.select { |offence| offence.path == patch.new_file_full_path.to_s }
+
+      offences.flat_map do |offence|
+        patch.added_lines
+             .select { |line| line.new_lineno == offence.line }
+             .map { |line| new_message(offence, line) }
+      end
+    end
+
+    def checkstyle_offences
+      @checkstyle_offences ||=
+        begin
+          pattern = File.join(checkstyle_reports_dir, '**', '*.xml')
+          Dir.glob(pattern).flat_map(&method(:read_checkstyle_report))
+        end
+    end
+
+    def read_checkstyle_report(path)
+      doc = REXML::Document.new(File.read(path))
+      REXML::XPath.match(doc, '/checkstyle/file').flat_map do |file|
+        REXML::XPath.match(file, 'error').map do |error|
+          Offence.new(path_from(file), line_from(error), message_from(error))
+        end
+      end
+    end
+
+    def path_from(file_node)
+      file_node.attribute('name').to_s
+    end
+
+    def line_from(error_node)
+      error_node.attribute('line').to_s.to_i
+    end
+
+    def message_from(error_node)
+      error_node.attribute('message').to_s
+    end
+
+    def new_message(offence, line)
+      path = line.patch.delta.new_file[:path]
+      Message.new(path, line, :warning, offence.message, nil, self.class)
+    end
+  end
+end

data/lib/pronto/checkstyle/version.rb

@@ -0,0 +1,5 @@
+module Pronto
+  module CheckstyleVersion
+    VERSION = '0.1.0'.freeze
+  end
+end

data/pronto-checkstyle.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pronto/checkstyle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pronto-checkstyle'
+  spec.version       = Pronto::CheckstyleVersion::VERSION
+  spec.authors       = ['Seiichi KONDO']
+  spec.email         = ['seikichi@kmc.gr.jp']
+
+  spec.summary       = 'Pronto runner for checkstyle / spotbugs'
+  spec.description   = <<-DESCRIPTION
+    A pronto runner for checkstyle and spotbugs.
+    Pronto runs analysis quickly by checking only the relevant changes.
+    Created to be used on pull requests, but suited for other scenarios as well.
+  DESCRIPTION
+  spec.homepage      = 'https://github.com/seikichi/pronto-checkstyle'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'pronto', '~> 0.9.5'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.62'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'test-unit', '~> 3.2.8'
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: pronto-checkstyle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Seiichi KONDO
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: 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'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.62'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.62'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+description: |2
+      A pronto runner for checkstyle and spotbugs.
+      Pronto runs analysis quickly by checking only the relevant changes.
+      Created to be used on pull requests, but suited for other scenarios as well.
+email:
+- seikichi@kmc.gr.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pronto/checkstyle.rb
+- lib/pronto/checkstyle/version.rb
+- pronto-checkstyle.gemspec
+homepage: https://github.com/seikichi/pronto-checkstyle
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Pronto runner for checkstyle / spotbugs
+test_files: []