spec_selector 0.1.0

data/spec/spec_selector_util/format_spec.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+describe 'SpecSelectorUtil::Format' do
+  include_context 'shared'
+
+  describe '#fetch_examples' do
+    context 'when argument is an example' do
+      let(:example) { build(:example) }
+
+      it 'returns an array containing only the argument' do
+        expect(spec_selector.fetch_examples(example)).to eq([example])
+      end
+    end
+
+    context 'when argument is an example group with no subgroups' do
+      before { ivar_set(:@map, mixed_map) }
+
+      it 'returns an array of the examples that belong to the example group' do
+        expect(spec_selector.fetch_examples(pass_group)).to eq(pass_group.examples)
+      end
+    end
+
+    context 'when argument is an example group with subgroups' do
+      before { ivar_set(:@map, deep_map) }
+
+      it 'returns an array of all descendent examples of the example group' do
+        expect(spec_selector.fetch_examples(fail_parent_group)).to eq(fail_subgroup.examples)
+      end
+    end
+  end
+
+  describe '#format_list_item' do
+    context 'when argument is a currently selected list item' do
+      before { ivars_set(:@list => deep_map[:top_level], :@selected => pass_parent_group, :@map => deep_map) }
+
+      it 'prints the argument description in highlighted text' do
+        spec_selector.format_list_item(pass_parent_group)
+        expect(output).to eq("\e[1;7mpass_parent_group\e[0m\n")
+      end
+    end
+
+    context 'when argument is non-selected passing example' do
+      before { ivar_set(:@map, deep_map) }
+
+      it 'prints the argument description in green text' do
+        spec_selector.format_list_item(passing_example)
+        expect(output).to eq("\e[1;32mpassing_example\e[0m\n")
+      end
+    end
+
+    context 'when argument is non-selected example group whose descendent examples all pass' do
+      before { ivar_set(:@map, mixed_map) }
+
+      it 'prints the argument description in green text' do
+        spec_selector.format_list_item(pass_group)
+        expect(output).to eq("\e[1;32mpass_group\e[0m\n")
+      end
+    end
+
+    context 'when argument is non-selected failed example' do
+      it 'prints the argument description in red text' do
+        spec_selector.format_list_item(failed_example)
+        expect(output).to eq("\e[1;31mfailed_example\e[0m\n")
+      end
+    end
+
+    context 'when argument is non-selected example group with at least one failed descendent example' do
+      before { ivar_set(:@map, deep_map) }
+
+      it 'prints the argument description in red text' do
+        spec_selector.format_list_item(fail_parent_group)
+        expect(output).to eq("\e[1;31mfail_parent_group\e[0m\n")
+      end
+    end
+
+    context 'when argument is a pending example' do
+      it 'prints the argument description in yellow text' do
+        spec_selector.format_list_item(pending_example)
+        expect(output).to eq("\e[1;33mpending_example\e[0m\n")
+      end
+    end
+
+    context 'when argument is non-selected example group with at least one pending and no failed descendent examples' do
+      before { ivar_set(:@map, pending_map) }
+
+      it 'prints the argument description in yellow text' do
+        spec_selector.format_list_item(pending_group)
+        expect(output).to eq("\e[1;33mpending_group\e[0m\n")
+      end
+    end
+
+    context 'when argument is included in filter' do
+      let(:example) { build(:example, metadata: { include: true, description: 'the example' }) }
+
+      it 'prints the argument description with a check mark' do
+        spec_selector.format_list_item(example)
+        expect(output).to eq("\e[1;32mthe example\e[0m √\n")
+      end
+    end
+  end
+
+  describe '#pass_count' do
+    before { ivar_set(:@pass_count, 30) }
+
+    it 'prints the current number of passing examples in green text' do
+      spec_selector.pass_count
+      expect(output).to eq("\e[1;32mPASS: 30\e[0m\n")
+    end
+  end
+
+  describe '#pending_count' do
+    before { ivar_set(:@pending_count, 10) }
+
+    it 'prints the current number of pending examples' do
+      spec_selector.pending_count
+      expect(output).to eq("\e[1;33mPENDING: 10\e[0m\n")
+    end
+  end
+
+  describe '#fail_count' do
+    before { ivar_set(:@fail_count, 20) }
+
+    it 'prints the current number of failed examples' do
+      spec_selector.fail_count
+      expect(output).to eq("\e[1;31mFAIL: 20\e[0m\n")
+    end
+  end
+
+  describe '#highlight' do
+    before { ivar_set(:@selected, passing_example) }
+
+    it 'prints the argument in highlighted text' do
+      spec_selector.highlight(passing_example.description)
+      expect(output).to eq("\e[1;7mpassing_example\e[0m\n")
+    end
+
+    context 'when argument is included in filter' do
+      it 'prints the argument with a check mark' do
+        spec_selector.highlight(passing_example.description, true)
+        expect(output).to eq("\e[1;7mpassing_example √\e[0m\n")
+      end
+    end
+  end
+
+  describe '#lineage' do
+    it 'recursively prepends descriptions of ancestor example groups to description of argument' do
+      expect(spec_selector.lineage(pass_subgroup.metadata)).to eq('pass_parent_group -> pass_subgroup')
+    end
+  end
+
+  describe '#format_example' do
+    it 'prints description of selected example' do
+      ivar_set(:@selected, passing_example)
+      spec_selector.format_example(:passed, nil)
+      expect(output).to match(/passing_example/)
+    end
+
+    context 'when selected example is passing' do
+      it 'prints "PASSED" in green text' do
+        ivar_set(:@selected, passing_example)
+        spec_selector.format_example(:passed, nil)
+        expect(output).to include("\e[1;32mPASSED\e[0m")
+      end
+    end
+
+    context 'when selected example is pending or failed' do
+      let(:notification) { build(:failed_example_notification) }
+
+      it 'prints example result summary' do
+        ivar_set(:@selector_index, 0)
+        spec_selector.format_example(:failed, notification)
+        expect(output).to include('failed example')
+      end
+    end
+  end
+
+  describe '#print_nonpassing_example' do
+    context 'when selected example is failed' do
+      let(:notification) { build(:failed_example_notification) }
+
+      it 'prints failure summary of selected example' do
+        ivar_set(:@selector_index, 0)
+        spec_selector.print_nonpassing_example(notification)
+        expect(output).to include('failed example')
+      end
+    end
+
+    context 'when selected example is pending' do
+      let(:notification) { build(:skipped_example_notification) }
+
+      it 'prints pending summary of selected example' do
+        ivar_set(:@selector_index, 0)
+        spec_selector.print_nonpassing_example(notification)
+        expect(output).to include('pending example')
+      end
+    end
+  end
+
+  describe '#print_passing_example' do
+    before do
+      ivar_set(:@selected, passing_example)
+      spec_selector.print_passing_example
+    end
+
+    it 'prints description of selected example' do
+      expect(output).to include('passing_example')
+    end
+
+    it 'prints "PASSED"' do
+      expect(output).to include('PASSED')
+    end
+  end
+end

