spec_selector 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80ae5c42cb85a3c4b3e8f0c03dc798f8e5f15e7f381d9b62266914aa470379a9
-  data.tar.gz: c062e730cead5ff989daaea538b610f692adf9329fcf997aad8da0e5fc53add8
+  metadata.gz: 943c909a6095c076c4979dc6a027e8218800c4e19da10b0b1e6502c6653ed9fd
+  data.tar.gz: 04badb6692b592d1bdf47971d4aa0380fa0ce75f428538b87b123b50f4664afd
 SHA512:
-  metadata.gz: 152df563a0e99607d8e24954e16dab41d7e8e6db49c29d97ea0087a6827431a5d38b7739ba880f7e08db15e6d4ee29c849bc412a615934e52e481186acbcbe07
-  data.tar.gz: 7fa3821bea0d8e20a6eeb5c562e5bec887d7bcdd767110733321c4652ed68b4cf192aaf9c15422d5df09e5ca26d21e2ba23b5d6c2b37c4eeb256bc64b6977cea
+  metadata.gz: 8a6fcf2deff3e8216991f98ac0d9d9d71f7cb982715f5eda7380ed4ecce3e0ea2b598707eb252a1392de019800615cf8e3d42b1d21a049b5f375c3fec094e12d
+  data.tar.gz: 351bd4fcc941732ec9ea9e4fd69e6b08122acf44e3c2c89b08ecc7c20a4edbac09a57b5cabe62aacfcd258f61b7426b327cac1a9a21f80e673060596d7274fc2

data/README.md

@@ -2,11 +2,15 @@
 
 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>
+
+**View 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. 
 
-**filter and rerun test results**
+<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.
 
@@ -16,6 +20,8 @@ Press C to clear the inclusion filter. Press A to clear the inclusion filter and
 
 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,42 @@ 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_
+
+Note: With the exception of T, letter key inputs are not case sensitive.
+
+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.|
+| 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. |
+| t | View the top failed example result summary from the current result set. |
+| V | View the inclusion filter as a list. |
+| Q | Exit spec_selector. |
+
+<br>
+
 **Installation**
 
 ````
@@ -41,6 +83,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 t to view top failed example'
     end
 
     def exit_instruction_page

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spec_selector
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Trevor Almon
@@ -34,7 +34,7 @@ cert_chain:
   2oaEU1xxH+4n3qzECM32PIry9QVrTud/3/ouDLy4LVVyutD5ZANsVQrr0y8vEA6+
   OXcnI0Yc8EI4dmIAwDI0ZfBo2OgFBxNJCeurVx36tUPsSWjJUd0BeA==
   -----END CERTIFICATE-----
-date: 2021-02-28 00:00:00.000000000 Z
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec