whirled_peas 0.1.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6608e1e6c9505eefea5409bcdc0f8af117b5bcf390564d163315f05b9fe73323
-  data.tar.gz: 713b7ff1c83c462b137e1a9203282ad74f8dc71e660237da35b40d472ae1d486
+  metadata.gz: 1b374c9d4250b281d3f87284f446e82c01ece7ff2fe196687be50502b2e42960
+  data.tar.gz: 0ebd7b96a154277121767eb8c33d63b831db37770ff0172b76f28fcf89c5dec9
 SHA512:
-  metadata.gz: 81d5ae8c86907fa5a32025be54fd4649d1c75c93726d0f581f0f63cd7182f8381285451cef1c2350b223c378ba98c00682b2a96ac65b31cabc05b5871cbaf1fc
-  data.tar.gz: 52cdda8685d24cd1ad89c5a2acc70b7fb77c22cf6c21cb3d3eb20dce5df2660bc2e9d285e04fbb13018189f9b2f9700203e3915c13f678ecb4d92f2ce173bfab
+  metadata.gz: f6dcc7dc00852a343f55056646db886903bc5735a21bd9af71a885e28ff70aa85bb3f26ff4f97c23dc4292fa401c1c624284c347b17fb957fb8e0069301b7ef9
+  data.tar.gz: 1f0ae0e07baf45703dff90396be7b6c705f17f8c9cb4fcd4e0b4b433513efc94dd8c3a056f50f1d3f47f7e3179c308d36264ef4e4be0c179815e650a6136a11a

data/.travis.yml

@@ -3,4 +3,6 @@ language: ruby
 cache: bundler
 rvm:
   - 2.6.6
+  - 2.7.2
+  - 3.0.0
 before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## v0.5.0 - 2021-01-25
