simplecov 0.15.1 → 0.18.0

data/lib/simplecov/defaults.rb

@@ -1,48 +1,19 @@
+# frozen_string_literal: true
+
 # Load default formatter gem
 require "simplecov-html"
 require "pathname"
-
-SimpleCov.profiles.define "root_filter" do
-  # Exclude all files outside of simplecov root
-  root_filter = nil
-  add_filter do |src|
-    root_filter ||= /\A#{Regexp.escape(SimpleCov.root + File::SEPARATOR)}/io
-    src.filename !~ root_filter
-  end
-end
-
-SimpleCov.profiles.define "test_frameworks" do
-  add_filter "/test/"
-  add_filter "/features/"
-  add_filter "/spec/"
-  add_filter "/autotest/"
-end
-
-SimpleCov.profiles.define "bundler_filter" do
-  add_filter "/vendor/bundle/"
-end
-
-SimpleCov.profiles.define "rails" do
-  load_profile "test_frameworks"
-
-  add_filter %r{^/config/}
-  add_filter %r{^/db/}
-
-  add_group "Controllers", "app/controllers"
-  add_group "Channels", "app/channels" if defined?(ActionCable)
-  add_group "Models", "app/models"
-  add_group "Mailers", "app/mailers"
-  add_group "Helpers", "app/helpers"
-  add_group "Jobs", %w[app/jobs app/workers]
-  add_group "Libraries", "lib"
-
-  track_files "{app,lib}/**/*.rb"
-end
+require "simplecov/profiles/root_filter"
+require "simplecov/profiles/test_frameworks"
+require "simplecov/profiles/bundler_filter"
+require "simplecov/profiles/hidden_filter"
+require "simplecov/profiles/rails"
 
 # Default configuration
 SimpleCov.configure do
   formatter SimpleCov::Formatter::HTMLFormatter
   load_profile "bundler_filter"
+  load_profile "hidden_filter"
   # Exclude files outside of SimpleCov.root
   load_profile "root_filter"
 end
@@ -50,52 +21,14 @@ end
 # Gotta stash this a-s-a-p, see the CommandGuesser class and i.e. #110 for further info
 SimpleCov::CommandGuesser.original_run_command = "#{$PROGRAM_NAME} #{ARGV.join(' ')}"
 
-at_exit do # rubocop:disable Metrics/BlockLength
+at_exit do
   # If we are in a different process than called start, don't interfere.
   next if SimpleCov.pid != Process.pid
 
-  @exit_status = if $! # was an exception thrown?
-                   # if it was a SystemExit, use the accompanying status
-                   # otherwise set a non-zero status representing termination by
-                   # some other exception (see github issue 41)
-                   $!.is_a?(SystemExit) ? $!.status : SimpleCov::ExitCodes::EXCEPTION
-                 else
-                   # Store the exit status of the test run since it goes away
-                   # after calling the at_exit proc...
-                   SimpleCov::ExitCodes::SUCCESS
-                 end
-
-  SimpleCov.at_exit.call
-
-  if SimpleCov.result? # Result has been computed
-    covered_percent = SimpleCov.result.covered_percent.round(2)
-    covered_percentages = SimpleCov.result.covered_percentages.map { |p| p.round(2) }
-
-    if @exit_status == SimpleCov::ExitCodes::SUCCESS # No other errors
-      if covered_percent < SimpleCov.minimum_coverage # rubocop:disable Metrics/BlockNesting
-        $stderr.printf("Coverage (%.2f%%) is below the expected minimum coverage (%.2f%%).\n", covered_percent, SimpleCov.minimum_coverage)
-        @exit_status = SimpleCov::ExitCodes::MINIMUM_COVERAGE
-      elsif covered_percentages.any? { |p| p < SimpleCov.minimum_coverage_by_file } # rubocop:disable Metrics/BlockNesting
-        $stderr.printf("File (%s) is only (%.2f%%) covered. This is below the expected minimum coverage per file of (%.2f%%).\n", SimpleCov.result.least_covered_file, covered_percentages.min, SimpleCov.minimum_coverage_by_file)
-        @exit_status = SimpleCov::ExitCodes::MINIMUM_COVERAGE
-      elsif (last_run = SimpleCov::LastRun.read) # rubocop:disable Metrics/BlockNesting
-        coverage_diff = last_run["result"]["covered_percent"] - covered_percent
-        if coverage_diff > SimpleCov.maximum_coverage_drop # rubocop:disable Metrics/BlockNesting
-          $stderr.printf("Coverage has dropped by %.2f%% since the last time (maximum allowed: %.2f%%).\n", coverage_diff, SimpleCov.maximum_coverage_drop)
-          @exit_status = SimpleCov::ExitCodes::MAXIMUM_COVERAGE_DROP
-        end
-      end
-    end
-
-    # Don't overwrite last_run file if refuse_coverage_drop option is enabled and the coverage has dropped
-    unless @exit_status == SimpleCov::ExitCodes::MAXIMUM_COVERAGE_DROP
-      SimpleCov::LastRun.write(:result => {:covered_percent => covered_percent})
-    end
-  end
+  # If SimpleCov is no longer running then don't run exit tasks
+  next unless SimpleCov.running
 
