simplecov 0.18.0.beta1 → 0.18.0

data/lib/simplecov.rb

@@ -46,13 +46,48 @@ module SimpleCov
     #
     def start(profile = nil, &block)
       require "coverage"
-      load_profile(profile) if profile
-      configure(&block) if block_given?
+      initial_setup(profile, &block)
       @result = nil
-      self.running = true
       self.pid = Process.pid
 
-      start_coverage_measurment
+      start_coverage_measurement
+    end
+
+    #
+    # Collate a series of SimpleCov result files into a single SimpleCov output.
+    # You can optionally specify configuration with a block:
+    #   SimpleCov.collate Dir["simplecov-resultset-*/.resultset.json"]
+    #    OR
+    #   SimpleCov.collate Dir["simplecov-resultset-*/.resultset.json"], 'rails' # using rails profile
+    #    OR
+    #   SimpleCov.collate Dir["simplecov-resultset-*/.resultset.json"] do
+    #     add_filter 'test'
+    #   end
+    #    OR
+    #   SimpleCov.collate Dir["simplecov-resultset-*/.resultset.json"], 'rails' do
+    #     add_filter 'test'
+    #   end
+    #
+    # Please check out the RDoc for SimpleCov::Configuration to find about
+    # available config options, or checkout the README for more in-depth
+    # information about coverage collation
+    #
+    def collate(result_filenames, profile = nil, &block)
+      raise "There's no reports to be merged" if result_filenames.empty?
+
+      initial_setup(profile, &block)
+
+      results = result_filenames.flat_map do |filename|
+        # Re-create each included instance of SimpleCov::Result from the stored run data.
+        (JSON.parse(File.read(filename)) || {}).map do |command_name, coverage|
+          SimpleCov::Result.from_hash(command_name => coverage)
+        end
+      end
+
+      # Use the ResultMerger to produce a single, merged result, ready to use.
+      @result = SimpleCov::ResultMerger.merge_and_store(*results)
+
+      run_exit_tasks!
     end
 
     #
@@ -159,6 +194,8 @@ module SimpleCov
     # Called from at_exit block
     #
     def run_exit_tasks!
+      set_exit_exception
+
       exit_status = SimpleCov.exit_status_from_exception
 
       SimpleCov.at_exit.call
@@ -170,7 +207,7 @@ module SimpleCov
       # Force exit with stored status (see github issue #5)
       # unless it's nil or 0 (see github issue #281)
       if exit_status&.positive?
-        $stderr.printf("SimpleCov failed with exit %<exit_status>d\n", :exit_status => exit_status) if print_error_status
+        $stderr.printf("SimpleCov failed with exit %<exit_status>d\n", exit_status: exit_status) if print_error_status
         Kernel.exit exit_status
       end
     end
@@ -194,28 +231,24 @@ module SimpleCov
     # rubocop:disable Metrics/MethodLength
     def result_exit_status(result, covered_percent)
       covered_percentages = result.covered_percentages.map { |percentage| percentage.floor(2) }
-      if covered_percent < SimpleCov.minimum_coverage
-        $stderr.printf(
-          "Coverage (%<covered>.2f%%) is below the expected minimum coverage (%<minimum_coverage>.2f%%).\n",
-          :covered => covered_percent,
-          :minimum_coverage => SimpleCov.minimum_coverage
-        )
+      if (minimum_violations = minimum_coverage_violated(result)).any?
+        report_minimum_violated(minimum_violations)
         SimpleCov::ExitCodes::MINIMUM_COVERAGE
       elsif covered_percentages.any? { |p| p < SimpleCov.minimum_coverage_by_file }
         $stderr.printf(
           "File (%<file>s) is only (%<least_covered_percentage>.2f%%) covered. This is below the expected minimum coverage per file of (%<min_coverage>.2f%%).\n",
-          :file => result.least_covered_file,
-          :least_covered_percentage => covered_percentages.min,
-          :min_coverage => SimpleCov.minimum_coverage_by_file
+          file: result.least_covered_file,
+          least_covered_percentage: covered_percentages.min,
+          min_coverage: SimpleCov.minimum_coverage_by_file
         )
         SimpleCov::ExitCodes::MINIMUM_COVERAGE
       elsif (last_run = SimpleCov::LastRun.read)
-        coverage_diff = last_run["result"]["covered_percent"] - covered_percent
+        coverage_diff = last_run[:result][:covered_percent] - covered_percent
         if coverage_diff > SimpleCov.maximum_coverage_drop
           $stderr.printf(
             "Coverage has dropped by %<drop_percent>.2f%% since the last time (maximum allowed: %<max_drop>.2f%%).\n",
-            :drop_percent => coverage_diff,
-            :max_drop => SimpleCov.maximum_coverage_drop
+            drop_percent: coverage_diff,
+            max_drop: SimpleCov.maximum_coverage_drop
           )
           SimpleCov::ExitCodes::MAXIMUM_COVERAGE_DROP
         else
