knapsack_pro 7.14.1 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74a234f9f6948aef8fb2f4c5aff8b2f56077c4cf227b78e76957c470681dc8e7
-  data.tar.gz: 980e6ebff8f7d49dfa4b1e7296f8d507600a052e49845e0ffde27ffa68d57272
+  metadata.gz: c531fc28ddde021a2417447b60d2feaec8924994bb5575cf1f3cd63484d2fa2b
+  data.tar.gz: 28eb5e92aff6522f1dfb31b2c2c076bb54f6e50daec25985a09286fb337fec90
 SHA512:
-  metadata.gz: '09abbaa277b6593990984ab0a0052b8ca7955366e3460971adb52656e5fb8298e5040af857cd14d87eb3d514127f8dbf388c7470880c86d129a409f30d55f2eb'
-  data.tar.gz: eef211470c7a006428b346eff52063e491461134ee7c82d02b9ebe6cd829ae2b1091e0432d8c0037f0aaafdc624f7b7707fc8e3b88dd5720721ceb6840514730
+  metadata.gz: 5b66568ea07f6ab6ef881e61d3f3affa5d9ba0c0201c64c2292573fc11afc8e212e4d848e63c22b2596b9e4ea36780ad4f5b72a25f729370e463f865aed324c4
+  data.tar.gz: '0021619b437b7815807667549ee8a49ffcfca23358b3456e3cbbc5331f2a03a535f271c9cdbf5c83db632709c47ec82e50f3806aab30a0660763011efe9e7800'

data/.circleci/config.yml

@@ -194,6 +194,15 @@ jobs:
             export KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=true
             export KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN="spec/features/calculator_spec.rb"
             bundle exec rake knapsack_pro:rspec
+      - run:
+          working_directory: ~/rails-app-with-knapsack_pro
+          command: |
+            # split custom files by test examples AND the --tag option passed ||
+            export KNAPSACK_PRO_BRANCH="$CIRCLE_BRANCH--$CIRCLE_BUILD_NUM--regular--split-custom-files--tag-option"
+            export KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=true
+            export KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN="spec/bar_spec.rb"
+            export SKIP_ME_OR_I_WILL_FAIL=true
+            bundle exec rake "knapsack_pro:rspec[--tag tag_x -t ~tag_y --tag ~skip_me_or_i_will_fail --format documentation]"
 
   e2e-queue-rspec:
     parameters:
@@ -289,24 +298,47 @@ jobs:
             export KNAPSACK_PRO_CI_NODE_TOTAL=1
             export KNAPSACK_PRO_CI_NODE_INDEX=0
             bundle exec rake knapsack_pro:queue:rspec
+      - run:
+          working_directory: ~/rails-app-with-knapsack_pro
+          command: |
+            # split custom files by test examples AND the --tag option passed ||
+            export KNAPSACK_PRO_BRANCH="$CIRCLE_BRANCH--$CIRCLE_BUILD_NUM--queue--split-custom-files--tag-option"
+            export KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=true
+            export KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN="spec/bar_spec.rb"
+            export SKIP_ME_OR_I_WILL_FAIL=true
+            bundle exec rake "knapsack_pro:queue:rspec[--tag tag_x -t ~tag_y --tag ~skip_me_or_i_will_fail --format documentation]"
       - run:
           working_directory: ~/rails-app-with-knapsack_pro
           command: |
             # turnip ||
+            mv .rspec .rspec.off
+            cp .rspec.turnip .rspec
             export KNAPSACK_PRO_BRANCH="$CIRCLE_BRANCH--$CIRCLE_BUILD_NUM--queue--turnip"
             export KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true
             export KNAPSACK_PRO_TEST_DIR=turnip
             export KNAPSACK_PRO_TEST_FILE_PATTERN="turnip/**/*.feature"
-            bundle exec rake "knapsack_pro:queue:rspec[-r turnip/rspec]"
+            export KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN="turnip/acceptance/foo.feature"
+            bundle exec rake knapsack_pro:queue:rspec
+            RSPEC_EXIT_CODE=$?
+            rm .rspec
+            mv .rspec.off .rspec
+            exit $RSPEC_EXIT_CODE
       - run:
           working_directory: ~/rails-app-with-knapsack_pro
           command: |
             # turnip retry ||