-  # Force exit with stored status (see github issue #5)
-  # unless it's nil or 0 (see github issue #281)
-  Kernel.exit @exit_status if @exit_status && @exit_status > 0
+  SimpleCov.run_exit_tasks!
 end
 
 # Autoload config from ~/.simplecov if present
@@ -111,7 +44,7 @@ loop do
     begin
       load filename
     rescue LoadError, StandardError
-      $stderr.puts "Warning: Error occurred while trying to load #{filename}. " \
+      warn "Warning: Error occurred while trying to load #{filename}. " \
         "Error message: #{$!.message}"
     end
     break

data/lib/simplecov/exit_codes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleCov
   module ExitCodes
     SUCCESS = 0

data/lib/simplecov/file_list.rb

@@ -1,28 +1,53 @@
-# An array of SimpleCov SourceFile instances with additional collection helper
-# methods for calculating coverage across them etc.
+# frozen_string_literal: true
+
 module SimpleCov
-  class FileList < Array
+  # An array of SimpleCov SourceFile instances with additional collection helper
+  # methods for calculating coverage across them etc.
+  class FileList
+    include Enumerable
+    extend Forwardable
+
+    def_delegators :@files,
+                   # For Enumerable
+                   :each,
+                   # also delegating methods implemented in Enumerable as they have
+                   # custom Array implementations which are presumably better/more
+                   # resource efficient
+                   :size, :map, :count,
+                   # surprisingly not in Enumerable
+                   :empty?, :length,
+                   # still act like we're kinda an array
+                   :to_a, :to_ary
+
+    def initialize(files)
+      @files = files
+    end
+
+    def coverage_statistics
+      @coverage_statistics ||= compute_coverage_statistics
+    end
+
     # Returns the count of lines that have coverage
     def covered_lines
-      return 0.0 if empty?
-      map { |f| f.covered_lines.count }.inject(:+)
+      coverage_statistics[:line]&.covered
     end
 
     # Returns the count of lines that have been missed
     def missed_lines
-      return 0.0 if empty?
-      map { |f| f.missed_lines.count }.inject(:+)
+      coverage_statistics[:line]&.missed
     end
 
     # Returns the count of lines that are not relevant for coverage
     def never_lines
       return 0.0 if empty?
+
       map { |f| f.never_lines.count }.inject(:+)
     end
 
     # Returns the count of skipped lines
     def skipped_lines
       return 0.0 if empty?
+
       map { |f| f.skipped_lines.count }.inject(:+)
     end
 
@@ -34,26 +59,56 @@ module SimpleCov
 
     # Finds the least covered file and returns that file's name
     def least_covered_file
