simplecov_linter_formatter 0.1.0

data/Gemfile.lock

@@ -0,0 +1,123 @@
+PATH
+  remote: .
+  specs:
+    simplecov_linter_formatter (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    ffi (1.15.4)
+    formatador (0.3.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      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)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    listen (3.7.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    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)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.21.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    rubocop-rails (2.12.2)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.7.0, < 2.0)
+    ruby-progressbar (1.11.0)
+    shellany (0.0.1)
+    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.3)
+    thor (0.18.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.2.15)
+  guard-rspec
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter
+  rubocop (~> 1.9)
+  rubocop-rails
+  simplecov (~> 0.21)
+  simplecov_linter_formatter!
+
+BUNDLED WITH
+   2.2.15

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright 2021 Platanus
+
+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,100 @@
+# SimpleCov Linter Formatter
+
+[![Gem Version](https://badge.fury.io/rb/simplecov_linter_formatter.svg)](https://badge.fury.io/rb/simplecov_linter_formatter)
+[![CircleCI](https://circleci.com/gh/platanus/simplecov_linter_formatter.svg?style=shield)](https://app.circleci.com/pipelines/github/platanus/simplecov_linter_formatter)
+
+Linter formatter for SimpleCov code coverage tool
+
+<img src="./docs/assets/not-covered.png" witdh="300" />
+<img src="./docs/assets/partial-cov.png" witdh="300" />
+<img src="./docs/assets/covered.png" witdh="300" />
+
+## Installation
+
+- Install [reviewdog](https://github.com/reviewdog/reviewdog)
+
+  ```bash
+  brew install reviewdog/tap/reviewdog
+  ```
+
+- Install [VSCode SimpleCov plugin](https://github.com/anykeyh/simplecov-vscode)
+
+  You need to configure `SimpleCovLinterFormatter.json_filename = '.resultset.json'` to use the extension's default configuration.
+  If you want yo keep the `.resultset.json` file intact you must change the plugin's "Path" option to point another file.
+
+- Add to your Gemfile:
+
+    ```ruby
+    gem 'simplecov'
+    gem 'simplecov_linter_formatter'
+    ```
+
+    ```bash
+    bundle install
+    ```
+
+## Usage
+
+Add the formatter to your `spec/spec_helper.rb`.
+
+```ruby
+require 'simplecov'
+require 'simplecov_linter_formatter'
+
+SimpleCovLinterFormatter.json_filename = '.resultset.json'
+SimpleCovLinterFormatter.scope = :all
+
+SimpleCov.start 'rails' do
+  # ...
+
+  formatter SimpleCov::Formatter::MultiFormatter.new(
+    [
+      SimpleCov::Formatter::LinterFormatter,
+      SimpleCov::Formatter::HTMLFormatter
+    ]
+  )
+end
+```
+
+If you configure `SimpleCovLinterFormatter.scope = :own_changes` instead of `:all` you will see coverage warnings related to your changes only (it uses `git diff`).
+
+## Testing
+
+To run the specs you need to execute, **in the root path of the gem**, the following command:
+
+```bash
+bundle exec guard
+```
+
+You need to put **all your tests** in the `/simplecov_linter_formatter/spec/` directory.
+
+## Publishing
+
+On master/main branch...
+
+1. Change `VERSION` in `lib/simplecov_linter_formatter/version.rb`.
+2. Change `Unreleased` title to current version in `CHANGELOG.md`.
+3. Run `bundle install`.
+4. Commit new release. For example: `Releasing v0.1.0`.
+5. Create tag. For example: `git tag v0.1.0`.
+6. Push tag. For example: `git push origin v0.1.0`.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+Thank you [contributors](https://github.com/platanus/simplecov_linter_formatter/graphs/contributors)!
+
+<img src="http://platan.us/gravatar_with_text.png" alt="Platanus" width="250"/>
+
+SimpleCov Linter Formatter is maintained by [platanus](http://platan.us).
+
+## License
+
+SimpleCov Linter Formatter is © 2021 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simplecov_linter_formatter"
+
+# 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/simplecov_linter_formatter/exporters/json_result_exporter.rb

@@ -0,0 +1,23 @@
+module SimpleCovLinterFormatter
+  class JsonResultExporter
+    def initialize(result_hash)
+      @result = result_hash
+    end
+
+    def export
+      File.open(export_path, 'w') do |file|
+        file << json_result
+      end
+    end
+
+    private
+
+    def json_result
+      JSON.pretty_generate(@result)
+    end
+
+    def export_path
+      File.join(SimpleCov.coverage_path, SimpleCovLinterFormatter.json_filename)
+    end
+  end
+end

data/lib/simplecov_linter_formatter/formatters/result_formatter.rb

@@ -0,0 +1,25 @@
+module SimpleCovLinterFormatter
+  class ResultFormatter
+    def initialize(result)
+      @result = result
+    end
+
+    def format
+      formatted_result = []
+
+      @result.files.each do |source_file|
+        messages = format_source_file(source_file)
+        formatted_result += messages if messages
+      end
+
+      formatted_result
+    end
+
+    private
+
+    def format_source_file(source_file)
+      source_file_formatter = SourceFileFormatter.new(source_file)
+      source_file_formatter.format
+    end
+  end
+end

data/lib/simplecov_linter_formatter/formatters/source_file_formatter.rb

@@ -0,0 +1,34 @@
+module SimpleCovLinterFormatter
+  class SourceFileFormatter
+    FILE_COLUMN = 1
+
+    def initialize(source_file)
+      @source_file = source_file
+    end
+
+    def format
+      lines.map do |line|
+        build_message(line)
+      end
+    end
+
+    private
+
+    def build_message(line)
+      [
+        @source_file.filename,
+        line.line_number,
+        FILE_COLUMN,
+        "#{line.status}-#{lines_count}"
+      ].map(&:to_s).join(":")
+    end
+
+    def lines_count
+      @lines_count ||= lines.count
+    end
+
+    def lines
+      @lines ||= @source_file.lines
+    end
+  end
+end

data/lib/simplecov_linter_formatter/formatters/text_lines_formatter.rb

@@ -0,0 +1,31 @@
+module SimpleCovLinterFormatter
+  class TextLinesFormatter
+    def initialize(command_name, lines)
+      @command_name = command_name
+      @lines = lines
+    end
+
+    def format
+      {
+        @command_name.to_sym => {
+          coverage: group_lines_by_file
+        }
+      }
+    end
+
+    private
+
+    def group_lines_by_file
+      result = {}
+
+      @lines.each do |line|
+        file_name, line_number, _column, status_lines_count = line.split(":")
+        status, lines_count = status_lines_count.split("-")
+        result[file_name] ||= { lines: [nil] * lines_count.to_i }
+        result[file_name][:lines][line_number.to_i - 1] = status.to_sym == :missed ? 0 : nil
+      end
+
+      result
+    end
+  end
+end

data/lib/simplecov_linter_formatter/text_lines_filter.rb

@@ -0,0 +1,28 @@
+module SimpleCovLinterFormatter
+  class TextLinesFilter
+    def initialize(text_lines)
+      @text_lines = text_lines
+    end
+
+    def filter
+      file_content = filter_result
+      format_result(file_content)
+    end
+
+    private
+
+    def filter_result
+      return "" if text_content == ""
+
+      `echo "#{text_content}" | reviewdog -efm="%f:%l:%c:%m" -diff="git diff"`
+    end
+
+    def text_content
+      @text_content ||= @text_lines.join('\n')
+    end
+
+    def format_result(file_content)
+      file_content.to_s.split("\n")
+    end
+  end
+end

data/lib/simplecov_linter_formatter/version.rb

@@ -0,0 +1,3 @@
+module SimpleCovLinterFormatter
+  VERSION = "0.1.0"
+end

data/lib/simplecov_linter_formatter.rb

@@ -0,0 +1,72 @@
+require 'simplecov_linter_formatter/version'
+require 'simplecov_linter_formatter/formatters/result_formatter'
+require 'simplecov_linter_formatter/formatters/source_file_formatter'
+require 'simplecov_linter_formatter/formatters/text_lines_formatter'
+require 'simplecov_linter_formatter/exporters/json_result_exporter'
+require 'simplecov_linter_formatter/text_lines_filter'
+
+module SimpleCovLinterFormatter
+  SCOPES = [:all, :own_changes]
+
+  def self.json_filename=(value)
+    @json_filename = value
+  end
+
+  def self.json_filename
+    @json_filename || 'coverage.linter.json'
+  end
+
+  def self.cover_all?
+    scope == :all
+  end
+
+  def self.scope=(value)
+    if !SCOPES.include?(value)
+      raise "Invalid scope. Must be one of: #{SCOPES.map(&:to_s).join('', '')}"
+    end
+
+    @scope = value
+  end
+
+  def self.scope
+    @scope || :all
+  end
+end
+
+module SimpleCov
+  module Formatter
+    class LinterFormatter
+      def format(simplecov_result)
+        text_lines = get_text_lines(simplecov_result)
+        hash_result = format_text_lines(simplecov_result.command_name, text_lines)
+        export_to_json(hash_result)
+        nil
+      end
+
+      private
+
+      def get_text_lines(simplecov_result)
+        text_lines = format_result(simplecov_result)
+        return text_lines if SimpleCovLinterFormatter.cover_all?
+
+        filter_text_lines(text_lines)
+      end
+
+      def filter_text_lines(text_lines)
+        SimpleCovLinterFormatter::TextLinesFilter.new(text_lines).filter
+      end
+
+      def format_result(simplecov_result)
+        SimpleCovLinterFormatter::ResultFormatter.new(simplecov_result).format
+      end
+
+      def format_text_lines(command_name, text_lines)
+        SimpleCovLinterFormatter::TextLinesFormatter.new(command_name, text_lines).format
+      end
+
+      def export_to_json(hash_result)
+        SimpleCovLinterFormatter::JsonResultExporter.new(hash_result).export
+      end
+    end
+  end
+end

data/simplecov_linter_formatter.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "simplecov_linter_formatter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simplecov_linter_formatter"
+  spec.version       = SimpleCovLinterFormatter::VERSION
+  spec.authors       = ["Platanus", "Leandro Segovia"]
+  spec.email         = ["rubygems@platan.us", "leandro@platan.us"]
+  spec.homepage      = "https://github.com/platanus/simplecov_linter_formatter"
+  spec.summary       = "Linter formatter for SimpleCov"
+  spec.description   = "Linter formatter for SimpleCov code coverage tool"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.2.15"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "rubocop", "~> 1.9"
+  spec.add_development_dependency "rubocop-rails"
+  spec.add_development_dependency "simplecov", "~> 0.21"
+end