data/spec/spec_selector_util/helpers_spec.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+describe 'SpecSelectorUtil::Helpers' do
+  include_context 'shared'
+
+  describe '#all_passing?' do
+    context 'when all examples have passed' do
+      before { ivars_set({ :@pass_count => 10, :@fail_count => 0, :@pending_count => 0 }) }
+
+      it 'returns true' do
+        expect(spec_selector.all_passing?).to be true
+      end
+    end
+
+    context 'when not all examples have passed' do
+      before { ivars_set({ :@pass_count => 5, :@fail_count => 5, :@pending_count => 5 }) }
+
+      it 'returns false' do
+        expect(spec_selector.all_passing?).to be false
+      end
+    end
+  end
+
+  describe '#none_passing?' do
+    context 'when no examples have passed' do
+      before { ivars_set({ :@pass_count => 0, :@fail_count => 5, :@pending_count => 5 }) }
+
+      it 'returns true' do
+        expect(spec_selector.none_passing?).to be true
+      end
+    end
+
+    context 'when at least one example has passed' do
+      before { ivars_set({ :@pass_count => 1, :@fail_count => 4, :@pending_count => 5 }) }
+
+      it 'returns false' do
+        expect(spec_selector.none_passing?).to be false
+      end
+    end
+  end
+
+  describe '#all_passed?' do
+    context 'when every example in argument array has passed' do
+      let(:examples) { pass_group.examples }
+
+      it 'returns true' do
+        expect(spec_selector.all_passed?(examples)).to be true
+      end
+    end
+
+    context 'when at least one example in argument array did not pass' do
+      let(:examples) { mixed_result_group.examples }
+
+      it 'returns false' do
+        expect(spec_selector.all_passed?(examples)).to be false
+      end
+    end
+  end
+
+  describe '#any_failed?' do
+    context 'when at least one example in argument array has failed' do
+      let(:examples) { fail_group.examples }
+
+      it 'returns true' do
+        expect(spec_selector.any_failed?(examples)).to be true
+      end
+    end
+
+    context 'when no examples in argument array have failed' do
+      let(:examples) { pass_group.examples }
+
+      it 'returns false' do
+        expect(spec_selector.any_failed?(examples)).to be false
+      end
+    end
+  end
+
+  describe '#any_pending?' do
+    context 'when at least one example has pending status' do
+      let(:examples) { mixed_result_group.examples }
+
+      it 'returns true' do
+        expect(spec_selector.any_pending?(examples)).to be true
+      end
+    end
+
+    context 'when no examples have pending status' do
+      let(:examples) { fail_group.examples }
+
+      it 'returns false' do
+        expect(spec_selector.any_pending?(examples)).to be false
+      end
+    end
+  end
+
+  describe '#example?' do
+    context 'when argument is an instance of RSpec::Core::Example' do
+      let(:example) { build(:example) }
+
+      it 'returns true' do
+        expect(spec_selector.example?(example)).to be true
+      end
+    end
+
+    context 'when argument is not an instance of RSpec::Core::Example' do
+      let(:non_example) { build(:example_group) }
+
+      it 'returns false' do
+        expect(spec_selector.example?(non_example)).to be false
+      end
+    end
+  end
+
+  describe '#status' do
+    it 'returns the execution result status of example' do
+      expect(spec_selector.status(passing_example)).to eq(:passed)
+    end
+  end
+
+  describe '#description_mode?' do
+    context 'when @filter_mode is set to :description' do
+      before { spec_selector.ivar_set(:@filter_mode, :description) }
+
+      it 'returns true' do
+        expect(spec_selector.description_mode?).to be true
+      end
+    end
+
+    context 'when @filter_mode is not set to :description' do
+      before { spec_selector.ivar_set(:@filter_mode, :location) }
+
+      it 'returns false' do
+        expect(spec_selector.description_mode?).to be false
+      end
+    end
+  end
+
+  describe '#location_mode?' do
+    context 'when @filter_mode is set to :location' do
+      before { spec_selector.ivar_set(:@filter_mode, :location) }
+
+      it 'returns true' do
+        expect(spec_selector.location_mode?).to be true
+      end
+    end
+
+    context 'when @filter_mode is not set to :location' do
+      before { spec_selector.ivar_set(:@filter_mode, :description) }
+
+      it 'returns false' do
+        expect(spec_selector.location_mode?).to be false
+      end
+    end
+  end
+
+  describe '#empty_line' do
+    it 'prints an newline character' do
+      spec_selector.empty_line
+      expect(output).to eq("\n")
+    end
+  end
+
+  describe '#top_level?' do
+    context 'when current list is a top-level list' do
+      before { ivars_set(:@active_map => mixed_map, :@list => mixed_map[:top_level]) }
+
+      it 'returns true' do
+        expect(spec_selector.top_level?).to be true
+      end
+    end
+
+    context 'when current list is not a top-level list' do
+      before { ivars_set(:@active_map => mixed_map, :@list => mixed_map[fail_group.metadata[:block]]) }
+
+      it 'returns false' do
+        expect(spec_selector.top_level?).to be false
+      end
+    end
+  end
+
+  describe '#filter_view?' do
+    context 'when current list is inclusion filter' do
+      before { ivars_set(:@inclusion_filter => fail_group.examples, :@list => fail_group.examples) }
+
+      it 'returns true' do
+        expect(spec_selector.filter_view?).to be true
+      end
+    end
+
+    context 'when current list is not inclusion filter' do
+      before { ivars_set(:@inclusion_filter => fail_group.examples, :@list => pass_group.examples) }
+
+      it 'returns false' do
+        expect(spec_selector.filter_view?).to be false
+      end
+    end
+  end
+
+  describe '#current_path' do
+    it 'returns the absolute path to directory that contains the current file' do
+      expect(spec_selector.current_path).to match(%r{spec_selector/lib/spec_selector$})
+    end
+  end
+
+  describe '#one_liner?' do
+    context 'when the argument is an example written in descriptionless (one-liner) syntax' do
+      let(:example) { build(:example, metadata: { description_args: [] }) }
+
+      it 'returns true' do
+        expect(spec_selector.one_liner?(example)).to be true
+      end
+    end
+
+    context 'when the argument is a described example' do
+      let(:example) { build(:example, metadata: { description_args: ['is a described example'] }) }
+
+      it 'returns false' do
+        expect(spec_selector.one_liner?(example)).to be false
+      end
+    end
+  end
+end