-      sort_by(&:covered_percent).first.filename
+      min_by(&:covered_percent).filename
     end
 
     # Returns the overall amount of relevant lines of code across all files in this list
     def lines_of_code
-      covered_lines + missed_lines
+      coverage_statistics[:line]&.total
     end
 
     # Computes the coverage based upon lines covered and lines missed
     # @return [Float]
     def covered_percent
-      return 100.0 if empty? || lines_of_code.zero?
-      Float(covered_lines * 100.0 / lines_of_code)
+      coverage_statistics[:line]&.percent
     end
 
     # Computes the strength (hits / line) based upon lines covered and lines missed
     # @return [Float]
     def covered_strength
-      return 0.0 if empty? || lines_of_code.zero?
-      Float(map { |f| f.covered_strength * f.lines_of_code }.inject(:+) / lines_of_code)
+      coverage_statistics[:line]&.strength
+    end
+
+    # Return total count of branches in all files
+    def total_branches
+      coverage_statistics[:branch]&.total
+    end
+
+    # Return total count of covered branches
+    def covered_branches
+      coverage_statistics[:branch]&.covered
+    end
+
+    # Return total count of covered branches
+    def missed_branches
+      coverage_statistics[:branch]&.missed
+    end
+
+    def branch_covered_percent
+      coverage_statistics[:branch]&.percent
+    end
+
+  private
+
+    def compute_coverage_statistics
+      total_coverage_statistics = @files.each_with_object(line: [], branch: []) do |file, together|
+        together[:line] << file.coverage_statistics[:line]
+        together[:branch] << file.coverage_statistics[:branch] if SimpleCov.branch_coverage?
+      end
+
+      coverage_statistics = {line: CoverageStatistics.from(total_coverage_statistics[:line])}
+      coverage_statistics[:branch] = CoverageStatistics.from(total_coverage_statistics[:branch]) if SimpleCov.branch_coverage?
+      coverage_statistics
     end
   end
 end

data/lib/simplecov/filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleCov
   #
   # Base filter class. Inherit from this to create custom filters,
@@ -16,7 +18,7 @@ module SimpleCov
       @filter_argument = filter_argument
     end
 
-    def matches?(_)
+    def matches?(_source_file)
       raise "The base filter class is not intended for direct use"
     end
 
@@ -27,6 +29,7 @@ module SimpleCov
 
     def self.build_filter(filter_argument)
       return filter_argument if filter_argument.is_a?(SimpleCov::Filter)
+
       class_for_argument(filter_argument).new(filter_argument)
     end
 
@@ -49,7 +52,7 @@ module SimpleCov
     # Returns true when the given source file's filename matches the
     # string configured when initializing this Filter with StringFilter.new('somestring)
     def matches?(source_file)
