simplecov 0.21.1 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afc0e78d256ce0dd4b33c55efb46a4463f31b72a6dcaefea8dba983ba366f7ba
-  data.tar.gz: d0c17198c79fe4e85ec21497355e618048637595b00fbecf180ab61815e75c65
+  metadata.gz: 53fa0b46a6da5abd78be052c332c7bc956bb9a432e929965f1cfd460d637c21d
+  data.tar.gz: 714c61ef2abd25f9fc78e0f56681811eb571904c9348775acf5b7b13ad002dfe
 SHA512:
-  metadata.gz: b6cd1717e5c3a639b6f4392e4067625d700aa9732c56898f3be5d9bf9c633715455efaecaf421e53e6c4c734756992ac623ba341a2b78fdc30d0ec56ed27e76f
-  data.tar.gz: c031ee7dfe0317d5e6536fb4cf393a8bf3dca3c691bb4ab3240678a253a6f514bccf544a0767291959d671581329399f6e1993ead0660fa5875980e6c0862114
+  metadata.gz: f2e715ac3b3067755b2f32981359736cbb5335606b83e84523b03b37d93804d39bbd1f40099d78058d21dad038623911eb031d672fbad97f1fdaa292b2c3652b
+  data.tar.gz: 9155c02eba7b6389c8e19de0c28a2b78017999ca404cadfbaa3cde1ee2012e0420d86471af81b0ced38dedef26bde60e7130fb86965fbb4021663fbb75c96554

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+0.22.0 (2022-12-23)
+==========
+
+## Enhancements
+
+* On Ruby 3.2+, you can now use the new Coverage library feature for `eval` - See https://github.com/simplecov-ruby/simplecov/pull/1037. Thanks [@mame](https://github.com/mame)!
+
+## Bugfixes
+* Fix for making the test suite pass against the upcoming Ruby 3.2 - See https://github.com/simplecov-ruby/simplecov/pull/1035. Thanks [@mame](https://github.com/mame)
+
+0.21.2 (2021-01-09)
+==========
+
+## Bugfixes
+* `maximum_coverage_drop` won't fail any more if `.last_run.json` is still in the old format. Thanks [@petertellgren](https://github.com/petertellgren)
+* `maximum_coverage_drop` won't fail if an expectation is specified for a previous unrecorded criterion, it will just pass (there's nothing, so nothing to drop)
+* fixed bug in `maximum_coverage_drop` calculation that could falsely report it had dropped for minimal differences
+
 0.21.1 (2021-01-04)
 ==========
 

data/README.md

@@ -69,6 +69,8 @@ Getting started
     The `SimpleCov.start` **must** be issued **before any of your application
     code is required!**
 
+    This is especially true if you use anything that keeps your tests application loaded like spring, check out the **[spring section](#want-to-use-spring-with-simplecov)**.
+
     SimpleCov must be running in the process that you want the code coverage
     analysis to happen on. When testing a server process (e.g. a JSON API
     endpoint) via a separate test process (e.g. when using Selenium) where you
@@ -105,10 +107,6 @@ Getting started
 5. Add the following to your `.gitignore` file to ensure that coverage results
    are not tracked by Git (optional):
 
-   ```
-   echo "coverage" >> .gitignore
-   ```
-   Or if you use Windows:
    ```
    echo coverage >> .gitignore
    ```
@@ -356,6 +354,18 @@ Primary coverage determines what will come in first all output, and the type of
 
 Note that coverage must first be enabled for non-default coverage types.
 
+## Coverage for eval
+
+You can measure coverage for code that is evaluated by `Kernel#eval`. Supported in CRuby versions 3.2+.
+
+```ruby
+SimpleCov.start do
+  enable_coverage_for_eval
+end
+```
+
+This is typically useful for ERB. Set `ERB#filename=` to make it possible for SimpleCov to trace the original .erb source file.
+
 ## Filters
 
 Filters can be used to remove selected files from your coverage data. By default, a filter is applied that removes all
@@ -840,15 +850,17 @@ You can use your own formatter with:
 SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
 ```
 
-When calling SimpleCov.result.format!, it will be invoked with SimpleCov::Formatter::YourFormatter.new.format(result),
-"result" being an instance of SimpleCov::Result. Do whatever your wish with that!
+Calling `SimpleCov.result.format!` will be invoked with `SimpleCov::Formatter::YourFormatter.new.format(result)`,
+and `result` is an instance of `SimpleCov::Result`. Do whatever your wish with that!
 
 
 ## Using multiple formatters
 
-As of SimpleCov 0.9, you can specify multiple result formats:
+As of SimpleCov 0.9, you can specify multiple result formats. Formatters besides the default HTML formatter require separate gems, however.
 
 ```ruby
+require "simplecov-html"
+
 SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([
   SimpleCov::Formatter::HTMLFormatter,
   SimpleCov::Formatter::CSVFormatter,
@@ -877,7 +889,7 @@ SimpleCov.formatter = SimpleCov::Formatter::JSONFormatter
 
 ## Ruby version compatibility
 
-SimpleCov is built in [Continuous Integration] on Ruby 2.5+ as well as JRuby 9.2+.
+SimpleCov is built in [Continuous Integration] on Ruby 2.7+ as well as JRuby 9.3+.
 
 Note for JRuby => You need to pass JRUBY_OPTS="--debug" or create .jrubyrc and add debug.fullTrace=true
 

data/lib/simplecov/configuration.rb

@@ -440,7 +440,26 @@ module SimpleCov
       end
     end
 
-    alias branch_coverage_supported? coverage_start_arguments_supported?
+    def branch_coverage_supported?
+      coverage_start_arguments_supported? && RUBY_ENGINE != "jruby"
+    end
+
+    def coverage_for_eval_supported?
+      require "coverage"
+      defined?(Coverage.supported?) && Coverage.supported?(:eval)
+    end
+
+    def coverage_for_eval_enabled?
+      @coverage_for_eval_enabled ||= false
+    end
+
+    def enable_coverage_for_eval
+      if coverage_for_eval_supported?
+        @coverage_for_eval_enabled = true
+      else
+        warn "Coverage for eval is not available; Use Ruby 3.2.0 or later"
+      end
+    end
 
   private
 

data/lib/simplecov/exit_codes/maximum_coverage_drop_check.rb

@@ -51,22 +51,32 @@ module SimpleCov
           {
             criterion: criterion,
             max_drop: percent,
-            drop_percent: last_coverage(criterion) -
-              SimpleCov.round_coverage(
-                result.coverage_statistics.fetch(criterion).percent
-              )
+            drop_percent: drop_percent(criterion)
           }
         end
       end
 
+      # if anyone says "max_coverage_drop 0.000000000000000001" I appologize. Please don't.
+      MAX_DROP_ACCURACY = 10
+      def drop_percent(criterion)
+        drop = last_coverage(criterion) -
+               SimpleCov.round_coverage(
+                 result.coverage_statistics.fetch(criterion).percent
+               )
+
+        # floats, I tell ya.
+        # irb(main):001:0* 80.01 - 80.0
+        # => 0.010000000000005116
+        drop.floor(MAX_DROP_ACCURACY)
+      end
+
       def last_coverage(criterion)
         last_coverage_percent = last_run[:result][criterion]
 
-        if !last_coverage_percent && criterion == "line"
-          last_run[:result][:covered_percent]
-        else
-          last_coverage_percent
-        end
+        # fallback for old file format
+        last_coverage_percent = last_run[:result][:covered_percent] if !last_coverage_percent && criterion == :line
+
+        last_coverage_percent || 0
       end
     end
   end

data/lib/simplecov/source_file.rb

@@ -18,7 +18,7 @@ module SimpleCov
 
     # The path to this source file relative to the projects directory
     def project_filename
-      @filename.sub(Regexp.new("^#{Regexp.escape(SimpleCov.root)}"), "")
+      @filename.delete_prefix(SimpleCov.root)
     end
 
     # The source code for this file. Aliased as :source
@@ -217,7 +217,13 @@ module SimpleCov
       # 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) }
+      file_lines.each do |line|
+        if line.encoding == Encoding::UTF_8
+          line
+        else
+          line.encode!("UTF-8", invalid: :replace, undef: :replace)
+        end
+      end
     end
 
     def build_lines
@@ -238,7 +244,7 @@ module SimpleCov
     end
 
     def lines_strength
-      lines.map(&:coverage).compact.reduce(:+)
+      lines.sum { |line| line.coverage.to_i }
     end
 
     # Warning to identify condition from Issue #56

data/lib/simplecov/version.rb

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

data/lib/simplecov.rb

@@ -342,7 +342,7 @@ module SimpleCov
       if coverage_start_arguments_supported?
         start_coverage_with_criteria
       else
-        Coverage.start
+        Coverage.start unless Coverage.running?
       end
     end
 
@@ -351,7 +351,9 @@ module SimpleCov
         [lookup_corresponding_ruby_coverage_name(criterion), true]
       end.to_h
 
-      Coverage.start(start_arguments)
+      start_arguments[:eval] = true if coverage_for_eval_enabled?
+
+      Coverage.start(start_arguments) unless Coverage.running?
     end
 
     CRITERION_TO_RUBY_COVERAGE = {

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: simplecov
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 0.22.0
 platform: ruby
 authors:
 - Christoph Olszowka
 - Tobias Pfeiffer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-04 00:00:00.000000000 Z
+date: 2022-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -116,10 +116,10 @@ licenses:
 metadata:
   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.21.1
+  documentation_uri: https://www.rubydoc.info/gems/simplecov/0.22.0
   mailing_list_uri: https://groups.google.com/forum/#!forum/simplecov
-  source_code_uri: https://github.com/simplecov-ruby/simplecov/tree/v0.21.1
-post_install_message: 
+  source_code_uri: https://github.com/simplecov-ruby/simplecov/tree/v0.22.0
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,8 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Code coverage for Ruby
 test_files: []