undercover-checkstyle 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5bb973c988f9367c91a266fe9f0f41f60aff4d2c0ebc5f8a2dd3b02e65e7d0c1
+  data.tar.gz: bb5dab6911a669557e3086cb18bd20099288ad62992b4a09bd2b9ba1d43bed95
+SHA512:
+  metadata.gz: eeef65f9631b5577523be2b873d93520592c7214a6e16dd3e7cdaf62ce00749c430ee3395d558caa76fc7a33573b2f1016f26b4b052da83c4cda8e2a96b4ef4b
+  data.tar.gz: 7f7ac8c5ba35dd373f023c9a9b9f4d32912527669dd5ae820eb7c36a95114820475483833546c1572153f5abb0cb268371fe13bcce4c8d0632f45765bb99bd27

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

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 lala.akira@gmail.com. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in undercover-checkstyle.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 aki
+
+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,80 @@
+# undercover-checkstyle
+
+![Actions Demo](https://i.gyazo.com/881890dcba76cf30a8db86d9635ba38a.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'undercover-checkstyle'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+[Setting up required LCOV reporting](https://github.com/grodowski/undercover#setting-up-required-lcov-reporting)
+
+```
+bundle exec undercover-checkstyle
+```
+
+### GitHub Actions Example
+
+*reviewdog.yml*
+```yaml
+runner:
+  undercover:
+    cmd: bundle exec undercover-checkstyle --compare origin/master
+    level: warning
+    format: checkstyle
+```
+
+*.github/workflows/ruby.yml*
+```yaml
+name: Ruby
+
+on:
+  pull_request:
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+
+    env:
+      RUBYOPT: -EUTF-8
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+
+      - name: Bundle install
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Rspec
+        run: bundle exec rspec
+
+      - name: Setup reviewdog
+        run: |
+          mkdir -p $HOME/bin && curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh| sh -s -- -b $HOME/bin
+          echo ::add-path::$HOME/bin
+          echo ::add-path::$(go env GOPATH)/bin # for Go projects
+
+      - name: Run reviewdog
+        env:
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          git fetch
+          reviewdog -reporter=github-pr-review -runners=undercover
+```
+
+## Thanks
+
+- [grodowski/undercover: Actionable code coverage \- detects untested code blocks in recent changes](https://github.com/grodowski/undercover)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "undercover/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/exe/undercover-checkstyle

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+$VERBOSE = nil
+
+require 'undercover/checkstyle'
+
+result = Undercover::Checkstyle::CLI.run(ARGV)
+exit result

data/lib/undercover/checkstyle.rb

@@ -0,0 +1,7 @@
+require "undercover/checkstyle/version"
+require "undercover/checkstyle/cli"
+
+module Undercover
+  module Checkstyle
+  end
+end

data/lib/undercover/checkstyle/cli.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'undercover'
+require 'undercover/checkstyle/formatter'
+
+module Undercover
+  module Checkstyle
+    module CLI
+      def self.run(args)
+        opts = Undercover::Options.new.parse(args)
+        syntax_version(opts.syntax_version)
+
+        run_report(opts)
+      end
+
+      def self.run_report(opts)
+        report = Undercover::Report.new(changeset(opts), opts).build
+        flagged = report.flagged_results
+        puts Undercover::Checkstyle::Formatter.new(flagged)
+        flagged.any? ? 1 : 0
+      end
+
+      def self.syntax_version(version)
+        return unless version
+
+        Imagen.parser_version = version
+      end
+
+      def self.changeset(opts)
+        git_dir = File.join(opts.path, opts.git_dir)
+        Undercover::Changeset.new(git_dir, opts.compare)
+      end
+    end
+  end
+end

data/lib/undercover/checkstyle/formatter.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+require 'stringio'
+require 'rexml/document'
+require 'rexml/formatters/pretty'
+
+module Undercover
+  module Checkstyle
+    class Formatter
+      def initialize(results)
+        @results = results
+      end
+
+      def to_s
+        file_annotations = warnings_to_annotations.group_by { |annotation| annotation[:path] }
+
+        doc = REXML::Document.new
+        doc << REXML::XMLDecl.new('1.0', 'UTF-8')
+        checkstyle = REXML::Element.new('checkstyle', doc)
+        file_annotations.each do |path, annotations|
+          checkstyle << file_element(path, annotations)
+        end
+
+        output = StringIO.new
+        pretty_formatter = REXML::Formatters::Pretty.new
+        pretty_formatter.write(doc, output)
+        output.string
+      end
+
+      private
+
+      def format_lines(lines)
+        prev = lines[0]
+        slices = lines.slice_before do |e|
+          (prev + 1 != e).tap { prev = e }
+        end
+        slices.map { |slice_first, *, slice_last| slice_last ? (slice_first..slice_last) : slice_first }
+      end
+
+      def file_element(path, annotations)
+        file = REXML::Element.new('file')
+        file.attributes['name'] = path
+        annotations.each do |annotation|
+          error = REXML::Element.new('error', file)
+          error.attributes['line'] = annotation[:end_line]
+          error.attributes['column'] = 0
+          error.attributes['severity'] = 'warning'
+          error.attributes['message'] = annotation[:message]
+          error.attributes['source'] = annotation[:title]
+        end
+        file
+      end
+
+      # SEE: https://github.com/grodowski/undercover-ci/blob/master/lib/check_runs/complete.rb
+      def warnings_to_annotations
+        @results.map do |result|
+          # TODO: duplicates pronto-undercover logic, move to Undercover::Result
+          lines = result.coverage.map { |ln, _cov| ln if result.uncovered?(ln) }.compact
+          message = "#{result.node.human_name.capitalize} `#{result.node.name}` is missing" \
+                    " coverage for line#{'s' if lines.size > 1} #{format_lines(lines).join(',')}" \
+                    " (node coverage: #{result.coverage_f})"
+          {
+            path: result.file_path,
+            start_line: result.first_line,
+            end_line: result.last_line,
+            annotation_level: "warning",
+            title: "Untested #{result.node.human_name}",
+            message: message
+          }
+        end
+      end
+    end
+  end
+end

data/lib/undercover/checkstyle/version.rb

@@ -0,0 +1,5 @@
+module Undercover
+  module Checkstyle
+    VERSION = "0.2.0"
+  end
+end

data/undercover-checkstyle.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/undercover/checkstyle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "undercover-checkstyle"
+  spec.version       = Undercover::Checkstyle::VERSION
+  spec.authors       = ["aki77"]
+  spec.email         = ["aki77@users.noreply.github.com"]
+
+  spec.summary       = %q{Undercover checkstyle reporter.}
+  spec.description   = %q{Undercover checkstyle reporter.}
+  spec.homepage      = "https://github.com/aki77/undercover-checkstyle"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency 'undercover', '>= 0.3.4'
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: undercover-checkstyle
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- aki77
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: undercover
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+description: Undercover checkstyle reporter.
+email:
+- aki77@users.noreply.github.com
+executables:
+- undercover-checkstyle
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/undercover-checkstyle
+- lib/undercover/checkstyle.rb
+- lib/undercover/checkstyle/cli.rb
+- lib/undercover/checkstyle/formatter.rb
+- lib/undercover/checkstyle/version.rb
+- undercover-checkstyle.gemspec
+homepage: https://github.com/aki77/undercover-checkstyle
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aki77/undercover-checkstyle
+  source_code_uri: https://github.com/aki77/undercover-checkstyle
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.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: Undercover checkstyle reporter.
+test_files: []