knapsack_pro 2.17.0 → 2.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e22a25e69f6cfda9a42568aed336631f601423b0b930525fc8becbc1b1ee7fe9
-  data.tar.gz: ac1df0750000066a933cc4814f185d09a6d38ce09028680c8f20678bb7b0473e
+  metadata.gz: b2e5ae3f380ffe2e210417898e30fc7091abcc4fbcacab97b340e9e5ea5e700b
+  data.tar.gz: 481dda7a93c2ba5964fa3c20cf60bf2666432311c9a7f1bf59b3be1c905939bb
 SHA512:
-  metadata.gz: 91687797a4f7c80bcd852f7c8e5ec18f523eb5a9375b3dc069b6abce67bc58ccda010f36b6c003fefa01971e628518bf0b9f9e855d7992c86d9ea7dcb375be4b
-  data.tar.gz: c32195b9e6fd4fdee7b5087f61f7d1b28fdb7a6a995930d23e109eda296156026a79fea579e06540e2a64c75ee3a03a6b216f2a8492eb48e422bc9193aad0146
+  metadata.gz: 185add13dfe335fb6b83c1d4a0121f7e097535459c10356401176e1acea5722764554e8f44a2db2ccf806e9a3f4f0a77ca3f701b5b1bc65881d1771722992e67
+  data.tar.gz: a267ddf7469e2affd5e472661dbd2a4fdd17c7f58543dc2c40e305d905004ff7d85808f3e7705892cb4da7ea2dd6fac447ca4a30fc15f296abfafb4668f0f001

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+### 2.18.0
+
+* Do not allow to use the RSpec tag option together with the RSpec split by test examples feature in knapsack_pro gem in Regular Mode 
+
+    https://github.com/KnapsackPro/knapsack_pro-ruby/pull/148
+
+https://github.com/KnapsackPro/knapsack_pro-ruby/compare/v2.17.0...v2.18.0
+
 ### 2.17.0
 
 * Use Ruby 3 in development and add small improvements

data/README.md

@@ -838,7 +838,7 @@ Here you can read how to configure [junit formatter](https://knapsackpro.com/faq
 # spec_helper.rb or rails_helper.rb
 
 # TODO This must be the same path as value for rspec --out argument
-# Note the path should not contain sign ~, for instance path ~/project/tmp/rspec.xml may not work. Please use full path instead.
+# Note the path should not contain ~ char, for instance path ~/project/tmp/rspec.xml may not work. Please use full path instead.
 TMP_RSPEC_XML_REPORT = 'tmp/rspec.xml'
 # move results to FINAL_RSPEC_XML_REPORT so the results won't accumulate with duplicated xml tags in TMP_RSPEC_XML_REPORT
 FINAL_RSPEC_XML_REPORT = 'tmp/rspec_final_results.xml'

data/lib/knapsack_pro/adapters/rspec_adapter.rb

@@ -3,6 +3,27 @@ module KnapsackPro
     class RSpecAdapter < BaseAdapter
       TEST_DIR_PATTERN = 'spec/**{,/*/**}/*_spec.rb'
 
+      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: https://knapsackpro.com/faq/question/how-to-split-slow-rspec-test-files-by-test-examples-by-individual-it#warning-dont-use-rspec-tag-option'
+          KnapsackPro.logger.error(error_message)
+          raise error_message
+        end
+      end
+
+      def self.has_tag_option?(cli_args)
+        # use start_with? because user can define tag option in a few ways:
+        # -t mytag
+        # -tmytag
+        # --tag mytag
+        # --tag=mytag
+        cli_args.any? { |arg| arg.start_with?('-t') || arg.start_with?('--tag') }
+      end
+
+      def self.has_format_option?(cli_args)
+        cli_args.any? { |arg| arg.start_with?('-f') || arg.start_with?('--format') }
+      end
+
       def self.test_path(example_group)
         if defined?(::Turnip) && ::Turnip::VERSION.to_i < 2
           unless example_group[:turnip]

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

@@ -11,18 +11,14 @@ module KnapsackPro
           ENV['KNAPSACK_PRO_QUEUE_RECORDING_ENABLED'] = 'true'
           ENV['KNAPSACK_PRO_QUEUE_ID'] = KnapsackPro::Config::EnvGenerator.set_queue_id
 
-          runner = new(KnapsackPro::Adapters::RSpecAdapter)
+          adapter_class = KnapsackPro::Adapters::RSpecAdapter
+          runner = new(adapter_class)
 
           cli_args = (args || '').split
-
-          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: https://knapsackpro.com/faq/question/how-to-split-slow-rspec-test-files-by-test-examples-by-individual-it#warning-dont-use-rspec-tag-option'
-            KnapsackPro.logger.error(error_message)
-            raise error_message
-          end
+          adapter_class.ensure_no_tag_option_when_rspec_split_by_test_examples_enabled!(cli_args)
 
           # when format option is not defined by user then use progress formatter to show tests execution progress
-          cli_args += ['--format', 'progress'] unless has_format_option?(cli_args)
+          cli_args += ['--format', 'progress'] unless adapter_class.has_format_option?(cli_args)
 
           cli_args += [
             # shows summary of all tests executed in Queue Mode at the very end
@@ -154,19 +150,6 @@ module KnapsackPro
             ::RSpec.configuration.reset_filters
           end
         end
-
-        def self.has_tag_option?(cli_args)
-          # use start_with? because user can define tag option in a few ways:
-          # -t mytag
-          # -tmytag
-          # --tag mytag
-          # --tag=mytag
-          cli_args.any? { |arg| arg.start_with?('-t') || arg.start_with?('--tag') }
-        end
-
-        def self.has_format_option?(cli_args)
-          cli_args.any? { |arg| arg.start_with?('-f') || arg.start_with?('--format') }
-        end
       end
     end
   end

data/lib/knapsack_pro/runners/rspec_runner.rb

@@ -11,6 +11,9 @@ 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/version.rb

@@ -1,3 +1,3 @@
 module KnapsackPro
-  VERSION = '2.17.0'
+  VERSION = '2.18.0'
 end

data/spec/knapsack_pro/adapters/rspec_adapter_spec.rb

@@ -12,6 +12,104 @@ describe KnapsackPro::Adapters::RSpecAdapter do
     it_behaves_like 'adapter'
   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) }
+
+    context 'when format option is provided as -f' do
+      let(:cli_args) { ['-f', 'documentation'] }
+
+      it { expect(subject).to be true }
+    end
+
+    context 'when format option is provided as --format' do
+      let(:cli_args) { ['--format', 'documentation'] }
+
+      it { expect(subject).to be true }
+    end
+
+    context 'when format option is provided without delimiter' do
+      let(:cli_args) { ['-fd'] }
+
+      it { expect(subject).to be true }
+    end
+
+    context 'when format option is not provided' do
+      let(:cli_args) { ['--fake', 'value'] }
+
+      it { expect(subject).to be false }
+    end
+  end
+
   describe '.test_path' do
     let(:current_example_metadata) do
       {

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

@@ -133,31 +133,16 @@ describe KnapsackPro::Runners::Queue::RSpecRunner do
       context 'when RSpec split by test examples feature is enabled' do
         before do
           expect(KnapsackPro::Config::Env).to receive(:rspec_split_by_test_examples?).and_return(true)
+          expect(KnapsackPro::Adapters::RSpecAdapter).to receive(:ensure_no_tag_option_when_rspec_split_by_test_examples_enabled!).and_call_original
         end
 
-        context 'when tag option is provided as --tag' do
+        context 'when tag option is provided' do
           let(:args) { '--tag example-value' }
 
           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 tag option is provided as -t' do
-          let(:args) { '-t example-value' }
-
-          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 tag option is provided without delimiter' do
-          let(:args) { '-texample-value' }
-
-          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
       end
     end
 

data/spec/knapsack_pro/runners/rspec_runner_spec.rb

@@ -34,7 +34,8 @@ describe KnapsackPro::Runners::RSpecRunner do
       let(:task) { double }
 
       before do
-        expect(KnapsackPro::Adapters::RSpecAdapter).to receive(:verify_bind_method_called)
+        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)
 
@@ -44,7 +45,7 @@ describe KnapsackPro::Runners::RSpecRunner do
         expect(t).to receive(:pattern=).with([])
       end
 
-      context 'when task already exists' do
+      context 'when rake task already exists' do
         before do
           expect(Rake::Task).to receive(:task_defined?).with('knapsack_pro:rspec_run').and_return(true)
           expect(task).to receive(:clear)
@@ -57,7 +58,7 @@ describe KnapsackPro::Runners::RSpecRunner do
         end
       end
 
-      context "when task doesn't exist" do
+      context "when rake task doesn't exist" do
         before do
           expect(Rake::Task).to receive(:task_defined?).with('knapsack_pro:rspec_run').and_return(false)
           expect(task).not_to receive(:clear)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knapsack_pro
 version: !ruby/object:Gem::Version
-  version: 2.17.0
+  version: 2.18.0
 platform: ruby
 authors:
 - ArturT
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-25 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake