simple_cov-formatter-terminal 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff0a8830c6b2de767299678ae7fbff95b236ae0d79de1f5f6abede949bb6f394
-  data.tar.gz: 48d18ad9742d24dfa1b6a70fc77bd56ebd6574e8c429ab680e4ac6e823946297
+  metadata.gz: deae1a8971e620250fa1a1748eaa59bd8b1036396514430f8da0137068d41445
+  data.tar.gz: 062c244a99ca1f92f9cff01d1566a24ac4c47b94d891c668d05a8da6f5299302
 SHA512:
-  metadata.gz: 5477653a52035b2835c64273a3f0f415ba67d8c66aee98921f6d243b3d698282c4126375cddfc11d37ba58f608bb5600d583b51177e7dab9a4446e38868977e4
-  data.tar.gz: 446961414ac5865814ed77700635c6243df80f0b064e9b38041bf4639e3cc776c5f2fac4e8d2c82afc5bd40ef8946e01c0afb8e18be45a24db1535027663117f
+  metadata.gz: 898eee91d6d0e588826fe800006eb51980a9bbe7af841a4eef025a77a103400a5afd78f16ff750b560651c70d21b57b0530e7ab0387dfed196023e0864a84821
+  data.tar.gz: df37c9668c61f2b605e1e4f07267223b138a5bc6ad58071d56f1d99ed421572a894018954889db9f8bfcd4e276fb86e07b63e3bf8fb027f96d59a0c080e5ea42

data/.ruby-version

@@ -1 +1 @@
-3.3.3
+3.3.4

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v1.5.0 (2024-07-28)
+- Print line numbers as terminal hyperlinks if a `SimpleCov::Formatter::Terminal.config.terminal_hyperlink_target_pattern` is provided
+
+## v1.4.0 (2024-07-21)
+- Handle map-spec-file-to-app failure more elegantly (#229)
+
 ## v1.3.0 (2024-06-28)
 - Enforce only major and minor parts of required Ruby version (loosening the required Ruby version from 3.3.3 to 3.3.0)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_cov-formatter-terminal (1.3.0)
+    simple_cov-formatter-terminal (1.5.0)
       activesupport (>= 7.0.4, < 8)
       memo_wise (>= 1.7.0, < 2)
       rouge (>= 4.0.0, < 5)
@@ -31,7 +31,7 @@ GEM
     concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
     diff-lcs (1.5.1)
-    docile (1.4.0)
+    docile (1.4.1)
     drb (2.2.1)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
@@ -39,10 +39,10 @@ GEM
     language_server-protocol (3.17.0.3)
     memo_wise (1.9.0)
     method_source (1.1.0)
-    minitest (5.24.0)
+    minitest (5.24.1)
     mutex_m (0.2.0)
     parallel (1.25.1)
-    parser (3.3.3.0)
+    parser (3.3.4.0)
       ast (~> 2.4.1)
       racc
     prism (0.30.0)
@@ -56,7 +56,7 @@ GEM
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.9.2)
-    rexml (3.3.1)
+    rexml (3.3.2)
       strscan
     rouge (4.3.0)
     rspec (3.13.0)
@@ -72,13 +72,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.64.1)
+    rubocop (1.65.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
+      regexp_parser (>= 2.4, < 3.0)
       rexml (>= 3.2.5, < 4.0)
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
@@ -88,17 +88,17 @@ GEM
     rubocop-performance (1.21.1)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rspec (3.0.1)
+    rubocop-rspec (3.0.3)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    runger_config (5.1.0)
+    runger_config (5.2.0)
       activesupport (>= 7.1.2)
-    runger_release_assistant (0.8.0)
+    runger_release_assistant (0.11.0)
       activesupport (>= 6, < 8)
       memo_wise (>= 1.7, < 2)
       rainbow (>= 3.0, < 4)
       slop (~> 4.8)
-    runger_style (2.8.0)
+    runger_style (2.13.0)
       prism (>= 0.24.0)
       rubocop (>= 1.38.0, < 2)
     simplecov (0.22.0)
@@ -136,7 +136,7 @@ DEPENDENCIES
   simplecov-cobertura
 
 RUBY VERSION
-   ruby 3.3.3p89
+   ruby 3.3.4p94
 
 BUNDLED WITH
    2.5.11

data/README.md

@@ -115,6 +115,21 @@ branch is not covered on line 18).
 
 [simple-cov-branch-coverage]: https://github.com/simplecov-ruby/simplecov#branch-coverage-ruby--25
 
+## Terminal hyperlinks
+
+If you provide a `terminal_hyperlink_target_pattern`, then SimpleCov::Formatter::Terminal will attempt to print the line numbers in its display as hyperlinks to the relevant line of code.
+
+The pattern can include these interpolation markers:
+
+- `%f` - This will be replaced with the absolute path of the application file.
+- `%l` - This will be replaced with the line number.
+
+For example, this pattern will work to make the line numbers clickable links that open the appropriate file at the appropriate line in VS Code:
+
+```rb
+SimpleCov::Formatter::Terminal.config.terminal_hyperlink_target_pattern = 'vscode://file/%f:%l'
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rspec` to run

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

@@ -16,12 +16,8 @@ class SimpleCov::Formatter::Terminal::Config < Runger::Config
     lines_to_print: LinesToPrint::UNCOVERED,
     spec_to_app_file_map:
       SimpleCov::Formatter::Terminal::SpecToAppMapping.default_spec_to_app_map,
+    terminal_hyperlink_target_pattern: nil,
     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'
-  end
 end

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

@@ -25,14 +25,18 @@ class SimpleCov::Formatter::Terminal::FileDeterminer
       return env_variable_file
     end
 
-    return nil if unmappable_spec_regexes.any? { executed_spec_file.match?(_1) }
+    return nil if unmappable_spec_file?
 
     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.first&.sub(/_spec\.rb\z/, '.rb')
+  end
+
+  memo_wise \
+  def unmappable_spec_file?
+    unmappable_spec_regexes.any? { executed_spec_file.match?(_1) }
   end
 
   memo_wise \

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

@@ -7,6 +7,8 @@ class SimpleCov::Formatter::Terminal::LinePrinter
   include SimpleCov::Formatter::Terminal::BranchCoverage
   include SimpleCov::Formatter::Terminal::ColorPrinting
 
+  LINE_NUMBER_WIDTH = 3
+
   def initialize(targeted_application_file = nil)
     @targeted_application_file = targeted_application_file
   end
@@ -37,20 +39,16 @@ class SimpleCov::Formatter::Terminal::LinePrinter
       else color(' ', :white_on_green)
       end
 
-    line_number_width =
-      if SimpleCov::Formatter::Terminal.config.write_target_info_file?
-        6
-      else
-        3
-      end
+    pattern = SimpleCov::Formatter::Terminal.config.terminal_hyperlink_target_pattern
+
+    link_text = line_number.to_s.rjust(LINE_NUMBER_WIDTH, ' ')
 
     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, ' ')
+      if pattern
+        link_target = pattern.sub('%f', absolute_target_path).sub('%l', line_number.to_s)
+        "\e]8;;#{link_target}\e\\#{link_text}\e]8;;\e\\"
       else
-        line_number.to_s.rjust(line_number_width, ' ')
+        link_text
       end
 
     output =
@@ -76,4 +74,11 @@ class SimpleCov::Formatter::Terminal::LinePrinter
     highlighted_source = formatter.format(lexer.lex(source))
     highlighted_source.split("\n")
   end
+
+  private
+
+  memo_wise \
+  def absolute_target_path
+    File.join(ENV.fetch('PWD'), @targeted_application_file)
+  end
 end

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

@@ -3,7 +3,6 @@
 require_relative 'branch_coverage'
 require_relative 'color_printing'
 require_relative 'line_printer'
-require_relative 'target_file_writer'
 
 class SimpleCov::Formatter::Terminal::ResultPrinter
   extend Forwardable
@@ -50,10 +49,6 @@ class SimpleCov::Formatter::Terminal::ResultPrinter
   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 = []
@@ -108,7 +103,7 @@ class SimpleCov::Formatter::Terminal::ResultPrinter
     puts('Not showing test coverage details because no specs were executed successfully.')
   end
 
-  def print_info_for_undetermined_application_target
+  def print_info_for_undeterminable_application_target
     puts(<<~LOG.squish)
       Not showing test coverage details because "#{executed_spec_file}" cannot
       be mapped to a single application file.
@@ -118,6 +113,17 @@ class SimpleCov::Formatter::Terminal::ResultPrinter
     LOG
   end
 
+  def print_info_for_undetermined_application_target
+    puts(<<~LOG.squish)
+      Not showing test coverage details because we could not map "#{executed_spec_file}"
+      to an application file.
+    LOG
+    puts(<<~LOG.squish)
+      Tip: You can provide a mapping via
+      `SimpleCov::Formatter::Terminal.config.spec_to_app_file_map`.
+    LOG
+  end
+
   def print_info_for_nonexistent_application_target
     puts(<<~LOG.squish)
       Cannot show code coverage. Looked for application file "#{targeted_application_file}",
@@ -131,11 +137,6 @@ class SimpleCov::Formatter::Terminal::ResultPrinter
     SimpleCov::Formatter::Terminal::RSpecIntegration.failure_occurred?
   end
 
-  memo_wise \
-  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)

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 = '1.3.0'
+  VERSION = '1.5.0'
 end
 # rubocop:enable Style/StaticClass

data/lib/simple_cov/formatter/terminal.rb

@@ -25,12 +25,14 @@ class SimpleCov::Formatter::Terminal
     :executed_spec_file,
     :executed_spec_files,
     :targeted_application_file,
+    :unmappable_spec_file?,
   )
   def_delegators(
     :result_printer,
     :print_coverage_info,
     :print_info_for_no_executed_specs,
     :print_info_for_nonexistent_application_target,
+    :print_info_for_undeterminable_application_target,
     :print_info_for_undetermined_application_target,
   )
 
@@ -46,6 +48,8 @@ class SimpleCov::Formatter::Terminal
   def format(result)
     if executed_spec_files.nil?
       print_info_for_no_executed_specs
+    elsif unmappable_spec_file?
+      print_info_for_undeterminable_application_target
     elsif targeted_application_file.nil?
       print_info_for_undetermined_application_target
     elsif File.exist?(targeted_application_file)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_cov-formatter-terminal
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - David Runger
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-28 00:00:00.000000000 Z
+date: 2024-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -151,7 +151,6 @@ files:
 - 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/simple_cov-formatter-terminal
@@ -177,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Print detailed code coverage info to the terminal

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

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require 'memo_wise'
-
-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