simplecov-review 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1d9deaba10268b776c6498b55c64035273b4eef4f15321dc8e8d035f80408c2
+  data.tar.gz: c5da36f9691120017450ac9ccb6d6d80fd1f347f40c567f043124bfef50a8888
+SHA512:
+  metadata.gz: d717454cfb87c084a8e93c63899059b77181d1d3679eff6236e70aae645503716721d7b8cf61dc70074a056772f16c08b1b81d7aa1fb849e304ae50600f403e3
+  data.tar.gz: 29977bbafbf8b17916f63f0c8247af6da82b1c016c6f0309532e4c24e1057d363625e91bc1eca9ca517428af828d8d6297120df9e4e2eca4f34a8dc78e18cfdc

data/.github/workflows/main.yml

@@ -0,0 +1,22 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7, 3.0]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run RSpec
+      run: bundle exec rspec
+    - name: Run Rubocop
+      run: bundle exec rubocop

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,17 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Naming/FileName:
+  Exclude:
+    - "lib/simplecov-review.rb"
+    - "spec/simplecov-review_spec.rb"
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-10-19
+
+- Initial release

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simplecov-review.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.7'
+gem 'rubocop-rspec', '~> 2.5'

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    simplecov-review (0.1.0)
+      simplecov (~> 0.21.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.22.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    rubocop-rspec (2.5.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-18
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+  rubocop-rspec (~> 2.5)
+  simplecov-review!
+
+BUNDLED WITH
+   2.2.17

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Karol Bąk
+
+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,70 @@
+# simplecov-review
+
+SimpleCov formatter to generate missing lines errors for reporting tools
+like [reviewdog](https://github.com/reviewdog/reviewdog). It creates `coverage/review.txt` file containing uncovered
+lines in a format that can be easily used with reviewdog.
+
+Example:
+
+```
+app/controllers/admin/companies_controller.rb:16:1: Missing coverage for line 16
+app/controllers/admin/company_owners_controller.rb:17:1: Missing coverage for line 17
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :test do
+  gem 'simplecov-review', require: false
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+Require the library in your `spec_helper.rb` and set it as your SimpleCov formatter:
+
+```ruby
+require 'simplecov'
+require 'simplecov-review'
+
+SimpleCov.start do
+  formatter SimpleCov::Formatter::ReviewFormatter
+end
+```
+
+### Reviewdog integration
+
+Since in your workflow rspec will be executed before reviewdog, make sure to disable minimum coverage check in
+SimpleCov since it will stop the process in case the coverage is below threshold or configure you CI to execute it anyway (on GitHub Actions use `if: always()`).
+
+To report uncovered lines with reviewdog, add following lines to `.reviewdog.yml`:
+
+```yaml
+runner:
+  # other checks
+  coverage:
+    cmd: cat coverage/review.txt
+    level: warning
+    errorformat:
+      - "%f:%l:%c: %m"
+```
+
+Result:
+
+![reviewdog result](https://kukicola.io/assets/img/review/missing-coverage.png)
+
+If you require 100% line coverage in your project change `level` value to `error`.
+
+## Roadmap
+
+* add branch coverage support
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kukicola/simplecov-review.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/simplecov-review/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  module Formatter
+    class ReviewFormatter
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/simplecov-review.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'simplecov-review/version'
+
+module SimpleCov
+  module Formatter
+    FILENAME = 'review.txt'
+    #
+    # Simple formatter to report missing coverage for reporting tools
+    #
+    class ReviewFormatter
+      def format(result)
+        File.open(export_path, 'w') do |output_file|
+          result.files.each do |file|
+            find_missing_groups(file).each do |lines|
+              output_file << error_for(file, lines)
+            end
+          end
+        end
+      end
+
+      private
+
+      def error_for(file, lines)
+        filename = file.filename.gsub("#{SimpleCov.root}/", '')
+        message = if lines.length > 1
+                    "Missing coverage for lines #{lines.first}-#{lines.last}"
+                  else
+                    "Missing coverage for line #{lines.first}"
+                  end
+        "#{filename}:#{lines.first}:1: #{message}\n"
+      end
+
+      def find_missing_groups(file)
+        lines_missing = file.lines.each_index.select { |index| file.lines[index].coverage&.zero? }.map { |l| l + 1 }
+        lines_missing.slice_when { |prev, curr| curr != prev.next }.to_a
+      end
+
+      def export_path
+        File.join(SimpleCov.coverage_path, FILENAME)
+      end
+    end
+  end
+end

data/simplecov-review.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'lib/simplecov-review/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simplecov-review'
+  spec.version       = SimpleCov::Formatter::ReviewFormatter::VERSION
+  spec.authors       = ['Karol Bąk']
+  spec.email         = ['kukicola@gmail.com']
+
+  spec.summary       = 'SimpleCov formatter to generate missing lines errors for reporting tools like reviewdog'
+  spec.homepage      = 'https://github.com/kukicola/simplecov-review'
+  spec.required_ruby_version = '>= 2.5.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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'simplecov', '~> 0.21.2'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: simplecov-review
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karol Bąk
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+description:
+email:
+- kukicola@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/simplecov-review.rb
+- lib/simplecov-review/version.rb
+- simplecov-review.gemspec
+homepage: https://github.com/kukicola/simplecov-review
+licenses: []
+metadata:
+  homepage_uri: https://github.com/kukicola/simplecov-review
+  source_code_uri: https://github.com/kukicola/simplecov-review
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: SimpleCov formatter to generate missing lines errors for reporting tools
+  like reviewdog
+test_files: []