simple_cov-formatter-terminal 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 955970eab8c1321b2666ee16641ee768fa9c403c05f388091fc093fb0755d7c0
-  data.tar.gz: 5484b17a524a65b0bdf996aa72169add91c2a1a59f193ab7ca09f6be4a272fd5
+  metadata.gz: afe58af417f8a70624c3a6deefa824a6e38f9135ac4fb25d39c02d88d08f5171
+  data.tar.gz: 6b518978a552895d25af3bc9a5c571147a609bb7709efcace7043fccb9a317af
 SHA512:
-  metadata.gz: aed8c163266de2a1decc875607aa7ba00aea4d81b309ec49b655b157d7fcb60f744264cdd6ffdf4801e1439f790c277f960e4aa8d0808701c1c76512512c4f6f
-  data.tar.gz: 900a825a976d73ba68ce91d16ec72cbdbcf3343acd4de5cfe8cf018f23534118bc05df31a9492fedb9580382ef9a22e8275c32ffc5618cf9a1b7a6fefab51eeb
+  metadata.gz: 8fe5ff1652801cdd2d012a53374aa5e30c4b10a475edbcd9d606eacfe62a1aab75a77f45a83e7c04bcf06301e2a933737864aee8c11b63ce1622b3faa1f2bca2
+  data.tar.gz: e75de61327497b94697d31472da4d2c01bb248785a8082cac0ea61987b660ce4c98dd3592b0fb8449c0f69f85ef8c428503496e560abf9698ab4e80d0305c536

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.3.0 (2023-11-19)
+
+- Print only uncovered lines by default
+
 ## v0.2.4 (2023-05-30)
 ### Fixed
 - Removed dangling memoist requires

data/Gemfile.lock

@@ -1,50 +1,63 @@
 PATH
   remote: .
   specs:
-    simple_cov-formatter-terminal (0.2.4)
+    simple_cov-formatter-terminal (0.3.0)
       activesupport (>= 7.0.4, < 8)
       memo_wise (>= 1.7.0, < 2)
       rouge (>= 4.0.0, < 5)
       rspec-core (>= 3.11.0, < 4)
+      runger_config (>= 3.0.0)
       simplecov (>= 0.21.2, < 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.5)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
     ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.4)
     byebug (11.1.3)
     climate_control (1.2.0)
     coderay (1.1.3)
-    colorize (0.8.1)
     concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     diff-lcs (1.5.0)
     docile (1.4.0)
-    i18n (1.13.0)
+    drb (2.2.0)
+      ruby2_keywords
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
-    memo_wise (1.7.0)
-    memoist (0.16.2)
+    language_server-protocol (3.17.0.3)
+    memo_wise (1.8.0)
     method_source (1.0.0)
-    minitest (5.18.0)
+    minitest (5.20.0)
+    mutex_m (0.2.0)
     parallel (1.23.0)
-    parser (3.2.2.1)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
+      racc
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.0)
-    rexml (3.2.5)
-    rouge (4.1.1)
+    rake (13.1.0)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rouge (4.2.0)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -54,40 +67,44 @@ GEM
     rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.51.0)
+    rspec-support (3.12.1)
+    rubocop (1.57.2)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.4)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.1)
+    rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.18.0)
+    rubocop-capybara (2.19.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.22.0)
+    rubocop-factory_bot (2.24.0)
       rubocop (~> 1.33)
-    rubocop-performance (1.18.0)
+    rubocop-performance (1.19.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.22.0)
-      rubocop (~> 1.33)
+    rubocop-rspec (2.25.0)
+      rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
-    runger_release_assistant (0.4.0)
+    ruby2_keywords (0.0.5)
+    runger_config (3.0.1)
+      activesupport (>= 7.1.2)
+    runger_release_assistant (0.5.0)
       activesupport (>= 6, < 8)
-      colorize (~> 0.8)
-      memoist (~> 0.16)
+      memo_wise (>= 1.7, < 2)
+      rainbow (>= 3.0, < 4)
       slop (~> 4.8)