+
+BREAKING: there was a significant amount of structural refactoring in this release. While that aspect did not add or remove any features, it fixed several layout bugs (some known and some unknown), so most template with moderate complexity will now be laid out slightly differently.
+
+- [3ddfede](https://github.com/tcollier/whirled_peas/tree/3ddfedee4ab2fadeecbe82c7c9caf25c2988f095): Allow relative positioning of containers
+- [507e77c](https://github.com/tcollier/whirled_peas/tree/507e77c551bcb9cc832d5c24e2f24eb1afe4eddc): Add height attribute for container settings
+- [af8ef19](https://github.com/tcollier/whirled_peas/tree/af8ef1950edebcd23a57a04982b22a56296ee09b): Add automated screen testing
+
+## v0.4.1 - 2021-01-22
+
+- [0f7aa6c](https://github.com/tcollier/whirled_peas/tree/0f7aa6ccc07323230dd602cb43e0341de5a69ad8): Allow relative path for config files
+
+## v0.4.0 - 2021-01-22
+
+- [7fd6712](https://github.com/tcollier/whirled_peas/tree/7fd6712818c94cdbfd81828277ca67c705e01793): BREAKING: replace `WhirledPeas.start` with command line executable
+- [2535342](https://github.com/tcollier/whirled_peas/tree/25353424f1ab4af4880f44eb7ddd28afefbbb9b2): Add support for loading screen
+- [7388fc2](https://github.com/tcollier/whirled_peas/tree/7388fc2eacdc8045b725311c11d650d6b8654be8): Add support for title fonts
+- [b345155](https://github.com/tcollier/whirled_peas/tree/b345155b1c212cabe73f9a2562ac8dbbedbbb6df): Add command to list title fonts to executable
+- [d3a8324](https://github.com/tcollier/whirled_peas/tree/d3a832496c36985993217ff11b6d83dd4697c4ed): Add commands for debugging application to executable
+
+## v0.3.0 - 2021-01-21
+
+- [617f802](https://github.com/tcollier/whirled_peas/tree/617f8027d6688a2ec81a3e594e529c94485cee85): BREAKING: send frames directly to EventLoop (`Producer#send` renamed to `Producer#send_frame`)
+
+## v0.2.0 - 2021-01-20
+
+- [73eb326](https://github.com/tcollier/whirled_peas/tree/73eb326426f9814e91e3bc7a60dfd87be3d69f7e): Convert "primitive" data types to strings
+- [f28b69d](https://github.com/tcollier/whirled_peas/tree/f28b69df8b6cfc973da2ebc0b8da29b278f23433): Give elements names
+- [1ae1c929](https://github.com/tcollier/whirled_peas/tree/1ae1c929429c2f8520054d33a064c2b6d71955fe): Consistently format exceptions in logs
+- [4c2114f](https://github.com/tcollier/whirled_peas/tree/4c2114fd360fd98c65e6e32f905a377f09b919ee): Fix bug with negative sleep times
+- [627bf12](https://github.com/tcollier/whirled_peas/tree/627bf126dd7f9c845f65105e0826d14a35a0a953): Don't reraise pipe error
+
 ## v0.1.1 - 2021-01-20
 
 - [3852c8c](https://github.com/tcollier/whirled_peas/tree/3852c8c700c2e8fb92e65bbca1c99be74304c6d0): Improve error handling

data/Gemfile

@@ -6,3 +6,4 @@ gemspec
 gem 'rake', '~> 12.0'
 gem 'rspec', '~> 3.0'
 gem 'pry-byebug'
+gem 'tty-cursor', '~> 0.7'

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.com/tcollier/whirled_peas.svg?branch=main)](https://travis-ci.com/tcollier/whirled_peas)
+
 # WhirledPeas
 
 Visualize your code's execution with Whirled Peas!
@@ -20,15 +22,24 @@ Or install it yourself as:
 
 ## Usage
 
+A Whirled Peas application consists of the following pieces
+
+- The driver (required) - the code that is to be visualized, it emits lightweight frame events through a producer
+- The main template factory (required) - builds templates to convert frame events from the driver into terminal graphics
+- A loading screen template factory (optional) - builds templates to display while content is loading
+
+These pieces are configured as following
+
 ```ruby
+# visualize.rb
 require 'whirled_peas'
 
 class TemplateFactory
   def build(frame, args)
-    WhirledPeas.template do |body|
-      body.add_box do |_, settings|
+    WhirledPeas.template do |composer|
+      composer.add_box('Title') do |_, settings|
         settings.underline = true
-        "Hello #{args['name']}"
+        "Hello #{args[:name]}"
       end
       # ...
     end
@@ -37,18 +48,44 @@ end
 
 class Driver
   def start(producer)
-    producer.send('starting', args: { 'name' => 'World' })
+    producer.send_frame('starting', args: { name: 'World' })
     # ...
   end
 end
 
-WhirledPeas.start(Driver.new, TemplateFactory.new)
+WhirledPeas.configure do |config|
+  config.driver = Driver.new
+  config.template_factory = TemplateFactory.new
+end
+```
+
+Then the visualizer is started on the command line with
+
 ```
+$ whirled_peas start visualize.rb
+```
+
+The optional loading screen can be configured like
 
-A Whirled Peas application consists of two pieces
+```ruby
+class LoadingTemplateFactory
+  def build
+    WhirledPeas.template do |composer|
+      composer.add_box('Loading') do |_, settings|
+        settings.set_margin(top: 15)
+        settings.align = :center
+        settings.full_border(color: :blue, style: :double)
+        "Loading..."
+      end
+    end
+  end
+end
 
-1. The driver, which emits lightweight frame events
-1. The template factory, which builds templates to convert frame events from the driver into terminal graphics
+WhirledPeas.configure do |config|
+  # ...
+  config.loading_template_factory = LoadingTemplateFactory.new
+end
+```
 
 ### Driver
 
@@ -70,13 +107,14 @@ The producer provides a single method
 #
 # @param name [String] application defined name for the frame. The template factory will be provided this name
 # @param duration [Number] time in seconds this frame should be displayed for (defaults to 1 frame)
-# @param args [Hash] key value pairs to send as arguments to the template factory, these values will be
-#   serialized/deserialized
-def send(name, duration:, args:)
+# @param args [Hash<Symbol, Object>] key value pairs to send as arguments to the template factory
+def send_frame(name, duration:, args:)
   # implementation
 end
 ```
 
+**IMPORTANT**: the keys in the `args` hash must be symbols!
+
 #### Example
 
 Simple application that loads a set of numbers and looks for a pair that adds up to 1,000
@@ -85,52 +123,56 @@ Simple application that loads a set of numbers and looks for a pair that adds up
 class Driver
   def start(producer)
     numbers = File.readlines('/path/to/numbers.txt').map(&:to_i)
-    producer.send('load-numbers', duration: 3, args: { numbers: numbers })
+    producer.send_frame('load-numbers', duration: 3, args: { numbers: numbers })
     numbers.sort!
-    producer.send('sort-numbers', duration: 3, args: { numbers: numbers })
+    producer.send_frame('sort-numbers', duration: 3, args: { numbers: numbers })
     low = 0
     high = numbers.length - 1
     while low < high
       sum = numbers[low] + numbers[high]
       if sum == 1000
-        producer.send('found-pair', duration: 5, args: { low: low, high: high, sum: sum })
+        producer.send_frame('found-pair', duration: 5, args: { low: low, high: high, sum: sum })
         return
       elsif sum < 1000
-        producer.send('too-low', args: { low: low, high: high, sum: sum })
+        producer.send_frame('too-low', args: { low: low, high: high, sum: sum })
         low += 1
       else
-        producer.send('too-high', args: { low: low, high: high, sum: sum })
+        producer.send_frame('too-high', args: { low: low, high: high, sum: sum })
         high -= 1
       end
     end
-    producer.send('no-solution', duration: 5)
+    producer.send_frame('no-solution', duration: 5)
   end
 end
 ```
 
 ### Template Factory
 
-To render the frame events sent by the driver, the application requires a template factory. This factory will be called for each frame event, with the frame name and the arguments supplied by the driver. A template factory can be a simple ruby class and thus can maintain state. Whirled Peas provides a few basic building blocks to make simple, yet elegant terminal-based UIs.
+To render the frame events sent by the driver, the application requires a template factory. This factory will be called for each frame event, with the frame name and the arguments supplied by the driver. A template factory can be an instance of ruby class and thus can maintain state. Whirled Peas provides a few basic building blocks to make simple, yet elegant terminal-based UIs.
+
+#### Loading Template Factory
+
+`WhirledPeas.configure` takes an optional template factory to build a loading screen. This instance must implement `#build` (taking no arguments). The template returned by that method will be painted while the event loop is waiting for frames. The factory method will be called once per refresh cycle, so it's possible to implement animation.
 
 #### Building Blocks
 
-A template is created with `WhirledPeas.template`, which yields a `Template` object and `TemplateSettings`. This template object is a `ComposableElement`, which allows for attaching child elements and setting layout options. `GridElement` and `BoxElement` are two other composable elements and `TextElement` is a simple element that can hold a text/number value and has layout options, but cannot have any child elements.
+A template is created with `WhirledPeas.template`, which yields a `Composer` object for a `BoxElement` and `BoxSettings`. The composer allows for attaching child elements and the settings for setting layout options.
 
-A `ComposableElement` provides the following methods to add child elements
+A `Composer` provides the following methods to add child elements, each of these takes an optional string argument that is set as the name of the element (which can be useful when debugging).
 
-- `add_box` - yields a `ComposableElement` and a `BoxSettings`, which will be added to the parent's children
-- `add_grid` - yields a `ComposableElement` and a `GridSettings`, which will be added to the parent's children
+- `add_box` - yields a `Composer` and a `BoxSettings`, which will be added to the parent's children
+- `add_grid` - yields a `Composer` and a `GridSettings`, which will be added to the parent's children
 - `add_text` - yields `nil` and a `TextSettings`, which will be added to the parent's children
 
 E.g.
 
 ```ruby
-WhirledPeas.template do |template, template_settings|
-  template_settings.bg_color = :blue
-  template.add_grid do |grid, grid_settings|
-    grid_settings.num_cols = 10
+WhirledPeas.template do |composer, settings|
+  settings.bg_color = :blue
+  composer.add_grid do |composer, settings|
+    settings.num_cols = 10
     100.times do |i|
-      grid.add_text { i.to_s }
+      composer.add_text { i }
     end
   end
 end
@@ -139,79 +181,93 @@ end
 The above template can also be broken down into more manageable methods, e.g.
 
 ```ruby
-def number_grid(grid, settings)
+def number_grid(_composer, settings)
   settings.num_cols = 10
-  100.times do |i|
-    grid.add_text { i.to_s }
-  end
+  100.times.map(&:itself)
 end
 
-WhirledPeas.template do |template, settings|
+WhirledPeas.template do |composer, settings|
   settings.bg_color = :blue
-  template.add_grid(&method(:number_grid))
+  composer.add_grid(&method(:number_grid))
 end
 ```
 
 Additionally, if no child element is explicitly added to a `GridElement`, but the block returns an array of strings or numbers, those will be converted to `TextElements` and added as children to the `GridElement`. For example, these are identical ways to create a grid of strings
 
 ```ruby
-template.add_grid do |g|
+template.add_grid do |composer|
   100.times do |i|
-    g.add_text { i.to_s }
+    composer.add_text { i }
   end
 end
 
-template.add_grid do |g|
-  100.times.map(&:to_s)
+template.add_grid do
+  100.times.map(&:itself)
 end
 ```
 
 Similarly, if no child element is explicilty added to a `BoxElement`, but the block returns a string or number, that value will be converted to a `TextElement` and added as a child. For example, these are identical ways to create a box with string content
 
 ```ruby
-template.add_box do |b|
-  b.add_text { "Hello!" }
+template.add_box do |composer|
+  composer.add_text { "Hello!" }
 end
 
-template.add_box do |b|
+template.add_box do
   "Hello!"
 end
 ```
 
 #### Settings
 
-Each element type has an associated settings type, which provide a custom set of options to format the output. Parent settings may be merged into child settings (assuming the child supports those settings)
+Each element type has an associated settings type, which provide a custom set of options to format the output. Child settings will inherit from the parent, where applicable
 The available settigs are
 
-| Setting       | Description                                                        | Default | Availability                      | Merged? |
-| ------------- | ------------------------------------------------------------------ | ------- | --------------------------------- | ------- |
-| `align`       | Justifies the text (allowed values: `:left`, `:center`, `:right`)  | `:left` | `Box`, `Grid`, `Text`             | Yes     |
-| `auto_margin` | Evenly distribute side margin (overrides left/right in `margin`)   | `false` | `Box`, `Grid`                     | Yes     |
-| `bg_color`    | Background color (see [Colors](#colors))                           |         | `Box`, `Grid`, `Template`, `Text` | Yes     |
-| `bold`        | `true` makes the font bold                                         | `false` | `Box`, `Grid`, `Template`, `Text` | Yes     |
-| `border`      | Set the border for the lements                                     | none    | `Box`, `Grid`,                    | Yes     |
-| `color`       | Foreground text color (see [Colors](#colors))                      |         | `Box`, `Grid`, `Template`, `Text` | Yes     |
-| `flow`        | Flow to display child elements (see [Display Flow](#display-flow)) | `:l2r`  | `Box`                             | Yes     |
-| `margin`      | Set the (left, top, right, bottom) margin of the element           | `0`     | `Box`, `Grid`                     | Yes     |
-| `padding`     | Set the (left, top, right, bottom) padding of the element          | `0`     | `Box`, `Grid`                     | Yes     |
-| `transpose`   | Display grid elements top-to-bottom, then left-to-right            | `false` | `Grid`                            | No      |
-| `underline`   | `true` underlines the font                                         | `false` | `Box`, `Grid`, `Template`, `Text` | Yes     |
-| `width`       | Override the calculated with of an element                         |         | `Box`, `Grid`, `Text`             | No      |
-
-##### Margin and Padding
-
-Margin and padding settings allow for setting the spacing on each of the 4 sides of the element independently. The set these values, use
+| Setting      | Description                                                                     | Default | Availability          | Inherited            |
+| ------------ | ------------------------------------------------------------------------------- | ------- | --------------------- | -------------------- |
+| `align`      | Justifies the content (allowed values: `:left`, `:center`, `:right`)            | `:left` | `Box`, `Grid`         | Yes                  |
+| `bg_color`   | Background color (see [Colors](#colors))                                        |         | `Box`, `Grid`, `Text` | Yes                  |
+| `bold`       | `true` makes the font bold                                                      | `false` | `Box`, `Grid`, `Text` | Yes                  |
+| `border`     | Set the border for the lements                                                  | none    | `Box`, `Grid`,        | Only style and color |
+| `color`      | Foreground text color (see [Colors](#colors))                                   |         | `Box`, `Grid`, `Text` | Yes                  |
+| `flow`       | Flow to display child elements (see [Display Flow](#display-flow))              | `:l2r`  | `Box`, `Grid`         | Yes                  |
+| `height`     | Override the calculated height of an element's content area                     |         | `Box`, `Grid`         | No                   |
+| `margin`     | Set the (left, top, right, bottom) margin of the element                        | `0`     | `Box`, `Grid`         | No                   |
+| `num_cols`   | Number of columns in the grid (must be set!)                                    |         | `Grid`                | No                   |
+| `padding`    | Set the (left, top, right, bottom) padding of the element                       | `0`     | `Box`, `Grid`         | No                   |
+| `position`   | Set the (left, top) position of the element relative to parent content area     | `0`     | `Box`, `Grid`         | No                   |
+| `title_font` | Font used for "large" text (see [Large Text](#large-text), ignores `underline`) |         | `Text`                | No                   |
+| `underline`  | `true` underlines the font                                                      | `false` | `Box`, `Grid`, `Text` | Yes                  |
+| `width`      | Override the calculated width of an element's content area                      |         | `Box`, `Grid`         | No                   |
+
+##### Position
+
+Position settings dictate the relative position from where the painter would have preferred to place the container. Negative numbers move the container left/up and positive numbers move it right/down. To set these values, use
+
+- `set_position(left:, top:)`
+
+##### Margin
+
+Margin settings dictate the spacing on the outside (i.e. outside of the border) of each of the 4 sides of the container independently. To set these values, use
 
 - `set_margin(left:, top:, right:, bottom:)`
+
+Note: values cannot be negative
+
+##### Padding
+
+Padding settings dictate the spacing on the inside (i.e. inside of the border) of each of the 4 sides of the container independently. To set these values, use
+
 - `set_padding(left:, top:, right:, bottom:)`
 
-Any argument value not provided will result in that value being 0.
+Note: values cannot be negative
 
 ##### Border
 
 The border settings consist of 6 boolean values (border are either width 1 or not shown), the 4 obvious values (`left`, `top`, `right`, and `bottom`) along with 2 other values for inner borders (`inner_horiz` and `inner_vert`) in a grid. A border also has a foreground color (defaults to `:white`) and a style. The background color is determined by the `bg_color` of the element. Border values can be set with
 
 - `set_border(left:, top:, right:, bottom:, inner_horiz:, inner_vert:, color:, style:)`
+- `full_border(style:, color:)`
 
 Available border styles are
 
@@ -302,14 +358,40 @@ Many of these also have a "bright" option:
 - `:bright_red`
 - `:bright_yellow`
 
+##### Large Text
+
+The `title_font` setting for `TextElement`s converts the standard terminal font into a large block font. The available fonts vary from system to system. Every system will have a `:default` font available, this font could look like
+
+```
+██████╗ ███████╗███████╗ █████╗ ██╗   ██╗██╗     ████████╗
+██╔══██╗██╔════╝██╔════╝██╔══██╗██║   ██║██║     ╚══██╔══╝
+██║  ██║█████╗  █████╗  ███████║██║   ██║██║        ██║
+██║  ██║██╔══╝  ██╔══╝  ██╔══██║██║   ██║██║        ██║
+██████╔╝███████╗██║     ██║  ██║╚██████╔╝███████╗   ██║
+╚═════╝ ╚══════╝╚═╝     ╚═╝  ╚═╝ ╚═════╝ ╚══════╝   ╚═╝
+```
+
+To print out a list of all available fonts as well as sample text in that font, run
+
+```
+$ whirled_peas title_fonts
+```
+
+Note: when using a title font with WhirledPeas for the first time on a system, the gem loads all fonts to check which ones are available. This can be a slow process and may cause a noticeable delay when running a visualization. Running the command above will cache the results and thus when a WhirledPeas visualization is run, there will be no lag from loading fonts.
+
 ### Example
 
 ```ruby
 class TemplateFactory
   def build(frame, args)
     set_state(frame, args)
-    WhirledPeas.template do |t|
-      t.add_box(&method(:body))
+    WhirledPeas.template do |composer, settings|
+      settings.flow = :l2r
+      settings.align = :center
+
+      composer.add_box('Title', &method(:title))
+      composer.add_box('Sum', &method(:sum))
+      composer.add_grid('NumberGrid', &method(:number_grid))
     end
   end
 
@@ -317,41 +399,105 @@ class TemplateFactory
 
   def set_state(frame, args)
     @frame = frame
-    @numbers = args.key?('numbers') ? args['numbers'] || []
-    @sum = args['sum'] if args.key?('sum')
-    @low = args['low'] if args.key?('low')
-    @high = args['high'] if args.key?('high')
+    @numbers = args.key?(:numbers) ? args[:numbers] || []
+    @sum = args[:sum] if args.key?(:sum)
+    @low = args[:low] if args.key?(:low)
+    @high = args[:high] if args.key?(:high)
   end
 
-  def title(_elem, settings)
+  def title(_composer, settings)
     settings.underline = true
     "Pair Finder"
   end
 
-  def sum(_elem, settings)
+  def sum(_composer, settings)
     settings.color = @frame == 'found-pair' ? :green : :red
     @sum ? "Sum: #{@sum}" : 'N/A'
   end
 
-  def number_grid(elem, settings)
+  def number_grid(composer, settings)
     settings.full_border
     @numbers.each.with_index do |num, index|
-      g.add_text do |_, settings|
+      composer.add_text do |_, settings|
         settings.bg_color = (@low == index || @high == index) ? :cyan : :white
-        num.to_s
+        num
       end
     end
   end
+end
+```
 
-  def body(elem, settings)
-    settings.flow = :l2r
-    settings.auto_margin = true
+### Debugging
 
-    elem.add_box(&method(:title))
-    elem.add_box(&method(:sum))
-    elem.add_grid(&method(:number_grid))
-  end
-end
+The `whirled_peas` executable provides some commands that are helpful for debugging.
+
+#### list_frames
+
+List the frames sent by the driver
+
+```
+$ whirled_peas <config file> list_frames
+Frame 'start' displayed for 5 second(s)
+Frame 'move' displayed for 1 frame ({:direction=>'N'})
+...
+EOF frame detected
+```
+
+#### play_frame
+
+Displays a single frame for several seconds
+
+```
+$ whirled_peas <config file> play_frame move '{"direction":"N"}'
+```
+
+Adding the `--template` flag will result in printing out debug information for the template, e.g.
+
+```
+$ whirled_peas <config file> play_frame move '{"direction":"N"}' --template
++ TEMPLATE [WhirledPeas::Template::BoxElement]
+  - Settings
+    WhirledPeas::Settings::BoxSettings
+      <default>
+  - Children
+    + TitleContainer [WhirledPeas::Template::BoxElement]
+...
+```
+
+Adding the `--painter` flag will result in printing out debug information the painter (the rendered template), e.g.
+
+```
+$ whirled_peas <config file> play_frame move '{"direction":"N"}' --painter
++ TEMPLATE [WhirledPeas::Graphics::BoxPainter]
+  - Settings
+    WhirledPeas::Settings::BoxSettings
+      <default>
+  - Dimensions
+  - Canvas:
+  - Children
+    + TitleContainer [WhirledPeas::Graphics::BoxPainter]
+...
+```
+
+#### loading
+
+Displays the configured loading screen for several seconds
+
+```
+$ whirled_peas <config file> loading
+```
+
+Adding the `--debug` flag will result in just printing out the loading template's debug information, e.g.
+
+```
+$ whirled_peas <config file> loading --debug
++ TEMPLATE [WhirledPeas::UI::Template]
+  - Settings
+    WhirledPeas::UI::TemplateSettings
+      <default>
+  - Children
+    + TitleContainer [WhirledPeas::UI::BoxElement]
+...
 ```
 
 ## Development
@@ -360,6 +506,21 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Testing
+
+In addition to standard RSpec tests, WhirledPeas has custom tests for rendered templates. These files live in `screen_test/rendered`. Each ruby file is expected to define a class named `TemplateFactory` that responds to `#build(name, args)` returning a template (the standard template factory role). Each file should also be accompanied by a `.frame` file with the same base name. This file will contain the output of the rendered screen and is considered the correct output when running tests.
+
+Note: viewing `.frame` files with `cat` works better than most other text editors.
+
+The following rake tasks are provided to interact with the screen tests
+
+- `screen_test` runs all screen tests in the `screen_test/rendered` directory
+- `screen_test:debug[path/to/file.rb]` print the rendered template debug tree
+- `screen_test:run[path/to/file.rb]` runs a single screen test
+- `screen_test:save[path/to/file.rb]` saves the output generated by the template in the `.frame` file, overwriting any existing file
+- `screen_test:view[path/to/file.rb]` views the output generated by the template
+- `screen_test:update_all[path/to/file.rb]` interactively step through each pending or failed screen test to compare/set the expected output
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/whirled_peas. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/whirled_peas/blob/master/CODE_OF_CONDUCT.md).