whirled_peas 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9652a887fc6a68ba5367864a25b4a211674433eae86a2f68db3923e873ab49e8
-  data.tar.gz: 72926cd288adc3c30393990d88dcc0bca53e2fbfe79d56768e438ffaee2cf3ba
+  metadata.gz: 7553fd2ea78bf560098d8be8cd3987f1e8a686cb000cf6ea082a922512764069
+  data.tar.gz: 8fa1e64c35b311ae9346badc0198f556528c53dad9bfa0b99b2805c901369b8f
 SHA512:
-  metadata.gz: 9e0124bd724ece36b76e1d527ffb3ccd5a06e9cd7f00c1ae5d0c39445d0c4ed4804d8c2cdc0c3df250f0d927b9927efd97d118fd0fd76bbc42277fda68a674cb
-  data.tar.gz: '09edc4873598d1363d7d3ef2c548699bcbfa229a8821e458c201608ec9f7e3aba8cf2f081f559edc51c04244267f569e8444b7952b21ab41bfea8a7807c0432a'
+  metadata.gz: 531b93061429918f99dc5aa7de09a53a7fda218c97bac57b47d5a450ad22510207f71ba5a095f5a1939e4cce9d1f13d70a981e15b4e3209d0786ba12be048bd6
+  data.tar.gz: ea7daec0ccd65894bec99bfff75219d55dfc2cd9fc7b80d1e593b60e7a15a3e8eb7cbfa49e8ef20e8da5acbce2738d054cf56a9b0231661e46a5c399c83b8906

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # 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`

data/README.md

@@ -93,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 add_frame(name, duration:, args:)
-  # implementation
+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
 ```
 
@@ -155,6 +172,7 @@ A template is created with `WhirledPeas.template`, which yields a `Composer` obj
 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` 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
 
@@ -217,25 +235,26 @@ 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 in the horizontal direction                                | `:left`    | `Box`, `Grid`         | No                   |
-| `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`         | No                   |
-| `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                   |
-| `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`    | `Box`, `Grid`, `Text` | Yes                  |
-| `width`      | Override the calculated width of an element's content area                       |            | `Box`, `Grid`         | No                   |
-| `valign`     | Justifies the content in the vertical direction                                  | `:top`     | `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
 
@@ -671,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
@@ -840,16 +1117,15 @@ 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
-
-If the file provide is a screen test, 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
-
+    --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
+
+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

data/bin/easing

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'whirled_peas'
+require 'whirled_peas/animator/easing'
+
+module WhirledPeas
+  NUM_POINTS = 60
+
+  Animator::Easing::EASING.keys.each do |func|
+    Animator::Easing::EFFECTS.each do |effect|
+      easing = Animator::Easing.new(func, effect)
+      graph = Array.new(NUM_POINTS / ASPECT_RATIO) { '┃' }
+      NUM_POINTS.times.each do |i|
+        input = i.to_f / (NUM_POINTS - 1)
+        eased_value = ((easing.ease(input) * NUM_POINTS * 2) / ASPECT_RATIO).floor
+        graph.each.with_index do |row, row_num|
+          y_value = NUM_POINTS.to_f / ASPECT_RATIO - row_num - 1
+          row << if eased_value == 2 * y_value
+            '▄'
+          elsif eased_value == 2 * y_value + 1
+            '▀'
+          else
+            ' '
+          end
+        end
+      end
+      graph << '┗' + '━' * NUM_POINTS
+      puts "#{func} (#{effect})"
+      puts graph.join("\n")
+    end
+  end
+end

data/examples/graph.rb

@@ -0,0 +1,54 @@
+require 'bundler/setup'
+require 'whirled_peas'
+require 'whirled_peas/animator/easing'
+
+module WhirledPeas
+  PublicEasing = Animator::Easing
+end
+
+class TemplateFactory
+  INNER_WIDTH = 60
+
+  def build(name, args)
+    WhirledPeas.template do |composer, settings|
+      settings.bg_color = :bright_white
+      settings.align = :center
+      settings.valign = :middle
+      composer.add_grid do |composer, settings|
+        settings.num_cols = 2
+        WhirledPeas::PublicEasing::EASING.keys.each do |func|
+          easing = WhirledPeas::PublicEasing.new(func, :in_out)
+          composer.add_box do |composer, settings|
+            settings.flow = :t2b
+            settings.set_padding(horiz: 4, vert: 2)
+            composer.add_box do |_, settings|
+              settings.margin.bottom = 1
+              settings.color = :blue
+              settings.underline = true
+              "#{func} (in_out)"
+            end
+            composer.add_graph do |composer, settings|
+              settings.axis_color = :black
+              settings.color = :bright_blue
+              settings.height = 15
+              INNER_WIDTH.times.map do |i|
+                easing.ease(i.to_f / (INNER_WIDTH - 1))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+class Application
+  def start(producer)
+    producer.add_frame('intro', duration: 5)
+  end
+end
+
+WhirledPeas.configure do |config|
+  config.template_factory = TemplateFactory.new
+  config.application = Application.new
+end

data/examples/scrolling.rb

@@ -42,7 +42,7 @@ end
 class Application
   def start(producer)
     producer.frameset(5, easing: :bezier) do |fs|
-      53.times { |i| fs.add_frame('intro', { top: -i }) }
+      53.times { |i| fs.add_frame('intro', args: { top: -i }) }
     end
     producer.add_frame('hold', duration: 1, args: { top: -52})
   end

data/lib/whirled_peas/animator/frameset.rb

@@ -10,7 +10,7 @@ module WhirledPeas
         @frames = []
       end
 
-      def add_frame(name, args={})
+      def add_frame(name, args: {})
         frames << [name, args]
       end
 

data/lib/whirled_peas/animator/producer.rb

@@ -17,7 +17,7 @@ module WhirledPeas
 
       def add_frame(name, duration: nil, args: {})
         frameset(duration || 1 / refresh_rate) do |fs|
-          fs.add_frame(name, args)
+          fs.add_frame(name, args: args)
         end
       end
 

data/lib/whirled_peas/graphics/composer.rb

@@ -1,8 +1,10 @@
 require 'whirled_peas/settings/box_settings'
+require 'whirled_peas/settings/graph_settings'
 require 'whirled_peas/settings/grid_settings'
 require 'whirled_peas/settings/text_settings'
 
 require_relative 'box_painter'
+require_relative 'graph_painter'
 require_relative 'grid_painter'
 require_relative 'text_painter'
 
@@ -45,6 +47,7 @@ module WhirledPeas
         child = TextPainter.new(name, child_settings)
         # TextPainters are not composable, so yield nil
         content = yield nil, child_settings
+        child_settings.validate!
         unless self.class.stringable?(content)
           raise ArgumentError, "Unsupported type for text: #{content.class}"
         end
@@ -52,11 +55,25 @@ module WhirledPeas
         painter.add_child(child)
       end
 
+      def add_graph(name=self.class.next_name, &block)
+        child_settings = Settings::GraphSettings.inherit(painter.settings)
+        child = GraphPainter.new(name, child_settings)
+        # GraphPainters are not composable, so yield nil
+        content = yield nil, child_settings
+        child_settings.validate!
+        unless content.is_a?(Array) && content.length > 0
+          raise ArgumentError, 'Graphs require a non-empty array as the content'
+        end
+        child.content = content
+        painter.add_child(child)
+      end
+
       def add_box(name=self.class.next_name, &block)
         child_settings = Settings::BoxSettings.inherit(painter.settings)
         child = BoxPainter.new(name, child_settings)
         composer = self.class.new(child)
         value = yield composer, child.settings
+        child_settings.validate!
         painter.add_child(child)
         if !child.children? && self.class.stringable?(value)
           composer.add_text("#{name}-Text") { value.to_s }
