spec_selector 0.1.0

data/lib/spec_selector/helpers.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module SpecSelectorUtil
+  # The Helpers module contains helper methods shared across multiple
+  # concerns.
+  module Helpers
+    def all_passing?
+      (@pending_count + @fail_count).zero? && @pass_count.positive?
+    end
+
+    def none_passing?
+      (@pending_count + @fail_count).positive? && @pass_count.zero?
+    end
+
+    def all_passed?(examples)
+      examples.all? { |example| example.execution_result.status == :passed }
+    end
+
+    def any_failed?(examples)
+      examples.any? { |example| example.execution_result.status == :failed }
+    end
+
+    def any_pending?(examples)
+      examples.any? { |example| example.execution_result.status == :pending }
+    end
+
+    def example?(item)
+      item.is_a?(RSpec::Core::Example)
+    end
+
+    def status(example)
+      example.execution_result.status
+    end
+
+    def description_mode?
+      @filter_mode == :description
+    end
+
+    def location_mode?
+      @filter_mode == :location
+    end
+
+    def empty_line
+      @output.puts "\n"
+    end
+
+    def top_level?
+      @list == @active_map[:top_level]
+    end
+
+    def filter_view?
+      @list == @inclusion_filter
+    end
+
+    def current_path
+      File.dirname(__FILE__)
+    end
+
+    def one_liner?(example)
+      example.metadata[:description_args].empty?
+    end
+  end
+end

data/lib/spec_selector/initialize.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module SpecSelectorUtil
+  # The Initialize module contains methods that initialize specific sets of
+  # instance variables for the SpecSelector instance.
+  module Initialize
+    def init_example_store
+      @failed = []
+      @passed = []
+      @pending = []
+    end
+
+    def init_summaries
+      @failure_summaries = {}
+      @pending_summaries = {}
+    end
+
+    def init_counters
+      @pass_count = 0
+      @fail_count = 0
+      @pending_count = 0
+    end
+
+    def init_pass_inclusion
+      @exclude_passing = false
+    end
+
+    def init_map
+      @groups = {}
+      @map = {}
+      @active_map = @map
+      @list = nil
+    end
+
+    def init_selector
+      @selected = nil
+      @selector_index = 0
+    end
+
+    def get_locations
+      if File.exist?(@locations_file)
+        locations = File.open(@locations_file)
+        @last_run_locations = JSON.load(locations)
+        @filter_mode = :location
+      else
+        @last_run_locations = []
+      end
+    end
+
+    def get_descriptions
+      if File.exist?(@descriptions_file)
+        included = File.open(@descriptions_file)
+        @last_run_descriptions = JSON.load(included)
+      else
+        @last_run_descriptions = []
+      end
+    end
+
+    def init_filter
+      inclusion_filter_path = "#{current_path}/inclusion_filter"
+      Dir.mkdir(inclusion_filter_path) unless Dir.exist?(inclusion_filter_path)
+      @descriptions_file = "#{current_path}/inclusion_filter/descriptions.json"
+      @locations_file = "#{current_path}/inclusion_filter/locations.json"
+      @inclusion_filter = []
+      @filter_mode = :description
+      get_descriptions
+      get_locations
+    end
+
+    def initialize_all
+      @messages = []
+      @notices = []
+      init_example_store
+      init_summaries
+      init_counters
+      init_pass_inclusion
+      init_map
+      init_selector
+      init_filter
+      @instructions = false
+    end
+  end
+end

data/lib/spec_selector/instructions.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module SpecSelectorUtil
+  # The Instructions module contains methods used to render the
+  # appropriate user instructions.
+  module Instructions
+    def basic_instructions
+      i_for_instructions
+      up_down_select_instructions
+      q_to_exit
+    end
+
+    def all_passed_message
+      bold("ALL EXAMPLES PASSED\n")
+    end
+
+    def empty_filter_notice
+      notice = '**********FILTER EMPTY**********'
+      row = term_width / 2 - notice.length / 2
+      position_cursor(1, row)
+      @output.puts notice
+      reset_cursor
+      nil
+    end
+
+    def display_filter_mode
+      unless @inclusion_filter.empty?
+        notice = "FILTER MODE: #{@filter_mode.to_s.upcase}"
+        col = term_width / 2 - notice.length / 2
+        position_cursor(1, col)
+        italicize notice
+        reset_cursor
+      end
+    end
+
+    def back_instructions
+      back_inst = 'Press [back] to view to parent group list'
+      escape_inst = 'Press [escape] to view to top-level group list'
+
+      [back_inst, escape_inst].each do |inst|
+        if @instructions
+          bold(inst)
+          empty_line
+        else
+          @output.puts inst
+        end
+      end
+    end
+
+    def q_to_exit
+      @output.puts 'Press Q to exit'
+    end
+
+    def view_other_examples(status)
+      verb = (status == :passed ? 'passing' : status.to_s)
+      @output.puts "Press ↑ or ↓ to view other #{verb} examples"
+    end
+
+    def filter_pass_instructions
+      verb = @exclude_passing ? 'show' : 'hide'
+      bold "Press P to #{verb} passing examples in current set"
+    end
+
+    def i_for_instructions
+      @output.puts 'Press I to view full instructions'
+    end
+
+    def up_down_select_instructions
+      up_down_inst = 'Press ↑ or ↓ to navigate list' if @list.count > 1
+      select_inst = 'press [enter] to select'
+
+      [up_down_inst, select_inst].each do |inst|
+        if @instructions
+          bold(inst)
+          empty_line
+        else
+          @output.puts inst
+        end
+      end
+    end
+
+    def view_instructions_page
+      @instructions = true
+      open_alt_buffer
+
+      unless @failed.empty? || @selected == @failed.first
+        top_fail_text
+        empty_line
+      end
+
+      unless all_passing? || none_passing?
+        filter_pass_instructions
+        empty_line
+      end
+
+      up_down_select_instructions
+      back_instructions unless top_level?
+      bold('Press R to rerun examples with filter selection')
+      empty_line
+      bold('Press F to rerun only failed examples')
+      empty_line
+      bold('Press SHIFT + T to rerun only the top failed example')
+      empty_line
+      bold('Press M to include or remove selected item from run filter')
+      empty_line
+
+      if @inclusion_filter.size.positive?
+        bold('Press C to clear filter')
+        empty_line
+        bold('Press A to clear filter and rerun all examples')
+        empty_line
+      end
+
+      bold('Press I to exit instructions')
+      empty_line
+      bold('Press Q to quit')
+      bind_input
+    end
+
+    def top_fail_text
+      bold 'Press T to view top failed example'
+    end
+
+    def exit_instruction_page
+      @instructions = false
+      close_alt_buffer
+    end
+
+    def example_summary_instructions
+      i_for_instructions
+      @output.puts 'Press M to remove from filter' if @selected.metadata[:include]
+      @output.puts 'Press C to clear filter' unless @inclusion_filter.empty?
+      top_fail_text unless @failed.empty? || @selected == @failed.first
+      back_instructions
+      q_to_exit
+      empty_line
+    end
+  end
+end

data/lib/spec_selector/scripts/rerun.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+
+cd $2
+args=("$@")
+len=${args[@]: -1}
+let start=-$len-1
+
+filter() {
+  descriptions=()
+  for arg in "${args[@]: $start: $len}"
+    do description=$(echo $arg | sed 's/^\[//;s/\]$//;s/,$//')
+    for (( i=0; i<${#description}; i++ )); do
+      if [ "${description:$i:1}" = "'" ]; then
+        description="\"$description\""
+        escaped=true
+        break
+      fi
+    done
+
+  if ! [ $escaped ]; then
+    description="'$description"
+    description="$description'"
+  fi
+  
+  descriptions+=" -e "
+  descriptions+=$description
+  done
+}
+
+let length=$#+$start-2
+
+if [ $len -eq 0 ]
+then
+  eval "${args[@]:2:$length}"
+else
+  filter
+  eval "${args[@]:2:$length} ${descriptions[@]}"
+fi
+
+kill $1

data/lib/spec_selector/state.rb

@@ -0,0 +1,142 @@
+module SpecSelectorUtil
+  module State
+    def rerun
+      prepare_rerun
+      descriptions, marker = appended_arguments
+      rerun_script = current_path + '/scripts/rerun.sh'
+      prepend = [rerun_script, Process.pid, Dir.pwd].join(' ')
+      Signal.trap('TERM') { clear_frame; exit }
+      system("#{prepend} #{$0} #{@rerun_arguments} #{descriptions} #{marker}")
+    end
+
+    def filter_include(item = @selected)
+      @filter_mode = :location if one_liner?(item)
+      item.metadata[:include] = true
+      @inclusion_filter << item
+    end
+
+    def prepare_rerun
+      display_rerun
+      persist_filter
+      reset_arguments
+      prepare_location_arguments if location_mode?
+      delete_filter_data if @inclusion_filter.empty?
+    end
+
+    def display_rerun
+      close_alt_buffer if @instructions
+      clear_frame
+      italicize('running examples...')
+    end
+
+    def appended_arguments
+      return [nil, 0] if location_mode?
+
+      [prepare_description_arguments, @filtered_descriptions.count]
+    end
+
+    def persist_filter
+      persist_descriptions
+      persist_locations if location_mode?
+    end
+
+    def run_only_fails
+      return if @failed.empty?
+
+      @inclusion_filter = []
+      @failed.each { |example| filter_include(example) }
+      rerun
+    end
+
+    def rerun_all
+      @inclusion_filter = []
+      rerun
+    end
+
+    def filter_remove
+      @inclusion_filter -= [@selected]
+      @selected.metadata[:include] = nil
+      @filter_mode = :descripton unless @inclusion_filter.any? { |item| one_liner?(item) }
+    end
+
+    def persist_descriptions
+      @filtered_descriptions = @inclusion_filter.map do |item|
+        item.metadata[:full_description]
+      end
+
+      filter = @filtered_descriptions.to_json
+      File.write(@descriptions_file, filter)
+    end
+
+    def delete_filter_data
+      [@descriptions_file, @locations_file].each do |file|
+        File.delete(file) if File.exist?(file)
+      end
+    end
+
+    def reset_arguments
+      remove_old_descriptions
+      remove_old_locations
+    end
+
+    def remove_old_locations
+      return if @last_run_locations.empty?
+
+      @last_run_locations.each { |loc| @rerun_arguments.slice!(loc) }
+    end
+
+    def remove_old_descriptions
+      old_descriptions = @last_run_descriptions.map { |desc| "-e #{desc}" }
+      @rerun_arguments = ARGV.join(' ')
+      old_descriptions.each { |desc| @rerun_arguments.slice!(desc) }
+    end
+
+    def persist_locations
+      @filtered_locations = @inclusion_filter.map { |item| item.location }
+      locations = @filtered_locations.to_json
+      File.write(@locations_file, locations)
+    end
+
+    def prepare_location_arguments
+      @rerun_arguments += " #{@filtered_locations.join(' ')}"
+    end
+
+    def prepare_description_arguments
+      return if @inclusion_filter.empty?
+
+      contains_singles = @filtered_descriptions.select { |desc| desc.include?("'") }
+      included = @filtered_descriptions - contains_singles
+      return contains_singles.to_s if included.empty?
+
+      included = included.to_s.gsub('"', "'")
+      return included if contains_singles.empty?
+
+      contains_singles.map!(&:dump)
+      included[-1] = ", #{contains_singles.join(', ')}]"
+      included
+    end
+
+    def clear_filter
+      return if @inclusion_filter.empty?
+
+      @inclusion_filter.each { |item| item.metadata[:include] = nil }
+      @inclusion_filter = []
+      return if @instructions
+
+      @example_display ? display_example : top_level_list
+    end
+
+    def top_fail!
+      @inclusion_filter = []
+      filter_include(@failed.first)
+      rerun
+    end
+
+    def check_inclusion_status(item)
+      if @last_run_descriptions.include?(item.metadata[:full_description])
+        @inclusion_filter << item
+        item.metadata[:include] = true
+      end
+    end
+  end
+end