single_cov 1.1.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc46724cb995c3bf97cfb5e59f0ffb96ab508522e56269386769f9a40bbf35b3
-  data.tar.gz: e7a93ad442bc9145900505b8d8c76e510aa2e9e4b7cf3ce9e4a03368fcbdeb8e
+  metadata.gz: 6cd1fb991b879dcaf753d2aa30c4f94ac3f97659cf602df4f9adab874046c16f
+  data.tar.gz: c2351364b4482ceff98314b881fd5b774e9040c117479674b8fb41c0b550dac4
 SHA512:
-  metadata.gz: 88acb179ed998ce309df2e5bcf80814591c0187c98093827e767f5ada0335f2a5db726b13d1ae56aa0f6a4134e17b69b9ca86d37033fe530c859f8637798ce4c
-  data.tar.gz: 1a2e84b437f57143087cfcba3249c871d9039331b45be8b1c7b5f3ecea046c1dec09d5c3cddcfa0687de9d32a872b0c8c77a26e42e6898d27fa3b8f1a5e6b63b
+  metadata.gz: 813924bc4aaad528db8afe9640178f3cfad2c11ffa4042573e4810a83cf941014e3d77352436b1c999330c70c066619054b88a3117e5d87885f95ce619dfaf2d
+  data.tar.gz: 31915f85ff52971fb4691f1fe52680c026b8f8e70c6b390b0c538e84ced5e59b035803130f09d5df03f4eba7731608c46f02ba28df366506322559495baf588d

data/lib/single_cov.rb

@@ -3,41 +3,62 @@ module SingleCov
   MAX_OUTPUT = 40
   APP_FOLDERS = ["models", "serializers", "helpers", "controllers", "mailers", "views", "jobs", "channels"]
   BRANCH_COVERAGE_SUPPORTED = (RUBY_VERSION >= "2.5.0")
+  UNCOVERED_COMMENT_MARKER = "uncovered"
 
   class << self
+    # enable coverage reporting, changed by forking-test-runner to combine multiple reports
+    attr_accessor :coverage_report
+
     # optionally rewrite the file we guessed with a lambda
     def rewrite(&block)
       @rewrite = block
     end
 
     def not_covered!
+      store_pid
     end
 
     def covered!(file: nil, uncovered: 0)
       file = guess_and_check_covered_file(file)
       COVERAGES << [file, uncovered]
+      store_pid
     end
 
     def all_covered?(result)
       errors = COVERAGES.map do |file, expected_uncovered|
         if coverage = result["#{root}/#{file}"]
           line_coverage = (coverage.is_a?(Hash) ? coverage.fetch(:lines) : coverage)
-          uncovered = line_coverage.each_with_index.map { |c, i| i + 1 if c == 0 }.compact
+          uncovered_lines = line_coverage.each_with_index.map { |c, i| i + 1 if c == 0 }.compact
+
           branch_coverage = (coverage.is_a?(Hash) && coverage[:branches])
+          uncovered_branches = (branch_coverage ? uncovered_branches(branch_coverage, uncovered_lines) : [])
 
-          if branch_coverage
-            uncovered.concat uncovered_branches(file, branch_coverage, uncovered)
-          end
+          uncovered = uncovered_lines.concat uncovered_branches
+          next if uncovered.size == expected_uncovered
 
+          # ignore lines that are marked as uncovered via comments
+          # NOTE: ideally we should also warn when using uncovered but the section is indeed covered
+          content = File.readlines(file)
+          uncovered.reject! do |line_start, _, _, _|
+            content[line_start - 1].include?(UNCOVERED_COMMENT_MARKER)
+          end
           next if uncovered.size == expected_uncovered
 
-          # branches are unsorted and added to the end, only sort when necessary
+          # branches are unsorted and added to the end, only sort when displayed
           if branch_coverage
-            uncovered.sort_by! { |line_start, char_start, line_end, char_end| [line_start, char_start || 0] }
+            uncovered.sort_by! { |line_start, char_start, _, _| [line_start, char_start || 0] }
           end
 
           uncovered.map! do |line_start, char_start, line_end, char_end|
-            char_start ? "#{file}:#{line_start}:#{char_start}-#{line_end}:#{char_end}" : "#{file}:#{line_start}"
+            if char_start # branch coverage
+              if line_start == line_end
+                "#{file}:#{line_start}:#{char_start}-#{char_end}"
+              else # possibly unreachable since branches always seem to be on the same line
+                "#{file}:#{line_start}:#{char_start}-#{line_end}:#{char_end}"
+              end
+            else
+              "#{file}:#{line_start}"
+            end
           end
 
           warn_about_bad_coverage(file, expected_uncovered, uncovered)
@@ -100,7 +121,11 @@ module SingleCov
       start_coverage_recording
 
       override_at_exit do |status, _exception|
-        exit 1 if (!defined?(@disabled) || !@disabled) && status == 0 && !SingleCov.all_covered?(coverage_results)
+        if enabled? && main_process? && status == 0
+          results = coverage_results
+          generate_report results
+          exit 1 unless SingleCov.all_covered?(results)
+        end
       end
     end
 
@@ -111,7 +136,19 @@ module SingleCov
 
     private
 
-    def uncovered_branches(file, coverage, uncovered_lines)
+    def enabled?
+      (!defined?(@disabled) || !@disabled)
+    end
+
+    def store_pid
+      @pid = Process.pid
+    end
+
+    def main_process?
+      (!defined?(@pid) || @pid == Process.pid)
+    end
+
+    def uncovered_branches(coverage, uncovered_lines)
       # {[branch_id] => {[branch_part] => coverage}} --> {branch_part -> sum-of-coverage}
       sum = Hash.new(0)
       coverage.each_value do |branch|
@@ -121,8 +158,8 @@ module SingleCov
       end
 
       # show missing coverage
-      found = sum.select { |k, v| v.zero? && !uncovered_lines.include?(k[0]) }.
-        map { |k, _| [k[0], k[1]+1, k[2], k[3]+1] }
+      sum.select! { |k, v| v.zero? && !uncovered_lines.include?(k[0]) }
+      found = sum.map { |k, _| [k[0], k[1]+1, k[2], k[3]+1] }
       found.uniq!
       found
     end
@@ -313,8 +350,8 @@ module SingleCov
       end
 
       # remove test extension
-      unless file_part.sub!(/_(?:test|spec)\.rb\b.*/, '.rb')
-        raise "Unable to remove test extension from #{file} ... _test.rb and _spec.rb are supported"
+      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
 
       # put back the subfolder
@@ -328,5 +365,21 @@ module SingleCov
     def root
       @root ||= (defined?(Bundler) && Bundler.root.to_s.sub(/\/gemfiles$/, '')) || Dir.pwd
     end
+
+    def generate_report(results)
+      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) }
+      data = JSON.pretty_generate(
+        "Unit Tests" => {"coverage" => covered, "timestamp" => Time.now.to_i }
+      )
+      FileUtils.mkdir_p(File.dirname(report))
+      File.write report, data
+    end
   end
 end

data/lib/single_cov/version.rb

@@ -1,3 +1,3 @@
 module SingleCov
-  VERSION = "1.1.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: single_cov
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-05 00:00:00.000000000 Z
+date: 2020-10-24 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: michael@grosser.it
@@ -38,8 +38,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Actionable code coverage.