spec_selector 0.1.4 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80ae5c42cb85a3c4b3e8f0c03dc798f8e5f15e7f381d9b62266914aa470379a9
-  data.tar.gz: c062e730cead5ff989daaea538b610f692adf9329fcf997aad8da0e5fc53add8
+  metadata.gz: d5ebcfc2cf3d1b1779bab9de9470bf160c00566c830cebaf290c44f26ba7351b
+  data.tar.gz: e80c880103bf8f7cc80701804fe227bff7d3c4de6cad50208c31a00ae6924ec4
 SHA512:
-  metadata.gz: 152df563a0e99607d8e24954e16dab41d7e8e6db49c29d97ea0087a6827431a5d38b7739ba880f7e08db15e6d4ee29c849bc412a615934e52e481186acbcbe07
-  data.tar.gz: 7fa3821bea0d8e20a6eeb5c562e5bec887d7bcdd767110733321c4652ed68b4cf192aaf9c15422d5df09e5ca26d21e2ba23b5d6c2b37c4eeb256bc64b6977cea
+  metadata.gz: f0a033f8cdc4a013e303ddfb00e942c117cca3a887792be54e7cc04e63561eb836f88b1e728b8fb7845fc2f9a6979a926d061df9d75f1db098a5de4e203e410d
+  data.tar.gz: f463910ca22286b2b605d08d29894004bdea3319e4f4c6b6b89412400a1dfb0576406ee76bbadf068d706638e655c0b7b007c2a512ca4cda523e417023319353

data/README.md

@@ -2,20 +2,26 @@
 
 SpecSelector is an RSpec formatter that opens a utility menu in your terminal window when you run tests (rather than just printing static text). The utility allows you to select, view, filter, and rerun specific test results with simple key controls. 
 
-**view test results**
+<br>
 
-Upon finishing the test run, the test result tree appears as a formatted list of top-level example groups. Select an example group to view its subgroups, select a subgroup to view its examples, and so on. You can view your test results with the selection tool, or just press T to immediately view the top failed test. 
+**View test results**
 
-**filter and rerun test results**
+Upon finishing the test run, the test result tree appears as a formatted list of top-level example groups. Select an example group to view its subgroups, select a subgroup to view its examples, and so on. You can view your test results with the selection tool, or just press t to immediately view the top failed test. 
+
+<br>
+
+**Filter and rerun test results**
 
 Using the selection tool, press M to add the selected group or example to the inclusion filter. Press R to rerun RSpec with only selected tests.
 
-Without using the selection tool, press F to rerun only failed tests. Press SHIFT + T to rerun only the top failed test.
+Without using the selection tool, press F to rerun only failed tests. Press T to rerun only the top failed test.
 
 Press C to clear the inclusion filter. Press A to clear the inclusion filter and rerun RSpec with all tests.
 
 Press V to view the inclusion filter as a selection list. 
 
+<br>
+
 _Filter Modes_
 
 Whenever the inclusion filter is not empty, the filter mode will display at the top center of the terminal window. 
@@ -24,6 +30,40 @@ There are two filter modes: _description_ and _location_.
 
 The filter always uses description matching by default, but will use location (line number) matching if examples without descriptions (i.e. "one-liners") are selected for inclusion.
 
+<br>
+
+**Usage notes**
+
+_Text color_
+
+An example description will appear in red text if the example failed, yellow text if the example is pending, or green text if the example passed.
+
+The color of an example group description is determined by the result status of its examples or recursively by the examples of its subgroups. The description will appear in red text if at least one failed example is present in its tree (e.g. if it contains a subgroup that contains a failed example), yellow text if its tree contains no failed examples and at least one pending example, or green text if every example in its tree passed.
+
+<br>
+
+_key controls_
+
+Key control | Description
+------------|--------------
+| BACKSPACE | View the list that contains the parent of the current list or example result summary.|
+| ENTER/RETURN | Select an example group or example from the result list.|
+| ESCAPE | Return to the top-level result list. If already viewing the top-level list, the escape key has no effect.|
+| SPACEBAR | View the top failed example result summary from the current result set. |
+| UP/DOWN | Navigate up and down the result list, or, if viewing an example result summary, view the next or previous example result summary.|
+| A | Clear the inclusion filter and rerun RSpec with all examples.|
+| C | Clear the inclusion filter.|
+| F | Rerun RSpec with only failed examples from the current result set. |
+| I | View or exit instructions.|
+| M | Include or remove an example or example group from the inclusion filter. |
+| P | Hide or reveal passing examples in the current result set. |
+| R | Rerun RSpec with only examples and example groups marked for inclusion. |
+| T | Rerun RSpec with only the top failed example from the current result set. |
+| V | View the inclusion filter as a list. |
+| Q | Exit spec_selector. |
+
+<br>
+
 **Installation**
 
 ````
@@ -41,6 +81,9 @@ Or, use the -f option on the command line
 ````
 rspec -f SpecSelector
 ````
+
+<br>
+<br>
   
 
 

data/lib/spec_selector/instructions.rb

@@ -99,7 +99,7 @@ module SpecSelectorUtil
       empty_line
       bold('Press F to rerun only failed examples')
       empty_line
-      bold('Press SHIFT + T to rerun only the top failed example')
+      bold('Press T to rerun only the top failed example')
       empty_line
       bold('Press M to include or remove selected item from run filter')
       empty_line
@@ -118,7 +118,7 @@ module SpecSelectorUtil
     end
 
     def top_fail_text
-      bold 'Press T to view top failed example'
+      bold 'Press [spacebar] to view top failed example'
     end
 
     def exit_instruction_page

data/lib/spec_selector/state.rb

@@ -127,6 +127,7 @@ module SpecSelectorUtil
     end
 
     def top_fail!
+      return if @failed.empty?
       @inclusion_filter = []
       filter_include(@failed.first)
       rerun

data/lib/spec_selector/ui.rb

@@ -6,12 +6,12 @@ module SpecSelectorUtil
     DIRECTION_KEYS = ["\e[A", "\e[B"].freeze
     TREE_NAVIGATION_KEYS = ["\r", "\x7F", "\e"].freeze
     OPTION_KEYS = [
-      /t/i, /f/i, /p/i, /q/i, /i/i, /r/i, /m/i, /c/i, /a/i, /v/i
+      /^t$/i, /^f$/i, /^p$/i, /^q$/i, /^i$/i, /^r$/i, /^m$/i, /^c$/i, /^a$/i, /^v$/i, /^ $/
     ].freeze
 
     def exit_only
       q_to_exit
-      loop { quit if user_input.match?(/q/i) }
+      loop { quit if user_input.match?(/^q$/i) }
     end
 
     def selector
@@ -125,35 +125,35 @@ module SpecSelectorUtil
 
     def option_keys(input)
       case input
-      when /T/
+      when /^t$/i
         top_fail!
-      when /t/
+      when /^ $/
         top_fail
-      when /p/i
+      when /^p$/i
         toggle_passing
-      when /f/i
+      when /^f$/i
         run_only_fails
-      when /q/i
+      when /^q$/i
         quit
-      when /i/i
+      when /^i$/i
         unless @instructions
           view_instructions_page
           return
         end
 
         exit_instruction_page_only
-      when /r/i
+      when /^r$/i
         rerun
       when /^a$/i
         rerun_all
-      when /m/i
+      when /^m$/i
         return if @instructions
 
         @selected.metadata[:include] ? filter_remove : filter_include
         refresh_display
       when /^c$/i
         clear_filter
-      when /v/i
+      when /^v$/i
         view_inclusion_filter
       end
     end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: spec_selector
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.8
 platform: ruby
 authors:
 - Trevor Almon
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -34,28 +34,22 @@ cert_chain:
   2oaEU1xxH+4n3qzECM32PIry9QVrTud/3/ouDLy4LVVyutD5ZANsVQrr0y8vEA6+
   OXcnI0Yc8EI4dmIAwDI0ZfBo2OgFBxNJCeurVx36tUPsSWjJUd0BeA==
   -----END CERTIFICATE-----
-date: 2021-02-28 00:00:00.000000000 Z
+date: 2021-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '3.0'
 description: "  SpecSelector is an RSpec formatter that opens a utility \n  menu in
   your terminal window when you run tests (rather \n  than just printing static text).
   The utility allows you to \n  select, view, filter, and rerun specific test results
@@ -78,23 +72,14 @@ files:
 - lib/spec_selector/terminal.rb
 - lib/spec_selector/ui.rb
 - license.md
-- spec/factories.rb
-- spec/shared.rb
-- spec/spec_helper.rb
-- spec/spec_selector_spec.rb
-- spec/spec_selector_util/data_map_spec.rb
-- spec/spec_selector_util/data_presentation_spec.rb
-- spec/spec_selector_util/format_spec.rb
-- spec/spec_selector_util/helpers_spec.rb
-- spec/spec_selector_util/initialize_spec.rb
-- spec/spec_selector_util/ui_spec.rb
 homepage: https://github.com/TrevorA-TrevorA/spec_selector
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/TrevorA-TrevorA/spec_selector
   homepage_uri: https://github.com/TrevorA-TrevorA/spec_selector
