simplecov_linter_formatter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 483e6b37b14cb89c8d7d464115018180fa013dd672f8a9f965b5fea0dad83a3f
-  data.tar.gz: 123ef1b96087793991debd9d356c30fffecefff1f081531bbd3679ed90369267
+  metadata.gz: 5f1ca65ad6bdacc453fa5df9593826cf34106da48e60886fd8ff69fccc523cad
+  data.tar.gz: e7b97571b7de89cf5babfde9695d06fcac5b3bb492f2e22036e1c566590b0d3e
 SHA512:
-  metadata.gz: 90fe058c5340e29ddcb0ae7346781fee8b9cdc8464d6d0b5c8cac06d8ce135d9174d1746e1dcbde8ee5bcb99d4782137ada8cdf62a54f641f3dbeea69341fde6
-  data.tar.gz: e605b920212343c9d65cdf0aaf9dc476b70bacf5fd5d6af6e27e11c98aaa7e4a7bcfa1c6d323fc85de0ea9897d31058009f669a6a964f51e7bd0532c1b12cfa0
+  metadata.gz: 2336fa2a71a62a6f60e99b82bbe1721254aa43269cfc362d97712190490d915d982e55a4d1f15914f433c50ff2d1fb823e6cc158d6967da906e976f51d424049
+  data.tar.gz: df7616fa9792a3ac67b84275430f523a8984c2066901c84ead8c5179ce2529010bdb421b6795c58298ef8446544d49889c43b11f02ea3a8cddb774a2d367c384

data/CHANGELOG.md

@@ -2,7 +2,12 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-### Unreleased
+### v0.2.0
+
+#### Added
+
+* Add on screen summary report.
+* Use `git diff` if `reviewdog` is not installed.
 
 ### v0.1.0
 

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    simplecov_linter_formatter (0.1.0)
+    simplecov_linter_formatter (0.2.0)
+      rainbow
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -5,9 +5,21 @@
 
 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" />
+***Note: To learn more about SimpleCov, check out the main repo at [https://github.com/simplecov-ruby/simplecov](https://github.com/colszowka/simplecov)***
+
+This formatter has two features:
+
+1) It generates a json file to feed the [VSCode SimpleCov plugin](https://github.com/anykeyh/simplecov-vscode).
+
+   The plugin uses by default the json file produced by simplecov but, with this gem, we can filter the file to show code coverage related to our changes.
+
+   <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" />
+
+2) It shows a code coverage report on screen.
+
+   <img src="./docs/assets/report-example.png" witdh="300" />
 
 ## Installation
 
@@ -17,6 +29,8 @@ Linter formatter for SimpleCov code coverage tool
   brew install reviewdog/tap/reviewdog
   ```
 
+  > You can avoid this step and `git status` will be used to filter results instead.
+
 - 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.
@@ -41,8 +55,10 @@ Add the formatter to your `spec/spec_helper.rb`.
 require 'simplecov'
 require 'simplecov_linter_formatter'
 
-SimpleCovLinterFormatter.json_filename = '.resultset.json'
-SimpleCovLinterFormatter.scope = :all
+SimpleCovLinterFormatter.setup do |config|
+  config.json_filename = '.resultset.json'
+  config.scope = :all
+end
 
 SimpleCov.start 'rails' do
   # ...
@@ -58,6 +74,41 @@ 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`).
 
+### Summary Report
+
+- Turn on the on screen report with option: `SimpleCovLinterFormatter.summary_enabled = true`
+- Scope variation will affect the report:
+  - `SimpleCovLinterFormatter.scope = :all`
+
+    <img src="./docs/assets/all-summary.png" witdh="300" />
+
+  - `SimpleCovLinterFormatter.scope = :own_changes`
+
+    <img src="./docs/assets/own-changes-summary.png" witdh="300" />
+
+- Sort by `:alphabet` or, the default, `:coverage` option with `SimpleCovLinterFormatter.summary_files_sorting = :alphabet`
+
+  <img src="./docs/assets/sorted-summary.png" witdh="300" />
+
+- Change the look of the report:
+  - Turn off the background with `SimpleCovLinterFormatter.summary_enabled_bg = false`
+
+    <img src="./docs/assets/no-bg-summary.png" witdh="300" />
+
+  - Change colors:
+
+    ```ruby
+    SimpleCovLinterFormatter.setup do |config|
+      config.summary_enabled_bg = true # you need enabled background
+      config.summary_covered_bg_color = :lightblue
+      config.summary_not_covered_bg_color = :pink
+      config.summary_text_color = :black
+    end
+    ```
+
+    <img src="./docs/assets/colors-summary.png" witdh="300" />
+
+
 ## Testing
 
 To run the specs you need to execute, **in the root path of the gem**, the following command:

data/lib/simplecov_linter_formatter/file_line.rb

@@ -0,0 +1,63 @@
+module SimpleCovLinterFormatter
+  class FileLine
+    attr_reader :file_name
+
+    def initialize(line)
+      @line = line
+      assign_attributes
+    end
+
+    def status
+      @status.to_sym
+    end
+
+    def line_number
+      @line_number.to_i
+    end
+
+    def line_number_idx
+      line_number - 1
+    end
+
+    def column
+      @column.to_i
+    end
+
+    def lines_count
+      @lines_count.to_i
+    end
+
+    def percentage
+      @percentage.to_f
+    end
+
+    def file_short_name
+      @file_short_name ||= file_name.gsub(project_path, "")
+    end
+
+    def file_int_percentage
+      @file_int_percentage ||= percentage.to_i
+    end
+
+    private
+
+    def project_path
+      root_path = ""
+      return root_path unless Object.const_defined?('Rails')
+      return root_path unless Rails.respond_to?(:root)
+
+      Rails.root.to_s
+    rescue NameError
+      ""
+    end
+
+    def assign_attributes
+      @file_name, @line_number, @column, status_lines_count = @line.split(
+        SimpleCovLinterFormatter::LINE_SECTIONS_DIVIDER
+      )
+      @status, @lines_count, @percentage = status_lines_count.split(
+        SimpleCovLinterFormatter::MSG_DIVIDER
+      )
+    end
+  end
+end

data/lib/simplecov_linter_formatter/formatters/source_file_formatter.rb

@@ -8,19 +8,31 @@ module SimpleCovLinterFormatter
 
     def format
       lines.map do |line|
-        build_message(line)
+        build_line_text(line)
       end
     end
 
     private
 
-    def build_message(line)
+    def build_line_text(line)
       [
         @source_file.filename,
         line.line_number,
         FILE_COLUMN,
-        "#{line.status}-#{lines_count}"
-      ].map(&:to_s).join(":")
+        build_line_msg(line)
+      ].map(&:to_s).join(SimpleCovLinterFormatter::LINE_SECTIONS_DIVIDER)
+    end
+
+    def build_line_msg(line)
+      [
+        line.status,
+        lines_count,
+        stats.percent
+      ].map(&:to_s).join(SimpleCovLinterFormatter::MSG_DIVIDER)
+    end
+
+    def stats
+      @stats ||= @source_file.coverage_statistics[:line]
     end
 
     def lines_count

data/lib/simplecov_linter_formatter/formatters/text_lines_formatter.rb

@@ -19,10 +19,9 @@ module SimpleCovLinterFormatter
       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
+        file = SimpleCovLinterFormatter::FileLine.new(line)
+        result[file.file_name] ||= { lines: [nil] * file.lines_count }
+        result[file.file_name][:lines][file.line_number_idx] = file.status == :missed ? 0 : nil
       end
 
       result

data/lib/simplecov_linter_formatter/summary_builder.rb

@@ -0,0 +1,127 @@
+module SimpleCovLinterFormatter
+  class SummaryBuilder
+    PERCENT_TEXT_SIZE = 3
+
+    def initialize(lines)
+      @lines = lines
+      @largest_file_name = 0
+      @largest_percentage = 0
+    end
+
+    def build
+      body = build_body
+      return body if body == ""
+
+      "#{build_title}\n#{body}#{divider}"
+    end
+
+    private
+
+    def build_title
+      "SimpleCov Report - #{build_coverage_title}:\n#{divider}"
+    end
+
+    def divider
+      '-' * report_width
+    end
+
+    def report_width
+      @largest_file_name + @largest_percentage + PERCENT_TEXT_SIZE
+    end
+
+    def build_coverage_title
+      if SimpleCovLinterFormatter.cover_all?
+        return "Total Coverage"
+      end
+
+      "Own Changes"
+    end
+
+    def build_body
+      result = ""
+
+      files.each do |file|
+        result += "#{build_line_output(file)}\n"
+      end
+
+      result
+    end
+
+    def files
+      unique_files = []
+      added_files = {}
+
+      @lines.each do |line|
+        file = SimpleCovLinterFormatter::FileLine.new(line)
+        next if added_files[file.file_short_name]
+
+        unique_files << file
+        added_files[file.file_short_name] = true
+        file_size = file.file_short_name.size
+        file_percentage = file.file_int_percentage.to_s.size
+        @largest_file_name = file_size if file_size > @largest_file_name
+        @largest_percentage = file_percentage if file_percentage > @largest_percentage
+      end
+
+      sort_files(unique_files)
+    end
+
+    def sort_files(files)
+      sorting_strategy = if SimpleCovLinterFormatter.summary_coverage_sorting?
+                           Proc.new { |file| [file.percentage, file.file_short_name] }
+                         else
+                           Proc.new { |file| file.file_short_name }
+                         end
+      files.sort_by { |file| sorting_strategy.call(file) }
+    end
+
+    def build_line_output(file)
+      file_name = adjusted_file_name(file)
+      covered_size = @largest_file_name * file.percentage / 100.0
+      covered_text = colorize_text(
+        covered_size.zero? ? "" : file_name[0..(covered_size - 1)],
+        :summary_covered_bg_color
+      )
+      not_covered_text = colorize_text(
+        file_name[covered_size..-1],
+        :summary_not_covered_bg_color
+      )
+      "#{build_percentage_output(file)} #{covered_text}#{not_covered_text}"
+    end
+
+    def colorize_text(text, bg_option)
+      text = Rainbow(text).color(SimpleCovLinterFormatter.summary_text_color)
+      return text unless SimpleCovLinterFormatter.summary_enabled_bg
+
+      text.bg(SimpleCovLinterFormatter.send(bg_option))
+    end
+
+    def build_percentage_output(file)
+      percentage_size = file.file_int_percentage.to_s.size
+      diff = @largest_percentage - percentage_size
+      Rainbow("#{' ' * diff}#{file.file_int_percentage} %").send(
+        get_percetage_color(file.file_int_percentage)
+      )
+    end
+
+    def get_percetage_color(percentage)
+      case percentage
+      when 100
+        :green
+      when 0
+        :red
+      else
+        :yellow
+      end
+    end
+
+    def adjusted_file_name(file)
+      diff = @largest_file_name - file.file_short_name.size
+      file.file_short_name + (" " * diff)
+    end
+
+    def covered_size(file)
+      @largest_file_name * file.percentage / 100.0
+    end
+  end
+end

data/lib/simplecov_linter_formatter/text_lines_filter.rb

@@ -5,24 +5,51 @@ module SimpleCovLinterFormatter
     end
 
     def filter
-      file_content = filter_result
-      format_result(file_content)
+      return [] if text_content == ""
+      return filter_with_reviewdog if reviewdog?
+
+      filter_with_git_status
     end
 
     private
 
-    def filter_result
-      return "" if text_content == ""
+    def reviewdog?
+      silence_stream($stdout) { !!system("reviewdog --version") }
+    end
+
+    def filter_with_reviewdog
+      `echo "#{text_content}" | reviewdog -efm="#{efm_param}" -diff="git diff"`.to_s.split("\n")
+    end
+
+    def efm_param
+      %w{%f %l %c %m}.join(SimpleCovLinterFormatter::LINE_SECTIONS_DIVIDER)
+    end
+
+    def filter_with_git_status
+      status_files = status_to_lines(`git status --porcelain`)
+      regexp = /#{status_files.join('|')}/
+      @text_lines.grep(regexp)
+    end
 
-      `echo "#{text_content}" | reviewdog -efm="%f:%l:%c:%m" -diff="git diff"`
+    def status_to_lines(status)
+      status.split("\n").map do |change|
+        file = change.split(" ").last
+        file.end_with?("/") ? nil : file
+      end.compact
     end
 
     def text_content
-      @text_content ||= @text_lines.join('\n')
+      @text_content ||= @text_lines.join("\n")
     end
 
-    def format_result(file_content)
-      file_content.to_s.split("\n")
+    def silence_stream(stream)
+      old_stream = stream.dup
+      stream.reopen(File::NULL)
+      stream.sync = true
+      yield
+    ensure
+      stream.reopen(old_stream)
+      old_stream.close
     end
   end
 end

data/lib/simplecov_linter_formatter/version.rb

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

data/lib/simplecov_linter_formatter.rb

@@ -1,35 +1,89 @@
+require 'rainbow'
+
 require 'simplecov_linter_formatter/version'
+require 'simplecov_linter_formatter/file_line'
 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'
+require 'simplecov_linter_formatter/summary_builder'
 
 module SimpleCovLinterFormatter
+  extend self
+
   SCOPES = [:all, :own_changes]
+  SORTING_MODES = [:coverage, :alphabet]
+  MSG_DIVIDER = "-"
+  LINE_SECTIONS_DIVIDER = ":"
 
-  def self.json_filename=(value)
-    @json_filename = value
-  end
+  attr_writer(
+    :json_filename,
+    :summary_covered_bg_color,
+    :summary_not_covered_bg_color,
+    :summary_text_color,
+    :summary_enabled_bg,
+    :summary_enabled
+  )
 
-  def self.json_filename
+  def json_filename
     @json_filename || 'coverage.linter.json'
   end
 
-  def self.cover_all?
+  def scope=(value)
+    if !SCOPES.include?(value.to_sym)
+      raise "Invalid scope. Must be one of: #{SCOPES.map(&:to_s).join(', ')}"
+    end
+
+    @scope = value
+  end
+
+  def scope
+    (@scope || :all).to_sym
+  end
+
+  def 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('', '')}"
+  def summary_enabled
+    !!@summary_enabled
+  end
+
+  def summary_files_sorting=(value)
+    if !SORTING_MODES.include?(value.to_sym)
+      raise "Invalid summary_files_sorting. Must be one of: #{SORTING_MODES.map(&:to_s).join(', ')}"
     end
 
-    @scope = value
+    @summary_files_sorting = value
+  end
+
+  def summary_files_sorting
+    (@summary_files_sorting || :coverage).to_sym
+  end
+
+  def summary_coverage_sorting?
+    summary_files_sorting == :coverage
+  end
+
+  def summary_enabled_bg
+    !!@summary_enabled_bg
+  end
+
+  def summary_covered_bg_color
+    (@summary_covered_bg_color || :darkgreen).to_sym
   end
 
-  def self.scope
-    @scope || :all
+  def summary_not_covered_bg_color
+    (@summary_not_covered_bg_color || :firebrick).to_sym
+  end
+
+  def summary_text_color
+    (@summary_text_color || :white).to_sym
+  end
+
+  def setup
+    yield self
   end
 end
 
@@ -38,6 +92,7 @@ module SimpleCov
     class LinterFormatter
       def format(simplecov_result)
         text_lines = get_text_lines(simplecov_result)
+        show_coverage_summary(text_lines)
         hash_result = format_text_lines(simplecov_result.command_name, text_lines)
         export_to_json(hash_result)
         nil
@@ -52,6 +107,12 @@ module SimpleCov
         filter_text_lines(text_lines)
       end
 
+      def show_coverage_summary(text_lines)
+        return unless SimpleCovLinterFormatter.summary_enabled
+
+        puts(SimpleCovLinterFormatter::SummaryBuilder.new(text_lines).build)
+      end
+
       def filter_text_lines(text_lines)
         SimpleCovLinterFormatter::TextLinesFilter.new(text_lines).filter
       end

data/simplecov_linter_formatter.gemspec

@@ -17,6 +17,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "rainbow"
+
   spec.add_development_dependency "bundler", "~> 2.2.15"
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "pry"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simplecov_linter_formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Platanus
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2021-10-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -162,14 +176,22 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docs/assets/all-summary.png
+- docs/assets/colors-summary.png
 - docs/assets/covered.png
+- docs/assets/no-bg-summary.png
 - docs/assets/not-covered.png
+- docs/assets/own-changes-summary.png
 - docs/assets/partial-cov.png
+- docs/assets/report-example.png
+- docs/assets/sorted-summary.png
 - lib/simplecov_linter_formatter.rb
 - lib/simplecov_linter_formatter/exporters/json_result_exporter.rb
+- lib/simplecov_linter_formatter/file_line.rb
 - lib/simplecov_linter_formatter/formatters/result_formatter.rb
 - lib/simplecov_linter_formatter/formatters/source_file_formatter.rb
 - lib/simplecov_linter_formatter/formatters/text_lines_formatter.rb
+- lib/simplecov_linter_formatter/summary_builder.rb
 - lib/simplecov_linter_formatter/text_lines_filter.rb
 - lib/simplecov_linter_formatter/version.rb
 - simplecov_linter_formatter.gemspec