-      (source_file.project_filename =~ /#{filter_argument}/)
+      source_file.project_filename.include?(filter_argument)
     end
   end
 

data/lib/simplecov/formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleCov
   # TODO: Documentation on how to build your own formatters
   module Formatter

data/lib/simplecov/formatter/multi_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleCov
   module Formatter
     class MultiFormatter
@@ -6,8 +8,8 @@ module SimpleCov
           formatters.map do |formatter|
             begin
               formatter.new.format(result)
-            rescue => e
-              STDERR.puts("Formatter #{formatter} failed with #{e.class}: #{e.message} (#{e.backtrace.first})")
+            rescue StandardError => e
+              warn("Formatter #{formatter} failed with #{e.class}: #{e.message} (#{e.backtrace.first})")
               nil
             end
           end

data/lib/simplecov/formatter/simple_formatter.rb

@@ -1,12 +1,14 @@
-#
-# A ridiculously simple formatter for SimpleCov results.
-#
+# frozen_string_literal: true
+
 module SimpleCov
   module Formatter
+    #
+    # A ridiculously simple formatter for SimpleCov results.
+    #
     class SimpleFormatter
       # Takes a SimpleCov::Result and generates a string out of it
       def format(result)
-        output = "".dup
+        output = +""
         result.groups.each do |name, files|
           output << "Group: #{name}\n"
           output << "=" * 40

data/lib/simplecov/last_run.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "json"
 
 module SimpleCov
@@ -9,9 +11,11 @@ module SimpleCov
 
       def read
         return nil unless File.exist?(last_run_path)
+
         json = File.read(last_run_path)
         return nil if json.strip.empty?
-        JSON.parse(json)
+
+        JSON.parse(json, symbolize_names: true)
       end
 
       def write(json)

data/lib/simplecov/lines_classifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleCov
   # Classifies whether lines are relevant for code coverage analysis.
   # Comments & whitespace lines, and :nocov: token blocks, are considered not relevant.
@@ -6,22 +8,36 @@ module SimpleCov
     RELEVANT = 0
     NOT_RELEVANT = nil
 
-    WHITESPACE_LINE = /^\s*$/
-    COMMENT_LINE = /^\s*#/
+    WHITESPACE_LINE = /^\s*$/.freeze
+    COMMENT_LINE = /^\s*#/.freeze
     WHITESPACE_OR_COMMENT_LINE = Regexp.union(WHITESPACE_LINE, COMMENT_LINE)
 
     def self.no_cov_line
-      /^(\s*)#(\s*)(\:#{SimpleCov.nocov_token}\:)/
+      /^(\s*)#(\s*)(\:#{SimpleCov.nocov_token}\:)/o
+    end
+
+    def self.no_cov_line?(line)
+      line =~ no_cov_line
+    rescue ArgumentError
+      # E.g., line contains an invalid byte sequence in UTF-8
+      false
+    end
+
+    def self.whitespace_line?(line)
+      line =~ WHITESPACE_OR_COMMENT_LINE
+    rescue ArgumentError
+      # E.g., line contains an invalid byte sequence in UTF-8
+      false
     end
 
     def classify(lines)
       skipping = false
 
       lines.map do |line|
-        if line =~ self.class.no_cov_line
+        if self.class.no_cov_line?(line)
           skipping = !skipping
           NOT_RELEVANT
-        elsif skipping || line =~ WHITESPACE_OR_COMMENT_LINE
+        elsif skipping || self.class.whitespace_line?(line)
           NOT_RELEVANT
         else
           RELEVANT

data/lib/simplecov/load_global_config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "etc"
 home_dir = (ENV["HOME"] && File.expand_path("~")) || Etc.getpwuid.dir || (ENV["USER"] && File.expand_path("~#{ENV['USER']}"))
 if home_dir

data/lib/simplecov/no_defaults.rb

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

data/lib/simplecov/profiles.rb

@@ -1,11 +1,13 @@
-#
-# Profiles are SimpleCov configuration procs that can be easily
-# loaded using SimpleCov.start :rails and defined using
-#   SimpleCov.profiles.define :foo do
-#     # SimpleCov configuration here, same as in  SimpleCov.configure
-#   end
-#
+# frozen_string_literal: true
+
 module SimpleCov
+  #
+  # Profiles are SimpleCov configuration procs that can be easily
+  # loaded using SimpleCov.start :rails and defined using
+  #   SimpleCov.profiles.define :foo do
+  #     # SimpleCov configuration here, same as in  SimpleCov.configure
+  #   end
+  #
   class Profiles < Hash
     #
     # Define a SimpleCov profile:
@@ -16,6 +18,7 @@ module SimpleCov
     def define(name, &blk)
       name = name.to_sym
       raise "SimpleCov Profile '#{name}' is already defined" unless self[name].nil?
+
       self[name] = blk
     end
 
@@ -25,6 +28,7 @@ module SimpleCov
     def load(name)
       name = name.to_sym
       raise "Could not find SimpleCov Profile called '#{name}'" unless key?(name)
+
       SimpleCov.configure(&self[name])
     end
   end

data/lib/simplecov/profiles/bundler_filter.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+SimpleCov.profiles.define "bundler_filter" do
+  add_filter "/vendor/bundle/"
+end