data/spec/spec_selector_util/initialize_spec.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+describe SpecSelectorUtil::Initialize do
+  # the subject calls #initialze_all during initialization, which calls
+  # all of the other methods in this block.
+  subject(:spec_selector) { SpecSelector.new(StringIO.new) }
+
+  describe '#init_example_store' do
+    it 'initializes @failed to an empty array' do
+      expect(spec_selector.ivar(:@failed)).to eq([])
+    end
+
+    it 'initializes @passed to an empty array' do
+      expect(spec_selector.ivar(:@passed)).to eq([])
+    end
+
+    it 'initializes @pending to an empty array' do
+      expect(spec_selector.ivar(:@pending)).to eq([])
+    end
+  end
+
+  describe '#init_summaries' do
+    it 'initializes @failure_summaries to an empty hash' do
+      expect(spec_selector.ivar(:@failure_summaries)).to eq({})
+    end
+
+    it 'initializes @pending_summaries to an empty hash' do
+      expect(spec_selector.ivar(:@pending_summaries)).to eq({})
+    end
+  end
+
+  describe '#init_counters' do
+    it 'initializes @pass_count to zero' do
+      expect(spec_selector.ivar(:@pass_count)).to eq(0)
+    end
+
+    it 'initializes @fail_count to zero' do
+      expect(spec_selector.ivar(:@fail_count)).to eq(0)
+    end
+
+    it 'initializes @pending_count to zero' do
+      expect(spec_selector.ivar(:@pending_count)).to eq(0)
+    end
+  end
+
+  describe '#init_pass_inclusion' do
+    it 'initializes @exclude_passing to false' do
+      expect(spec_selector.ivar(:@exclude_passing)).to eq(false)
+    end
+  end
+
+  describe '#init_map' do
+    let(:map) { spec_selector.ivar(:@map) }
+
+    it 'initializes @groups to an empty hash' do
+      expect(spec_selector.ivar(:@groups)).to eq({})
+    end
+
+    it 'initializes @map to an empty hash' do
+      expect(map).to eq({})
+    end
+
+    it 'initializes @active_map to @map' do
+      expect(spec_selector.ivar(:@active_map)).to eq(map)
+    end
+
+    it 'initializes @list to nil' do
+      expect(spec_selector.ivar(:@list)).to be_nil
+    end
+  end
+
+  describe '#init_selector' do
+    it 'initializes @selected to nil' do
+      expect(spec_selector.ivar(:@selected)).to be_nil
+    end
+
+    it 'initialzes @selector_index to zero' do
+      expect(spec_selector.ivar(:@selector_index)).to eq(0)
+    end
+  end
+
+  # #initialize_all calls the above methods and initializes the
+  # instance variables tested below.
+  describe '#initialize_all' do
+    it 'initializes @messages to an empty array' do
+      expect(spec_selector.ivar(:@messages)).to eq([])
+    end
+
+    it 'initializes @instructions to false' do
+      expect(spec_selector.ivar(:@instructions)).to eq(false)
+    end
+  end
+end