+            mv .rspec .rspec.off
+            cp .rspec.turnip .rspec
             export KNAPSACK_PRO_BRANCH="$CIRCLE_BRANCH--$CIRCLE_BUILD_NUM--queue--turnip"
             export KNAPSACK_PRO_FIXED_QUEUE_SPLIT=true
             export KNAPSACK_PRO_TEST_DIR=turnip
             export KNAPSACK_PRO_TEST_FILE_PATTERN="turnip/**/*.feature"
-            bundle exec rake "knapsack_pro:queue:rspec[-r turnip/rspec]"
+            export KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN="turnip/acceptance/foo.feature"
+            bundle exec rake knapsack_pro:queue:rspec
+            RSPEC_EXIT_CODE=$?
+            rm .rspec
+            mv .rspec.off .rspec
+            exit $RSPEC_EXIT_CODE
 
   e2e-regular-minitest:
     parallelism: 2

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+### 8.0.0
+
+* Enable [`KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES`](https://docs.knapsackpro.com/ruby/split-by-test-examples/) by default
+    * This should improve the speed of your builds, but you can disable it with [`KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=false`](https://docs.knapsackpro.com/ruby/reference/#knapsack_pro_rspec_split_by_test_examples-rspec)
+* Support RSpec tags when using [RSpec split by examples](https://docs.knapsackpro.com/ruby/split-by-test-examples/).
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/288
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v7.14.1...v8.0.0
+
 ### 7.14.1
 
 * Improve execution time tracking for RSpec individual test examples

data/knapsack_pro.gemspec

@@ -29,15 +29,15 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rake', '>= 0'
 
   spec.add_development_dependency 'bundler', '>= 1.6'
+  spec.add_development_dependency 'cucumber', '>= 0'
+  spec.add_development_dependency 'minitest', '>= 5.0.0'
+  spec.add_development_dependency 'ostruct', '>= 0.6.0'
+  spec.add_development_dependency 'pry', '~> 0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-its', '~> 1.3'
-  spec.add_development_dependency 'cucumber', '>= 0'
   spec.add_development_dependency 'spinach', '>= 0.8'
-  spec.add_development_dependency 'minitest', '>= 5.0.0'
   spec.add_development_dependency 'test-unit', '>= 3.0.0'
-  spec.add_development_dependency 'pry', '~> 0'
+  spec.add_development_dependency 'timecop', '>= 0.9.9'
   spec.add_development_dependency 'vcr', '>= 6.0'
   spec.add_development_dependency 'webmock', '>= 3.13'
-  spec.add_development_dependency 'timecop', '>= 0.9.9'
-  spec.add_development_dependency 'ostruct', '>= 0.6.0'
 end

data/lib/knapsack_pro/adapters/rspec_adapter.rb

@@ -37,18 +37,6 @@ module KnapsackPro
         KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector.new.test_file_example_paths
       end
 
-      def self.ensure_no_tag_option_when_rspec_split_by_test_examples_enabled!(cli_args)
-        if KnapsackPro::Config::Env.rspec_split_by_test_examples? && has_tag_option?(cli_args)
-          error_message = "It is not allowed to use the RSpec tag option together with the RSpec split by test examples feature. Please see: #{KnapsackPro::Urls::RSPEC__SPLIT_BY_TEST_EXAMPLES__TAG}"
-          KnapsackPro.logger.error(error_message)
-          raise error_message
-        end
-      end
-
-      def self.has_tag_option?(cli_args)
-        !!parsed_options(cli_args)&.[](:inclusion_filter)
-      end
-
       def self.has_format_option?(cli_args)
         !!parsed_options(cli_args)&.[](:formatters)
       end
@@ -61,6 +49,17 @@ module KnapsackPro
         parsed_options(cli_args)&.[](:order)
       end
 
+      def self.remove_formatters(cli_args)
+        formatter_options = ['-f', '--format', '-o', '--out']
+        cli_args.dup.each_with_index do |arg, index|
+          if formatter_options.include?(arg)
+            cli_args[index] = nil
+            cli_args[index + 1] = nil
+          end
+        end
+        cli_args.compact
+      end
+
       def self.file_path_for(example)
         [
           -> { parse_file_path(example.id) },

data/lib/knapsack_pro/base_allocator_builder.rb

@@ -23,15 +23,15 @@ module KnapsackPro
       KnapsackPro::Config::Env.test_dir || TestFilePattern.test_dir(adapter_class)
     end
 
-    # in fallback mode we always want to run the whole test files
-    # (not split by test cases) to guarantee that each test will be executed
-    # at least once across parallel CI nodes
+    # In Fallback Mode, we always want to run whole test files (not split by
+    # test cases) to guarantee that each test will be executed at least once
+    # across parallel CI nodes.
     def fallback_mode_test_files
       all_test_files_to_run
     end
 
-    # detect test files present on the disk that should be run
-    # this may include some fast test files + slow test files split by test cases
+    # Detect test files present on the disk that should be run.
+    # This may include fast test files + slow test files split by test cases.
     def fast_and_slow_test_files_to_run
       test_files_to_run = all_test_files_to_run
 

data/lib/knapsack_pro/config/env.rb

@@ -179,10 +179,17 @@ module KnapsackPro
         def rspec_split_by_test_examples?
           return @rspec_split_by_test_examples if defined?(@rspec_split_by_test_examples)
 
-          split = ENV.fetch('KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES', false).to_s == 'true'
+          env = ENV['KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES']
+
+          if test_files_encrypted? && env.nil?
+            KnapsackPro.logger.warn("Skipping split by test examples because test file names encryption is enabled:\n#{KnapsackPro::Urls::ENCRYPTION}\n#{KnapsackPro::Urls::SPLIT_BY_TEST_EXAMPLES}")
+            return (@rspec_split_by_test_examples = false)
+          end
+
+          split = (env || true).to_s == 'true'
 
           if split && ci_node_total < 2
-            KnapsackPro.logger.debug('Skipping split of test files by test examples because you are running tests on a single CI node (no parallelism)')
+            KnapsackPro.logger.debug('Skipping split by test examples because tests are running on a single CI node (no parallelism)')
             @rspec_split_by_test_examples = false
           else
             @rspec_split_by_test_examples = split

data/lib/knapsack_pro/runners/queue/rspec_runner.rb

@@ -21,6 +21,7 @@ module KnapsackPro
         end
 
         def initialize(adapter_class, rspec_pure, args, stream_error, stream_out)
+          ENV['KNAPSACK_PRO_RSPEC_OPTIONS'] = args.to_s
           super(adapter_class)
           @adapter_class = adapter_class
           @rspec_pure = rspec_pure
@@ -149,7 +150,6 @@ module KnapsackPro
           KnapsackPro::Config::Env.set_test_runner_adapter(@adapter_class)
 
           ENV['SPEC_OPTS'] = @rspec_pure.add_knapsack_pro_formatters_to(ENV['SPEC_OPTS'])
-          @adapter_class.ensure_no_tag_option_when_rspec_split_by_test_examples_enabled!(@cli_args)
 
           rspec_configuration_options = ::RSpec::Core::ConfigurationOptions.new(@cli_args)
           @rspec_runner = ::RSpec::Core::Runner.new(rspec_configuration_options)

data/lib/knapsack_pro/runners/rspec_runner.rb

@@ -8,6 +8,7 @@ module KnapsackPro
 
         ENV['KNAPSACK_PRO_TEST_SUITE_TOKEN'] = KnapsackPro::Config::Env.test_suite_token_rspec
         ENV['KNAPSACK_PRO_REGULAR_MODE_ENABLED'] = 'true'
+        ENV['KNAPSACK_PRO_RSPEC_OPTIONS'] = args.to_s
 
         adapter_class = KnapsackPro::Adapters::RSpecAdapter
         KnapsackPro::Config::Env.set_test_runner_adapter(adapter_class)
@@ -16,9 +17,6 @@ module KnapsackPro
         if runner.test_files_to_execute_exist?
           adapter_class.verify_bind_method_called
 
-          cli_args = (args || '').split
-          adapter_class.ensure_no_tag_option_when_rspec_split_by_test_examples_enabled!(cli_args)
-
           require 'rspec/core/rake_task'
 
           task_name = 'knapsack_pro:rspec_run'

data/lib/knapsack_pro/test_case_detectors/rspec_test_example_detector.rb

@@ -3,7 +3,9 @@
 module KnapsackPro
   module TestCaseDetectors
     class RSpecTestExampleDetector
-      def generate_json_report
+      def generate_json_report(rspec_args)
+        raise "The internal KNAPSACK_PRO_RSPEC_OPTIONS environment variable is unset. Ensure it is not overridden accidentally. Otherwise, please report this as a bug: #{KnapsackPro::Urls::SUPPORT}" if rspec_args.nil?
+
         require 'rspec/core'
 
         cli_format =
@@ -25,7 +27,11 @@ module KnapsackPro
           return
         end
 
-        cli_args = cli_format + [
+        args = (rspec_args || '').split
+        cli_args_without_formatters = KnapsackPro::Adapters::RSpecAdapter.remove_formatters(args)
+
+        # Apply a --format option which overrides formatters from the RSpec custom option files like `.rspec`.
+        cli_args = cli_args_without_formatters + cli_format + [
           '--dry-run',
           '--no-color',
           '--out', report_path,

data/lib/knapsack_pro/tracker.rb

@@ -113,7 +113,7 @@ module KnapsackPro
     end
 
     def read_prerun_tests_report
-      raise "Report #{prerun_tests_report_path} doest not exist on the disk. Most likely, it was removed accidentally. Please report the bug to the Knapsack Pro support team at #{KnapsackPro::Urls::SUPPORT}" unless File.exist?(prerun_tests_report_path)
+      raise "Report #{prerun_tests_report_path} does not exist on the disk. Most likely, it was removed accidentally. Please report the bug to the Knapsack Pro support team at #{KnapsackPro::Urls::SUPPORT}" unless File.exist?(prerun_tests_report_path)
       JSON.parse(File.read(prerun_tests_report_path))
     end
 

data/lib/knapsack_pro/urls.rb

@@ -32,8 +32,6 @@ module KnapsackPro
 
     RSPEC__SKIPS_TESTS = "#{HOST}/perma/ruby/rspec-skips-tests"
 
-    RSPEC__SPLIT_BY_TEST_EXAMPLES__TAG = "#{HOST}/perma/ruby/rspec-split-by-test-examples-tag"
-
     SPLIT_BY_TEST_EXAMPLES = "#{HOST}/perma/ruby/split-by-test-examples"
 
     TEST_UNIT__TEST_FILE_PATH_DETECTION = "#{HOST}/perma/ruby/test-unit-test-file-path-detection"

data/lib/knapsack_pro/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KnapsackPro
-  VERSION = '7.14.1'
+  VERSION = '8.0.0'
 end

data/lib/tasks/rspec.rake

@@ -13,6 +13,6 @@ namespace :knapsack_pro do
     ENV.delete('SPEC_OPTS')
 
     detector = KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector.new
-    detector.generate_json_report
+    detector.generate_json_report(ENV['KNAPSACK_PRO_RSPEC_OPTIONS'])
   end
 end

data/spec/integration/runners/queue/rspec_runner_spec.rb

@@ -1961,16 +1961,13 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
 
   context 'when the RSpec split by test examples is enabled' do
     before do
-      ENV['KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES'] = 'true'
-
-      # remember to stub Queue API batches to include test examples (example: a_spec.rb[1:1])
-      # for the following slow test files
+      # Remember to stub the Queue API batches to include test examples (example: a_spec.rb[1:1])
+      # for the following slow test files.
       ENV['KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN'] = "#{SPEC_DIRECTORY}/a_spec.rb"
 
       ENV['KNAPSACK_PRO_CI_NODE_TOTAL'] = '2'
     end
     after do
-      ENV.delete('KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES')
       ENV.delete('KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN')
       ENV.delete('KNAPSACK_PRO_CI_NODE_TOTAL')
     end
@@ -2060,21 +2057,18 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
 
   context 'when the RSpec split by test examples is enabled AND --tag is set' do
     before do
-      ENV['KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES'] = 'true'
-
-      # remember to stub Queue API batches to include test examples (example: a_spec.rb[1:1])
-      # for the following slow test files
+      # Remember to stub the Queue API batches to include test examples (example: a_spec.rb[1:2])
+      # for the following slow test files.
       ENV['KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN'] = "#{SPEC_DIRECTORY}/a_spec.rb"
 
       ENV['KNAPSACK_PRO_CI_NODE_TOTAL'] = '2'
     end
     after do
-      ENV.delete('KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES')
       ENV.delete('KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN')
       ENV.delete('KNAPSACK_PRO_CI_NODE_TOTAL')
     end
 
-    it 'sets 1 as exit code AND raises an error (a test example path as a_spec.rb[1:1] would always be executed even when it does not have the tag that is set via the --tag option. We cannot run tests because it could lead to running unintentional tests)' do
+    it 'splits slow test files by test examples AND ensures the test examples are executed only once' do
       rspec_options = '--format d --tag my_tag'
 
       spec_a = Spec.new('a_spec.rb', <<~SPEC)
@@ -2082,7 +2076,7 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
           it 'A1 test example' do
             expect(1).to eq 1
           end
-          it 'A2 test example' do
+          it 'A2 test example', :my_tag do
             expect(1).to eq 1
           end
         end
@@ -2101,7 +2095,7 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
 
       spec_c = Spec.new('c_spec.rb', <<~SPEC)
         describe 'C_describe' do
-          it 'C1 test example' do
+          it 'C1 test example', :my_tag do
             expect(1).to eq 1
           end
           it 'C2 test example' do
@@ -2114,26 +2108,25 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
         [spec_a, spec_b, spec_c]
       ])
       stub_test_cases_for_slow_test_files([
-        "#{spec_a.path}[1:1]",
-        "#{spec_a.path}[1:2]",
+        "#{spec_a.path}[1:2]", # only this test example is tagged
       ])
       stub_spec_batches([
-        ["#{spec_a.path}[1:1]", spec_b.path],
+        [spec_b.path],
         ["#{spec_a.path}[1:2]", spec_c.path],
       ])
 
       actual = subject
 
-      expect(actual.stdout).to include('ERROR -- : [knapsack_pro] It is not allowed to use the RSpec tag option together with the RSpec split by test examples feature. Please see: https://knapsackpro.com/perma/ruby/rspec-split-by-test-examples-tag')
-
       expect(actual.stdout).to_not include('A1 test example')
-      expect(actual.stdout).to_not include('A2 test example')
-      expect(actual.stdout).to_not include('B1 test example')
-      expect(actual.stdout).to_not include('B2 test example')
-      expect(actual.stdout).to_not include('C1 test example')
+      expect(actual.stdout).to include('A2 test example')
+      expect(actual.stdout).to include('B1 test example')
+      expect(actual.stdout).to include('B2 test example')
+      expect(actual.stdout).to include('C1 test example')
       expect(actual.stdout).to_not include('C2 test example')
 
-      expect(actual.exit_code).to eq 1
+      expect(actual.stdout).to include('4 examples, 0 failures')
+
+      expect(actual.exit_code).to eq 0
     end
   end
 
@@ -2141,16 +2134,13 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
     let(:json_file) { "#{SPEC_DIRECTORY}/rspec.json" }
 
     before do
-      ENV['KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES'] = 'true'
-
-      # remember to stub Queue API batches to include test examples (example: a_spec.rb[1:1])
-      # for the following slow test files
+      # Remember to stub the Queue API batches to include test examples (example: a_spec.rb[1:1])
+      # for the following slow test files.
       ENV['KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN'] = "#{SPEC_DIRECTORY}/a_spec.rb"
 
       ENV['KNAPSACK_PRO_CI_NODE_TOTAL'] = '2'
     end
     after do
-      ENV.delete('KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES')
       ENV.delete('KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN')
       ENV.delete('KNAPSACK_PRO_CI_NODE_TOTAL')
     end
@@ -2243,16 +2233,13 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
     let(:xml_file) { "#{SPEC_DIRECTORY}/rspec.xml" }
 
     before do
-      ENV['KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES'] = 'true'
-
-      # remember to stub Queue API batches to include test examples (example: a_spec.rb[1:1])
-      # for the following slow test files
+      # Remember to stub the Queue API batches to include test examples (example: a_spec.rb[1:1])
+      # for the following slow test files.
       ENV['KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN'] = "#{SPEC_DIRECTORY}/a_spec.rb"
 
       ENV['KNAPSACK_PRO_CI_NODE_TOTAL'] = '2'
     end
     after do
-      ENV.delete('KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES')
       ENV.delete('KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN')
       ENV.delete('KNAPSACK_PRO_CI_NODE_TOTAL')
     end
@@ -2343,16 +2330,13 @@ describe "#{KnapsackPro::Runners::Queue::RSpecRunner} - Integration tests", :cle
     let(:coverage_file) { "#{coverage_dir}/index.html" }
 
     before do
-      ENV['KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES'] = 'true'
-
-      # remember to stub Queue API batches to include test examples (example: a_spec.rb[1:1])
-      # for the following slow test files
+      # Remember to stub the Queue API batches to include test examples (example: a_spec.rb[1:1])
+      # for the following slow test files.
       ENV['KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN'] = "#{SPEC_DIRECTORY}/a_spec.rb"
 
       ENV['KNAPSACK_PRO_CI_NODE_TOTAL'] = '2'
     end
     after do
-      ENV.delete('KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES')
       ENV.delete('KNAPSACK_PRO_SLOW_TEST_FILE_PATTERN')
       ENV.delete('KNAPSACK_PRO_CI_NODE_TOTAL')
     end

data/spec/knapsack_pro/adapters/rspec_adapter_spec.rb

@@ -89,76 +89,6 @@ describe KnapsackPro::Adapters::RSpecAdapter do
     end
   end
 
-  describe '.ensure_no_tag_option_when_rspec_split_by_test_examples_enabled!' do
-    let(:cli_args) { double }
-
-    subject { described_class.ensure_no_tag_option_when_rspec_split_by_test_examples_enabled!(cli_args) }
-
-    before do
-      expect(KnapsackPro::Config::Env).to receive(:rspec_split_by_test_examples?).and_return(rspec_split_by_test_examples_enabled)
-    end
-
-    context 'when RSpec split by test examples enabled' do
-      let(:rspec_split_by_test_examples_enabled) { true }
-
-      before do
-        expect(described_class).to receive(:has_tag_option?).with(cli_args).and_return(has_tag_option)
-      end
-
-      context 'when RSpec tag option is provided' do
-        let(:has_tag_option) { true }
-
-        it do
-          expect { subject }.to raise_error(/It is not allowed to use the RSpec tag option together with the RSpec split by test examples feature/)
-        end
-      end
-
-      context 'when RSpec tag option is not provided' do
-        let(:has_tag_option) { false }
-
-        it 'does nothing' do
-          expect(subject).to be_nil
-        end
-      end
-    end
-
-    context 'when RSpec split by test examples disabled' do
-      let(:rspec_split_by_test_examples_enabled) { false }
-
-      it 'does nothing' do
-        expect(subject).to be_nil
-      end
-    end
-  end
-
-  describe '.has_tag_option?' do
-    subject { described_class.has_tag_option?(cli_args) }
-
-    context 'when tag option is provided as -t' do
-      let(:cli_args) { ['-t', 'mytag'] }
-
-      it { expect(subject).to be true }
-    end
-
-    context 'when tag option is provided as --tag' do
-      let(:cli_args) { ['--tag', 'mytag'] }
-
-      it { expect(subject).to be true }
-    end
-
-    context 'when tag option is provided without delimiter' do
-      let(:cli_args) { ['-tmytag'] }
-
-      it { expect(subject).to be true }
-    end
-
-    context 'when tag option is not provided' do
-      let(:cli_args) { ['--fake', 'value'] }
-
-      it { expect(subject).to be false }
-    end
-  end
-
   describe '.has_format_option?' do
     subject { described_class.has_format_option?(cli_args) }
 
@@ -315,6 +245,18 @@ describe KnapsackPro::Adapters::RSpecAdapter do
     end
   end
 
+  describe '.remove_formatters' do
+    subject { described_class.remove_formatters(cli_args) }
+
+    context "when CLI args include formatters" do
+      let(:cli_args) { ['-t', 'awesome_tag', '-f', 'documentation', '-o', '/tmp/documentation.txt', '--tag', 'mytag', '--format', 'json', '--out', '/tmp/file.json', '--no-color'] }
+
+      it 'removes formatters and the related output file options' do
+        expect(subject).to eq ['-t', 'awesome_tag', '--tag', 'mytag', '--no-color']
+      end
+    end
+  end
+
   describe '.file_path_for' do
     let(:current_example) { ::RSpec.describe.example }
 

data/spec/knapsack_pro/config/env_spec.rb

@@ -977,47 +977,36 @@ describe KnapsackPro::Config::Env do
       described_class.remove_instance_variable(:@rspec_split_by_test_examples)
     end
 
-    context 'when KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=true AND KNAPSACK_PRO_CI_NODE_TOTAL >= 2' do
-      before do
-        stub_const("ENV", { 'KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES' => 'true', 'KNAPSACK_PRO_CI_NODE_TOTAL' => '2' })
-        expect(KnapsackPro).not_to receive(:logger)
-      end
-
-      it { should be true }
-    end
-
-    context 'when KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=false AND KNAPSACK_PRO_CI_NODE_TOTAL >= 2' do
-      before do
-        stub_const("ENV", { 'KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES' => 'false', 'KNAPSACK_PRO_CI_NODE_TOTAL' => '2' })
-        expect(KnapsackPro).not_to receive(:logger)
-      end
-
-      it { should be false }
-    end
-
-    context 'when KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=true AND KNAPSACK_PRO_CI_NODE_TOTAL < 2' do
-      before { stub_const("ENV", { 'KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES' => 'true', 'KNAPSACK_PRO_CI_NODE_TOTAL' => '1' }) }
-
-      it { should be false }
-
-      context 'when called twice' do
-        it 'logs a debug message only once' do
-          logger = instance_double(Logger)
-          expect(KnapsackPro).to receive(:logger).and_return(logger)
-          expect(logger).to receive(:debug).with('Skipping split of test files by test examples because you are running tests on a single CI node (no parallelism)')
+    [
+      ['false', '2', nil, false],
+      ['true',  '2', nil, true],
+      [nil,     '2', nil, true],
+      ['false', '1', nil, false],
+      ['true',  '1', nil, false, :debug, 'Skipping split by test examples because tests are running on a single CI node (no parallelism)'],
+      [nil,     '1', nil, false, :debug, 'Skipping split by test examples because tests are running on a single CI node (no parallelism)'],
+      ['false', '2', 'true', false],
+      ['true',  '2', 'true', true],
+      [nil,     '2', 'true', false, :warn, "Skipping split by test examples because test file names encryption is enabled:\nhttps://knapsackpro.com/perma/ruby/encryption\nhttps://knapsackpro.com/perma/ruby/split-by-test-examples"],
+      ['false', '1', 'true', false],
+      ['true',  '1', 'true', false, :debug, 'Skipping split by test examples because tests are running on a single CI node (no parallelism)'],
+      [nil,     '1', 'true', false, :warn, "Skipping split by test examples because test file names encryption is enabled:\nhttps://knapsackpro.com/perma/ruby/encryption\nhttps://knapsackpro.com/perma/ruby/split-by-test-examples"],
+    ].each do |sbte, node_total, encrypted, expected, log_level, log_message|
+      context "KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES=#{sbte.inspect} AND KNAPSACK_PRO_CI_NODE_TOTAL=#{node_total.inspect} AND KNAPSACK_PRO_TEST_FILES_ENCRYPTED=#{encrypted.inspect}" do
+        before do
+          stub_const("ENV", { 'KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES' => sbte, 'KNAPSACK_PRO_CI_NODE_TOTAL' => node_total, 'KNAPSACK_PRO_TEST_FILES_ENCRYPTED' => encrypted }.compact)
 
-          2.times { described_class.rspec_split_by_test_examples? }
+          if log_level && log_message
+            logger = instance_double(Logger)
+            expect(KnapsackPro).to receive(:logger).and_return(logger)
+            expect(logger).to receive(log_level).once.with(log_message)
+          end
         end
-      end
-    end
 
-    context "when ENV doesn't exist" do
-      before do
-        stub_const("ENV", {})
-        expect(KnapsackPro).not_to receive(:logger)
+        it do
+          expect(described_class.rspec_split_by_test_examples?).to eq(expected)
+          expect(described_class.rspec_split_by_test_examples?).to eq(expected)
+        end
       end
-
-      it { should be false }
     end
   end
 

data/spec/knapsack_pro/runners/rspec_runner_spec.rb

@@ -17,6 +17,7 @@ describe KnapsackPro::Runners::RSpecRunner do
 
       expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_TEST_SUITE_TOKEN', test_suite_token_rspec)
       expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_REGULAR_MODE_ENABLED', 'true')
+      expect(ENV).to receive(:[]=).with('KNAPSACK_PRO_RSPEC_OPTIONS', args)
 
       expect(KnapsackPro::Config::Env).to receive(:set_test_runner_adapter).with(KnapsackPro::Adapters::RSpecAdapter)
 
@@ -40,7 +41,6 @@ describe KnapsackPro::Runners::RSpecRunner do
 
       before do
         expect(KnapsackPro::Adapters::RSpecAdapter).to receive(:verify_bind_method_called).ordered
-        expect(KnapsackPro::Adapters::RSpecAdapter).to receive(:ensure_no_tag_option_when_rspec_split_by_test_examples_enabled!).with(['--profile', '--color']).ordered
 
         expect(Rake::Task).to receive(:[]).with('knapsack_pro:rspec_run').at_least(1).and_return(task)
 

data/spec/knapsack_pro/test_case_detectors/rspec_test_example_detector_spec.rb

@@ -4,21 +4,21 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
   let(:rspec_test_example_detector) { described_class.new }
 
   describe '#generate_json_report' do
-    subject { rspec_test_example_detector.generate_json_report }
+    subject { rspec_test_example_detector.generate_json_report(rspec_args) }
 
-    before do
-      expect(KnapsackPro::Config::TempFiles).to receive(:ensure_temp_directory_exists!)
+    shared_examples 'generate_json_report runs RSpec::Core::Runner' do
+      before do
+        expect(KnapsackPro::Config::TempFiles).to receive(:ensure_temp_directory_exists!)
 
-      expect(FileUtils).to receive(:mkdir_p).with(report_dir)
+        expect(FileUtils).to receive(:mkdir_p).with(report_dir)
 
-      allow(File).to receive(:exist?)
-      expect(File).to receive(:exist?).at_least(:once).with(report_path).and_return(true)
-      expect(File).to receive(:delete).with(report_path)
+        allow(File).to receive(:exist?)
+        expect(File).to receive(:exist?).at_least(:once).with(report_path).and_return(true)
+        expect(File).to receive(:delete).with(report_path)
 
-      expect(rspec_test_example_detector).to receive(:slow_test_files).and_return(test_file_entities)
-    end
+        expect(rspec_test_example_detector).to receive(:slow_test_files).and_return(test_file_entities)
+      end
 
-    shared_examples 'generate_json_report runs RSpec::Core::Runner' do
       context 'when there are no slow test files' do
         let(:test_file_entities) { [] }
 
@@ -45,7 +45,7 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
           expect(KnapsackPro::TestFilePattern).to receive(:test_dir).with(KnapsackPro::Adapters::RSpecAdapter).and_return(test_dir)
 
           options = double
-          expect(RSpec::Core::ConfigurationOptions).to receive(:new).with([
+          expect(RSpec::Core::ConfigurationOptions).to receive(:new).with(expected_args + [
             '--format', expected_format,
             '--dry-run',
             '--no-color',
@@ -85,12 +85,16 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
     end
 
     context 'when RSpec >= 3.6.0' do
+      let(:rspec_args) { '' }
+      let(:expected_args) { [] }
       let(:expected_format) { 'json' }
 
       it_behaves_like 'generate_json_report runs RSpec::Core::Runner'
     end
 
     context 'when RSpec < 3.6.0' do
+      let(:rspec_args) { '' }
+      let(:expected_args) { [] }
       let(:expected_format) { 'KnapsackPro::Formatters::RSpecJsonFormatter' }
 
       before do
@@ -99,6 +103,26 @@ describe KnapsackPro::TestCaseDetectors::RSpecTestExampleDetector do
 
       it_behaves_like 'generate_json_report runs RSpec::Core::Runner'
     end
+
+    context 'when RSpec CLI args are present including format option' do
+      let(:rspec_args) { '-t mytag --format documentation --out /tmp/documentation.txt --tag ~@skip --example-matches regexp --example string' }
+      let(:expected_args) { ['-t', 'mytag', '--tag', '~@skip', '--example-matches', 'regexp', '--example', 'string'] }
+      let(:expected_format) { 'json' }
+
+      describe 'removes formatters from RSpec CLI args' do
+        it_behaves_like 'generate_json_report runs RSpec::Core::Runner'
+      end
+    end
+
+    context 'when RSpec CLI args are not set' do
+      let(:rspec_args) { nil }
+      let(:expected_args) { [] }
+      let(:expected_format) { 'json' }
+
+      it do
+        expect { subject }.to raise_error("The internal KNAPSACK_PRO_RSPEC_OPTIONS environment variable is unset. Ensure it is not overridden accidentally. Otherwise, please report this as a bug: https://knapsackpro.com/perma/ruby/support")
+      end
+    end
   end
 
   describe '#test_file_example_paths' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 7.14.1
+  version: 8.0.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-21 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -39,159 +39,159 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-its
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: spinach
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: spinach
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: 0.9.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: 0.9.9
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.9
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.9
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: ostruct
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '3.13'
 description: Knapsack Pro wraps your current test runner(s) and works with your existing
   CI infrastructure to parallelize tests optimally. It dynamically splits your tests
   based on up-to-date test execution data. It's designed from the ground up for CI