circleci_reporter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ada134b1de48734b63db0b3d490b58574636d8f75f7bd1feae84b350a39554e
+  data.tar.gz: e95c83a50b10a110fcb44dd6496eb53c838b2769f9471a3f6c01fca094ead057
+SHA512:
+  metadata.gz: 813e662bfa72e64cca3e5d51645de34a30a25ac31b7a103f9ad5f1722e98c560d43ceea3dc9c0dd3d3aa211a1ccc45db4e0f8309b68d048d6b6a9727e5508426
+  data.tar.gz: 00e71ea752be325437005ed29a93cf8d4f33155aa25c0e2af266aed9063b7f3c9e3fc8fa8edc9a1e566e43c26d7feae451d4e51c543ad03128b8d4485febf368

data/.config.reek

@@ -0,0 +1,23 @@
+---
+Attribute:
+  enabled: false
+DuplicateMethodCall:
+  max_calls: 2
+FeatureEnvy:
+  enabled: false
+IrresponsibleModule:
+  enabled: false
+RepeatedConditional:
+  exclude:
+    - "CircleCI::CoverageReporter::Client"
+TooManyStatements:
+  exclude:
+    - "CircleCI::CoverageReporter::Sandbox#self.sandboxed"
+UnusedParameters:
+  exclude:
+    - !ruby/regexp /Abstract/
+    - "CircleCI::CoverageReporter::ReportsRenderer#render"
+UtilityFunction:
+  enabled: false
+
+# vim:set ft=yaml:

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/examples.txt
+/spec/reports/
+/tmp/
+/rubycritic/
+
+.rubocop-*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+require:
+  - rubocop-rake
+  - rubocop-performance
+
+inherit_from:
+  - https://relaxed.ruby.style/rubocop.yml
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7

data/.yardopts

@@ -0,0 +1,4 @@
+--markup markdown
+-
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,94 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [1.0.0] - 2020-04-16
+### Changed
+- Upgrade Faraday version dependency
+- Minor fixes
+
+## [0.8.0] - 2017-05-31
+### Changed
+- Use artifacts in container No. 0
+
+## [0.7.0] - 2017-05-31
+### Changed
+- Add base and previous links to Link reporter
+
+## [0.6.0] - 2017-05-30
+### Changed
+- Refactor how to implement reporter. Now a reporter consists of a single ruby class
+
+### Removed
+- Remove template configuration
+
+## [0.5.0] - 2017-05-18
+### Added
+- Add Link reporter
+
+## [0.4.0] - 2017-03-18
+### Added
+- Support [RubyCritic](https://github.com/whitesmith/rubycritic) score
+- Enable to change score unit
+
+### Changed
+- Round coverage by default
+
+### Fixed
+- Make sure that `#coverage` methods return a `Float` object
+
+## [0.3.1] - 2017-03-17
+### Fixed
+- Suppress emoji if base diff is NaN or zero
+
+## [0.3.0] - 2017-03-16
+### Added
+- Add template configuration
+
+### Changed
+- Remove `CircleCI::CoverageReporter::Client#configuration`
+
+### Fixed
+- Run each example in sandbox
+
+## [0.2.0] - 2017-03-14
+### Added
+- Support [Flow](https://flowtype.org) coverage reported by [flow-coverage-report](https://github.com/rpl/flow-coverage-report)
+
+### Fixed
+- Disable inactive reporters
+- Fix uninitialized constant `Float::NaN`
+
+## [0.1.3] - 2017-03-12
+### Fixed
+- Raise `RequestError` if some API reqeust fails
+- Show `NaN` if .last_run.json does not exist
+
+## [0.1.2] - 2017-03-12
+### Fixed
+- Set `nil` to previous_build_number if CIRCLE_PREVIOUS_BUILD_NUM environment variable is empty
+
+## [0.1.1] - 2017-03-12
+### Fixed
+- Ignore base_build if it is on master branch
+
+## 0.1.0 - 2017-03-12
+### Added
+- Initial release
+
+[Unreleased]: https://github.com/increments/circleci-coverage_reporter/compare/v0.8.0...HEAD
+[0.8.0]: https://github.com/increments/circleci-coverage_reporter/compare/v0.7.0...v0.8.0
+[0.7.0]: https://github.com/increments/circleci-coverage_reporter/compare/v0.6.0...v0.7.0
+[0.6.0]: https://github.com/increments/circleci-coverage_reporter/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/increments/circleci-coverage_reporter/compare/v0.4.0...v0.5.0
+[0.4.0]: https://github.com/increments/circleci-coverage_reporter/compare/v0.3.1...v0.4.0
+[0.3.1]: https://github.com/increments/circleci-coverage_reporter/compare/v0.3.0...v0.3.1
+[0.3.0]: https://github.com/increments/circleci-coverage_reporter/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/increments/circleci-coverage_reporter/compare/v0.1.3...v0.2.0
+[0.1.3]: https://github.com/increments/circleci-coverage_reporter/compare/v0.1.2...v0.1.3
+[0.1.2]: https://github.com/increments/circleci-coverage_reporter/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/increments/circleci-coverage_reporter/compare/v0.1.0...v0.1.1

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Increments inc,
+
+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,115 @@
+# CircleCIReporter
+
+This is a maitained fork of [CircleCI::CoverageReporter](https://github.com/increments/circleci-coverage_reporter)
+
+**CircleCIReporter** reports test coverage to your GitHub repository.
+
+## Getting started
+
+1.  Add CircleCIReporter to your `Gemfile` and `bundle install`:
+
+    ```ruby
+    gem 'circleci_reporter', group: :test
+    ```
+
+2.  Load `circleci_reporter/rake_task` in your `Rakefile`:
+
+    ```ruby
+    require 'circleci_reporter/rake_task' if ENV['CIRCLECI']
+    ```
+
+3.  Issue CircleCI and GitHub tokens and add them to build environment variables as follows:
+
+    Name                               | Value
+    -----------------------------------|----------------------------------------------------------------
+    `CIRCLECI_REPORTER_CIRCLECI_TOKEN` | CircleCI API token with "view-builds" scope
+    `CIRCLECI_REPORTER_VCS_TOKEN`      | GitHub personal access token with "repo" or "public_repo" scope
+
+4.  Add the following step to your `circle.yml`:
+
+    ```yaml
+    test:
+      post:
+      - bundle exec rake circleci_reporter:coverage
+    ```
+
+## Run manually
+
+You must configure `circleci_token` and `vcr_token` before `CircleCIReporter.run`:
+
+```ruby
+CircleCIReporter.configure do |config|
+  config.circleci_token = YOUR_CIRCLECI_API_TOKEN
+  config.vcr_token = YOUR_GITHUB_PERSONAL_ACCESS_TOKEN
+end
+
+CircleCIReporter.run
+```
+
+## Reporters
+### SimpleCov
+
+`CircleCIReporter::Reporters::SimpleCovReporter` handles coverage files generated by
+[SimpleCov](https://github.com/colszowka/simplecov).
+
+It expects that coverage files are located in `$CIRCLE_ARTIFACTS/coverage` directory:
+
+```ruby
+# spec/spec_helper.rb
+require 'simplecov'
+# Save to CircleCI's artifacts directory if we're on CircleCI
+SimpleCov.coverage_dir(File.join(ENV['CIRCLE_ARTIFACTS'], 'coverage')) if ENV['CIRCLECI']
+SimpleCov.start
+```
+
+If you put files in another directory, say `$CIRCLE_ARTIFACTS/foo/bar`, you have to set reporter as follows:
+
+```ruby
+CircleCIReporter.configure do |config|
+  config.reporters << CircleCIReporter::Reporters::SimpleCov.new(dir: 'foo/bar')
+end
+```
+
+### Flow
+
+`CircleCIReporter::Reporters::FlowReporter` handles coverage files generated by
+[flow-coverage-report](https://github.com/rpl/flow-coverage-report)
+
+It expects that there is `$CIRCLE_ARTIFACTS/flow-coverage/flow-coverage.json`:
+
+```bash
+$(npm bin)/flow-coverage-report -t json -o $CIRCLE_ARTIFACTS/flow-coverage
+```
+
+If you put the file in another path, say `$CIRCLE_ARTIFACTS/foo/bar/flow-coverage.json`,
+you have to set reporter as follows:
+
+```ruby
+CircleCIReporter.configure do |config|
+  config.reporters << CircleCIReporter::Reporters::Flow.new(dir: 'foo/bar')
+end
+```
+
+### RubyCritic
+
+`CircleCIReporter::Reporters::RubyCritic` handles code quality files generated by
+[rubycritic](https://github.com/whitesmith/rubycritic)
+
+```bash
+bundle exec rubycritic -p $CIRCLE_ARTIFACTS/rubycritic -f json --no-browser --mode-ci app
+bundle exec rubycritic -p $CIRCLE_ARTIFACTS/rubycritic -f html --no-browser --mode-ci app
+```
+
+### Link
+
+`CircleCIReporter::Reporters::Link` reports a link to an artifact file.
+
+```ruby
+CircleCIReporter.configure do |config|
+  config.reporters << CircleCI::CoverateReporter::Reporters::Link.new(path: 'path/to/file', name: 'NAME')
+end
+```
+
+## 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,29 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+require 'circleci_reporter/rake_task'
+require 'rubycritic/rake_task'
+
+RSpec::Core::RakeTask.new do |task|
+  task.verbose = false
+end
+
+RuboCop::RakeTask.new
+
+YARD::Rake::YardocTask.new
+
+CircleCIReporter.configure do |config|
+  config.reporters << CircleCIReporter::Reporters::Link.new(path: 'doc/index.html', name: 'YARD')
+end
+
+desc 'Run RubyCritic'
+task :rubycritic do
+  base_options = "-p #{ENV['CIRCLE_ARTIFACTS'] || '.'}/rubycritic --mode-ci --no-browser"
+  sh "bundle exec rubycritic #{base_options} -f html lib"
+  sh "bundle exec rubycritic #{base_options} -f json lib" if ENV['CIRCLECI']
+end
+
+task default: %i[spec rubocop]

data/bin/rspec

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

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/bin/yard

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yard')

data/circle.yml

@@ -0,0 +1,11 @@
+machine:
+  ruby:
+    version: 2.4.0
+test:
+  override:
+  - bundle exec rspec --format progress --require rspec_junit_formatter --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml
+  - bundle exec rubocop
+  post:
+  - bundle exec rake rubycritic
+  - bundle exec yard doc -o $CIRCLE_ARTIFACTS/doc
+  - bundle exec rake circleci_reporter:coverage

data/circleci_reporter.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'circleci_reporter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'circleci_reporter'
+  spec.version       = CircleCIReporter::Version.to_s
+  spec.authors       = ['Yuku Takahashi', 'Filippo Liverani']
+
+  spec.summary       = 'Report CircleCI test coverage and static analysis'
+  spec.description   = 'Report CircleCI test coverage and static analysis results to your GitHub repository'
+  spec.homepage      = 'https://github.com/filippoliverani/circleci-reporter'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.7'
+
+  spec.add_dependency 'faraday', '~> 1.0'
+
+  spec.add_development_dependency 'ffaker', '~> 2.18'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4'
+  spec.add_development_dependency 'rubocop', '~> 1.12'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.10'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.5'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.0'
+  spec.add_development_dependency 'rubycritic', '~> 4.6'
+  spec.add_development_dependency 'simplecov', '~> 0.21'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end