whirled_peas 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b374c9d4250b281d3f87284f446e82c01ece7ff2fe196687be50502b2e42960
-  data.tar.gz: 0ebd7b96a154277121767eb8c33d63b831db37770ff0172b76f28fcf89c5dec9
+  metadata.gz: 4a2a839ef0ed84dd94f346be47c38d65c0d23b6faa399abdf8f56023138788a4
+  data.tar.gz: 04a43d7c60d2e3896adea98036012bdba20448ecdf530947b72ca535ee5c3464
 SHA512:
-  metadata.gz: f6dcc7dc00852a343f55056646db886903bc5735a21bd9af71a885e28ff70aa85bb3f26ff4f97c23dc4292fa401c1c624284c347b17fb957fb8e0069301b7ef9
-  data.tar.gz: 1f0ae0e07baf45703dff90396be7b6c705f17f8c9cb4fcd4e0b4b433513efc94dd8c3a056f50f1d3f47f7e3179c308d36264ef4e4be0c179815e650a6136a11a
+  metadata.gz: dfff87fa6a87ed784b35b400ad9ac737508b4ded1e791840a3a3194a0ef22eae1ad517c9f8db9459b929e37ce132cfa97662f85762b0b02df691f58ececa7d19
+  data.tar.gz: 504e279d386d56d3b476220c4f8a015134c446b7a0cdcebc5c65db50ee750f48ce2b8b5e6a72ce0d3844bdca916f832230b7974dfdd5d982140b8bc15db003c6

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

@@ -2,6 +2,12 @@
 
 ## v0.5.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.
 
 - [3ddfede](https://github.com/tcollier/whirled_peas/tree/3ddfedee4ab2fadeecbe82c7c9caf25c2988f095): Allow relative positioning of containers

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 visual 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
 
@@ -156,12 +172,12 @@ To render the frame events sent by the driver, the application requires a templa
 
 #### 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.
 
 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_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 +208,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 +222,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|
@@ -236,6 +252,7 @@ The available settigs are
 | `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                   |
 | `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                   |
@@ -262,6 +279,12 @@ Padding settings dictate the spacing on the inside (i.e. inside of the border) o
 
 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_padding(horiz:, vert:)`
+
 ##### 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
@@ -308,31 +331,53 @@ Child elements can flow in one of 4 directions
 - `:l2r` left-to-right
 
 ```
+# 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
 
 ```
+# 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
 
 ```
+# In a Box
 [child 1]
 [child 2]
  ...
 [child N]
+
+# In a Grid
+[child 1] [child 4]
+[child 2] [child 5]
+[child 3]
 ```
 
 - `:b2t` bottom-to-top
 
 ```
+# In a Box
 [child N]
 [child N - 1]
  ...
 [child 1]
+
+# In a Grid
+[child 3]
+[child 2] [child 5]
+[child 1] [child 4]
 ```
 
 ##### Colors
@@ -360,7 +405,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
 
 ```
 ██████╗ ███████╗███████╗ █████╗ ██╗   ██╗██╗     ████████╗
@@ -455,30 +500,17 @@ Adding the `--template` flag will result in printing out debug information for t
 
 ```
 $ 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]
 ...
 ```
 
+Note: the `list_frames` command will print out frame names and arguments formatted for this command
+
 #### loading
 
 Displays the configured loading screen for several seconds
@@ -487,16 +519,16 @@ 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.
+Adding the `--template` 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]
+$ whirled_peas <config file> loading --template
++ TEMPLATE [WhirledPeas::Graphics::BoxPainter]
   - Settings
-    WhirledPeas::UI::TemplateSettings
+    WhirledPeas::Settings::BoxSettings
       <default>
   - Children
-    + TitleContainer [WhirledPeas::UI::BoxElement]
+    + TitleContainer [WhirledPeas::Graphics::BoxPainter]
 ...
 ```
 
@@ -515,7 +547,8 @@ Note: viewing `.frame` files with `cat` works better than most other text editor
 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:debug[path/to/file.rb]` render the screen without printing it, this allows for debug print statments in the code to appear in the terminal
+- `screen_test:template[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

data/Rakefile

@@ -14,7 +14,7 @@ def screen_test(file, method)
 end
 
 namespace :screen_test do
-  %i[debug run save view].each do |t|
+  %i[template view run save debug].each do |t|
     task t, [:file] do |_, args|
       screen_test(args[:file], t)
     end
@@ -37,4 +37,5 @@ task :screen_test do
   WhirledPeas::ScreenTester.run_all
 end
 
-task default: [:screen_test, :spec]
+task default: :ci
+task ci: [:screen_test, :spec]

data/examples/intro.rb

@@ -0,0 +1,52 @@
+require 'bundler/setup'
+require 'whirled_peas'
+
+class TemplateFactory
+  TITLE_FONT = :default #roman
+  PRIMARY_COLOR = :bright_blue
+  SECONDARY_COLOR = :blue
+  BG_COLOR = :bright_white
+
+  def build(name, args)
+    WhirledPeas.template do |composer, settings|
+      settings.set_padding(left: 10, top: 6, right: 10, bottom: 6)
+      settings.align = :center
+      settings.width = 120
+      settings.flow = :t2b
+      settings.bold = true
+      settings.bg_color = BG_COLOR
+
+      composer.add_box do |composer, settings|
+        composer.add_text do |_, settings|
+          settings.title_font = TITLE_FONT
+          settings.color = PRIMARY_COLOR
+          'Visualize'
+        end
+      end
+      composer.add_box do |_, settings|
+        settings.set_margin(top: 1)
+        settings.color = SECONDARY_COLOR
+        "your code's execution with"
+      end
+      composer.add_box do |composer, settings|
+        settings.set_margin(top: 1)
+        composer.add_text do |_, settings|
+          settings.title_font = TITLE_FONT
+          settings.color = PRIMARY_COLOR
+          'Whirled Peas'
+        end
+      end
+    end
+  end
+end
+
+class Driver
+  def start(producer)
+    producer.send_frame('intro', duration: 5)
+  end
+end
+
+WhirledPeas.configure do |config|
+  config.template_factory = TemplateFactory.new
+  config.driver = Driver.new
+end

data/examples/scrolling.rb

@@ -0,0 +1,53 @@
+require 'bundler/setup'
+require 'whirled_peas'
+
+class TemplateFactory
+  HPADDING = 0
+  VPADDING = 0
+  ITEM_COUNT = 64
+
+  def build(name, args)
+    top = args[:top]
+    WhirledPeas.template do |composer, settings|
+      settings.color = :green
+      composer.add_box('Vert') do |composer, settings|
+        settings.bg_color = :bright_red
+        settings.full_border(color: :blue)
+        settings.set_scrollbar(vert: true)
+        settings.height = 12
+        composer.add_box('Inner') do |composer, settings|
+          settings.flow = :t2b
+          settings.set_padding(left: HPADDING, right: HPADDING, top: VPADDING, bottom: VPADDING)
+          settings.set_position(top: top)
+          ITEM_COUNT.times do |i|
+            composer.add_text { "%2d" % i }
+          end
+        end
+      end
+      composer.add_box('Horiz') do |composer, settings|
+        settings.bg_color = :bright_red
+        settings.full_border(color: :blue)
+        settings.set_padding(left: HPADDING, right: HPADDING, top: VPADDING, bottom: VPADDING)
+        settings.set_scrollbar(horiz: true)
+        settings.width = 12
+        composer.add_box('Inner') do |composer, settings|
+          settings.set_position(left: top)
+          ITEM_COUNT.times.map { |i| (i % 10).to_s }.join
+        end
+      end
+    end
+  end
+end
+
+class Driver
+  def start(producer)
+    53.times do |i|
+      producer.send_frame('intro', duration: 0.3, args: { top: -i })
+    end
+  end
+end
+
+WhirledPeas.configure do |config|
+  config.template_factory = TemplateFactory.new
+  config.driver = Driver.new
+end

data/lib/whirled_peas.rb

@@ -2,11 +2,9 @@ require 'logger'
 
 require 'whirled_peas/errors'
 require 'whirled_peas/config'
-require 'whirled_peas/debugger'
 require 'whirled_peas/frame'
 require 'whirled_peas/graphics'
 require 'whirled_peas/settings'
-require 'whirled_peas/template'
 require 'whirled_peas/utils'
 require 'whirled_peas/version'
 
@@ -19,12 +17,8 @@ module WhirledPeas
     yield config
   end
 
-  def self.debug(config_file, option=nil)
-    Debugger.new(config_file, option).debug
-  end
-
   def self.template(&block)
-    require 'whirled_peas/template/composer'
-    Template::Composer.build(&block)
+    require 'whirled_peas/graphics/composer'
+    Graphics::Composer.build(&block)
   end
 end

data/lib/whirled_peas/command_line.rb

@@ -6,7 +6,6 @@ require 'whirled_peas/graphics/screen'
 require 'whirled_peas/frame/debug_consumer'
 require 'whirled_peas/frame/event_loop'
 require 'whirled_peas/frame/producer'
-require 'whirled_peas/template/debugger'
 
 module WhirledPeas
   class Command
@@ -138,24 +137,17 @@ module WhirledPeas
       super
 
       if args.last == '--template'
-        element = WhirledPeas.config.template_factory.build(frame, frame_args)
-        puts Template::Debugger.new(element).debug
-        exit
-      elsif args.last == '--painter'
-        element = WhirledPeas.config.template_factory.build(frame, frame_args)
-        painter = Graphics::Renderer.new(element, *Graphics::Screen.current_dimensions).painter
-        puts Graphics::Debugger.new(painter).debug
-        exit
-      end
-
-      logger = self.class.build_logger(File.open('whirled_peas.log', 'a'))
-
-      consumer = Frame::EventLoop.new(
-        WhirledPeas.config.template_factory,
-        logger: logger
-      )
-      Frame::Producer.produce(consumer, logger) do |producer|
-        producer.send_frame(frame, args: frame_args)
+        template = WhirledPeas.config.template_factory.build(frame, frame_args)
+        puts Graphics::Debugger.new(template).debug
+      else
+        logger = self.class.build_logger(File.open('whirled_peas.log', 'a'))
+        consumer = Frame::EventLoop.new(
+          WhirledPeas.config.template_factory,
+          logger: logger
+        )
+        Frame::Producer.produce(consumer, logger) do |producer|
+          producer.send_frame(frame, args: frame_args)
+        end
       end
     end
 
@@ -180,7 +172,7 @@ module WhirledPeas
     end
 
     def print_usage
-      puts "Usage: #{$0} #{self.class.command_name} <config file> <frame> [args as a JSON string] [--debug]"
+      puts "Usage: #{$0} #{self.class.command_name} <config file> <frame> [args as a JSON string] [--template]"
     end
   end
 
@@ -189,27 +181,27 @@ module WhirledPeas
       super
       unless WhirledPeas.config.loading_template_factory
         puts 'No loading screen configured'
-        exit
+        exit(1)
       end
 
-      if args.last == '--debug'
-        puts WhirledPeas.config.loading_template_factory.build.inspect
-        exit
+      if args.last == '--template'
+        template = WhirledPeas.config.loading_template_factory.build
+        puts Graphics::Debugger.new(template).debug
+      else
+        logger = self.class.build_logger(File.open('whirled_peas.log', 'a'))
+        consumer = Frame::EventLoop.new(
+          WhirledPeas.config.template_factory,
+          WhirledPeas.config.loading_template_factory,
+          logger: logger
+        )
+        Frame::Producer.produce(consumer, logger) { sleep(5) }
       end
-
-      logger = self.class.build_logger(File.open('whirled_peas.log', 'a'))
-      consumer = Frame::EventLoop.new(
-        WhirledPeas.config.template_factory,
-        WhirledPeas.config.loading_template_factory,
-        logger: logger
-      )
-      Frame::Producer.produce(consumer, logger) { sleep(5) }
     end
 
     private
 
     def print_usage
-      puts "Usage: #{$0} #{self.class.command_name} [--debug]"
+      puts "Usage: #{$0} #{self.class.command_name} [--template]"
     end
   end