simplecov 0.15.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: f8f001c1d4f9343c21eee5371b68f31a56caf35b752a08a662115418176a6156
-  data.tar.gz: 519eaaee340436685bc0c31a61d9fc1356072e1d39d573bce8049afe79332252
+SHA1:
+  metadata.gz: 47d20d0dc990b18c8ac6bcc24755bb66521230c3
+  data.tar.gz: 22c23ddd73f1052aa525905f82f7545f63207ee7
 SHA512:
-  metadata.gz: 94a6c0d8f0245befdf662d339bae1b2e0d4a077d3591764f9c215f06453f9e86a40127d3fe5f7488875c470caf8743d19307352e72eaff6f5dfc2c657a828622
-  data.tar.gz: eb674773b777504acba00508c7cc62f2e0f1451fb26d1a06463a822130e2cceeda4a8aba964569579becd62b7951f5968dbdd351549143cc81a69e1628923cad
+  metadata.gz: 320807d6f5176f76cb38f7fcbc6eb1e59b2e0cffcd4eb28bcf804f0eaf824b5a44926345f0516ae40a091ec866ad8e8aff43aed8536b5812bffabe5b6d2bc005
+  data.tar.gz: cf2c3e9a80d843f3970b3a0ac9ab5e21e81a18ea1ae306cebe74bc7f77bf6263115a1b6405547d26f608a574ab7a8d1da901d9d9a8524edee0e5a19241cd932d

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+0.16.0 (2018-03-15)
+==========
+
+## Enhancements
+
+* Relax version constraint on `docile`, per SemVer
+* exception that occurred on exit is available as `exit_exception`! See [#639](https://github.com/colszowka/simplecov/pull/639)  (thanks @thomas07vt)
+* Performance: processing results now runs from 2.5x to 3.75x faster. See [#662](https://github.com/colszowka/simplecov/pull/662) (thanks @BMorearty & @eregon)
+* Decrease gem size by only shipping lib and docs
+
+## Bugfixes
+
+* (breaking) Stop handling string filters as regular expressions, use the dedicated regex filter if you need that behaviour. See [#616](https://github.com/colszowka/simplecov/pull/616) (thanks @yujinakayama)
+* Avoid overwriting the last coverage results on unsuccessful test runs. See [#625](https://github.com/colszowka/simplecov/pull/625) (thanks @thomas07vt)
+* Don't crash on invalid UTF-8 byte sequences. (thanks @BMorearty)
+
 0.15.1 (2017-09-11) ([changes](https://github.com/colszowka/simplecov/compare/v0.15.0...v0.15.1))
 =======
 
@@ -16,7 +32,7 @@
 ## Bugfixes
 
 * Fix merging race condition when running tests in parallel and merging them. See [#570](https://github.com/colszowka/simplecov/pull/570) (thanks @jenseng)
-* Fix relevant lines for unloaded files - comments, skipped code etc. are correctly classigied as irrelevant. See [#605](https://github.com/colszowka/simplecov/pull/605) (thanks @odlp)
+* Fix relevant lines for unloaded files - comments, skipped code etc. are correctly classified as irrelevant. See [#605](https://github.com/colszowka/simplecov/pull/605) (thanks @odlp)
 * Allow using simplecov with frozen-string-literals enabled. See [#590](https://github.com/colszowka/simplecov/pull/590) (thanks @pat)
 * Make sure Array Filter can use all other filter types. See [#589](https://github.com/colszowka/simplecov/pull/589) (thanks @jsteel)
 * Make sure file names use `Simplecov.root` as base avoiding using full absolute project paths. See [#589](https://github.com/colszowka/simplecov/pull/589) (thanks @jsteel)

data/CONTRIBUTING.md

@@ -2,19 +2,21 @@
 
 You can report issues at https://github.com/colszowka/simplecov/issues
 
-Search existing issues for your problem, chances are someone else already reported it.
+Before you go ahead please search existing issues for your problem, chances are someone else already reported it.
 
+To make sure that we can help you quickly please include and check the following information:
+
+ * Include how you run your tests and which testing framework or frameworks you are running.
+    - please ensure you are requiring and starting SimpleCov before requiring any application code.
+    - If running via rake, please ensure you are requiring SimpleCov at the top of your Rakefile
+      For example, if running via RSpec, this would be at the top of your spec_helper.
+    - Have you tried using a [`.simplecov` file](https://github.com/colszowka/simplecov#using-simplecov-for-centralized-config)?
  * Include the SimpleCov version you are running in your report.
  * If you are not running the latest version (please check), and you cannot update it,
    please specify in your report why you can't update to the latest version.
  * Include your `ruby -e "puts RUBY_DESCRIPTION"`.
  * Please also specify the gem versions of Rails (if applicable).
  * Include any other coverage gems you may be using and their versions.
- * Include how you run your tests and which testing framework or frameworks you are running.
-    - If running via rake, please ensure you are requiring SimpleCov at the top of your Rakefile
-    - Otherwise, please ensure you are requiring and starting SimpleCov before requiring any application code.
-      For example, if running via RSpec, this would be at the top of your spec_helper.
-    - Have you tried using a [`.simplecov` file](https://github.com/colszowka/simplecov#using-simplecov-for-centralized-config)?
 
 Include as much sample code as you can to help us reproduce the issue. (Inline, repo link, or gist, are fine. A failing test would help the most.)
 
@@ -37,12 +39,13 @@ If you want to contribute, please:
   * Make your feature addition or bug fix.
   * Add tests for it. This is important so I don't break it in a future version unintentionally.
   * **Bonus Points** go out to anyone who also updates `CHANGELOG.md` :)
-  * Send me a pull request on Github.
+  * Send me a pull request on GitHub.
 
 ## Running Individual Tests
 
-This project uses Test::Unit. Individual tests can be run like this:
+This project uses RSpec and Cucumber. Individual tests can be run like this:
 
 ```bash
-ruby -I test path/to/test.rb
+bundle exec rspec path/to/test.rb
+bundle exec cucumber path/to/test.feature
 ```

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,23 @@
+Howdy! Thanks for reporting an issue <3
+
+Before you go ahead please search existing issues for your problem, chances are someone else already reported it.
+
+To make sure that we can help you quickly please include and check the following information:
+
+ * Include how you run your tests and which testing framework or frameworks you are running.
+    - please ensure you are requiring and starting SimpleCov before requiring any application code.
+    - If running via rake, please ensure you are requiring SimpleCov at the top of your Rakefile
+      For example, if running via RSpec, this would be at the top of your spec_helper.
+    - Have you tried using a [`.simplecov` file](https://github.com/colszowka/simplecov#using-simplecov-for-centralized-config)?
+ * Include the SimpleCov version you are running in your report.
+ * If you are not running the latest version (please check), and you cannot update it,
+   please specify in your report why you can't update to the latest version.
+ * Include your `ruby -e "puts RUBY_DESCRIPTION"`.
+ * Please also specify the gem versions of Rails (if applicable).
+ * Include any other coverage gems you may be using and their versions.
+
+Include as much sample code as you can to help us reproduce the issue. (Inline, repo link, or gist, are fine. A failing test would help the most.)
+
+This is extremely important for narrowing down the cause of your problem.
+
+Thanks!

data/README.md

@@ -28,7 +28,7 @@ etc. SimpleCov automatically takes care of this by caching and merging results w
 report actually includes coverage across your test suites and thereby gives you a better picture of blank spots.
 
 The official formatter of SimpleCov is packaged as a separate gem called [simplecov-html], but will be installed and configured
-automatically when you launch SimpleCov. If you're curious, you can find it [on Github, too][simplecov-html].
+automatically when you launch SimpleCov. If you're curious, you can find it [on GitHub, too][simplecov-html].
 
 
 ## Contact
@@ -47,10 +47,10 @@ Getting started
 1. Add SimpleCov to your `Gemfile` and `bundle install`:
 
     ```ruby
-    gem 'simplecov', :require => false, :group => :test
+    gem 'simplecov', require: false, group: :test
     ```
 2. Load and launch SimpleCov **at the very top** of your `test/test_helper.rb`
-   (*or `spec_helper.rb`, cucumber `env.rb`, or whatever your preferred test
+   (*or `spec_helper.rb`, `rails_helper`, cucumber `env.rb`, or whatever your preferred test
    framework uses*):
 
     ```ruby
@@ -246,7 +246,7 @@ If you use SimpleCov to merge multiple test suite results (e.g. Test/Unit and Cu
 set up all your config options twice, once in `test_helper.rb` and once in `env.rb`.
 
 To avoid this, you can place a file called `.simplecov` in your project root. You can then just leave the `require 'simplecov'` in each
-test setup helper and move the `SimpleCov.start` code with all your custom config options into `.simplecov`:
+test setup helper (**at the top**) and move the `SimpleCov.start` code with all your custom config options into `.simplecov`:
 
 ```ruby
 # test/test_helper.rb
@@ -260,6 +260,7 @@ SimpleCov.start 'rails' do
   # any custom configs like groups and filters can be here at a central place
 end
 ```
+
 Using `.simplecov` rather than separately requiring SimpleCov multiple times is recommended if you are merging multiple test frameworks like Cucumber and RSpec that rely on each other, as invoking SimpleCov multiple times can cause coverage information to be lost.
 
 ## Filters
@@ -619,7 +620,7 @@ Only Ruby 1.9+ ships with the coverage library that SimpleCov depends upon and t
 SimpleCov is also built against Ruby 1.8 in [Continuous Integration], but this happens only to ensure that SimpleCov
 does not make your test suite crash right now.
 
-SimpleCov is built in [Continuous Integration] on Ruby 1.9.3, 2.0.0, 2.1, 2.2, 2.3, 2.4 as well as JRuby 9.1.
+SimpleCov is built in [Continuous Integration] on Ruby 1.9.3, 2.0.0, 2.1, 2.2, 2.3, 2.4, 2.5 as well as JRuby 9.1.
 
 ## Want to find dead code in production?
 
@@ -632,14 +633,8 @@ If you're using [Spring](https://github.com/rails/spring) to speed up test suite
 1. Change the following settings in `test.rb`.
 
     ```ruby
-    # For Rails 4 or earlier, use the following configuration:
-    # Disable Rails's static asset server (Apache or nginx will already do this)
-    config.serve_static_files = false
-    config.eager_load = false
-
-    # For Rails 5, use the following configuration:
-    # Disable Rails's static asset server (Apache or nginx will already do this)
-    config.public_file_server.enabled = false
+    # For Rails
+    # Do not eager load code on boot
     config.eager_load = false
     ```
 2. Add your SimpleCov config, as you normally would, to your `spec_helper.rb`
@@ -655,7 +650,7 @@ If you're using [Spring](https://github.com/rails/spring) to speed up test suite
     ```
 3. Run `spring rspec <path>` as normal. Remember to run `spring stop` after
    making important changes to your app or its specs!
-   
+
 ## Want to use bootsnap with SimpleCov?
 
 As mentioned in [this issue](https://github.com/Shopify/bootsnap/issues/35) iseq
@@ -670,6 +665,38 @@ Bootsnap.setup(
 )
 ```
 
+## Troubleshooting
+
+The **most common problem is that simplecov isn't required and started before everything else**. In order to track coverage for your whole application **simplecov needs to be the first one** so that it (and the underlying coverage library) can subsequently track loaded files and their usage.
+
+If you are missing coverage for some code a simple trick is to put a puts statement in there and right after `SimpleCov.start` so you can see if the file really was loaded after simplecov was started.
+
+```ruby
+# my_code.rb
+class MyCode
+
+  puts "MyCode is being loaded!"
+
+  def my_method
+    # ...
+  end
+end
+
+# spec_helper.rb/rails_helper.rb/test_helper.rb/.simplecov whatever
+
+SimpleCov.start
+puts "SimpleCov started successfully!"
+```
+
+Now when you run your test suite and you see:
+
+```
+SimpleCov started successfully!
+MyCode is being loaded!
+```
+
+then it's good otherwise you likely have a problem :)
+
 ## Contributing
 
 See the [contributing guide](https://github.com/colszowka/simplecov/blob/master/CONTRIBUTING.md).

data/doc/alternate-formatters.md

@@ -20,11 +20,21 @@ A formatter that generates Cobertura XML.
 
 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*
 

data/lib/simplecov.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require "English"
+
 #
 # Code coverage for ruby 1.9. Please check out README for a full introduction.
 #
@@ -20,6 +24,7 @@ module SimpleCov
   class << self
     attr_accessor :running
     attr_accessor :pid
+    attr_reader :exit_exception
 
     #
     # Sets up SimpleCov to run against your project.
@@ -163,6 +168,92 @@ module SimpleCov
     def clear_result
       @result = nil
     end
+
+    #
+    # Capture the current exception if it exists
+    # This will get called inside the at_exit block
+    #
+    def set_exit_exception
+      @exit_exception = $ERROR_INFO
+    end
+
+    #
+    # Returns the exit status from the exit exception
+    #
+    def exit_status_from_exception
+      return SimpleCov::ExitCodes::SUCCESS unless exit_exception
+
+      if exit_exception.is_a?(SystemExit)
+        exit_exception.status
+      else
+        SimpleCov::ExitCodes::EXCEPTION
+      end
+    end
+
+    # @api private
+    #
+    # Called from at_exit block
+    #
+    def run_exit_tasks!
+      exit_status = SimpleCov.exit_status_from_exception
+
+      SimpleCov.at_exit.call
+
+      exit_status = SimpleCov.process_result(SimpleCov.result, exit_status)
+
+      # 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
+    end
+
+    # @api private
+    #
+    # Usage:
+    #   exit_status = SimpleCov.process_result(SimpleCov.result, exit_status)
+    #
+    def process_result(result, exit_status)
+      return exit_status unless SimpleCov.result? # Result has been computed
+      return exit_status if exit_status != SimpleCov::ExitCodes::SUCCESS # Existing errors
+
+      covered_percent = result.covered_percent.round(2)
+      result_exit_status = result_exit_status(result, covered_percent)
+      if result_exit_status == SimpleCov::ExitCodes::SUCCESS # No result errors
+        write_last_run(covered_percent)
+      end
+      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.round(2) }
+      if covered_percent < SimpleCov.minimum_coverage
+        $stderr.printf("Coverage (%.2f%%) is below the expected minimum coverage (%.2f%%).\n", covered_percent, SimpleCov.minimum_coverage)
+        SimpleCov::ExitCodes::MINIMUM_COVERAGE
+      elsif covered_percentages.any? { |p| p < SimpleCov.minimum_coverage_by_file }
+        $stderr.printf("File (%s) is only (%.2f%%) covered. This is below the expected minimum coverage per file of (%.2f%%).\n", result.least_covered_file, covered_percentages.min, 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 %.2f%% since the last time (maximum allowed: %.2f%%).\n", coverage_diff, SimpleCov.maximum_coverage_drop)
+          SimpleCov::ExitCodes::MAXIMUM_COVERAGE_DROP
+        else
+          SimpleCov::ExitCodes::SUCCESS
+        end
+      else
+        SimpleCov::ExitCodes::SUCCESS
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    #
+    # @api private
+    #
+    def write_last_run(covered_percent)
+      SimpleCov::LastRun.write(:result => {:covered_percent => covered_percent})
+    end
   end
 end
 

data/lib/simplecov/command_guesser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Helper that tries to find out what test suite is running (for SimpleCov.command_name)
 #

data/lib/simplecov/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "fileutils"
 require "docile"
 require "simplecov/formatter/multi_formatter"

data/lib/simplecov/defaults.rb

@@ -1,43 +1,12 @@
+# 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/rails"
 
 # Default configuration
 SimpleCov.configure do
@@ -50,52 +19,12 @@ 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
-
-  # 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.set_exit_exception
+  SimpleCov.run_exit_tasks!
 end
 
 # Autoload config from ~/.simplecov if present