simple_cov-formatter-terminal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0037c0f75039602b73a5c02b56091392b253bbd14d297f44fe6a0a1463dfa844
+  data.tar.gz: a91aee34a3560e838481318fc56680682b01a3a635ca7f18ae0d83049aeea298
+SHA512:
+  metadata.gz: 5bc1c96efcf14e290abdeca72bf850a4762239f8a01760c7db162c7cfb2418093e42c34c2fd4482379a3565b1eec292254b097e5a63a9def8dbf431703e9933b
+  data.tar.gz: cc5c94164de7385f4bb770017b657d548aff92e516fbc9fc580b192f2e387b190997118cc11a89460e925a7d6cbc318f165f2fa3df3a3957fd020130d6738427

data/.release_assistant.yml

@@ -0,0 +1,3 @@
+---
+git: true
+rubygems: true

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_gem:
+  runger_style:
+    - rulesets/default.yml # gem 'rubocop'
+    - rulesets/performance.yml # gem 'rubocop-performance'
+    - rulesets/rspec.yml # gem 'rubocop-rspec'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-10-07
+
+- Initial release

data/Gemfile

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+ruby '3.2.0'
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fcom.gemspec
+gemspec
+
+group :development, :test do
+  gem 'bundler', require: false
+  gem 'pry', require: false
+  gem 'pry-byebug', require: false
+  gem 'rubocop', require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rspec', require: false
+  gem 'runger_style', github: 'davidrunger/runger_style', require: false
+end
+
+group :test do
+  gem 'climate_control', require: false
+  gem 'codecov', require: false
+  gem 'rspec', require: false
+  gem 'simplecov', require: false
+end
+
+group :development do
+  gem 'rake', require: false
+  gem 'release_assistant', require: false, git: 'https://github.com/davidrunger/release_assistant'
+end

data/Gemfile.lock

@@ -0,0 +1,131 @@
+GIT
+  remote: https://github.com/davidrunger/release_assistant
+  revision: 4a6db008f26327bbee9758ddd2bad070b14d2e88
+  specs:
+    release_assistant (0.3.3.alpha)
+      activesupport (>= 6, < 8)
+      colorize (~> 0.8)
+      memoist (~> 0.16)
+      slop (~> 4.8)
+
+GIT
+  remote: https://github.com/davidrunger/runger_style
+  revision: 4a68671e36d5734cb50331f904fb5a1a7ab9b429
+  specs:
+    runger_style (0.2.22.alpha)
+      rubocop (>= 1.38.0, < 2)
+
+PATH
+  remote: .
+  specs:
+    simple_cov-formatter-terminal (0.1.0)
+      activesupport (>= 7.0.4, < 8)
+      memoist (>= 0.16.2, < 1)
+      rouge (>= 4.0.0, < 5)
+      rspec-core (>= 3.11.0, < 4)
+      simplecov (>= 0.21.2, < 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    climate_control (1.2.0)
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
+    coderay (1.1.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    memoist (0.16.2)
+    method_source (1.0.0)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rouge (4.0.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    rubocop (1.42.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.13.2)
+      rubocop (~> 1.33)
+    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.4)
+    slop (4.9.3)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  climate_control
+  codecov
+  pry
+  pry-byebug
+  rake
+  release_assistant!
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  runger_style!
+  simple_cov-formatter-terminal!
+  simplecov
+
+RUBY VERSION
+   ruby 3.2.0p0
+
+BUNDLED WITH
+   2.3.23

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 David Runger
+
+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,123 @@
+# SimpleCov::Formatter::Terminal
+
+![image](https://user-images.githubusercontent.com/8197963/195740768-e2cbb99d-7cf2-42bf-a178-2f78eb653dd3.png)
+
+## Installation
+
+*Note:* This gem depends upon RSpec. If you aren't using RSpec to run your tests, it won't work!
+
+Add the gem to your application's `Gemfile`. Because the gem is not released via RubyGems, you will
+need to install it from GitHub.
+
+```rb
+group :test do
+  gem 'simple_cov-formatter-terminal', github: 'davidrunger/simple_cov-formatter-terminal'
+end
+```
+
+Then execute:
+
+```
+$ bundle install
+```
+
+## Usage
+
+Add something like the following to your `spec/spec_helper.rb` file:
+
+```rb
+require 'simplecov'
+if RSpec.configuration.files_to_run.one?
+  require 'simple_cov/formatter/terminal'
+  SimpleCov.formatter = SimpleCov::Formatter::Terminal
+end
+SimpleCov.start
+```
+
+**Note** that this setup only uses `SimpleCov::Formatter::Terminal` when specs are run with a single
+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).
+
+### Modifying the `spec_to_app_file_map`
+
+`SimpleCov::Formatter::Terminal` has a default hash that is used to map spec files to their
+corresponding application file.
+
+For gems (determined from whether there is a `.gemspec` file at the top level of the project), the
+default mapping is very simple:
+
+```rb
+SimpleCov::Formatter::Terminal.config.spec_to_app_file_map = {
+  %r{\Aspec/} => 'lib/',
+}
+```
+
+This is the default used for non-gems; it is optimized for Rails applications using Active Admin:
+
+```rb
+SimpleCov::Formatter::Terminal.config.spec_to_app_file_map = {
+  %r{\Aspec/lib/} => 'lib/',
+  %r{\Aspec/controllers/admin/(.*)_controller_spec.rb} => 'app/admin/\1.rb',
+  %r{
+    \Aspec/
+    (
+    actions|
+    channels|
+    controllers|
+    decorators|
+    helpers|
+    mailboxes|
+    mailers|
+    models|
+    policies|
+    serializers|
+    views|
+    workers
+    )
+    /
+  }x => 'app/\1/',
+}
+```
+
+If needed for your application, you can add to this hash in your `spec/spec_helper.rb`, e.g.:
+
+```rb
+SimpleCov::Formatter::Terminal.config.spec_to_app_file_map.merge!(
+  %r{\Aspec/my_special/directory_structure/} => 'my_special/app_directory/',
+)
+```
+
+Or you can override the default mapping completely:
+
+```rb
+SimpleCov::Formatter::Terminal.config.spec_to_app_file_map = {
+  %r{\Aspec/my_special/directory_structure/} => 'my_special/app_directory/',
+}
+```
+
+## Branch coverage
+
+If you enable branch coverage for SimpleCov (via `enable_coverage(:branch)` within your
+`SimpleCov.start` block; read more [here][simple-cov-branch-coverage]), then branch coverage info
+will be included in SimpleCov::Formatter::Terminal's output. Missed branches will be indicated with
+white text on a red background at the end of the line, and the line number will be printed in red
+text on a yellow background, as seen in the screenshot at the top of this README (where a `then`
+branch is not covered on line 18).
+
+[simple-cov-branch-coverage]: https://github.com/simplecov-ruby/simplecov#branch-coverage-ruby--25
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rspec` to run
+the tests. You can also run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/davidrunger/simple_cov-formatter-terminal.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

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/simple_cov/formatter/terminal/branch_coverage.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'memoist'
+
+module SimpleCov::Formatter::Terminal::BranchCoverage
+  extend Memoist
+
+  private
+
+  memoize \
+  def uncovered_branches(sourcefile)
+    sourcefile.branches.
+      reject(&:covered?).
+      reject do |branch|
+        line = sourcefile.lines[branch.start_line - 1]
+        source_code = line.src
+        line.coverage == 0 || source_code.match?(/# :nocov-(#{branch.type}):/)
+      end
+  end
+
+  def missed_branch_info(line, sourcefile)
+    uncovered_branches(sourcefile).
+      select { _1.start_line == line.line_number }.
+      map { _1.type.to_s }.
+      join(', ').
+      presence
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SimpleCov::Formatter::Terminal::ColorPrinting
+  # rubocop:disable Metrics/CyclomaticComplexity
+  def color(message, color)
+    case color
+    when :white then "\e[0;37;49m#{message}\e[0m"
+    when :red then "\e[0;31m#{message}\e[0m"
+    when :green then "\e[1;32;49m#{message}\e[0m"
+    when :yellow then "\e[0;33m#{message}\e[0m"
+    when :white_on_green then "\e[1;39;102m#{message}\e[0m"
+    when :red_on_yellow then "\e[0;31;103m#{message}\e[0m"
+    when :white_on_red then "\e[1;37;41m#{message}\e[0m"
+    else raise("Unknown color format '#{color}'.")
+    end
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative './spec_to_app_mapping'
+require 'memoist'
+
+class SimpleCov::Formatter::Terminal::Config
+  extend Memoist
+  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
+  end
+
+  memoize \
+  def write_target_info_file?
+    ENV.fetch('SIMPLECOV_WRITE_TARGET_TO_FILE', nil) == '1'
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'memoist'
+
+class SimpleCov::Formatter::Terminal::FileDeterminer
+  extend Memoist
+
+  memoize \
+  def executed_spec_file
+    if executed_spec_files.size == 1
+      executed_spec_files.first
+    else
+      raise(<<~ERROR)
+        Multiple spec files were executed (#{executed_spec_files}), but
+        SimpleCov::Formatter::Terminal only works when a single spec file is executed.
+      ERROR
+    end
+  end
+
+  memoize \
+  def targeted_application_file
+    env_variable_file = ENV.fetch('SIMPLECOV_TARGET_FILE', nil)
+    if !env_variable_file.nil?
+      puts('Determined targeted application file from SIMPLECOV_TARGET_FILE environment variable!!')
+      return env_variable_file
+    end
+
+    return nil if unmappable_spec_regexes.any? { executed_spec_file.match?(_1) }
+
+    spec_to_app_file_map.lazy.filter_map do |spec_file_regex, app_file_substitution|
+      if executed_spec_file.match?(spec_file_regex)
+        executed_spec_file.sub(spec_file_regex, app_file_substitution)
+      end
+    end.first&.sub(/_spec\.rb\z/, '.rb') ||
+    raise("Could not map executed spec file #{executed_spec_file} to application file!")
+  end
+
+  memoize \
+  def executed_spec_files
+    SimpleCov::Formatter::Terminal::RSpecIntegration.executed_spec_files
+  end
+
+  memoize \
+  def spec_to_app_file_map
+    SimpleCov::Formatter::Terminal.config.spec_to_app_file_map ||
+    SimpleCov::Formatter::Terminal::SpecToAppMapping.default_spec_to_app_map
+  end
+
+  memoize \
+  def unmappable_spec_regexes
+    SimpleCov::Formatter::Terminal.config.unmappable_spec_regexes
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'memoist'
+
+class SimpleCov::Formatter::Terminal::LinePrinter
+  extend Memoist
+  include SimpleCov::Formatter::Terminal::BranchCoverage
+  include SimpleCov::Formatter::Terminal::ColorPrinting
+
+  def initialize(targeted_application_file)
+    @targeted_application_file = targeted_application_file
+  end
+
+  def colored_line(line, sourcefile)
+    colored_source_code = syntax_highlighted_source_lines[line.line_number - 1]
+    line_number = line.line_number
+
+    case
+    when line.skipped?
+      numbered_line_output(line_number, :white, colored_source_code)
+    when line.coverage == 0
+      numbered_line_output(line_number, :white_on_red, colored_source_code)
+    when (missed_branch_info = missed_branch_info(line, sourcefile))
+      numbered_line_output(line_number, :red_on_yellow, colored_source_code, missed_branch_info)
+    when line.coverage.nil?
+      numbered_line_output(line_number, :white, colored_source_code, missed_branch_info)
+    else
+      numbered_line_output(line_number, :green, colored_source_code, missed_branch_info)
+    end
+  end
+
+  # rubocop:disable Style/StringConcatenation
+  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 =
+      if SimpleCov::Formatter::Terminal.config.write_target_info_file?
+        ":::#{line_number}".rjust(6, ' ')
+      else
+        line_number.to_s.rjust(3, ' ')
+      end
+
+    output =
+      colored_space +
+      color(line_number_string, color) +
+      colored_space +
+      ' ' +
+      source_code
+
+    if missed_branch_info
+      output << " #{color(missed_branch_info, :white_on_red)}"
+    end
+
+    output
+  end
+  # rubocop:enable Style/StringConcatenation
+
+  memoize \
+  def syntax_highlighted_source_lines
+    source = File.read(@targeted_application_file)
+    formatter = Rouge::Formatters::Terminal256.new(Rouge::Themes::Base16.mode(:dark).new)
+    lexer = Rouge::Lexers::Ruby.new
+    highlighted_source = formatter.format(lexer.lex(source))
+    highlighted_source.split("\n")
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module SimpleCov::Formatter::Terminal::RSpecIntegration
+  class << self
+    attr_accessor :executed_spec_files, :failure_occurred
+
+    def setup_rspec
+      return if @rspec_is_set_up # :nocov-else:
+
+      # We can't easily test this, since we use this library in its own RSpec tests,
+      # so we'd be setting it up twice if we tested it, which would be a bit of a problem.
+      # :nocov:
+      _setup_rspec
+      @rspec_is_set_up = true
+      # :nocov:
+    end
+
+    def failure_occurred?
+      !!@failure_occurred
+    end
+
+    private
+
+    def _setup_rspec
+      RSpec.configure do |config|
+        config.before(:suite) do
+          SimpleCov::Formatter::Terminal::RSpecIntegration.failure_occurred = false
+        end
+
+        config.after(:suite) do
+          examples = RSpec.world.filtered_examples.values.flatten
+          SimpleCov::Formatter::Terminal::RSpecIntegration.failure_occurred =
+            examples.any?(&:exception)
+          SimpleCov::Formatter::Terminal::RSpecIntegration.executed_spec_files =
+            examples.map { _1.file_path.delete_prefix('./') }.uniq
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SimpleCov::Formatter::Terminal::RailsAwareness
+  class << self
+    def rails?
+      !!defined?(Rails)
+    end
+  end
+end

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

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require_relative './branch_coverage'
+require_relative './color_printing'
+require_relative './line_printer'
+require_relative './target_file_writer'
+
+class SimpleCov::Formatter::Terminal::ResultPrinter
+  extend Forwardable
+  extend Memoist
+  include SimpleCov::Formatter::Terminal::BranchCoverage
+  include SimpleCov::Formatter::Terminal::ColorPrinting
+
+  def_delegators(:@file_determiner, :executed_spec_file, :targeted_application_file)
+
+  def initialize(file_determiner)
+    @file_determiner = file_determiner
+  end
+
+  def print_coverage_info(result)
+    sourcefile = result.files.find { _1.filename.end_with?(targeted_application_file) }
+    force_coverage = ENV.fetch('SIMPLECOV_FORCE_DETAILS', nil) == '1'
+
+    if sourcefile.nil?
+      print_no_coverage_info_found
+    elsif failure_occurred? && !force_coverage
+      print_coverage_summary(sourcefile, 'Not showing detailed coverage because an example failed.')
+    elsif sourcefile.covered_percent < 100 || uncovered_branches(sourcefile).any? || force_coverage
+      print_coverage_details(sourcefile)
+    else
+      print_coverage_summary(sourcefile)
+    end
+  end
+
+  def print_coverage_summary(sourcefile, log_addendum = nil)
+    summary = +"-- Coverage for #{targeted_application_file} --\n"
+    summary << "Line coverage: #{colorized_coverage(sourcefile.covered_percent)}"
+    if SimpleCov.branch_coverage?
+      summary << ' '
+      summary << <<~LOG
+        | Uncovered branches: #{colorized_uncovered_branches(uncovered_branches(sourcefile).size)}
+      LOG
+    else
+      summary << "\n"
+    end
+    summary << log_addendum if log_addendum
+    puts(summary)
+  end
+
+  def print_coverage_details(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)
+    sourcefile.lines.each do |line|
+      puts(line_printer.colored_line(line, sourcefile))
+    end
+    puts(<<~LOG.squish)
+      ----
+      Line coverage: #{colorized_coverage(sourcefile.covered_percent)}
+      |
+      Uncovered branches: #{colorized_uncovered_branches(uncovered_branches(sourcefile).size)}
+      ----
+    LOG
+  end
+
+  def print_no_coverage_info_found
+    puts(<<~LOG.squish)
+      No code coverage info was found for "#{targeted_application_file}". Try stopping and
+      disabling `spring`, if you are using it, and then rerun the spec.
+    LOG
+  end
+
+  def print_info_for_no_executed_specs
+    puts('Not showing test coverage details because no specs were executed successfully.')
+  end
+
+  def print_info_for_undetermined_application_target
+    puts(<<~LOG.squish)
+      Not showing test coverage details because "#{executed_spec_file}" cannot
+      be mapped to a single application file.
+    LOG
+    puts(<<~LOG.squish)
+      Tip: you can specify a file manually via a SIMPLECOV_TARGET_FILE environment variable.
+    LOG
+  end
+
+  def print_info_for_nonexistent_application_target
+    puts(<<~LOG.squish)
+      Cannot show code coverage. Looked for application file "#{targeted_application_file}",
+      but it does not exist.
+    LOG
+  end
+
+  private
+
+  def failure_occurred?
+    SimpleCov::Formatter::Terminal::RSpecIntegration.failure_occurred?
+  end
+
+  memoize \
+  def target_file_writer
+    SimpleCov::Formatter::Terminal::TargetFileWriter.new(targeted_application_file)
+  end
+
+  def colorized_coverage(covered_percent)
+    case
+    when covered_percent >= 100 then color("#{covered_percent.round(2)}%", :green)
+    when covered_percent >= 80 then color("#{covered_percent.round(2)}%", :yellow)
+    else color("#{covered_percent.round(2)}%", :red)
+    end
+  end
+
+  def colorized_uncovered_branches(num_uncovered_branches)
+    case num_uncovered_branches
+    when 0 then color(num_uncovered_branches.to_s, :green)
+    when (1..3) then color(num_uncovered_branches.to_s, :yellow)
+    else color(num_uncovered_branches.to_s, :red)
+    end
+  end
+
+  memoize \
+  def line_printer
+    SimpleCov::Formatter::Terminal::LinePrinter.new(targeted_application_file)
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative './rails_awareness'
+
+module SimpleCov::Formatter::Terminal::SpecToAppMapping
+  # rubocop:disable Lint/OrAssignmentToConstant
+  DEFAULT_UNMAPPABLE_SPEC_REGEXES ||= [
+    %r{\Aspec/features/},
+  ].freeze
+  SPEC_TO_GEM_DEFAULT_MAP ||= {
+    %r{\Aspec/} => 'lib/',
+  }.freeze
+  SPEC_TO_RAILS_DEFAULT_MAP ||= {
+    %r{\Aspec/lib/} => 'lib/',
+    %r{\Aspec/controllers/admin/(.*)_controller_spec.rb} => 'app/admin/\1.rb',
+    %r{
+      \Aspec/
+      (
+      actions|
+      channels|
+      controllers|
+      decorators|
+      helpers|
+      mailboxes|
+      mailers|
+      models|
+      policies|
+      serializers|
+      views|
+      workers
+      )
+      /
+    }x => 'app/\1/',
+  }.freeze
+  # rubocop:enable Lint/OrAssignmentToConstant
+
+  class << self
+    def default_spec_to_app_map
+      # dup the maps because the maps are frozen but we want to allow the user to customize them
+      if SimpleCov::Formatter::Terminal::RailsAwareness.rails?
+        SPEC_TO_RAILS_DEFAULT_MAP.dup
+      else
+        SPEC_TO_GEM_DEFAULT_MAP.dup
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'memoist'
+
+class SimpleCov::Formatter::Terminal::TargetFileWriter
+  def initialize(targeted_application_file)
+    @targeted_application_file = targeted_application_file
+  end
+
+  def write_target_info_file
+    directory = 'tmp/simple_cov/formatter/terminal'
+    FileUtils.mkdir_p(directory)
+    File.write("#{directory}/target.txt", "#{@targeted_application_file}\n")
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module SimpleCov; end
+module SimpleCov::Formatter; end
+
+# rubocop:disable Style/StaticClass
+class SimpleCov::Formatter::Terminal
+  VERSION = '0.1.0'
+end
+# rubocop:enable Style/StaticClass

data/lib/simple_cov/formatter/terminal.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+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 'memoist'
+require 'rouge'
+require 'rspec/core'
+require 'simplecov'
+
+class SimpleCov::Formatter::Terminal
+  extend Forwardable
+  extend Memoist
+
+  def_delegators(
+    :file_determiner,
+    :executed_spec_file,
+    :executed_spec_files,
+    :targeted_application_file,
+  )
+  def_delegators(
+    :result_printer,
+    :print_coverage_info,
+    :print_info_for_no_executed_specs,
+    :print_info_for_nonexistent_application_target,
+    :print_info_for_undetermined_application_target,
+  )
+
+  class << self
+    extend Memoist
+
+    memoize \
+    def config
+      Config.new
+    end
+  end
+
+  def format(result)
+    if executed_spec_files.nil?
+      print_info_for_no_executed_specs
+    elsif targeted_application_file.nil?
+      print_info_for_undetermined_application_target
+    elsif File.exist?(targeted_application_file)
+      print_coverage_info(result)
+    else
+      print_info_for_nonexistent_application_target
+    end
+  end
+
+  private
+
+  memoize \
+  def file_determiner
+    SimpleCov::Formatter::Terminal::FileDeterminer.new
+  end
+
+  memoize \
+  def result_printer
+    SimpleCov::Formatter::Terminal::ResultPrinter.new(file_determiner)
+  end
+end
+
+SimpleCov::Formatter::Terminal::RSpecIntegration.setup_rspec

data/simple_cov-formatter-terminal.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'lib/simple_cov/formatter/terminal/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'simple_cov-formatter-terminal'
+  spec.version = SimpleCov::Formatter::Terminal::VERSION
+  spec.authors = ['David Runger']
+  spec.email = ['davidjrunger@gmail.com']
+
+  spec.summary = 'Print detailed code coverage info to the terminal'
+  spec.description = 'Print detailed code coverage info to the terminal'
+  spec.homepage = 'https://github.com/davidrunger/simplecov-formatter-terminal'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.2.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/davidrunger/simplecov-formatter-terminal'
+  spec.metadata['changelog_uri'] =
+    'https://github.com/davidrunger/simplecov-formatter-terminal/blob/master/CHANGELOG.md'
+
+  # 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(__dir__) do
+      `git ls-files -z`.split("\x0").reject do |f|
+        (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git))})
+      end
+    end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency('activesupport', '>= 7.0.4', '< 8')
+  spec.add_dependency('memoist', '>= 0.16.2', '< 1')
+  spec.add_dependency('rouge', '>= 4.0.0', '< 5')
+  spec.add_dependency('rspec-core', '>= 3.11.0', '< 4')
+  spec.add_dependency('simplecov', '>= 0.21.2', '< 1')
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: simple_cov-formatter-terminal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Runger
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: memoist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Print detailed code coverage info to the terminal
+email:
+- davidjrunger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".release_assistant.yml"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_cov/formatter/terminal.rb
+- lib/simple_cov/formatter/terminal/branch_coverage.rb
+- lib/simple_cov/formatter/terminal/color_printing.rb
+- lib/simple_cov/formatter/terminal/config.rb
+- lib/simple_cov/formatter/terminal/file_determiner.rb
+- lib/simple_cov/formatter/terminal/line_printer.rb
+- lib/simple_cov/formatter/terminal/r_spec_integration.rb
+- lib/simple_cov/formatter/terminal/rails_awareness.rb
+- lib/simple_cov/formatter/terminal/result_printer.rb
+- lib/simple_cov/formatter/terminal/spec_to_app_mapping.rb
+- lib/simple_cov/formatter/terminal/target_file_writer.rb
+- lib/simple_cov/formatter/terminal/version.rb
+- simple_cov-formatter-terminal.gemspec
+homepage: https://github.com/davidrunger/simplecov-formatter-terminal
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/davidrunger/simplecov-formatter-terminal
+  source_code_uri: https://github.com/davidrunger/simplecov-formatter-terminal
+  changelog_uri: https://github.com/davidrunger/simplecov-formatter-terminal/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.2
+signing_key:
+specification_version: 4
+summary: Print detailed code coverage info to the terminal
+test_files: []