@@ -68,6 +85,7 @@ module WhirledPeas
         child = GridPainter.new(name, child_settings)
         composer = self.class.new(child)
         values = yield composer, child.settings
+        child_settings.validate!
         painter.add_child(child)
         if !child.children? && values.is_a?(Array)
           values.each.with_index do |value, index|

data/lib/whirled_peas/graphics/content_dimensions.rb

@@ -0,0 +1,19 @@
+module WhirledPeas
+  module Graphics
+    class ContentDimensions
+      attr_reader :outer_width, :outer_height
+
+      def initialize(settings, content)
+        if settings.width
+          @outer_width = settings.width
+        else
+          @outer_width = 0
+          content.each do |line|
+            @outer_width = line.length if line.length > @outer_width
+          end
+        end
+        @outer_height = settings.height || content.length
+      end
+    end
+  end
+end

data/lib/whirled_peas/graphics/content_painter.rb

@@ -0,0 +1,20 @@
+require_relative 'painter'
+
+module WhirledPeas
+  module Graphics
+    class ContentPainter < Painter
+      attr_accessor :content
+
+      def dimensions
+        ContentDimensions.new(settings, content_lines)
+      end
+
+      private
+
+      def content_lines
+        raise NotImplementedError, "#{self.class} must implement #content_lines"
+      end
+    end
+    private_constant :ContentPainter
+  end
+end

data/lib/whirled_peas/graphics/graph_dimensions.rb

@@ -0,0 +1,12 @@
+module WhirledPeas
+  module Graphics
+    class TextDimensions
+      attr_reader :outer_width, :outer_height
+
+      def initialize(settings, content)
+        @outer_width = settings.width
+        @outer_height = settings.height
+      end
+    end
+  end
+end

data/lib/whirled_peas/graphics/graph_painter.rb

@@ -0,0 +1,95 @@
+require 'whirled_peas/utils/ansi'
+
+require_relative 'content_painter'
+
+module WhirledPeas
+  module Graphics
+    class GraphPainter < ContentPainter
+      def paint(canvas, left, top, &block)
+        axis_formatting = [*settings.axis_color, *settings.bg_color]
+        plot_formatting = [*settings.color, *settings.bg_color]
+        axes_lines.each.with_index do |axis_line, row_index|
+          canvas.stroke(left, top + row_index, axis_line, axis_formatting, &block)
+          next if row_index >= plot_lines.length
+          canvas.stroke(left + 1, top + row_index, plot_lines[row_index], plot_formatting, &block)
+        end
+      end
+
+      private
+
+      def content_lines
+        axes_lines
+      end
+
+      def plot_lines
+        return @plot_lines if @plot_lines
+        min_y = 1.0 / 0
+        max_y = -1.0 / 0
+        if settings.width
+          interpolated = inner_width.times.map do |i|
+            x = (i * (content.length - 1).to_f / inner_width).floor
+            max_y = content[x] if content[x] > max_y
+            min_y = content[x] if content[x] < min_y
+            content[x]
+          end
+        else
+          interpolated = content
+          content.each do |y|
+            max_y = y if y > max_y
+            min_y = y if y < min_y
+          end
+        end
+        scaled = interpolated.map do |y|
+          (2 * inner_height * (y - min_y).to_f / (max_y - min_y)).floor
+        end
+        @plot_lines = Array.new(inner_height) { '' }
+        scaled.each.with_index do |y, x_index|
+          @plot_lines.each.with_index do |row, row_index|
+            y_index = inner_height - row_index - 1
+            asc, next_y = if scaled.length == 1
+              [true, y]
+            elsif x_index == scaled.length - 1
+              y >= scaled[x_index - 1]
+              [true, y]
+            else
+              scaled[x_index + 1] >= y
+              [true, scaled[x_index + 1]]
+            end
+            if asc
+              top_half = (y...next_y).include?(2 * y_index + 1)
+              bottom_half = (y...next_y).include?(2 * y_index)
+            else
+              top_half = (next_y...y).include?(2 * y_index + 1)
+              bottom_half = (next_y...y).include?(2 * y_index)
+            end
+            row << if top_half && bottom_half
+              '█'
+            elsif top_half
+              '▀'
+            elsif bottom_half
+              '▄'
+            else
+              ' '
+            end
+          end
+        end
+        @plot_lines
+      end
+
+      def inner_height
+        settings.height - 1
+      end
+
+      def inner_width
+        settings.width.nil? ? content.length : settings.width - 1
+      end
+
+      def axes_lines
+        return @axes_lines if @axes_lines
+        @axes_lines = inner_height.times.map { '┃' }
+        @axes_lines << '┗' + '━' * inner_width
+        @axes_lines
+      end
+    end
+  end
+end

data/lib/whirled_peas/graphics/grid_painter.rb

@@ -28,9 +28,6 @@ module WhirledPeas
 
       def dimensions
         @dimensions ||= begin
-          if settings.num_cols.nil? || settings.num_cols == 0
-            raise SettingsError, "`num_cols` must be set for GridSettings(#{name})"
-          end
           num_cols = settings.num_cols
           num_rows = (num_children.to_f / num_cols).ceil
           content_width = 0

data/lib/whirled_peas/graphics/text_painter.rb

@@ -1,14 +1,12 @@
 require 'whirled_peas/utils/formatted_string'
 require 'whirled_peas/utils/title_font'
 
-require_relative 'painter'
-require_relative 'text_dimensions'
+require_relative 'content_dimensions'
+require_relative 'content_painter'
 
 module WhirledPeas
   module Graphics
-    class TextPainter < Painter
-      attr_reader :content
-
+    class TextPainter < ContentPainter
       def paint(canvas, left, top, &block)
         return unless canvas.writable?
         formatting = [*settings.color, *settings.bg_color]
@@ -16,17 +14,15 @@ module WhirledPeas
         if settings.underline? && settings.title_font.nil?
           formatting << Utils::Ansi::UNDERLINE
         end
-        content.each.with_index do |line, index|
+        content_lines.each.with_index do |line, index|
           canvas.stroke(left, top + index, line, formatting, &block)
         end
       end
 
-      def dimensions
-        TextDimensions.new(content)
-      end
+      private
 
-      def content=(content)
-        @content = if settings.title_font
+      def content_lines
+        @content_lines = if settings.title_font
           Utils::TitleFont.to_s(
             content, settings.title_font
           ).split("\n")

data/lib/whirled_peas/settings/container_settings.rb

@@ -12,8 +12,6 @@ require_relative 'vert_alignment'
 module WhirledPeas
   module Settings
     class ContainerSettings < ElementSettings
-      attr_accessor :width, :height
-
       def align
         @_align || Alignment::DEFAULT
       end

data/lib/whirled_peas/settings/element_settings.rb

@@ -13,6 +13,11 @@ module WhirledPeas
         child
       end
 
+      attr_accessor :width, :height
+
+      def validate!
+      end
+
       def bg_color
         @_bg_color || BgColor::DEFAULT
       end

data/lib/whirled_peas/settings/graph_settings.rb

@@ -0,0 +1,21 @@
+require_relative 'text_color'
+require_relative 'element_settings'
+
+module WhirledPeas
+  module Settings
+    class GraphSettings < ElementSettings
+      def axis_color
+        @_axis_color || color
+      end
+
+      def axis_color=(color)
+        @_axis_color = TextColor.validate!(color)
+      end
+
+      def validate!
+        super
+        raise SettingsError, "`height` must be set for GraphSettings" if height.nil?
+      end
+    end
+  end
+end

data/lib/whirled_peas/settings/grid_settings.rb

@@ -7,6 +7,13 @@ module WhirledPeas
     class GridSettings < ContainerSettings
       attr_accessor :num_cols
 