@@ -248,18 +281,24 @@ module SimpleCov
     # @api private
     #
     def write_last_run(covered_percent)
-      SimpleCov::LastRun.write(:result => {:covered_percent => covered_percent})
+      SimpleCov::LastRun.write(result: {covered_percent: covered_percent})
     end
 
   private
 
+    def initial_setup(profile, &block)
+      load_profile(profile) if profile
+      configure(&block) if block_given?
+      self.running = true
+    end
+
     #
     # Trigger Coverage.start depends on given config coverage_criterion
     #
     # With Positive branch it supports all coverage measurement types
     # With Negative branch it supports only line coverage measurement type
     #
-    def start_coverage_measurment
+    def start_coverage_measurement
       # This blog post gives a good run down of the coverage criterias introduced
       # in Ruby 2.5: https://blog.bigbinary.com/2018/04/11/ruby-2-5-supports-measuring-branch-and-method-coverages.html
       # There is also a nice writeup of the different coverage criteria made in this
@@ -287,13 +326,29 @@ module SimpleCov
       # :oneshot_lines - can not be combined with lines
       # :all - same as lines + branches + methods
       #
-      if branch_coverage?
-        Coverage.start(:all)
+      if coverage_start_arguments_supported?
+        start_coverage_with_criteria
       else
         Coverage.start
       end
     end
 
+    def start_coverage_with_criteria
+      start_arguments = coverage_criteria.map do |criterion|
+        [lookup_corresponding_ruby_coverage_name(criterion), true]
+      end.to_h
+
+      Coverage.start(start_arguments)
+    end
+
+    CRITERION_TO_RUBY_COVERAGE = {
+      branch: :branches,
+      line: :lines
+    }.freeze
+    def lookup_corresponding_ruby_coverage_name(criterion)
+      CRITERION_TO_RUBY_COVERAGE.fetch(criterion)
+    end
+
     #
     # Finds files that were to be tracked but were not loaded and initializes
     # the line-by-line coverage to zero (if relevant) or nil (comments / whitespace etc).
@@ -350,13 +405,40 @@ module SimpleCov
     def result_with_not_loaded_files
       @result = SimpleCov::Result.new(add_not_loaded_files(@result))
     end
+
+    def minimum_coverage_violated(result)
+      coverage_achieved = minimum_coverage.map do |criterion, percent|
+        {
+          criterion: criterion,
+          minimum_expected: percent,
+          actual: result.coverage_statistics[criterion].percent
+        }
+      end
+
+      coverage_achieved.select do |achieved|
+        achieved.fetch(:actual) < achieved.fetch(:minimum_expected)
+      end
+    end
+
+    def report_minimum_violated(violations)
+      violations.each do |violation|
+        $stderr.printf(
+          "%<criterion>s coverage (%<covered>.2f%%) is below the expected minimum coverage (%<minimum_coverage>.2f%%).\n",
+          covered: violation.fetch(:actual).floor(2),
+          minimum_coverage: violation.fetch(:minimum_expected),
+          criterion: violation.fetch(:criterion).capitalize
+        )
+      end
+    end
   end
 end
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__)))
 require "set"
+require "forwardable"
 require "simplecov/configuration"
 SimpleCov.extend SimpleCov::Configuration
+require "simplecov/coverage_statistics"
 require "simplecov/exit_codes"
 require "simplecov/profiles"
 require "simplecov/source_file/line"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecov
 version: !ruby/object:Gem::Version
-  version: 0.18.0.beta1
+  version: 0.18.0
 platform: ruby
 authors:
 - Christoph Olszowka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-05 00:00:00.000000000 Z
+date: 2020-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0.beta1
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0.beta1
+        version: 0.11.0
 description: Code coverage for Ruby with a powerful configuration library and automatic
   merging of coverage across test suites
 email:
@@ -63,6 +63,7 @@ files:
 - lib/simplecov/combine/results_combiner.rb
 - lib/simplecov/command_guesser.rb
 - lib/simplecov/configuration.rb
+- lib/simplecov/coverage_statistics.rb
 - lib/simplecov/defaults.rb
 - lib/simplecov/exit_codes.rb
 - lib/simplecov/file_list.rb
@@ -95,9 +96,9 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/colszowka/simplecov/issues
   changelog_uri: https://github.com/colszowka/simplecov/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/simplecov/0.18.0.beta1
+  documentation_uri: https://www.rubydoc.info/gems/simplecov/0.18.0
   mailing_list_uri: https://groups.google.com/forum/#!forum/simplecov
-  source_code_uri: https://github.com/colszowka/simplecov/tree/v0.18.0.beta1
+  source_code_uri: https://github.com/colszowka/simplecov/tree/v0.18.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -109,9 +110,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: