simplecov 0.18.2 → 0.19.0

data/lib/simplecov/lines_classifier.rb

@@ -13,7 +13,7 @@ module SimpleCov
     WHITESPACE_OR_COMMENT_LINE = Regexp.union(WHITESPACE_LINE, COMMENT_LINE)
 
     def self.no_cov_line
-      /^(\s*)#(\s*)(\:#{SimpleCov.nocov_token}\:)/o
+      /^(\s*)#(\s*)(:#{SimpleCov.nocov_token}:)/o
     end
 
     def self.no_cov_line?(line)

data/lib/simplecov/no_defaults.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
 ENV["SIMPLECOV_NO_DEFAULTS"] = "yes, no defaults"
-require "simplecov"
+require_relative "../simplecov"

data/lib/simplecov/process.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Process
+  class << self
+    def fork_with_simplecov(&block)
+      if defined?(SimpleCov) && SimpleCov.running
+        fork_without_simplecov do
+          SimpleCov.at_fork.call(Process.pid)
+          block.call if block_given?
+        end
+      else
+        fork_without_simplecov(&block)
+      end
+    end
+
+    alias fork_without_simplecov fork
+    alias fork fork_with_simplecov
+  end
+end

data/lib/simplecov/result.rb

@@ -25,9 +25,11 @@ module SimpleCov
 
     # Initialize a new SimpleCov::Result from given Coverage.result (a Hash of filenames each containing an array of
     # coverage data)
-    def initialize(original_result)
+    def initialize(original_result, command_name: nil, created_at: nil)
       result = adapt_result(original_result)
       @original_result = result.freeze
+      @command_name = command_name
+      @created_at = created_at
       @files = SimpleCov::FileList.new(result.map do |filename, coverage|
         SimpleCov::SourceFile.new(filename, JSON.parse(JSON.dump(coverage))) if File.file?(filename)
       end.compact.sort_by(&:filename))
@@ -70,15 +72,15 @@ module SimpleCov
       }
     end
 
+    def time_since_creation
+      Time.now - created_at
+    end
+
     # Loads a SimpleCov::Result#to_hash dump
     def self.from_hash(hash)
-      command_name, data = hash.first
-
-      result = SimpleCov::Result.new(data["coverage"])
-
-      result.command_name = command_name
-      result.created_at = Time.at(data["timestamp"])
-      result
+      hash.map do |command_name, data|
+        new(data.fetch("coverage"), command_name: command_name, created_at: Time.at(data["timestamp"]))
+      end
     end
 
   private
@@ -86,7 +88,7 @@ module SimpleCov
     # We changed the format of the raw result data in simplecov, as people are likely
     # to have "old" resultsets lying around (but not too old so that they're still
     # considered we can adapt them).
-    # See https://github.com/colszowka/simplecov/pull/824#issuecomment-576049747
+    # See https://github.com/simplecov-ruby/simplecov/pull/824#issuecomment-576049747
     def adapt_result(result)
       if pre_simplecov_0_18_result?(result)
         adapt_pre_simplecov_0_18_result(result)
@@ -103,9 +105,9 @@ module SimpleCov
     end
 
     def adapt_pre_simplecov_0_18_result(result)
-      result.map do |file_path, line_coverage_data|
-        [file_path, {"lines" => line_coverage_data}]
-      end.to_h
+      result.transform_values do |line_coverage_data|
+        {"lines" => line_coverage_data}
+      end
     end
 
     def coverage

data/lib/simplecov/result_merger.rb

@@ -53,13 +53,8 @@ module SimpleCov
       # All results that are above the SimpleCov.merge_timeout will be
       # dropped. Returns an array of SimpleCov::Result items.
       def results
-        results = []
-        resultset.each do |command_name, data|
-          result = SimpleCov::Result.from_hash(command_name => data)
-          # Only add result if the timeout is above the configured threshold
-          results << result if (Time.now - result.created_at) < SimpleCov.merge_timeout
-        end
-        results
+        results = Result.from_hash(resultset)
+        results.select { |result| result.time_since_creation < SimpleCov.merge_timeout }
       end
 
       def merge_and_store(*results)

data/lib/simplecov/source_file.rb

@@ -25,7 +25,7 @@ module SimpleCov
     def src
       # We intentionally read source code lazily to
       # suppress reading unused source code.
-      @src ||= File.open(filename, "rb", &:readlines)
+      @src ||= load_source
     end
     alias source src
 
@@ -175,6 +175,51 @@ module SimpleCov
       end
     end
 
+    def load_source
+      lines = []
+      # The default encoding is UTF-8
+      File.open(filename, "rb:UTF-8") do |file|
+        current_line = file.gets
+
+        if shebang?(current_line)
+          lines << current_line
+          current_line = file.gets
+        end
+
+        read_lines(file, lines, current_line)
+      end
+    end
+
+    SHEBANG_REGEX = /\A#!/.freeze
+    def shebang?(line)
+      SHEBANG_REGEX.match?(line)
+    end
+
+    def read_lines(file, lines, current_line)
+      return lines unless current_line
+
+      set_encoding_based_on_magic_comment(file, current_line)
+      lines.concat([current_line], ensure_remove_undefs(file.readlines))
+    end
+
+    RUBY_FILE_ENCODING_MAGIC_COMMENT_REGEX = /\A#\s*(?:-\*-)?\s*(?:en)?coding:\s*(\S+)\s*(?:-\*-)?\s*\z/.freeze
+    def set_encoding_based_on_magic_comment(file, line)
+      # Check for encoding magic comment
+      # Encoding magic comment must be placed at first line except for shebang
+      if (match = RUBY_FILE_ENCODING_MAGIC_COMMENT_REGEX.match(line))
+        file.set_encoding(match[1], "UTF-8")
+      end
+    end
+
+    def ensure_remove_undefs(file_lines)
+      # invalid/undef replace are technically not really necessary but nice to
+      # have and work around a JRuby incompatibility. Also moved here from
+      # simplecov-html to have encoding shenaningans in one place. See #866
+      # also setting these option on `file.set_encoding` doesn't seem to work
+      # properly so it has to be done here.
+      file_lines.each { |line| line.encode!("UTF-8", invalid: :replace, undef: :replace) }
+    end
+
     def build_lines
       coverage_exceeding_source_warn if coverage_data["lines"].size > src.size
       lines = src.map.with_index(1) do |src, i|

data/lib/simplecov/useless_results_remover.rb

@@ -5,12 +5,14 @@ module SimpleCov
   # Select the files that related to working scope directory of SimpleCov
   #
   module UselessResultsRemover
-    ROOT_REGX = /\A#{Regexp.escape(SimpleCov.root + File::SEPARATOR)}/io.freeze
-
     def self.call(coverage_result)
       coverage_result.select do |path, _coverage|
-        path =~ ROOT_REGX
+        path =~ root_regx
       end
     end
+
+    def self.root_regx
+      @root_regx ||= /\A#{Regexp.escape(SimpleCov.root + File::SEPARATOR)}/i.freeze
+    end
   end
 end

data/lib/simplecov/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimpleCov
-  VERSION = "0.18.2"
+  VERSION = "0.19.0"
 end

data/lib/simplecov.rb

@@ -7,8 +7,8 @@ if defined?(JRUBY_VERSION) && defined?(JRuby)
 
   # @see https://github.com/jruby/jruby/issues/1196
   # @see https://github.com/metricfu/metric_fu/pull/226
-  # @see https://github.com/colszowka/simplecov/issues/420
-  # @see https://github.com/colszowka/simplecov/issues/86
+  # @see https://github.com/simplecov-ruby/simplecov/issues/420
+  # @see https://github.com/simplecov-ruby/simplecov/issues/86
   # @see https://jira.codehaus.org/browse/JRUBY-6106
 
   unless org.jruby.RubyInstanceConfig.FULL_TRACE_ENABLED
@@ -23,9 +23,12 @@ end
 #
 module SimpleCov
   class << self
-    attr_accessor :running
-    attr_accessor :pid
-    attr_reader :exit_exception
+    attr_accessor :running, :pid
+
+    # Basically, should we take care of at_exit behavior or something else?
+    # Used by the minitest plugin. See lib/minitest/simplecov_plugin.rb
+    attr_accessor :external_at_exit
+    alias external_at_exit? external_at_exit
 
     #
     # Sets up SimpleCov to run against your project.
@@ -47,6 +50,9 @@ module SimpleCov
     def start(profile = nil, &block)
       require "coverage"
       initial_setup(profile, &block)
+      require_relative "./simplecov/process" if SimpleCov.enabled_for_subprocesses?
+      make_parallel_tests_available
+
       @result = nil
       self.pid = Process.pid
 
@@ -79,13 +85,11 @@ module SimpleCov
 
       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
+        Result.from_hash(JSON.parse(File.read(filename)) || {})
       end
 
       # Use the ResultMerger to produce a single, merged result, ready to use.
-      @result = SimpleCov::ResultMerger.merge_and_store(*results)
+      @result = ResultMerger.merge_and_store(*results)
 
       run_exit_tasks!
     end
@@ -98,7 +102,6 @@ module SimpleCov
       return @result if result?
 
       # Collect our coverage result
-
       process_coverage_result if running
 
       # If we're using merging of results, store the current result
@@ -168,46 +171,71 @@ module SimpleCov
       @result = nil
     end
 
+    def at_exit_behavior
+      # If we are in a different process than called start, don't interfere.
+      return if SimpleCov.pid != Process.pid
+
+      # If SimpleCov is no longer running then don't run exit tasks
+      SimpleCov.run_exit_tasks! if SimpleCov.running
+    end
+
+    # @api private
     #
-    # Capture the current exception if it exists
-    # This will get called inside the at_exit block
+    # Called from at_exit block
     #
-    def set_exit_exception
-      @exit_exception = $ERROR_INFO
+    def run_exit_tasks!
+      error_exit_status = exit_status_from_exception
+
+      at_exit.call
+
+      exit_and_report_previous_error(error_exit_status) if previous_error?(error_exit_status)
+      process_results_and_report_error if ready_to_process_results?
     end
 
+    #
+    # @api private
     #
     # Returns the exit status from the exit exception
     #
     def exit_status_from_exception
-      return SimpleCov::ExitCodes::SUCCESS unless exit_exception
+      # Capture the current exception if it exists
+      @exit_exception = $ERROR_INFO
+      return nil unless @exit_exception
 
-      if exit_exception.is_a?(SystemExit)
-        exit_exception.status
+      if @exit_exception.is_a?(SystemExit)
+        @exit_exception.status
       else
         SimpleCov::ExitCodes::EXCEPTION
       end
     end
 
     # @api private
+    def previous_error?(error_exit_status)
+      # Normally it'd be enough to check for previous error but when running test_unit
+      # status is 0
+      error_exit_status && error_exit_status != SimpleCov::ExitCodes::SUCCESS
+    end
+
     #
-    # Called from at_exit block
+    # @api private
     #
-    def run_exit_tasks!
-      set_exit_exception
-
-      exit_status = SimpleCov.exit_status_from_exception
+    # Thinking: Move this behavior earlier so if there was an error we do nothing?
+    def exit_and_report_previous_error(exit_status)
+      warn("Stopped processing SimpleCov as a previous error not related to SimpleCov has been detected") if print_error_status
+      Kernel.exit(exit_status)
+    end
 
-      SimpleCov.at_exit.call
+    # @api private
+    def ready_to_process_results?
+      final_result_process? && result?
+    end
 
-      # Don't modify the exit status unless the result has already been
-      # computed
-      exit_status = SimpleCov.process_result(SimpleCov.result, exit_status) if SimpleCov.result?
+    def process_results_and_report_error
+      exit_status = process_result(result)
 
       # 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
+      if exit_status.positive?
+        warn("SimpleCov failed with exit #{exit_status} due to a coverage related error") if print_error_status
         Kernel.exit exit_status
       end
     end
@@ -217,55 +245,29 @@ module SimpleCov
     # Usage:
     #   exit_status = SimpleCov.process_result(SimpleCov.result, exit_status)
     #
-    def process_result(result, exit_status)
-      return exit_status if exit_status != SimpleCov::ExitCodes::SUCCESS # Existing errors
-
-      covered_percent = result.covered_percent.floor(2)
-      result_exit_status = result_exit_status(result, covered_percent)
-      write_last_run(covered_percent) if result_exit_status == SimpleCov::ExitCodes::SUCCESS # No result errors
-      final_result_process? ? result_exit_status : SimpleCov::ExitCodes::SUCCESS
+    def process_result(result)
+      result_exit_status = result_exit_status(result)
+      write_last_run(result) if result_exit_status == SimpleCov::ExitCodes::SUCCESS
+      result_exit_status
     end
 
     # @api private
-    #
-    # rubocop:disable Metrics/MethodLength
-    def result_exit_status(result, covered_percent)
-      covered_percentages = result.covered_percentages.map { |percentage| percentage.floor(2) }
-      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
-        )
-        SimpleCov::ExitCodes::MINIMUM_COVERAGE
-      elsif (last_run = SimpleCov::LastRun.read)
-        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
-          )
-          SimpleCov::ExitCodes::MAXIMUM_COVERAGE_DROP
-        else
-          SimpleCov::ExitCodes::SUCCESS
-        end
-      else
-        SimpleCov::ExitCodes::SUCCESS
-      end
+    CoverageLimits = Struct.new(:minimum_coverage, :minimum_coverage_by_file, :maximum_coverage_drop, keyword_init: true)
+    def result_exit_status(result)
+      coverage_limits = CoverageLimits.new(
+        minimum_coverage: minimum_coverage, minimum_coverage_by_file: minimum_coverage_by_file,
+        maximum_coverage_drop: maximum_coverage_drop
+      )
+
+      ExitCodes::ExitCodeHandling.call(result, coverage_limits: coverage_limits)
     end
-    # rubocop:enable Metrics/MethodLength
 
     #
     # @api private
     #
     def final_result_process?
-      # checking for ENV["TEST_ENV_NUMBER"] to determine if the tess are being run in parallel
-      !defined?(ParallelTests) || !ENV["TEST_ENV_NUMBER"] || ParallelTests.number_of_running_processes <= 1
+      # checking for ENV["TEST_ENV_NUMBER"] to determine if the tests are being run in parallel
+      !defined?(ParallelTests) || !ENV["TEST_ENV_NUMBER"] || ParallelTests.last_process?
     end
 
     #
@@ -280,8 +282,16 @@ module SimpleCov
     #
     # @api private
     #
-    def write_last_run(covered_percent)
-      SimpleCov::LastRun.write(result: {covered_percent: covered_percent})
+    def write_last_run(result)
+      SimpleCov::LastRun.write(result: {covered_percent: round_coverage(result.covered_percent)})
+    end
+
+    #
+    # @api private
+    #
+    # Rounding down to be extra strict, see #679
+    def round_coverage(coverage)
+      coverage.floor(2)
     end
 
   private
@@ -302,7 +312,7 @@ module SimpleCov
       # 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
-      # comment  https://github.com/colszowka/simplecov/pull/692#discussion_r281836176 :
+      # comment  https://github.com/simplecov-ruby/simplecov/pull/692#discussion_r281836176 :
       # Ruby < 2.5:
       # https://github.com/ruby/ruby/blob/v1_9_3_374/ext/coverage/coverage.c
       # traditional mode (Array)
@@ -406,61 +416,50 @@ module SimpleCov
       @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
+    # parallel_tests isn't always available, see: https://github.com/grosser/parallel_tests/issues/772
+    def make_parallel_tests_available
+      return if defined?(ParallelTests)
+      return unless probably_running_parallel_tests?
 
-      coverage_achieved.select do |achieved|
-        achieved.fetch(:actual) < achieved.fetch(:minimum_expected)
-      end
+      require "parallel_tests"
+    rescue LoadError
+      warn("SimpleCov guessed you were running inside parallel tests but couldn't load it. Please file a bug report with us!")
     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
+    def probably_running_parallel_tests?
+      ENV["TEST_ENV_NUMBER"] && ENV["PARALLEL_TEST_GROUPS"]
     end
   end
 end
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__)))
+# requires are down here here for a load order reason I'm not sure what it is about
 require "set"
 require "forwardable"
-require "simplecov/configuration"
+require_relative "simplecov/configuration"
 SimpleCov.extend SimpleCov::Configuration
-require "simplecov/coverage_statistics"
-require "simplecov/exit_codes"
-require "simplecov/profiles"
-require "simplecov/source_file/line"
-require "simplecov/source_file/branch"
-require "simplecov/source_file"
-require "simplecov/file_list"
-require "simplecov/result"
-require "simplecov/filter"
-require "simplecov/formatter"
-require "simplecov/last_run"
-require "simplecov/lines_classifier"
-require "simplecov/result_merger"
-require "simplecov/command_guesser"
-require "simplecov/version"
-require "simplecov/result_adapter"
-require "simplecov/combine"
-require "simplecov/combine/branches_combiner"
-require "simplecov/combine/files_combiner"
-require "simplecov/combine/lines_combiner"
-require "simplecov/combine/results_combiner"
-require "simplecov/useless_results_remover"
-require "simplecov/simulate_coverage"
+require_relative "simplecov/coverage_statistics"
+require_relative "simplecov/exit_codes"
+require_relative "simplecov/profiles"
+require_relative "simplecov/source_file/line"
+require_relative "simplecov/source_file/branch"
+require_relative "simplecov/source_file"
+require_relative "simplecov/file_list"
+require_relative "simplecov/result"
+require_relative "simplecov/filter"
+require_relative "simplecov/formatter"
+require_relative "simplecov/last_run"
+require_relative "simplecov/lines_classifier"
+require_relative "simplecov/result_merger"
+require_relative "simplecov/command_guesser"
+require_relative "simplecov/version"
+require_relative "simplecov/result_adapter"
+require_relative "simplecov/combine"
+require_relative "simplecov/combine/branches_combiner"
+require_relative "simplecov/combine/files_combiner"
+require_relative "simplecov/combine/lines_combiner"
+require_relative "simplecov/combine/results_combiner"
+require_relative "simplecov/useless_results_remover"
+require_relative "simplecov/simulate_coverage"
 
 # Load default config
-require "simplecov/defaults" unless ENV["SIMPLECOV_NO_DEFAULTS"]
+require_relative "simplecov/defaults" unless ENV["SIMPLECOV_NO_DEFAULTS"]

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: simplecov
 version: !ruby/object:Gem::Version
-  version: 0.18.2
+  version: 0.19.0
 platform: ruby
 authors:
 - Christoph Olszowka
+- Tobias Pfeiffer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-12 00:00:00.000000000 Z
+date: 2020-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -42,6 +43,7 @@ description: Code coverage for Ruby with a powerful configuration library and au
   merging of coverage across test suites
 email:
 - christoph at olszowka de
+- pragtob@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -55,6 +57,7 @@ files:
 - doc/alternate-formatters.md
 - doc/commercial-services.md
 - doc/editor-integration.md
+- lib/minitest/simplecov_plugin.rb
 - lib/simplecov.rb
 - lib/simplecov/combine.rb
 - lib/simplecov/combine/branches_combiner.rb
@@ -66,6 +69,10 @@ files:
 - lib/simplecov/coverage_statistics.rb
 - lib/simplecov/defaults.rb
 - lib/simplecov/exit_codes.rb
+- lib/simplecov/exit_codes/exit_code_handling.rb
+- lib/simplecov/exit_codes/maximum_coverage_drop_check.rb
+- lib/simplecov/exit_codes/minimum_coverage_by_file_check.rb
+- lib/simplecov/exit_codes/minimum_overall_coverage_check.rb
 - lib/simplecov/file_list.rb
 - lib/simplecov/filter.rb
 - lib/simplecov/formatter.rb
@@ -75,6 +82,7 @@ files:
 - lib/simplecov/lines_classifier.rb
 - lib/simplecov/load_global_config.rb
 - lib/simplecov/no_defaults.rb
+- lib/simplecov/process.rb
 - lib/simplecov/profiles.rb
 - lib/simplecov/profiles/bundler_filter.rb
 - lib/simplecov/profiles/hidden_filter.rb
@@ -90,15 +98,15 @@ files:
 - lib/simplecov/source_file/line.rb
 - lib/simplecov/useless_results_remover.rb
 - lib/simplecov/version.rb
-homepage: https://github.com/colszowka/simplecov
+homepage: https://github.com/simplecov-ruby/simplecov
 licenses:
 - MIT
 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.2
+  bug_tracker_uri: https://github.com/simplecov-ruby/simplecov/issues
+  changelog_uri: https://github.com/simplecov-ruby/simplecov/blob/main/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/simplecov/0.19.0
   mailing_list_uri: https://groups.google.com/forum/#!forum/simplecov
-  source_code_uri: https://github.com/colszowka/simplecov/tree/v0.18.2
+  source_code_uri: https://github.com/simplecov-ruby/simplecov/tree/v0.19.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -107,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="