+      def validate!
+        super
+        if num_cols.nil? || num_cols <= 0
+          raise SettingsError, "`num_cols` must be set to a positive number for GridSettings"
+        end
+      end
+
       def set_scrollbar(*)
         raise NotImplementedError, 'Grids do not support scrollbars'
       end

data/lib/whirled_peas/utils/ansi.rb

@@ -28,7 +28,7 @@ module WhirledPeas
       BRIGHT_OFFSET = 60
 
       class << self
-        def with_screen(output, width: nil, height: nil, &block)
+        def with_screen(output=STDOUT, width: nil, height: nil, &block)
           require 'highline'
           unless width && height
             width, height = HighLine.new.terminal.terminal_size

data/lib/whirled_peas/version.rb

@@ -1,3 +1,3 @@
 module WhirledPeas
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/screen_test/elements/graph.frame

@@ -0,0 +1 @@
+[?25l┃        █ ┃        █ ┃       ▄▀ ┃       █  ┃      ▄▀  ┃      █   ┃     ▄▀   ┃     █    ┃    █     ┃   █      ┃ ▄▀       ┗━━━━━━━━━━[?25h

data/screen_test/elements/graph.rb

@@ -0,0 +1,12 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_graph('Graph') do |_, settings|
+        settings.height = 12
+        10.times.map { |i| i ** 2 }
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whirled_peas
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Tom Collier
@@ -70,9 +70,11 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/easing
 - bin/reset_cursor
 - bin/screen_test
 - bin/setup
+- examples/graph.rb
 - examples/intro.rb
 - examples/scrolling.rb
 - exe/whirled_peas
@@ -109,12 +111,15 @@ files:
 - lib/whirled_peas/graphics/container_coords.rb
 - lib/whirled_peas/graphics/container_dimensions.rb
 - lib/whirled_peas/graphics/container_painter.rb
+- lib/whirled_peas/graphics/content_dimensions.rb
+- lib/whirled_peas/graphics/content_painter.rb
 - lib/whirled_peas/graphics/debugger.rb
+- lib/whirled_peas/graphics/graph_dimensions.rb
+- lib/whirled_peas/graphics/graph_painter.rb
 - lib/whirled_peas/graphics/grid_painter.rb
 - lib/whirled_peas/graphics/mock_screen.rb
 - lib/whirled_peas/graphics/painter.rb
 - lib/whirled_peas/graphics/renderer.rb
-- lib/whirled_peas/graphics/text_dimensions.rb
 - lib/whirled_peas/graphics/text_painter.rb
 - lib/whirled_peas/null_logger.rb
 - lib/whirled_peas/settings.rb
@@ -127,6 +132,7 @@ files:
 - lib/whirled_peas/settings/debugger.rb
 - lib/whirled_peas/settings/display_flow.rb
 - lib/whirled_peas/settings/element_settings.rb
+- lib/whirled_peas/settings/graph_settings.rb
 - lib/whirled_peas/settings/grid_settings.rb
 - lib/whirled_peas/settings/margin.rb
 - lib/whirled_peas/settings/padding.rb
@@ -145,6 +151,8 @@ files:
 - lib/whirled_peas/version.rb
 - screen_test/elements/box.frame
 - screen_test/elements/box.rb
+- screen_test/elements/graph.frame
+- screen_test/elements/graph.rb
 - screen_test/elements/grid.frame
 - screen_test/elements/grid.rb
 - screen_test/elements/screen_overflow_x.frame

data/lib/whirled_peas/graphics/text_dimensions.rb

@@ -1,15 +0,0 @@
-module WhirledPeas
-  module Graphics
-    class TextDimensions
-      attr_reader :outer_width, :outer_height
-
-      def initialize(content)
-        @outer_width = 0
-        content.each do |line|
-          @outer_width = line.length if line.length > @outer_width
-        end
-        @outer_height = content.length
-      end
-    end
-  end
-end