-    runger_style (0.3.0)
+    runger_style (0.5.1)
       rubocop (>= 1.38.0, < 2)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -101,7 +118,7 @@ GEM
     slop (4.10.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -37,6 +37,16 @@ SimpleCov.start
 spec file (e.g. `bin/rspec spec/models/user_spec.rb`) and not when multiple specs are executed (e.g.
 when simply running `bin/rspec` without any argument).
 
+## Which lines to print
+
+By default, only uncovered lines will be printed.
+
+If you would like to print all lines, add this to your `spec_helper.rb` file:
+
+```rb
+SimpleCov::Formatter::Terminal.config.lines_to_print = :all
+```
+
 ### Modifying the `spec_to_app_file_map`
 
 `SimpleCov::Formatter::Terminal` has a default hash that is used to map spec files to their

data/lib/simple_cov/formatter/terminal/branch_coverage.rb

@@ -25,4 +25,12 @@ module SimpleCov::Formatter::Terminal::BranchCoverage
       join(', ').
       presence
   end
+
+  memo_wise \
+  def line_numbers_with_missing_branches(sourcefile)
+    uncovered_branches(sourcefile).
+      map(&:start_line).
+      uniq.
+      sort
+  end
 end

data/lib/simple_cov/formatter/terminal/config.rb

@@ -1,21 +1,25 @@
 # frozen_string_literal: true
 
-require_relative './spec_to_app_mapping'
+require_relative 'spec_to_app_mapping'
 require 'memo_wise'
 
-class SimpleCov::Formatter::Terminal::Config
+class SimpleCov::Formatter::Terminal::Config < Anyway::Config
   prepend MemoWise
   include SimpleCov::Formatter::Terminal::SpecToAppMapping
 
-  attr_accessor :spec_to_app_file_map, :unmappable_spec_regexes
-
-  def initialize
-    @spec_to_app_file_map =
-      SimpleCov::Formatter::Terminal::SpecToAppMapping.default_spec_to_app_map
-    @unmappable_spec_regexes =
-      SimpleCov::Formatter::Terminal::SpecToAppMapping::DEFAULT_UNMAPPABLE_SPEC_REGEXES
+  module LinesToPrint
+    ALL = :all
+    UNCOVERED = :uncovered
   end
 
+  attr_config(
+    lines_to_print: LinesToPrint::UNCOVERED,
+    spec_to_app_file_map:
+      SimpleCov::Formatter::Terminal::SpecToAppMapping.default_spec_to_app_map,
+    unmappable_spec_regexes:
+      SimpleCov::Formatter::Terminal::SpecToAppMapping::DEFAULT_UNMAPPABLE_SPEC_REGEXES,
+  )
+
   memo_wise \
   def write_target_info_file?
     ENV.fetch('SIMPLECOV_WRITE_TARGET_TO_FILE', nil) == '1'

data/lib/simple_cov/formatter/terminal/line_printer.rb

@@ -7,7 +7,7 @@ class SimpleCov::Formatter::Terminal::LinePrinter
   include SimpleCov::Formatter::Terminal::BranchCoverage
   include SimpleCov::Formatter::Terminal::ColorPrinting
 
-  def initialize(targeted_application_file)
+  def initialize(targeted_application_file = nil)
     @targeted_application_file = targeted_application_file
   end
 
@@ -30,18 +30,27 @@ class SimpleCov::Formatter::Terminal::LinePrinter
   end
 
   # rubocop:disable Style/StringConcatenation
-  def numbered_line_output(line_number, color, source_code, missed_branch_info = nil)
+  def numbered_line_output(line_number, color, source_code = '', missed_branch_info = nil)
     colored_space =
       case color
       when :red_on_yellow, :white_on_red then color(' ', color)
       else color(' ', :white_on_green)
       end
 
-    line_number_string =
+    line_number_width =
       if SimpleCov::Formatter::Terminal.config.write_target_info_file?
-        ":::#{line_number}".rjust(6, ' ')
+        6
+      else
+        3
+      end
+
+    line_number_string =
+      if line_number.blank?
+        ' ' * line_number_width
+      elsif SimpleCov::Formatter::Terminal.config.write_target_info_file?
+        ":::#{line_number}".rjust(line_number_width, ' ')
       else
-        line_number.to_s.rjust(3, ' ')
+        line_number.to_s.rjust(line_number_width, ' ')
       end
 
     output =

data/lib/simple_cov/formatter/terminal/result_printer.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative './branch_coverage'
-require_relative './color_printing'
-require_relative './line_printer'
-require_relative './target_file_writer'
+require_relative 'branch_coverage'
+require_relative 'color_printing'
+require_relative 'line_printer'
+require_relative 'target_file_writer'
 
 class SimpleCov::Formatter::Terminal::ResultPrinter
   extend Forwardable
@@ -48,14 +48,32 @@ class SimpleCov::Formatter::Terminal::ResultPrinter
   end
 
   def print_coverage_details(sourcefile)
+    @sourcefile = sourcefile
+
     if SimpleCov::Formatter::Terminal.config.write_target_info_file?
       target_file_writer.write_target_info_file
     end
 
     puts("---- Coverage for #{targeted_application_file} ".ljust(80, '-').rstrip)
+
+    skipped_lines = []
     sourcefile.lines.each do |line|
-      puts(line_printer.colored_line(line, sourcefile))
+      if print_line?(line.line_number)
+        if skipped_lines.any?
+          print_skipped_lines(skipped_lines)
+        end
+
+        puts(line_printer.colored_line(line, sourcefile))
+        skipped_lines = []
+      else
+        skipped_lines << line.line_number
+      end
+    end
+
+    if skipped_lines.any?
+      print_skipped_lines(skipped_lines)
     end
+
     puts(<<~LOG.squish)
       ----
       Line coverage: #{colorized_coverage(sourcefile.covered_percent)}
@@ -65,6 +83,20 @@ class SimpleCov::Formatter::Terminal::ResultPrinter
     LOG
   end
 
+  def print_skipped_lines(skipped_lines)
+    divider = ' -' * 40
+
+    puts(line_printer.numbered_line_output(nil, :white, divider))
+    puts(
+      line_printer.numbered_line_output(
+        nil,
+        :white,
+        "#{skipped_lines.size} covered line(s) omitted".center(80, ' '),
+      ),
+    )
+    puts(line_printer.numbered_line_output(nil, :white, divider))
+  end
+
   def print_no_coverage_info_found
     puts(<<~LOG.squish)
       No code coverage info was found for "#{targeted_application_file}". Try stopping and
@@ -120,6 +152,52 @@ class SimpleCov::Formatter::Terminal::ResultPrinter
     end
   end
 
+  def print_line?(line_number)
+    line_numbers_to_print.include?(line_number)
+  end
+
+  def sourcefile
+    @sourcefile ||= @result.files.find { _1.filename.end_with?(targeted_application_file) }
+  end
+
+  # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+  memo_wise \
+  def line_numbers_to_print
+    max_line_number = sourcefile.lines.map(&:line_number).max
+
+    begin
+      case SimpleCov::Formatter::Terminal.config.lines_to_print.to_sym
+      in SimpleCov::Formatter::Terminal::Config::LinesToPrint::ALL
+        (1..max_line_number).to_a
+      in SimpleCov::Formatter::Terminal::Config::LinesToPrint::UNCOVERED
+        line_numbers_to_print = []
+
+        sourcefile.lines.each do |line|
+          if (
+            line.coverage.nil? || (
+              (line.coverage > 0) &&
+                !line_numbers_with_missing_branches(sourcefile).include?(line.line_number)
+            )
+          )
+            next
+          end
+
+          line_number = line.line_number
+          contextualized_line_numbers =
+            ((line_number - 2)..(line_number + 2)).
+              to_a.
+              select do |context_line_number|
+                context_line_number.positive? && context_line_number <= max_line_number
+              end
+          line_numbers_to_print += contextualized_line_numbers
+        end
+
+        line_numbers_to_print
+      end
+    end.to_set
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
   memo_wise \
   def line_printer
     SimpleCov::Formatter::Terminal::LinePrinter.new(targeted_application_file)

data/lib/simple_cov/formatter/terminal/spec_to_app_mapping.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './rails_awareness'
+require_relative 'rails_awareness'
 
 module SimpleCov::Formatter::Terminal::SpecToAppMapping
   # rubocop:disable Lint/OrAssignmentToConstant

data/lib/simple_cov/formatter/terminal/version.rb

@@ -5,6 +5,6 @@ module SimpleCov::Formatter; end
 
 # rubocop:disable Style/StaticClass
 class SimpleCov::Formatter::Terminal
-  VERSION = '0.2.4'
+  VERSION = '0.3.0'
 end
 # rubocop:enable Style/StaticClass

data/lib/simple_cov/formatter/terminal.rb

@@ -2,18 +2,20 @@
 
 class SimpleCov::Formatter::Terminal ; end # rubocop:disable Lint/EmptyClass
 
-require_relative 'terminal/config'
-require_relative 'terminal/file_determiner'
-require_relative 'terminal/r_spec_integration'
-require_relative 'terminal/result_printer'
-require_relative 'terminal/version'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/string/filters'
+require 'anyway_config'
 require 'memo_wise'
 require 'rouge'
 require 'rspec/core'
 require 'simplecov'
 
+require_relative 'terminal/config'
+require_relative 'terminal/file_determiner'
+require_relative 'terminal/r_spec_integration'
+require_relative 'terminal/result_printer'
+require_relative 'terminal/version'
+
 class SimpleCov::Formatter::Terminal
   extend Forwardable
   prepend MemoWise

data/simple_cov-formatter-terminal.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency('memo_wise', '>= 1.7.0', '< 2')
   spec.add_dependency('rouge', '>= 4.0.0', '< 5')
   spec.add_dependency('rspec-core', '>= 3.11.0', '< 4')
+  spec.add_dependency('runger_config', '>= 3.0.0')
   spec.add_dependency('simplecov', '>= 0.21.2', '< 1')
 
   # For more information and examples about making a new gem, check out our

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_cov-formatter-terminal
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - David Runger
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-30 00:00:00.000000000 Z
+date: 2023-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -90,6 +90,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: runger_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -162,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Print detailed code coverage info to the terminal