single_cov 1.11.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ffed2c03e29890449010148c9492563266983dd70d0f32e7a600692fa6b6a57
-  data.tar.gz: a9395fb02ed4dd4f5490cf4faf8a7c8ef3bd8b084081958c3a86fabb3cbbedcf
+  metadata.gz: 03abb741a629409eca737e84185cbd61c34a24a65fdb5b4c381d295f00690eed
+  data.tar.gz: fee46d0a03e4812f372c375745ff9a02229292bc1c153e028ee7dc46691edfb0
 SHA512:
-  metadata.gz: dddfdd5778b9e3c34b92db87d4288970a6a0bd27154d0c40572bf5fa581f92806214827974b55c2612b19f1298bd1d5827072006fb1d131bf5feb36ccca33513
-  data.tar.gz: 6b82b17a84a018334c140027bab24ef3ac9c08cb0d52973f87d580006d19b0c7cfd3a80b8331b7d487e38af34c8e51f817066170ddee360378587b0b8af03981
+  metadata.gz: 52da7209346a1ec927241e0db7390d664ef155a6146642e0895964cbcaa7c6e704ee6dc027591032fcb4727546543de60aa68ddd57f9b7e5f8879b9c98169a73
+  data.tar.gz: 3f0ae6f966cb07c608efd71cc8b87787c7506363c8bf2e43c4e334cf88b51122f56d2ad56864afc302b7158339eb4c5f3d8935f8a924c3132e43ab216604f700

data/lib/single_cov/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module SingleCov
-  VERSION = "1.11.0"
+  VERSION = "2.1.0"
 end

data/lib/single_cov.rb

@@ -4,6 +4,7 @@ module SingleCov
   MAX_OUTPUT = Integer(ENV["SINGLE_COV_MAX_OUTPUT"] || "40")
   RAILS_APP_FOLDERS = ["models", "serializers", "helpers", "controllers", "mailers", "views", "jobs", "channels"]
   UNCOVERED_COMMENT_MARKER = /#.*uncovered/
+  NOCOV_MARKER = /^\s*#\s*:nocov:/ # see https://github.com/simplecov-ruby/simplecov/blob/00376ea2f29ce7a7355b7c2d7d094b666b57cb9b/lib/simplecov/lines_classifier.rb#L16
   PREFIXES_TO_IGNORE = [] # things to not prefix with lib/ etc
 
   class << self
@@ -32,7 +33,7 @@ module SingleCov
 
     def all_covered?(result)
       errors = COVERAGES.flat_map do |file, expected_uncovered|
-        next no_coverage_error(file) unless coverage = result["#{root}/#{file}"]
+        next no_coverage_error(file) unless (coverage = result["#{root}/#{file}"])
 
         uncovered = uncovered(coverage)
         next if uncovered.size == expected_uncovered
@@ -40,8 +41,10 @@ module SingleCov
         # ignore lines that are marked as uncovered via comments
         # TODO: warn when using uncovered but the section is indeed covered
         content = File.readlines("#{root}/#{file}")
+        nocov_lines_nums = nocov_line_numbers(content)
         uncovered.reject! do |line_start, _, _, _, _|
-          content[line_start - 1].match?(UNCOVERED_COMMENT_MARKER)
+          content[line_start - 1].match?(UNCOVERED_COMMENT_MARKER) ||
+            nocov_lines_nums.include?(line_start)
         end
         next if uncovered.size == expected_uncovered
 
@@ -119,8 +122,7 @@ module SingleCov
 
       case framework
       when :minitest
-        minitest_should_not_be_running!
-        return if minitest_running_subset_of_tests?
+        return if minitest_running_subset_of_tests?(ARGV)
       when :rspec
         return if rspec_running_subset_of_tests?
       else
@@ -129,15 +131,35 @@ module SingleCov
 
       start_coverage_recording
 
-      override_at_exit do |status, _exception|
-        if enabled? && main_process? && status == 0
-          results = coverage_results
-          generate_report results
-          exit 1 unless SingleCov.all_covered?(results)
+      # minitest overrides at_exit, so we need to get into it to execute after it finishes
+      # so when using the `minitest` executable or loading minitest before SingleCov the first branch is used
+      if defined?(Minitest)
+        (class << Minitest; self; end).prepend(Module.new do
+          def run(args = [])
+            original_args = args.dup # minitest modified them
+            result = super
+            if result && !SingleCov.send(:minitest_running_subset_of_tests?, original_args)
+              return SingleCov.report_at_exit
+            end
+            result
+          end
+        end)
+      else
+        override_at_exit do |status, _exception|
+          if main_process? && status == 0 && !report_at_exit
+            exit 1
+          end
         end
       end
     end
 
+    def report_at_exit
+      return unless enabled?
+      results = coverage_results
+      generate_report results
+      SingleCov.all_covered?(results)
+    end
+
     # use this in forks when using rspec to silence duplicated output
     def disable
       @disabled = true
@@ -159,7 +181,7 @@ module SingleCov
     end
 
     def enabled?
-      (!defined?(@disabled) || !@disabled)
+      !defined?(@disabled) || !@disabled
     end
 
     # assuming that the main process will load all the files, we store it's pid
@@ -168,7 +190,7 @@ module SingleCov
     end
 
     def main_process?
-      (!defined?(@main_process_pid) || @main_process_pid == Process.pid)
+      !defined?(@main_process_pid) || @main_process_pid == Process.pid
     end
 
     # {[branch_id] => {[branch_part] => coverage}} --> uncovered location
@@ -196,6 +218,19 @@ module SingleCov
       Dir["#{root}/#{pattern}"].map! { |f| f.sub("#{root}/", '') }
     end
 
+    # @returns [Integer] 1-based line numbers that are inside :nocov: blocks
+    def nocov_line_numbers(content)
+      inside = false
+      content.each_with_index.filter_map do |line, index|
+        if line.match?(NOCOV_MARKER)
+          inside = !inside # toggle
+          nil # line itself cannot be uncovered since it is only a comment
+        elsif inside
+          index + 1
+        end
+      end
+    end
+
     def indexes(list, find)
       list.each_with_index.filter_map { |v, i| i if v == find }
     end
@@ -230,56 +265,26 @@ module SingleCov
       COVERAGES.size == 1
     end
 
-    # we cannot insert our hooks when minitest is already running
-    def minitest_should_not_be_running!
-      return unless defined?(Minitest)
-      return unless Minitest.class_variable_defined?(:@@installed_at_exit)
-      return unless Minitest.class_variable_get(:@@installed_at_exit)
-
-      # untested
-      # https://github.com/rails/rails/pull/26515 rails loads autorun before test
-      # but it works out for some reason
-      return if Minitest.extensions.include?('rails')
-
-      # untested
-      # forking test runner does some hacky acrobatics to fake minitest status
-      # and the resets it ... works out ok in the end ...
-      return if faked_by_forking_test_runner?
-
-      # ... but only if it's used with `--merge-coverage` otherwise the coverage reporting is useless
-      if $0.end_with?("/forking-test-runner")
-        raise "forking-test-runner only work with single_cov when using --merge-coverage"
-      end
-
-      raise "Load minitest after setting up SingleCov"
-    end
-
-    # ForkingTestRunner fakes an initialized minitest to avoid multiple hooks being installed
-    # so hooks still get added in order https://github.com/grosser/forking_test_runner/pull/4
-    def faked_by_forking_test_runner?
-      defined?(Coverage) && Coverage.respond_to?(:capture_coverage!)
-    end
-
     # do not record or verify when only running selected tests since it would be missing data
-    def minitest_running_subset_of_tests?
+    def minitest_running_subset_of_tests?(argv)
       # via direct option (ruby test.rb -n /foo/)
-      (ARGV.map { |a| a.split('=', 2).first } & ['-n', '--name', '-l', '--line']).any? ||
+      # or `minitest foo.rb:123` which is translated to -n
+      argv.map { |a| a.split('=', 2).first }.intersect?(['-n', '--name', '-l', '--line']) ||
 
-      # via testrbl or mtest or rails with direct line number (mtest test.rb:123)
-      (ARGV.first =~ /:\d+\Z/) ||
+      # via testrbl, mtest, or rails with direct line number (mtest test.rb:123)
+      (argv.first =~ /:\d+\Z/) ||
 
       # via rails test which preloads mintest, removes ARGV and fills options
       (
-        defined?(Minitest) &&
         defined?(Minitest.reporter) &&
         Minitest.reporter &&
         (reporter = Minitest.reporter.reporters.first) &&
-        reporter.options[:filter]
+        (reporter.options[:filter] || reporter.options[:include]) # MT 5 vs MT 6
       )
     end
 
     def rspec_running_subset_of_tests?
-      (ARGV & ['-t', '--tag', '-e', '--example']).any? || ARGV.any? { |a| a =~ /:\d+$|\[[\d:]+\]$/ }
+      ARGV.intersect?(['-t', '--tag', '-e', '--example']) || ARGV.any? { |a| a =~ /:\d+$|\[[\d:]+\]$/ }
     end
 
     # code stolen from SimpleCov
@@ -400,7 +405,7 @@ module SingleCov
           end
 
         # remove test extension
-        if !file_part.sub!(/_(?:test|spec)\.rb\b.*/, '.rb') && !file_part.sub!(/\/test_/, "/")
+        if !file_part.sub!(/_(?:test|spec)\.rb\b.*/, '.rb') && !file_part.sub!('/test_', "/")
           raise "Unable to remove test extension from #{file} ... /test_, _test.rb and _spec.rb are supported"
         end
       end
@@ -418,14 +423,14 @@ module SingleCov
     end
 
     def generate_report(results)
-      return unless report = coverage_report
+      return unless (report = coverage_report)
 
       # not a hard dependency for the whole library
       require "json"
       require "fileutils"
 
       used = COVERAGES.map { |f, _| "#{root}/#{f}" }
-      covered = results.select { |k, _| used.include?(k) }
+      covered = results.slice(*used)
 
       if coverage_report_lines
         covered = covered.transform_values { |v| v.is_a?(Hash) ? v.fetch(:lines) : v }

metadata

@@ -1,16 +1,98 @@
 --- !ruby/object:Gem::Specification
 name: single_cov
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Michael Grosser
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-03 00:00:00.000000000 Z
-dependencies: []
-description:
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 email: michael@grosser.it
 executables: []
 extensions: []
@@ -23,7 +105,6 @@ homepage: https://github.com/grosser/single_cov
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -31,15 +112,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Actionable code coverage.
 test_files: []