Merge remote-tracking branch 'upstream/main' into add-method-coverage-support-update

tycooon · tycooon · commit c3e55792196a · 2024-11-30T12:09:31.000+03:00
diff --git a/.github/workflows/push_gem.yml b/.github/workflows/push_gem.yml
@@ -0,0 +1,37 @@
+name: Push Gem
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  push:
+    if: github.repository == 'simplecov-ruby/simplecov'
+    runs-on: ubuntu-latest
+
+    environment:
+      name: rubygems.org
+      url: https://rubygems.org/gems/simplecov
+
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      # Set up
+      - name: Harden Runner
+        uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v2.9.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@cacc9f1c0b3f4eb8a16a6bb0ed10897b43b9de49 # v1.176.0
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      # Release
+      - uses: rubygems/release-gem@612653d273a73bdae1df8453e090060bb4db5f31 # v1
diff --git a/.github/workflows/stable.yml b/.github/workflows/stable.yml
@@ -5,6 +5,7 @@ on: [push, pull_request]
 jobs:
   tests:
     runs-on: ubuntu-latest
+
     env:
       BUNDLE_WITHOUT: "benchmark"
       JRUBY_OPTS: "--debug"
@@ -14,20 +15,38 @@ jobs:
 
       matrix:
         ruby-version:
+          - '2.5'
+          - '2.6'
           - '2.7'
           - '3.0'
           - '3.1'
           - '3.2'
           - '3.3'
           - jruby-9.4
+          - truffleruby
 
     steps:
       - uses: actions/checkout@v4
 
+      - run: rm Gemfile.lock && rm test_projects/rails/rspec_rails/Gemfile.lock
+
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
+          rubygems: ${{ (matrix.ruby_version < '2.6' && '3.3.26') || 'default' }}
           bundler-cache: true
 
-      - run: |
-          bundle exec rake
+      - name: Run Rubocop
+        run: bundle exec rake rubocop
+        # code style is enough to check once (and might even take some time on JRuby)
+        if: matrix.ruby-version == '3.3'
+
+      - name: Run tests
+        run: bundle exec rake test
+        if: matrix.ruby-version != 'truffleruby'
+
+      # Run only `rake spec` on truffleruby, because just `rake` runs cucumber
+      # which fails because it uses an old childprocess which depends on fork.
+      - name: Run specs (truffleruby)
+        run: bundle exec rake spec
+        if: matrix.ruby-version == 'truffleruby'
diff --git a/.github/workflows/unstable.yml b/.github/workflows/unstable.yml
@@ -17,6 +17,7 @@ jobs:
         ruby-version:
           - ruby-head
           - jruby-head
+          - truffleruby-head
 
     steps:
       - uses: actions/checkout@v4
@@ -25,8 +26,13 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true
-        continue-on-error: ${{ (matrix.ruby-version == 'ruby-head') || (matrix.ruby-version == 'jruby-head') }}
 
-      - run: |
-          bundle exec rake
-        continue-on-error: ${{ (matrix.ruby-version == 'ruby-head') || (matrix.ruby-version == 'jruby-head') }}
+      - name: Run tests
+        run: bundle exec rake test
+        if: matrix.ruby-version != 'truffleruby-head'
+
+      # Run only `rake spec` on truffleruby, because just `rake` runs cucumber
+      # which fails because it uses an old childprocess which depends on fork.
+      - name: Run specs (truffleruby)
+        run: bundle exec rake spec
+        if: matrix.ruby-version == 'truffleruby-head'
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -10,7 +10,7 @@ AllCops:
     - "tmp/**/*"
     - "vendor/bundle/**/*"
     - "vendor/bundle/**/.*"
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 2.5
   NewCops: enable
   # we might wanna adopt rspec and rake but it's a bit annoying for now
   SuggestExtensions: false
@@ -239,6 +239,9 @@ Style/DocumentDynamicEvalDefinition:
 Style/EndlessMethod:
   Enabled: true
 
+Style/EnvHome:
+  Enabled: false
+
 Style/ExplicitBlockArgument:
   # capturing as a proc has a performance hit, so is a case by case choice
   Enabled: false
diff --git a/Gemfile b/Gemfile
@@ -16,12 +16,16 @@ end
 gem "matrix"
 
 group :development do
-  gem "apparition", github: "twalpole/apparition" # LOCKED: When this is released, use a released version https://github.com/twalpole/apparition/pull/79
+  gem "apparition", github: "twalpole/apparition"
   gem "activesupport", "~> 6.1"
-  gem "aruba", "~> 1.0"
+  gem "aruba"
   gem "capybara"
-  gem "rackup"
-  gem "cucumber", "~> 6.0"
+  if RUBY_VERSION < "2.7"
+    gem "rack", "< 3"
+  else
+    gem "rackup"
+  end
+  gem "cucumber"
   gem "minitest"
   gem "rake"
   gem "rspec"
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -190,10 +190,10 @@ PLATFORMS
 DEPENDENCIES
   activesupport (~> 6.1)
   apparition!
-  aruba (~> 1.0)
+  aruba
   benchmark-ips
   capybara
-  cucumber (~> 6.0)
+  cucumber
   matrix
   minitest
   pry
@@ -206,4 +206,4 @@ DEPENDENCIES
   webrick
 
 BUNDLED WITH
-   2.4.20
+   2.5.23
diff --git a/README.md b/README.md
@@ -350,7 +350,7 @@ SimpleCov.start do
 end
 ```
 
-Primary coverage determines what will come in first all output, and the type of coverage to check if you don't specify the type of coverage when customizing exit behavior (`SimpleCov.minimum_coverage 90`).
+Primary coverage determines what will come first in all output, and the type of coverage to check if you don't specify the type of coverage when customizing exit behavior (`SimpleCov.minimum_coverage 90`).
 
 Note that coverage must first be enabled for non-default coverage types.
 
@@ -861,10 +861,10 @@ As of SimpleCov 0.9, you can specify multiple result formats. Formatters besides
 ```ruby
 require "simplecov-html"
 
-SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([
+SimpleCov.formatters = [
   SimpleCov::Formatter::HTMLFormatter,
   SimpleCov::Formatter::CSVFormatter,
-])
+]
 ```
 
 ## JSON formatter
@@ -889,7 +889,7 @@ SimpleCov.formatter = SimpleCov::Formatter::JSONFormatter
 
 ## Ruby version compatibility
 
-SimpleCov is built in [Continuous Integration] on Ruby 2.7+ as well as JRuby 9.3+.
+SimpleCov is built in [Continuous Integration] on Ruby 2.5+ as well as JRuby 9.2+.
 
 Note for JRuby => You need to pass JRUBY_OPTS="--debug" or create .jrubyrc and add debug.fullTrace=true
 
diff --git a/Rakefile b/Rakefile
@@ -29,4 +29,5 @@ Cucumber::Rake::Task.new do |t|
   t.cucumber_opts = %w[--retry 3 --no-strict-flaky]
 end
 
+task test: %i[spec cucumber]
 task default: %i[rubocop spec cucumber]
diff --git a/features/parallel_tests.feature b/features/parallel_tests.feature
@@ -66,4 +66,4 @@ Feature:
       end
       """
     When I successfully run `bundle exec parallel_rspec spec`
-    Then the output should not match /+cover.+below.+minimum/
+    Then the output should not match /.*cover.+below.+minimum/
diff --git a/features/support/env.rb b/features/support/env.rb
@@ -5,12 +5,22 @@
 
 require "bundler"
 Bundler.setup
-require "aruba/cucumber"
-require "aruba/config/jruby" if RUBY_ENGINE == "jruby"
 require "capybara/cucumber"
 require "capybara/apparition"
+require "aruba/cucumber"
+require "aruba/config/jruby" if RUBY_ENGINE == "jruby"
 require "simplecov"
 
+# Monkey-patching Capybara::DSL if Capybara::DSLRSpecProxyInstaller has no `extended` hook
+unless Module.new.extend(RSpec::Matchers).extend(Capybara::DSL).singleton_class.ancestors.include?(Capybara::RSpecMatcherProxies)
+  Capybara::DSL.extend(Module.new do
+    def extended(base)
+      base.extend(Capybara::RSpecMatcherProxies) if defined?(RSpec::Matchers) && base.is_a?(RSpec::Matchers)
+      super
+    end
+  end)
+end
+
 # Rack app for Capybara which returns the latest coverage report from Aruba temp project dir
 coverage_dir = File.expand_path("../../tmp/aruba/project/coverage/", __dir__)
 Capybara.app = Rack::Builder.new do
@@ -39,7 +49,15 @@
 
 Before("@process_fork") do
   # Process.fork is NotImplementedError in jruby
-  skip_this_scenario if defined?(RUBY_ENGINE) && RUBY_ENGINE == "jruby"
+  skip_this_scenario if jruby?
+end
+
+Before("@no_jruby") do
+  skip_this_scenario if jruby?
+end
+
+def jruby?
+  defined?(RUBY_ENGINE) && RUBY_ENGINE == "jruby"
 end
 
 Aruba.configure do |config|
diff --git a/features/warnings.feature b/features/warnings.feature
@@ -1,4 +1,5 @@
-@rspec
+# deactivating on JRuby due to https://github.com/jruby/jruby/issues/8200
+@rspec @no_jruby
 Feature:
 
   Running SimpleCov with verbosity enabled does not yield warnings.
diff --git a/lib/simplecov.rb b/lib/simplecov.rb
@@ -334,18 +334,24 @@ def start_coverage_measurement
       if coverage_start_arguments_supported?
         start_coverage_with_criteria
       else
-        Coverage.start unless Coverage.running?
+        Coverage.start unless coverage_running?
       end
     end
 
     def start_coverage_with_criteria
-      start_arguments = coverage_criteria.to_h do |criterion|
+      start_arguments = coverage_criteria.map do |criterion|
         [lookup_corresponding_ruby_coverage_name(criterion), true]
-      end
+      end.to_h
 
       start_arguments[:eval] = true if coverage_for_eval_enabled?
 
-      Coverage.start(start_arguments) unless Coverage.running?
+      Coverage.start(start_arguments) unless coverage_running?
+    end
+
+    def coverage_running?
+      # for ruby versions which do not implement Coverage.running?,
+      # Coverage.start may be called multiple times without raising.
+      Coverage.respond_to?(:running?) && Coverage.running?
     end
 
     CRITERION_TO_RUBY_COVERAGE = {
diff --git a/lib/simplecov/configuration.rb b/lib/simplecov/configuration.rb
@@ -344,7 +344,7 @@ def minimum_coverage_by_file(coverage = nil)
     def refuse_coverage_drop(*criteria)
       criteria = coverage_criteria if criteria.empty?
 
-      maximum_coverage_drop(criteria.to_h { |c| [c, 0] })
+      maximum_coverage_drop(criteria.map { |c| [c, 0] }.to_h)
     end
 
     #
diff --git a/lib/simplecov/load_global_config.rb b/lib/simplecov/load_global_config.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "etc"
-home_dir = Dir.home || File.expand_path("~") || Etc.getpwuid.dir || (ENV.fetch("USER", nil) && File.expand_path("~#{ENV.fetch('USER', nil)}"))
+home_dir = (ENV.fetch("HOME", nil) && File.expand_path("~")) || Etc.getpwuid.dir || (ENV.fetch("USER", nil) && File.expand_path("~#{ENV.fetch('USER', nil)}"))
 if home_dir
   global_config_path = File.join(home_dir, ".simplecov")
   load global_config_path if File.exist?(global_config_path)
diff --git a/lib/simplecov/source_file/branch.rb b/lib/simplecov/source_file/branch.rb
@@ -33,7 +33,7 @@ def covered?
       end
 
       #
-      # Check if branche missed or not
+      # Check if branch missed or not
       #
       # @return [Boolean]
       #
diff --git a/lib/simplecov/useless_results_remover.rb b/lib/simplecov/useless_results_remover.rb
@@ -12,7 +12,7 @@ def self.call(coverage_result)
     end
 
     def self.root_regx
-      @root_regx ||= /\A#{Regexp.escape(SimpleCov.root + File::SEPARATOR)}/i.freeze
+      @root_regx ||= /\A#{Regexp.escape(SimpleCov.root + File::SEPARATOR)}/i
     end
   end
 end
diff --git a/simplecov.gemspec b/simplecov.gemspec
@@ -33,7 +33,7 @@ Gem::Specification.new do |gem|
 "rubygems_mfa_required" => "true"
   }
 
-  gem.required_ruby_version = ">= 2.7.0"
+  gem.required_ruby_version = ">= 2.5.0"
 
   gem.add_dependency "docile", "~> 1.1"
   gem.add_dependency "simplecov-html", "~> 0.11"
diff --git a/spec/configuration_spec.rb b/spec/configuration_spec.rb
@@ -142,29 +142,29 @@
       end
 
       it "sets the right coverage value when called with `:line`" do
-        config.public_send(:refuse_coverage_drop, :line)
+        config.refuse_coverage_drop(:line)
 
-        expect(config.public_send(:maximum_coverage_drop)).to eq line: 0
+        expect(config.maximum_coverage_drop).to eq line: 0
       end
 
       it "sets the right coverage value when called with `:branch`" do
         config.enable_coverage :branch
-        config.public_send(:refuse_coverage_drop, :branch)
+        config.refuse_coverage_drop(:branch)
 
-        expect(config.public_send(:maximum_coverage_drop)).to eq branch: 0
+        expect(config.maximum_coverage_drop).to eq branch: 0
       end
 
       it "sets the right coverage value when called with `:line` and `:branch`" do
         config.enable_coverage :branch
-        config.public_send(:refuse_coverage_drop, :line, :branch)
+        config.refuse_coverage_drop(:line, :branch)
 
-        expect(config.public_send(:maximum_coverage_drop)).to eq line: 0, branch: 0
+        expect(config.maximum_coverage_drop).to eq line: 0, branch: 0
       end
 
       it "sets the right coverage value when called with no args" do
-        config.public_send(:refuse_coverage_drop)
+        config.refuse_coverage_drop
 
-        expect(config.public_send(:maximum_coverage_drop)).to eq line: 0
+        expect(config.maximum_coverage_drop).to eq line: 0
       end
     end
 
diff --git a/spec/return_codes_spec.rb b/spec/return_codes_spec.rb
@@ -34,6 +34,9 @@
         end
 
         it "prints a message to STDERR" do
+          # https://github.com/oracle/truffleruby/issues/3535
+          skip "fails on truffleruby" if RUBY_ENGINE == "truffleruby" && Object::Object::RUBY_ENGINE_VERSION < "24.1" && command.include?("testunit_bad.rb")
+
           expect(@stderr).to match(/stopped.+SimpleCov.+previous.+error/i)
         end
       end
diff --git a/test_projects/rails/rspec_rails/Gemfile b/test_projects/rails/rspec_rails/Gemfile
diff --git a/test_projects/rails/rspec_rails/Gemfile.lock b/test_projects/rails/rspec_rails/Gemfile.lock
