whirled_peas 0.5.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b374c9d4250b281d3f87284f446e82c01ece7ff2fe196687be50502b2e42960
-  data.tar.gz: 0ebd7b96a154277121767eb8c33d63b831db37770ff0172b76f28fcf89c5dec9
+  metadata.gz: 7553fd2ea78bf560098d8be8cd3987f1e8a686cb000cf6ea082a922512764069
+  data.tar.gz: 8fa1e64c35b311ae9346badc0198f556528c53dad9bfa0b99b2805c901369b8f
 SHA512:
-  metadata.gz: f6dcc7dc00852a343f55056646db886903bc5735a21bd9af71a885e28ff70aa85bb3f26ff4f97c23dc4292fa401c1c624284c347b17fb957fb8e0069301b7ef9
-  data.tar.gz: 1f0ae0e07baf45703dff90396be7b6c705f17f8c9cb4fcd4e0b4b433513efc94dd8c3a056f50f1d3f47f7e3179c308d36264ef4e4be0c179815e650a6136a11a
+  metadata.gz: 531b93061429918f99dc5aa7de09a53a7fda218c97bac57b47d5a450ad22510207f71ba5a095f5a1939e4cce9d1f13d70a981e15b4e3209d0786ba12be048bd6
+  data.tar.gz: ea7daec0ccd65894bec99bfff75219d55dfc2cd9fc7b80d1e593b60e7a15a3e8eb7cbfa49e8ef20e8da5acbce2738d054cf56a9b0231661e46a5c399c83b8906

data/.gitignore

@@ -11,4 +11,5 @@ Gemfile.lock
 
 # rspec failure tracking
 .rspec_status
+*.wpz
 

data/.travis.yml

@@ -6,3 +6,4 @@ rvm:
   - 2.7.2
   - 3.0.0
 before_install: gem install bundler -v 2.1.4
+script: bundle exec rake ci

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## v0.9.0 - 2021-01-29
+
+BREAKING: `Frameset#add_frame` signature changed
+
+- [1c28947](https://github.com/tcollier/whirled_peas/tree/1c28947980eedce034d2596732ee4860717904c5): Add graph support
+
+## v0.8.0 - 2021-01-29
+
+BREAKING: `Producer` now responds to `#add_frame` instead of `#send_frame`
+
+- [67fdc17](https://github.com/tcollier/whirled_peas/tree/67fdc172434cb97f31ca20a674f28aefec6babb3): Add easing functions for frame transitions
+- [b888f2e](https://github.com/tcollier/whirled_peas/tree/b888f2e7a3b7c3341300326b417641cc8cf2e89b): Add record and playback functionality to command line tool
+
+## v0.7.1 - 2021-01-27
+
+- [b98781d](https://github.com/tcollier/whirled_peas/tree/b98781de23a24b596955f25cfc48936c0cc1efac): Fix num_cols bug for vertical grid flow
+
+## v0.7.0 - 2021-01-27
+
+BREAKING: the settings for the template now fills the full screen and disallows margin.
+
+- [b7c12c2](https://github.com/tcollier/whirled_peas/tree/b7c12c2c34d7077b9c2496d05ddd0c6d1eb90699): Update template to fill full screen with border sizing
+- [963b819](https://github.com/tcollier/whirled_peas/tree/963b8196f0d046ba03c893f07e5578bf8c88b7a3): Implement vertical alignment
+- [4bddd54](https://github.com/tcollier/whirled_peas/tree/4bddd54bec5c8f93d145c285379c1816f313f35e): Add `between`, `around`, and `evenly` alignments
+
+## v0.6.0 - 2021-01-25
+
+- [73df2af](https://github.com/tcollier/whirled_peas/tree/73df2af1f1eac37fe94f720dce16da1ed568dade): Add support for scroll bars along both axes
+- [f4f44e1](https://github.com/tcollier/whirled_peas/tree/f4f44e1ff6c75ed03cd682e3fa9921401dcd2d00): Implement remaining 3 flow directions for grids
+- [c01d083](https://github.com/tcollier/whirled_peas/tree/c01d083e10bf70983109a8def836bb181099f59c): Implement reverse flow directions for grids
+
 ## 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.

data/README.md

@@ -1,8 +1,24 @@
 [![Build Status](https://travis-ci.com/tcollier/whirled_peas.svg?branch=main)](https://travis-ci.com/tcollier/whirled_peas)
 
-# WhirledPeas
+```
+                ██╗   ██╗██╗███████╗██╗   ██╗ █████╗ ██╗     ██╗███████╗███████╗
+                ██║   ██║██║██╔════╝██║   ██║██╔══██╗██║     ██║╚══███╔╝██╔════╝
+                ██║   ██║██║███████╗██║   ██║███████║██║     ██║  ███╔╝ █████╗
+                ╚██╗ ██╔╝██║╚════██║██║   ██║██╔══██║██║     ██║ ███╔╝  ██╔══╝
+                 ╚████╔╝ ██║███████║╚██████╔╝██║  ██║███████╗██║███████╗███████╗
+                  ╚═══╝  ╚═╝╚══════╝ ╚═════╝ ╚═╝  ╚═╝╚══════╝╚═╝╚══════╝╚══════╝
+
+                                   your code's execution with
+
+    ██╗    ██╗██╗  ██╗██╗██████╗ ██╗     ███████╗██████╗    ██████╗ ███████╗ █████╗ ███████╗
+    ██║    ██║██║  ██║██║██╔══██╗██║     ██╔════╝██╔══██╗   ██╔══██╗██╔════╝██╔══██╗██╔════╝
+    ██║ █╗ ██║███████║██║██████╔╝██║     █████╗  ██║  ██║   ██████╔╝█████╗  ███████║███████╗
+    ██║███╗██║██╔══██║██║██╔══██╗██║     ██╔══╝  ██║  ██║   ██╔═══╝ ██╔══╝  ██╔══██║╚════██║
+    ╚███╔███╔╝██║  ██║██║██║  ██║███████╗███████╗██████╔╝   ██║     ███████╗██║  ██║███████║
+     ╚══╝╚══╝ ╚═╝  ╚═╝╚═╝╚═╝  ╚═╝╚══════╝╚══════╝╚═════╝    ╚═╝     ╚══════╝╚═╝  ╚═╝╚══════╝
+```
 
-Visualize your code's execution with Whirled Peas!
+Easily create terminal-based graphics to visualize the execution of your code. Whirled Peas offers templating inspired by HTML and CSS and provides a lightweight tie-in for your code to produce visual animations with these templates.
 
 ## Installation
 
@@ -24,9 +40,8 @@ Or install it yourself as:
 
 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
+- The application (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 application into terminal graphics
 
 These pieces are configured as following
 
@@ -46,15 +61,15 @@ class TemplateFactory
   end
 end
 
-class Driver
+class Application
   def start(producer)
-    producer.send_frame('starting', args: { name: 'World' })
+    producer.add_frame('starting', args: { name: 'World' })
     # ...
   end
 end
 
 WhirledPeas.configure do |config|
-  config.driver = Driver.new
+  config.application = Application.new
   config.template_factory = TemplateFactory.new
 end
 ```
@@ -62,34 +77,12 @@ end
 Then the visualizer is started on the command line with
 
 ```
-$ whirled_peas start visualize.rb
-```
-
-The optional loading screen can be configured like
-
-```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
-
-WhirledPeas.configure do |config|
-  # ...
-  config.loading_template_factory = LoadingTemplateFactory.new
-end
+$ whirled_peas play visualize.rb
 ```
 
-### Driver
+### Application
 
-The driver is the application code to be visualized. This is typically a lightweight wrapper around an existing application that conforms to the signature below.
+The application is code to be visualized that integrates with Whirled Peas by providing the signature below
 
 ```ruby
 # Start the application and pass frame events to the producer to be rendered by the UI
@@ -100,16 +93,33 @@ def start(producer)
 end
 ```
 
-The producer provides a single method
+The producer provides the following methods
 
 ```ruby
-# Send frame events to the UI
+# Add a frame to be displayed
 #
 # @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<Symbol, Object>] key value pairs to send as arguments to the template factory
-def send_frame(name, duration:, args:)
-  # implementation
+def add_frame(name, duration:, args:)
+end
+
+# Create and yield a frameset instance that allows applications to add multiple frames to play over the
+# given duration. Adding frames to the yielded frameset will result in playback that is eased by the
+# gvien `easing` and `effect` arguments (default is `:linear` easing)
+def frameset(duration, easing:, effect:, &block)
+end
+```
+
+A frameset instance provides one method
+
+```ruby
+# Add a frame to be displayed, the duration will be determine by the number of frames in the frameset along
+# with the duration and easing of the frameset
+#
+# @param name [String] application defined name for the frame. The template factory will be provided this name
+# @param args [Hash<Symbol, Object>] key value pairs to send as arguments to the template factory
+def add_frame(name, args:)
 end
 ```
 
@@ -120,48 +130,50 @@ end
 Simple application that loads a set of numbers and looks for a pair that adds up to 1,000
 
 ```ruby
-class Driver
+class Application
   def start(producer)
     numbers = File.readlines('/path/to/numbers.txt').map(&:to_i)
-    producer.send_frame('load-numbers', duration: 3, args: { numbers: numbers })
+    producer.add_frame('load-numbers', duration: 3, args: { numbers: numbers })
     numbers.sort!
-    producer.send_frame('sort-numbers', duration: 3, args: { numbers: numbers })
+    producer.add_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_frame('found-pair', duration: 5, args: { low: low, high: high, sum: sum })
+        producer.add_frame('found-pair', duration: 5, args: { low: low, high: high, sum: sum })
         return
       elsif sum < 1000
-        producer.send_frame('too-low', args: { low: low, high: high, sum: sum })
+        producer.add_frame('too-low', args: { low: low, high: high, sum: sum })
         low += 1
       else
-        producer.send_frame('too-high', args: { low: low, high: high, sum: sum })
+        producer.add_frame('too-high', args: { low: low, high: high, sum: sum })
         high -= 1
       end
     end
-    producer.send_frame('no-solution', duration: 5)
+    producer.add_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 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.
+To render the frame events sent by the application, 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 application. 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.
 
 #### Building Blocks
 
-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 template is created with `WhirledPeas.template`, which yields a `Composer` object for a `Box` and `BoxSettings`. The composer allows for attaching child elements and the settings for setting layout options. The following attributes of the template's settings will be overridden before it is rendered to ensure that it fills the screen exactly
+
+- `margin` - all margin will be set to 0
+- `width` - will be set to the screen's width
+- `height` - will be set to the screen's height
+- `sizing` - will be set `:border` to ensure the entire box fits on the screen and fills it entirely.
 
 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 `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_box` - yields a `Composer` for a `Box` and a `BoxSettings`, which will be added to the parent's children
+- `add_graph` - yields a `nil` and a `GraphSettings`, which will be added to the parent's children, the block should return an array of numbers
+- `add_grid` - yields a `Composer` for a `Grid` 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.
@@ -192,7 +204,7 @@ WhirledPeas.template do |composer, settings|
 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
+Additionally, if no child element is explicitly added to a `Grid`, but the block returns an array of strings or numbers, those will be converted to `Text` elements and added as children to the `Grid`. For example, these are identical ways to create a grid of strings
 
 ```ruby
 template.add_grid do |composer|
@@ -206,7 +218,7 @@ template.add_grid do
 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
+Similarly, if no child element is explicilty added to a `Box`, but the block returns a string or number, that value will be converted to a `Text` and added as a child. For example, these are identical ways to create a box with string content
 
 ```ruby
 template.add_box do |composer|
@@ -223,22 +235,212 @@ end
 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          | 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                   |
+| Setting      | Description                                                                      | Default    | Availability | Inherited            |
+| ------------ | -------------------------------------------------------------------------------- | ---------- | ------------ | -------------------- |
+| `align`      | Justifies the content in the horizontal direction                                | `:left`    | `Container`  | No                   |
+| `axis_color` | Color used to paint the axes of the graph (see [Colors](#colors))                |            | `Graph`      | No                   |
+| `bg_color`   | Background color (see [Colors](#colors))                                         |            | all          | Yes                  |
+| `bold`       | `true` makes the font bold                                                       | `false`    | all          | Yes                  |
+| `border`     | Set the border for the lements                                                   | none       | `Container`, | Only style and color |
+| `color`      | Foreground text color (see [Colors](#colors))                                    |            | all          | Yes                  |
+| `flow`       | Flow to display child elements (see [Display Flow](#display-flow))               | `:l2r`     | `Container`  | No                   |
+| `height`     | Override the calculated height of an element's content area                      |            | all          | No                   |
+| `margin`     | Set the (left, top, right, bottom) margin of the element                         | `0`        | `Container`  | 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`        | `Container`  | No                   |
+| `position`   | Set the (left, top) position of the element relative to parent content area      | `0`        | `Container`  | No                   |
+| `scrollbar`  | Display a scroll bar for vertical or horizontal scrolling                        |            | `Box`        | No                   |
+| `sizing`     | Sizing model (`:content` or `:border`) used in conjunction with `width`/`height` | `:content` | `Box`        | No                   |
+| `title_font` | Font used for "large" text (see [Large Text](#large-text), ignores `underline`)  |            | `Text`       | No                   |
+| `underline`  | `true` underlines the font                                                       | `false`    | all          | Yes                  |
+| `width`      | Override the calculated width of an element's content area                       |            | all          | No                   |
+| `valign`     | Justifies the content in the vertical direction                                  | `:top`     | `Container`  | No                   |
+
+##### Alignment
+
+The `align` setting takes one of several values
+
+- `:left` - align content starting at the leftmost edge of the container's content area
+
+```
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃[child 1][child 2][child 3]            ┃
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+```
+
+- `:right` - align content starting at the rightmost edge of the container's content area
+
+```
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃            [child 1][child 2][child 3]┃
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+```
+
+- `:center` - align content starting in the horizontal center of the container's content area
+
+```
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃      [child 1][child 2][child 3]      ┃
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+```
+
+- `:between` - distribute children so there is equal space between children no space outside of the children
+
+```
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃[child 1]      [child 2]      [child 3]┃
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+```
+
+- `:around` - distribute children so that they have equal spacing around them, space between two children is twice the space between an edge and a child.
+
+```
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃  [child 1]    [child 2]    [child 3]  ┃
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+```
+
+- `:evenly` - distribute children so there is even spacing between any two children (or space to the edge)
+
+```
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃   [child 1]   [child 2]   [child 3]   ┃
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+```
+
+The `valign` setting takes one of several values
+
+- `:top` - align content starting at the top of the container's content area
+
+```
+┏━━━━━━━━━┓
+┃[child 1]┃
+┃[child 2]┃
+┃[child 3]┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┗━━━━━━━━━┛
+```
+
+- `:bottom` - align content starting at the bottom of the container's content area
+
+```
+┏━━━━━━━━━┓
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃[child 1]┃
+┃[child 2]┃
+┃[child 3]┃
+┗━━━━━━━━━┛
+```
+
+- `:middle` - align content starting in the vertical middle of the container's content area
+
+```
+┏━━━━━━━━━┓
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃[child 1]┃
+┃[child 2]┃
+┃[child 3]┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┗━━━━━━━━━┛
+```
+
+- `:between` - distribute children so there is equal space between children no space outside of the children
+
+```
+┏━━━━━━━━━┓
+┃[child 1]┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃[child 2]┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃[child 3]┃
+┗━━━━━━━━━┛
+```
+
+- `:around` - distribute children so that they have equal spacing around them, space between two children is twice the space between an edge and a child.
+
+```
+┏━━━━━━━━━┓
+┃         ┃
+┃         ┃
+┃[child 1]┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃[child 2]┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃[child 3]┃
+┃         ┃
+┃         ┃
+┗━━━━━━━━━┛
+```
+
+- `:evenly` - distribute children so there is even spacing between any two children (or space to the edge)
+
+```
+┏━━━━━━━━━┓
+┃         ┃
+┃         ┃
+┃         ┃
+┃[child 1]┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃[child 2]┃
+┃         ┃
+┃         ┃
+┃         ┃
+┃[child 3]┃
+┃         ┃
+┃         ┃
+┃         ┃
+┗━━━━━━━━━┛
+```
 
 ##### Position
 
@@ -246,11 +448,56 @@ Position settings dictate the relative position from where the painter would hav
 
 - `set_position(left:, top:)`
 
+##### Sizing Model
+
+The sizing model determines how to interpret the `width` and `height` settings. The default sizing model is `:content`, which sets the width and height of the cotent area, whereas `:border` sets the width and height of the element inlcuding the padding and border and scroll bars.
+
+###### Examples
+
+In the examples below, the `~` character represents padding and would not be displayed in the acutal rendered screen.
+
+```ruby
+settings.width = 10
+settings.height = 3
+settings.set_padding(left: 3, top: 1, right: 3, bottom: 1)
+settings.full_border
+
+## Content sizing
+settings.sizing = :content
+
+# Results in the box
+#
+#   ┏━━━━━━━━━━━━━━━━┓
+#   ┃~~~~~~~~~~~~~~~~┃
+#   ┃~~~1234567890~~~┃
+#   ┃~~~1234567890~~~┃
+#   ┃~~~1234567890~~~┃
+#   ┃~~~~~~~~~~~~~~~~┃
+#   ┗━━━━━━━━━━━━━━━━┛
+
+## Border sizing
+settings.sizing = :border
+
+# Results in the box
+#
+#   ┏━━━━━━━━┓
+#   ┃~~~12~~~┃
+#   ┗━━━━━━━━┛
+```
+
+Notice that a box rendered with `:border` sizing would fit exactly in the content area of a box with the same `width` and `height` that is rendered with `:content` sizing. For containers with no padding and no border, the resulting size is the same for either sizing model.
+
 ##### 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:)`
+- `set_margin(left:, top:, right:, bottom:, horiz:, vert:)` - set any combination of margin (note: setting `horiz` and `left`/`right` or setting `vert` and `top`/`bottom` is not allowed)
+- `margin.left=(value)` - set left margin
+- `margin.top=(value)` - set top margin
+- `margin.right=(value)` - set right margin
+- `margin.bottom=(value)` - set bottom margin
+- `margin.horiz=(value)` - set left and right margin to the same value
+- `margin.vert=(value)` - set top and bottom margin to the same value
 
 Note: values cannot be negative
 
@@ -258,16 +505,40 @@ Note: values cannot be negative
 
 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:)`
+- `set_padding(left:, top:, right:, bottom:, horiz:, vert:)` - set any combination of padding (note: setting `horiz` and `left`/`right` or setting `vert` and `top`/`bottom` is not allowed)
+- `padding.left=(value)` - set left padding
+- `padding.top=(value)` - set top padding
+- `padding.right=(value)` - set right padding
+- `padding.bottom=(value)` - set bottom padding
+- `padding.horiz=(value)` - set left and right padding to the same value
+- `padding.vert=(value)` - set top and bottom padding to the same value
 
 Note: values cannot be negative
 
+##### Scrollbar
+
+Scroll settings dictate whether the scrollbar will be shown when child content is larger the the container's viewport. A scrollbar adds a unit to the dimensions of a container (as opposed to overwriting the leftmost/bottommost padding)
+
+- `set_scrollbar(horiz:, vert:)` - set both scrollbar settings
+- `scrollbar.horiz=(flag)` - show/hide the horizontal scrollbar
+- `scrollbar.vert=(flag)` - show/hide the vertical scrollbar
+
+Note: there is a know bug with scrollbars and `center`/`right` alignments. Using `left` alignment is the supported workaround
+
 ##### 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:)`
+- `set_border(left:, top:, right:, bottom:, inner_horiz:, inner_vert:, color:, style:)` - set any combination of border settings
+- `full_border(style:, color:)` - set all borders to true and optionally set the style or color
+- `border.left=(flag)` - show/hide left border
+- `border.top=(flag)` - show/hide top border
+- `border.right=(flag)` - show/hide right border
+- `border.bottom=(flag)` - show/hide bottom border
+- `border.inner_horiz=(flag)` - show/hide inner horizontal border (dividing grid rows)
+- `border.inner_vert=(flag)` - show/hide inner vertical border (dividing grid columns)
+- `border.color=(text_color)` - set the border color
+- `border.style=(style)` - set the border style
 
 Available border styles are
 
@@ -308,31 +579,71 @@ Child elements can flow in one of 4 directions
 - `:l2r` left-to-right
 
 ```
-[child 1] [child 2] ... [child N]
+# In a Box
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃[child 1] [child 2] ... [child N]┃
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+
+# In a Grid
+┏━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┓
+┃[child 1]┃[child 2]┃[child 3]┃
+┣━━━━━━━━━╋━━━━━━━━━╋━━━━━━━━━┫
+┃[chiid 4]┃[child 5]┃         ┃
+┗━━━━━━━━━┻━━━━━━━━━┻━━━━━━━━━┛
 ```
 
 - `:r2l` right-to-left
 
 ```
-[child N] [child N - 1] ... [child 1]
+# In a Box
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃[child N] [child N - 1] ... [child 1]┃
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+
+# In a Grid
+┏━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┓
+┃[child 3]┃[child 2]┃[child 1]┃
+┣━━━━━━━━━╋━━━━━━━━━╋━━━━━━━━━┫
+┃         ┃[chiid 5]┃[child 4]┃
+┗━━━━━━━━━┻━━━━━━━━━┻━━━━━━━━━┛
 ```
 
 - `:t2b` top-to-bottom
 
 ```
-[child 1]
-[child 2]
- ...
-[child N]
+# In a Box
+┏━━━━━━━━━┓
+┃[child 1]┃
+┃[child 2]┃
+┃ ...     ┃
+┃[child N]┃
+┗━━━━━━━━━┛
+
+# In a Grid
+┏━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┓
+┃[child 1]┃[child 3]┃[child 5]┃
+┣━━━━━━━━━╋━━━━━━━━━╋━━━━━━━━━┫
+┃[child 2]┃[child 4]┃         ┃
+┗━━━━━━━━━┻━━━━━━━━━┻━━━━━━━━━┛
 ```
 
 - `:b2t` bottom-to-top
 
 ```
-[child N]
-[child N - 1]
- ...
-[child 1]
+# In a Box
+┏━━━━━━━━━━━━━┓
+┃[child N]    ┃
+┃[child N - 1]┃
+┃ ...         ┃
+┃[child 1]    ┃
+┗━━━━━━━━━━━━━┛
+
+# In a Grid
+┏━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┓
+┃[child 2]┃[child 4]┃         ┃
+┣━━━━━━━━━╋━━━━━━━━━╋━━━━━━━━━┫
+┃[child 1]┃[child 3]┃[child 5]┃
+┗━━━━━━━━━┻━━━━━━━━━┻━━━━━━━━━┛
 ```
 
 ##### Colors
@@ -360,7 +671,7 @@ Many of these also have a "bright" option:
 
 ##### 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
+The `title_font` setting for `Text`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
 
 ```
 ██████╗ ███████╗███████╗ █████╗ ██╗   ██╗██╗     ████████╗
@@ -379,7 +690,265 @@ $ 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
+#### Easing
+
+The play duration of a frame within a frameset is determined by the easing function and effect along with the frames relative position within the frameset. The three effects are
+
+- `:in` - apply easing only to the start of the frameset
+- `:out` - apply easing only to the end of the frameset
+- `:in_out` - apply easing to the start and end of the frameset
+
+The available easing functions are
+
+- `:bezier`
+
+```
+# bezier (in)
+┃                                                         ▄▀
+┃                                                      ▄▄▀
+┃                                                    ▄▀
+┃                                                 ▄▀▀
+┃                                              ▄▄▀
+┃                                           ▄▄▀
+┃                                        ▄▄▀
+┃                                      ▄▀
+┃                                  ▄▄▀▀
+┃                               ▄▄▀
+┃                            ▄▀▀
+┃                        ▄▄▀▀
+┃                   ▄▄▀▀▀
+┃             ▄▄▄▀▀▀
+┃▄▄▄▄▄▄▄▄▄▄▀▀▀
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+```
+
+```
+# bezier (out)
+┃                                               ▄▄▄▀▀▀▀▀▀▀▀▀
+┃                                         ▄▄▄▀▀▀
+┃                                    ▄▄▄▀▀
+┃                                ▄▄▀▀
+┃                             ▄▄▀
+┃                          ▄▀▀
+┃                      ▄▄▀▀
+┃                    ▄▀
+┃                 ▄▀▀
+┃              ▄▀▀
+┃           ▄▀▀
+┃        ▄▄▀
+┃      ▄▀
+┃   ▄▀▀
+┃▄▄▀
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+```
+
+```
+# bezier (in_out)
+┃                                                  ▄▄▄▀▀▀▀▀▀
+┃                                              ▄▄▀▀
+┃                                           ▄▀▀
+┃                                        ▄▀▀
+┃                                     ▄▀▀
+┃                                  ▄▀▀
+┃                               ▄▄▀
+┃                             ▄▀
+┃                          ▄▀▀
+┃                       ▄▄▀
+┃                    ▄▄▀
+┃                 ▄▄▀
+┃              ▄▄▀
+┃          ▄▄▀▀
+┃▄▄▄▄▄▄▄▀▀▀
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+```
+
+`:linear`
+
+```
+# linear (in)
+┃                                                        ▄▄▀
+┃                                                    ▄▄▀▀
+┃                                                ▄▄▀▀
+┃                                            ▄▄▀▀
+┃                                        ▄▄▀▀
+┃                                    ▄▄▀▀
+┃                                ▄▄▀▀
+┃                            ▄▄▀▀
+┃                        ▄▄▀▀
+┃                    ▄▄▀▀
+┃                ▄▄▀▀
+┃            ▄▄▀▀
+┃        ▄▄▀▀
+┃    ▄▄▀▀
+┃▄▄▀▀
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+```
+
+```
+# linear (out)
+┃                                                        ▄▄▀
+┃                                                    ▄▄▀▀
+┃                                                ▄▄▀▀
+┃                                            ▄▄▀▀
+┃                                        ▄▄▀▀
+┃                                    ▄▄▀▀
+┃                                ▄▄▀▀
+┃                            ▄▄▀▀
+┃                        ▄▄▀▀
+┃                    ▄▄▀▀
+┃                ▄▄▀▀
+┃            ▄▄▀▀
+┃        ▄▄▀▀
+┃    ▄▄▀▀
+┃▄▄▀▀
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+```
+
+```
+# linear (in_out)
+┃                                                        ▄▄▀
+┃                                                    ▄▄▀▀
+┃                                                ▄▄▀▀
+┃                                            ▄▄▀▀
+┃                                        ▄▄▀▀
+┃                                    ▄▄▀▀
+┃                                ▄▄▀▀
+┃                            ▄▄▀▀
+┃                        ▄▄▀▀
+┃                    ▄▄▀▀
+┃                ▄▄▀▀
+┃            ▄▄▀▀
+┃        ▄▄▀▀
+┃    ▄▄▀▀
+┃▄▄▀▀
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+```
+
+`:parametric`
+
+```
+# parametric (in)
+┃                                                          ▄
+┃                                                        ▄▀
+┃                                                      ▄▀
+┃                                                   ▄▄▀
+┃                                                 ▄▀
+┃                                               ▄▀
+┃                                             ▄▀
+┃                                          ▄▄▀
+┃                                        ▄▀
+┃                                     ▄▀▀
+┃                                  ▄▀▀
+┃                              ▄▄▀▀
+┃                         ▄▄▄▀▀
+┃                   ▄▄▄▄▀▀
+┃▄▄▄▄▄▄▄▄▄▄▄▄▄▄▀▀▀▀▀
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+```
+
+```
+# parametric (out)
+┃                                         ▄▄▄▄▄▀▀▀▀▀▀▀▀▀▀▀▀▀
+┃                                   ▄▄▀▀▀▀
+┃                              ▄▄▀▀▀
+┃                          ▄▄▀▀
+┃                       ▄▄▀
+┃                    ▄▄▀
+┃                  ▄▀
+┃               ▄▀▀
+┃             ▄▀
+┃           ▄▀
+┃         ▄▀
+┃      ▄▀▀
+┃    ▄▀
+┃  ▄▀
+┃▄▀
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+```
+
+```
+# parametric (in_out)
+┃                                               ▄▄▄▀▀▀▀▀▀▀▀▀
+┃                                           ▄▄▀▀
+┃                                        ▄▀▀
+┃                                     ▄▄▀
+┃                                   ▄▀
+┃                                 ▄▀
+┃                               ▄▀
+┃                             ▄▀
+┃                           ▄▀
+┃                         ▄▀
+┃                       ▄▀
+┃                    ▄▀▀
+┃                 ▄▄▀
+┃             ▄▄▀▀
+┃▄▄▄▄▄▄▄▄▄▄▀▀▀
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+```
+
+`:quadratic`
+
+```
+# quadratic (in)
+┃                                                         ▄▄
+┃                                                       ▄▀
+┃                                                     ▄▀
+┃                                                   ▄▀
+┃                                                 ▄▀
+┃                                              ▄▀▀
+┃                                            ▄▀
+┃                                         ▄▀▀
+┃                                      ▄▀▀
+┃                                   ▄▀▀
+┃                               ▄▄▀▀
+┃                           ▄▄▀▀
+┃                      ▄▄▄▀▀
+┃                ▄▄▄▀▀▀
+┃▄▄▄▄▄▄▄▄▄▄▄▀▀▀▀▀
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+```
+
+```
+# quadratic (out)
+┃                                            ▄▄▄▄▄▀▀▀▀▀▀▀▀▀▀
+┃                                      ▄▄▄▀▀▀
+┃                                 ▄▄▀▀▀
+┃                             ▄▄▀▀
+┃                         ▄▄▀▀
+┃                      ▄▄▀
+┃                   ▄▄▀
+┃                ▄▄▀
+┃              ▄▀
+┃           ▄▄▀
+┃         ▄▀
+┃       ▄▀
+┃     ▄▀
+┃   ▄▀
+┃▄▀▀
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+```
+
+```
+# quadratic (in_out)
+┃                                                 ▄▄▄▀▀▀▀▀▀▀
+┃                                            ▄▄▀▀▀
+┃                                         ▄▀▀
+┃                                      ▄▀▀
+┃                                   ▄▄▀
+┃                                 ▄▀
+┃                               ▄▀
+┃                             ▄▀
+┃                           ▄▀
+┃                         ▄▀
+┃                      ▄▀▀
+┃                   ▄▄▀
+┃                ▄▄▀
+┃           ▄▄▄▀▀
+┃▄▄▄▄▄▄▄▄▀▀▀
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+```
+
+### Full template example
 
 ```ruby
 class TemplateFactory
@@ -427,77 +996,106 @@ class TemplateFactory
 end
 ```
 
-### Debugging
+### Full usage
 
-The `whirled_peas` executable provides some commands that are helpful for debugging.
+```
+Usage: whirled_peas <command> [command options]
+
+Available commands:
 
-#### list_frames
+    debug     Print template tree for specified frame
+    fonts     List installed title fonts with sample text
+    frames    Print out list of frames generated by application
+    help      Show detailed help for a command
+    play      Play an animation from an application or prerecorded file
+    record    Record animation to a file
+    still     Show the specified still frame
+```
 
-List the frames sent by the driver
+#### `debug`
+
+Print the template tree for specified frame.
 
 ```
-$ whirled_peas <config file> list_frames
-Frame 'start' displayed for 5 second(s)
-Frame 'move' displayed for 1 frame ({:direction=>'N'})
-...
-EOF frame detected
+# Usage: whirled_peas debug <config file> <frame> [args as a JSON string]
+% whirled_peas debug my_app.rb greeting '{"name":"World"}'
+* WhirledPeas::Graphics::BoxPainter(TEMPLATE)
+  - Dimensions(outer=140x27, content=120x15, grid=1x1)
+  - Settings
+    WhirledPeas::Settings::BoxSettings
+      padding: Padding(left: 10, top: 6, right: 10, bottom: 6)
+      align: :center
+      width: 120
+      flow: :t2b
+      bold: true
+      bg_color: BgColor(code=107, bright=true)
+  - Children
+    * WhirledPeas::Graphics::BoxPainter(Element-1)
+      - Dimensions(outer=64x6, content=64x6, grid=1x1)
 ```
 
-#### play_frame
+#### `fonts`
 
-Displays a single frame for several seconds
+List all installed title fonts with sample text.
 
 ```
-$ whirled_peas <config file> play_frame move '{"direction":"N"}'
+# Usage: whirled_peas fonts
 ```
 
-Adding the `--template` flag will result in printing out debug information for the template, e.g.
+#### `frames`
+
+Print out list of frames generated by application.
 
 ```
-$ whirled_peas <config file> play_frame move '{"direction":"N"}' --template
-+ TEMPLATE [WhirledPeas::Template::BoxElement]
-  - Settings
-    WhirledPeas::Settings::BoxSettings
-      <default>
-  - Children
-    + TitleContainer [WhirledPeas::Template::BoxElement]
+# Usage: whirled_peas frames <config file>
+% whirled_peas frames my_app.rb
+Frame 'intro' displayed for 3 second(s) '{"title":"Foo"}'
+Frame 'greet' displayed for 0.3 second(s)
 ...
 ```
 
-Adding the `--painter` flag will result in printing out debug information the painter (the rendered template), e.g.
+#### `help`
+
+Print out command-specific help message
 
 ```
-$ 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]
-...
+Usage: whirled_peas help <command>
 ```
 
-#### loading
+#### `play`
 
-Displays the configured loading screen for several seconds
+Play an animation from an application or prerecorded file
 
 ```
-$ whirled_peas <config file> loading
+# Usage: whirled_peas play <config/wpz file>
+
+# Play animation directly from app
+% whirled_peas play my_app.rb
+# Animation plays
+
+# Play animation from previously recorded file
+% whirled_peas play my_animation.wpz
+# Animation plays
 ```
 
-Adding the `--debug` flag will result in just printing out the loading template's debug information, e.g.
+#### `record`
+
+Record animation to a file
 
 ```
-$ whirled_peas <config file> loading --debug
-+ TEMPLATE [WhirledPeas::UI::Template]
-  - Settings
-    WhirledPeas::UI::TemplateSettings
-      <default>
-  - Children
-    + TitleContainer [WhirledPeas::UI::BoxElement]
-...
+# Usage: whirled_peas record <config file> <output file>
+% whirled_peas record my_app.rb my_animation.wpz
+# Record animation to my_animation.wpz
+```
+
+#### `still`
+
+Show the specified still frame
+
+```
+# Usage: whirled_peas still <config file> <frame> [args as a JSON string]
+% whirled_peas still my_app.rb greeting '{"name":"World"}'
+# Still frame is displayed
 ```
 
 ## Development
@@ -508,18 +1106,27 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ### 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.
+In addition to standard RSpec tests, WhirledPeas has custom tests for rendered templates. These files live in `screen_test/`. 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
+```
+
+Usage: screen_test [file] [options]
+
+If not file or options are provide, all tests are run
+
+If no file is provided, the supported options are
+    --help             print this usage statement and exit
+    --view-pending     interactively display and optionally save rendered output for each pending test
+    --view-failed      interactively display and optionally save rendered output for each faiing test
 
-- `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
+If a screen test file is provided as the first argument, the supported options are
+    --run        run screen test for given file
+    --view       interactively display and optionally save the file's test output
+    --template   print out template tree for the test template
+    --debug      render the test template without displying it, printing out debug information
+```
 
 ## Contributing
 
@@ -532,3 +1139,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the WhirledPeas project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/whirled_peas/blob/master/CODE_OF_CONDUCT.md).
+
+```
+
+```