spec_selector 0.1.0

data/lib/spec_selector/terminal.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module SpecSelectorUtil
+  # The Terminal module contains methods concerned with terminal display
+  # function.
+  module Terminal
+    def clear_frame
+      system("printf '\e[H'")
+      system("printf '\e[3J'")
+      system("printf '\e[0J'")
+    end
+
+    def hide_cursor
+      system("printf '\e[?25l'")
+    end
+
+    def reveal_cursor
+      system("printf '\e[?25h'")
+    end
+
+    def term_height
+      $stdout.winsize[0]
+    end
+
+    def open_alt_buffer
+      system('tput smcup')
+    end
+
+    def close_alt_buffer
+      system('tput rmcup')
+    end
+
+    def reset_cursor
+      system("printf '\e[H'")
+    end
+
+    def term_width
+      $stdout.winsize[1]
+    end
+
+    def position_cursor(row, col)
+      system("printf '\e[#{row};#{col}H'")
+    end
+  end
+end

data/lib/spec_selector/ui.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+module SpecSelectorUtil
+  # The UI module contains methods used to bind and process user input.
+  module UI
+    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
+    ].freeze
+
+    def exit_only
+      q_to_exit
+      loop { quit if user_input.match?(/q/i) }
+    end
+
+    def selector
+      set_selected
+      @example_count > 1 ? display_list : display_example
+      navigate
+    end
+
+    def set_selected
+      @list ||= @active_map[:top_level]
+      @selected ||= @list.first
+    end
+
+    def navigate
+      @selector_index = @list.index(@selected) || 0
+      loop { bind_input }
+    end
+
+    def bind_input
+      input = user_input
+      direction_keys(input) if DIRECTION_KEYS.include?(input)
+      tree_nav_keys(input) if TREE_NAVIGATION_KEYS.include?(input)
+      option_keys(input) if OPTION_KEYS.any? { |key| input.match?(key) }
+    end
+
+    def quit
+      close_alt_buffer if @instructions
+      clear_frame
+      delete_filter_data
+      reveal_cursor
+      exit
+    end
+
+    def top_level_list
+      exit_instruction_page if @instructions
+      @example_display = false
+      @selected = nil
+      @list = @active_map[:top_level]
+      set_selected
+      display_list
+    end
+
+    def select_item
+      return if @example_display
+
+      if example?(@selected)
+        display_example
+        return
+      end
+
+      @list = @active_map[@selected.metadata[:block]]
+      @selected = nil
+      set_selected
+      display_list
+    end
+
+    def exit_instruction_page_only
+      exit_instruction_page
+      refresh_display
+    end
+
+    def top_fail
+      exit_instruction_page if @instructions
+      return if @failed.empty?
+
+      @selected = @failed.first
+      display_example
+    end
+
+    def back
+      return if top_level?
+
+      parent_list
+      set_selected
+      display_list
+    end
+
+    def parent_list
+      if @example_display
+        @example_display = false
+        @list = @active_map[@selected.example_group.metadata[:block]]
+      else
+        data = parent_data(@selected.metadata)
+        p_data = parent_data(data)
+        parent_key = p_data ? p_data[:block] : :top_level
+        @list = @active_map[parent_key]
+        @selected = @groups[data[:block]]
+      end
+    end
+
+    def direction_keys(input)
+      exit_instruction_page if @instructions
+      dir = input == "\e[A" ? -1 : 1
+      @selector_index = (@selector_index + dir) % @list.length
+      @selected = @list[@selector_index]
+      @example_display ? display_example : display_list
+    end
+
+    def tree_nav_keys(input)
+      exit_instruction_page_only if @instructions && input != "\e"
+
+      case input
+      when "\r"
+        select_item
+      when "\x7F"
+        back
+      when "\e"
+        top_level_list
+      end
+    end
+
+    def option_keys(input)
+      case input
+      when /T/
+        top_fail!
+      when /t/
+        top_fail
+      when /p/i
+        toggle_passing
+      when /f/i
+        run_only_fails
+      when /q/i
+        quit
+      when /i/i
+        unless @instructions
+          view_instructions_page
+          return
+        end
+
+        exit_instruction_page_only
+      when /r/i
+        rerun
+      when /^a$/i
+        rerun_all
+      when /m/i
+        return if @instructions
+
+        @selected.metadata[:include] ? filter_remove : filter_include
+        refresh_display
+      when /^c$/i
+        clear_filter
+      when /v/i
+        view_inclusion_filter
+      end
+    end
+
+    def user_input
+      input = $stdin.getch
+      return input unless IO.select([$stdin], nil, nil, 0.000001)
+
+      input << $stdin.read_nonblock(2)
+      input
+    end
+  end
+end

data/license.md

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2021 Trevor Almon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/spec/factories.rb

@@ -0,0 +1,89 @@
+# 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

@@ -0,0 +1,145 @@
+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