simplecov 0.6.0 → 0.22.0

data/doc/alternate-formatters.md

@@ -0,0 +1,71 @@
+## Alternate coverage report formatters
+
+The community around simplecov provides a whole bunch of alternate formatters beyond the official
+[simplecov-html](https://github.com/simplecov-ruby/simplecov-html) gem.
+
+If you have built or found one that is missing here, please send a Pull Request for this document!
+
+#### [simplecov-badge](https://github.com/matthew342/simplecov-badge)
+*by Matt Hale*
+
+A formatter that generates a coverage badge for use in your project's readme using ImageMagick.
+
+#### [simplecov-small-badge](https://github.com/marcgrimme/simplecov-small-badge)
+*by Marc Grimme*
+
+A formatter that generates a small coverage badge for use in your project's readme using the SVG.
+
+#### [simplecov_badger](https://github.com/traels-it/simplecov_badger)
+*by traels.it*
+
+A formatter that uploads your coverage to a server, that will then host a SVG badge of the score. No need to have the badge stored in repository.
+
+#### [simplecov-cobertura](https://github.com/dashingrocket/simplecov-cobertura)
+*by Jesse Bowes*
+
+A formatter that generates Cobertura XML.
+
+#### [simplecov-csv](https://github.com/fguillen/simplecov-csv)
+*by Fernando Guillen*
+
+CSV formatter for SimpleCov
+
+#### [simplecov-erb](https://github.com/kpaulisse/simplecov-erb)
+*by [Kevin Paulisse](https://github.com/kpaulisse)*
+
+Flexible formatter that generates the output from an ERB template.
+
+#### [simplecov-json](https://github.com/vicentllongo/simplecov-json)
+*by Vicent Llongo*
+
+JSON formatter for SimpleCov
+
+#### [simplecov-lcov](https://github.com/fortissimo1997/simplecov-lcov)
+*by fortissimo1997*
+
+lcov formatter for SimpleCov
+
+#### [simplecov-rcov](https://github.com/fguillen/simplecov-rcov)
+*by Fernando Guillen*
+
+"The target of this formatter is to cheat on Hudson so I can use the Ruby metrics plugin with SimpleCov."
+
+#### [simplecov-single_file_reporter](https://github.com/grosser/simplecov-single_file_reporter)
+*by [Michael Grosser](http://grosser.it)*
+
+A formatter that prints the coverage of the file under test when you run a single test file.
+
+#### [simplecov-t_wada](https://github.com/ysksn/simplecov-t_wada)
+*by [Yosuke Kabuto](https://github.com/ysksn)*
+
+t_wada AA formatter for SimpleCov
+
+#### [simplecov-tailwindcss](https://github.com/chiefpansancolt/simplecov-tailwindcss)
+*by [Chiefpansancolt](https://github.com/chiefpansancolt)*
+
+A TailwindCSS & TailwindUI Designed HTML formatter with clean and easy search of files with a tabular left Navigation.
+
+#### [simplecov-material](https://github.com/chiefpansancolt/simplecov-material)
+*by [Chiefpansancolt](https://github.com/chiefpansancolt)*
+
+A Material Designed HTML formatter with clean and easy search of files with a tabular left Navigation.

data/doc/commercial-services.md

@@ -0,0 +1,25 @@
+## Commercial Services with SimpleCov integration
+
+There is a bunch of services that offer integration with your existing CI pipeline and SimpleCov coverage
+reports. Please note these are not associated with the SimpleCov project itself, so please report problems with
+these integrations with their respective owners.
+
+#### [Codacy](https://github.com/codacy/codacy-coverage-reporter)
+*by [Codacy](https://www.codacy.com/)*
+
+Upload coverage reports to [codacy.com](https://www.codacy.com/), a hosted (or self-hosted) software quality analysis platform that also includes coverage reporting.
+
+#### [codeclimate](https://github.com/codeclimate/ruby-test-reporter)
+*by [Code Climate](https://codeclimate.com/)*
+
+Upload coverage reports to [codeclimate.com](https://codeclimate.com/), a hosted software quality analysis and that also includes coverage reporting.
+
+#### [codecov](https://github.com/codecov/codecov-ruby)
+*by [Codecov](https://codecov.io/)*
+
+Upload coverage reports to [codecov.io](https://codecov.io/), a hosted coverage reporting solution.
+
+#### [coveralls](https://github.com/lemurheavy/coveralls-ruby)
+*by [Coveralls](https://coveralls.io/)*
+
+Upload coverage reports to [coveralls.io](https://coveralls.io/), a hosted coverage reporting solution.

data/doc/editor-integration.md

@@ -0,0 +1,18 @@
+## Editor integration
+
+Some editors have a graphical integration for the simplecov gem.
+
+#### [Atom Editor: coverage](https://atom.io/packages/coverage)
+*by Philip Giuliani*
+
+Adds an overview of your current test coverage to Atom.
+
+#### [Sublime Editor: Simple​Cov](https://packagecontrol.io/packages/SimpleCov)
+*by sentience*
+
+Adds in editor live coverage highlighting, status bar coverage information, and summary coverage information.
+
+#### [cadre](https://github.com/nyarly/cadre)
+*by Judson Lester*
+
+Includes a formatter for Simplecov that emits a Vim script to mark up code files with coverage information.

data/lib/minitest/simplecov_plugin.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# How minitest plugins. See https://github.com/simplecov-ruby/simplecov/pull/756 for why we need this.
+# https://github.com/seattlerb/minitest#writing-extensions
+module Minitest
+  def self.plugin_simplecov_init(_options)
+    if defined?(SimpleCov)
+      SimpleCov.external_at_exit = true
+
+      Minitest.after_run do
+        SimpleCov.at_exit_behavior
+      end
+    end
+  end
+end

data/lib/simplecov/combine/branches_combiner.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  module Combine
+    #
+    # Combine different branch coverage results on single file.
+    #
+    # Should be called through `SimpleCov.combine`.
+    module BranchesCombiner
+    module_function
+
+      #
+      # Return merged branches or the existed brach if other is missing.
+      #
+      # Branches inside files are always same if they exist, the difference only in coverage count.
+      # Branch coverage report for any conditional case is built from hash, it's key is a condition and
+      # it's body is a hash << keys from condition and value is coverage rate >>.
+      # ex: branches =>{ [:if, 3, 8, 6, 8, 36] => {[:then, 4, 8, 6, 8, 12] => 1, [:else, 5, 8, 6, 8, 36]=>2}, other conditions...}
+      # We create copy of result and update it values depending on the combined branches coverage values.
+      #
+      # @return [Hash]
+      #
+      def combine(coverage_a, coverage_b)
+        coverage_a.merge(coverage_b) do |_condition, branches_inside_a, branches_inside_b|
+          branches_inside_a.merge(branches_inside_b) do |_branch, a_count, b_count|
+            a_count + b_count
+          end
+        end
+      end
+    end
+  end
+end

data/lib/simplecov/combine/files_combiner.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  module Combine
+    #
+    # Handle combining two coverage results for same file
+    #
+    # Should be called through `SimpleCov.combine`.
+    module FilesCombiner
+    module_function
+
+      #
+      # Combines the results for 2 coverages of a file.
+      #
+      # @return [Hash]
+      #
+      def combine(coverage_a, coverage_b)
+        combination = {"lines" => Combine.combine(LinesCombiner, coverage_a["lines"], coverage_b["lines"])}
+        combination["branches"] = Combine.combine(BranchesCombiner, coverage_a["branches"], coverage_b["branches"]) if SimpleCov.branch_coverage?
+        combination
+      end
+    end
+  end
+end

data/lib/simplecov/combine/lines_combiner.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  module Combine
+    #
+    # Combine two different lines coverage results on same file
+    #
+    # Should be called through `SimpleCov.combine`.
+    module LinesCombiner
+    module_function
+
+      def combine(coverage_a, coverage_b)
+        coverage_a
+          .zip(coverage_b)
+          .map do |coverage_a_val, coverage_b_val|
+            merge_line_coverage(coverage_a_val, coverage_b_val)
+          end
+      end
+
+      # Return depends on coverage in a specific line
+      #
+      # @param [Integer || nil] first_val
+      # @param [Integer || nil] second_val
+      #
+      # Logic:
+      #
+      # => nil + 0 = nil
+      # => nil + nil = nil
+      # => int + int = int
+      #
+      # @return [Integer || nil]
+      def merge_line_coverage(first_val, second_val)
+        sum = first_val.to_i + second_val.to_i
+
+        if sum.zero? && (first_val.nil? || second_val.nil?)
+          nil
+        else
+          sum
+        end
+      end
+    end
+  end
+end

data/lib/simplecov/combine/results_combiner.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  module Combine
+    # There might be reports from different kinds of tests,
+    # e.g. RSpec and Cucumber. We need to combine their results
+    # into unified one. This class does that.
+    # To unite the results on file basis, it leverages
+    # the combine of lines and branches inside each file within given results.
+    module ResultsCombiner
+    module_function
+
+      #
+      # Combine process explanation
+      # => ResultCombiner: define all present files between results and start combine on file level.
+      # ==> FileCombiner: collect result of next combine levels lines and branches.
+      # ===> LinesCombiner: combine lines results.
+      # ===> BranchesCombiner: combine branches results.
+      #
+      # @return [Hash]
+      #
+      def combine(*results)
+        results.reduce({}) do |combined_results, next_result|
+          combine_result_sets(combined_results, next_result)
+        end
+      end
+
+      #
+      # Manage combining results on files level
+      #
+      # @param [Hash] combined_results
+      # @param [Hash] result
+      #
+      # @return [Hash]
+      #
+      def combine_result_sets(combined_results, result)
+        results_files = combined_results.keys | result.keys
+
+        results_files.each_with_object({}) do |file_name, file_combination|
+          file_combination[file_name] = combine_file_coverage(
+            combined_results[file_name],
+            result[file_name]
+          )
+        end
+      end
+
+      #
+      # Combine two files coverage results
+      #
+      # @param [Hash] coverage_a
+      # @param [Hash] coverage_b
+      #
+      # @return [Hash]
+      #
+      def combine_file_coverage(coverage_a, coverage_b)
+        Combine.combine(Combine::FilesCombiner, coverage_a, coverage_b)
+      end
+    end
+  end
+end

data/lib/simplecov/combine.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  # Functionally for combining coverage results
+  #
+  module Combine
+  module_function
+
+    #
+    # Combine two coverage based on the given combiner_module.
+    #
+    # Combiners should always be called through this interface,
+    # as it takes care of short-circuiting of one of the coverages is nil.
+    #
+    # @return [Hash]
+    def combine(combiner_module, coverage_a, coverage_b)
+      return existing_coverage(coverage_a, coverage_b) if empty_coverage?(coverage_a, coverage_b)
+
+      combiner_module.combine(coverage_a, coverage_b)
+    end
+
+    def empty_coverage?(coverage_a, coverage_b)
+      !(coverage_a && coverage_b)
+    end
+
+    def existing_coverage(coverage_a, coverage_b)
+      coverage_a || coverage_b
+    end
+  end
+end

data/lib/simplecov/command_guesser.rb

@@ -1,49 +1,64 @@
-#
-# Helper that tries to find out what test suite is running (for SimpleCov.command_name)
-#
-module SimpleCov::CommandGuesser
-  class << self
-    # Storage for the original command line call that invoked the test suite.
-    # This has got to be stored as early as possible because i.e. rake and test/unit 2
-    # have a habit of tampering with ARGV, which makes i.e. the automatic distinction
-    # between rails unit/functional/integration tests impossible without this cached
-    # item.
-    attr_accessor :original_run_command
-    
-    def guess
-      from_command_line_options || from_defined_constants
-    end
-    
+# frozen_string_literal: true
+
+module SimpleCov
+  #
+  # Helper that tries to find out what test suite is running (for SimpleCov.command_name)
+  #
+  module CommandGuesser
+    class << self
+      # Storage for the original command line call that invoked the test suite.
+      # This has got to be stored as early as possible because i.e. rake and test/unit 2
+      # have a habit of tampering with ARGV, which makes i.e. the automatic distinction
+      # between rails unit/functional/integration tests impossible without this cached
+      # item.
+      attr_accessor :original_run_command
+
+      def guess
+        from_env || from_command_line_options || from_defined_constants
+      end
+
     private
-    
-    def from_command_line_options
-      case original_run_command
-        when /#{'test/functional/'}/
+
+      def from_env
+        # If being run from inside parallel_tests set the command name according to the process number
+        return unless ENV["PARALLEL_TEST_GROUPS"] && ENV["TEST_ENV_NUMBER"]
+
+        number = ENV["TEST_ENV_NUMBER"]
+        number = "1" if number.empty?
+        "(#{number}/#{ENV['PARALLEL_TEST_GROUPS']})"
+      end
+
+      def from_command_line_options
+        case original_run_command
+        when /test\/functional\//, /test\/\{.*functional.*\}\//
           "Functional Tests"
-        when /#{'test/integration/'}/
+        when /test\/integration\//
           "Integration Tests"
-        when /#{'test/'}/
+        when /test\//
           "Unit Tests"
+        when /spec/
+          "RSpec"
         when /cucumber/, /features/
           "Cucumber Features"
-        when /spec/
+        end
+      end
+
+      def from_defined_constants
+        # If the command regexps fail, let's try checking defined constants.
+        if defined?(RSpec)
           "RSpec"
+        elsif defined?(Test::Unit)
+          "Unit Tests"
+        elsif defined?(Minitest)
+          "Minitest"
+        elsif defined?(MiniTest)
+          "MiniTest"
         else
-          nil
-      end
-    end
-  
-    def from_defined_constants
-      # If the command regexps fail, let's try checking defined constants.
-      if defined?(RSpec)
-        "RSpec"
-      elsif defined?(Test::Unit)
-        "Unit Tests"
-      else
-        # TODO: Provide link to docs/wiki article
-        warn "SimpleCov failed to recognize the test framework and/or suite used. Please specify manually using SimpleCov.command_name 'Unit Tests'."
-        'Unknown Test Framework'
+          # TODO: Provide link to docs/wiki article
+          warn "SimpleCov failed to recognize the test framework and/or suite used. Please specify manually using SimpleCov.command_name 'Unit Tests'."
+          "Unknown Test Framework"
+        end
       end
     end
   end
-end
+end