-post_install_message: 
+  changelog_uri: https://github.com/TrevorA-TrevorA/spec_selector/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,8 +94,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.21
+signing_key:
 specification_version: 4
 summary: A results viewer and filter utility for RSpec
 test_files: []

data/spec/factories.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-module TestObjects
-  RSN = RSpec::Core::Notifications
-
-  class Example < RSpec::Core::Example
-    attr_accessor :metadata, :execution_result, :description, :example_group
-
-    def initialize
-    end
-  end
-
-  class ExecutionResult < RSpec::Core::Example::ExecutionResult
-    attr_accessor :status
-  end
-
-  class ExampleGroup < RSpec::Core::ExampleGroup
-    attr_accessor :examples, :metadata, :description
-  end
-
-  class SummaryNotification < RSN::SummaryNotification
-    attr_accessor :example_count,
-                  :duration,
-                  :load_time,
-                  :errors_outside_of_example_count
-
-    :examples
-  end
-
-  class SkippedExampleNotification < RSN::SkippedExampleNotification
-    attr_accessor :example
-
-    def fully_formatted(_)
-      "\npending example"
-    end
-  end
-
-  class FailedExampleNotification < RSN::FailedExampleNotification
-    attr_accessor :example
-
-    def initialize
-    end
-
-    def fully_formatted(_)
-      "\nfailed example"
-    end
-  end
-end
-
-FactoryBot.define do
-  factory :execution_result, class: 'TestObjects::ExecutionResult' do
-    status { :passed }
-  end
-
-  factory :example, class: 'TestObjects::Example' do
-    execution_result { build(:execution_result) }
-    description { 'passed' }
-    metadata { {} }
-  end
-
-  factory :example_group, class: 'TestObjects::ExampleGroup' do
-    examples { [build(:example)] }
-    metadata { { block: self } }
-    description do
-      if examples.all? { |ex| ex.execution_result.status == :passed }
-        'passing example group'
-      else
-        'non-passing example group'
-      end
-    end
-  end
-
-  factory :summary_notification, class: 'TestObjects::SummaryNotification' do
-    example_count { 25 }
-    duration { 1.5 }
-    load_time { 0.5 }
-    errors_outside_of_examples_count { 0 }
-  end
-
-  factory :skipped_example_notification,
-          class: 'TestObjects::SkippedExampleNotification' do
-    example
-  end
-
-  factory :failed_example_notification,
-          class: 'TestObjects::FailedExampleNotification' do
-    example
-  end
-end

data/spec/shared.rb

@@ -1,145 +0,0 @@
-RSpec.shared_context 'shared' do
-  let(:spec_selector) { SpecSelector.new(StringIO.new) }
-  let(:output) { spec_selector.ivar(:@output).string }
-  let(:fail_result) { build(:execution_result, status: :failed) }
-  let(:pending_result) { build(:execution_result, status: :pending) }
-  let(:failed_example) { build(:example, execution_result: fail_result, metadata: { description: 'failed_example' }) }
-  let(:pending_example) do
-    build(:example, execution_result: pending_result, metadata: { description: 'pending_example' })
-  end
-  let(:passing_example) do
-    build(:example, metadata: { description: 'passing_example' }, description: 'passing_example')
-  end
-  let(:pass_group) do
-    build(:example_group, examples: [build(:example), build(:example)], metadata: { description: 'pass_group' })
-  end
-  let(:fail_group) { build(:example_group, examples: [failed_example, failed_example]) }
-  let(:pending_group) do
-    build(:example_group, examples: [pending_example, pending_example], metadata: { description: 'pending_group' })
-  end
-  let(:mixed_result_group) { build(:example_group, examples: [passing_example, failed_example, pending_example]) }
-  let(:fail_subgroup) do
-    build(
-      :example_group,
-      metadata: {
-        parent_example_group: {}
-      },
-      examples: [failed_example, failed_example]
-    )
-  end
-
-  let(:pending_subgroup) do
-    build(
-      :example_group,
-      metadata: {
-        parent_example_group: {}
-      },
-      examples: [pending_example, pending_example]
-    )
-  end
-
-  let(:fail_parent_group) { build(:example_group, examples: [], metadata: { description: 'fail_parent_group' }) }
-  let(:pending_parent_group) { build(:example_group, examples: [], metadata: { description: 'pending_parent_group' }) }
-  let(:pass_subgroup) do
-    build(
-      :example_group,
-      metadata: { parent_example_group: pass_parent_group.metadata, description: 'pass_subgroup' },
-      examples: [passing_example, passing_example]
-    )
-  end
-
-  let(:pass_parent_group) { build(:example_group, examples: [], metadata: { description: 'pass_parent_group' }) }
-  let(:mixed_list) { [pass_group, fail_group] }
-  let(:mixed_map) do
-    {
-      :top_level => [pass_group, fail_group],
-      pass_group.metadata[:block] => pass_group.examples,
-      fail_group.metadata[:block] => fail_group.examples
-    }
-  end
-
-  let(:pending_map) do
-    {
-      :top_level => [pending_group],
-      pending_group.metadata[:block] => pending_group.examples
-    }
-  end
-
-  let(:deep_map) do
-    {
-      :top_level => [pending_parent_group, pass_parent_group, fail_parent_group],
-      pending_parent_group.metadata[:block] => [pending_subgroup],
-      pass_parent_group.metadata[:block] => [pass_subgroup],
-      fail_parent_group.metadata[:block] => [fail_subgroup],
-      pending_subgroup.metadata[:block] => pending_subgroup.examples,
-      pass_subgroup.metadata[:block] => pass_subgroup.examples,
-      fail_subgroup.metadata[:block] => fail_subgroup.examples
-    }
-  end
-
-  let(:all_passing_map) do
-    {
-      top_level: [pass_group, pass_group],
-      pass_group.metadata[:block] => pass_group.examples,
-      pass_group.metadata[:block] => pass_group.examples
-    }
-  end
-
-  def allow_methods(*methods)
-    methods.each do |method|
-      allow(spec_selector).to receive(method)
-    end
-  end
-
-  def ivars_set(ivar_hash)
-    ivar_hash.each do |ivar, value|
-      spec_selector.ivar_set(ivar, value)
-    end
-  end
-
-  def ivar_set(sym, value)
-    spec_selector.ivar_set(sym, value)
-  end
-
-  def ivar(sym)
-    spec_selector.ivar(sym)
-  end
-
-  def more_data?(readable)
-    IO.select([readable], nil, nil, 0.000001)
-  end
-
-  def summary_settings(example)
-    case example
-    when failed_example
-      notification_type = :failed_example_notification
-      summary_list = :@failure_summaries
-      ivar = :@failed
-    when pending_example
-      notification_type = :skipped_example_notification
-      summary_list = :@pending_summaries
-      ivar = :@pending
-    end
-
-    ivars_set(:@selected => example, ivar => [example])
-    notification = build(notification_type, example: example)
-    spec_selector.ivar(summary_list)[example] = notification
-  end
-
-  def expect_full_instructions_to_be_displayed
-    expect(output).to include('Press I to hide instructions')
-    expect(output).to include('Press F to exclude passing examples')
-    expect(output).to include('Press ↑ or ↓ to navigate list')
-    expect(output).to include('Press [enter] to select')
-    expect(output).to include('Press Q to exit')
-  end
-
-  def expect_full_instructions_to_be_hidden
-    expect(output).to include('Press I to view instructions')
-    expect(output).not_to include('Press I to hide instructions')
-    expect(output).not_to include('Press F to exclude passing examples')
-    expect(output).not_to include('Press ↑ or ↓ to navigate list')
-    expect(output).not_to include('Press [enter] to select')
-    expect(output).not_to include('Press Q to exit')
-  end
-end

data/spec/spec_helper.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_selector'
-require 'stringio'
-require 'factory_bot'
-require 'timeout'
-require 'shared'
-
-RCN = RSpec::Core::Notifications
-EXAMPLE_STUBS = { description: 'description',
-                  execution_result: 'result',
-                  full_description: 'full_description' }.freeze
-
-alias ivar instance_variable_get
-alias ivar_set instance_variable_set
-
-RSpec.configure do |config|
-  config.expect_with :rspec do |expectations|
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  config.filter_run_when_matching :focus
-
-  config.mock_with :rspec do |mocks|
-    mocks.verify_partial_doubles = true
-  end
-
-  config.shared_context_metadata_behavior = :apply_to_host_groups
-
-  config.include_context 'shared', include_shared: true
-
-  config.include FactoryBot::Syntax::Methods
-
-  config.before(:suite) do
-    FactoryBot.find_definitions
-  end
-
-  config.around(:example, break_loop: true) do |example|
-    begin
-      Timeout.timeout(0.001) do
-        example.run
-      end
-    rescue Timeout::Error
-      nil
-    end
-  end
-end