whirled_peas 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 740b5ae88bfdd0f6dfbf4b1ef9e220a4298ddd8f4d8b01d62e904e3bfb4e109b
-  data.tar.gz: 1e78f0bf1664187825441258909a750c74455017266d01b4b64d5cdd7c609572
+  metadata.gz: 563cc06007d90aa0599b61c5366a5d9b2c5224ec2973367b6c358cad95ddaedc
+  data.tar.gz: fa798abdfb8a8e4fd229f08b964c8ee4f4d480939ece9ddaeb5731c171985504
 SHA512:
-  metadata.gz: '0960008e3b09aae39cf0655ff57d6dde8859bd3437844b68b37fd72b49bc04199dae2fa5544ba219f795d87f5b5ada80d56f0e96f005eaffddbd74de67d4037c'
-  data.tar.gz: ce998b69ac1db491577cdfaaaa4b35fb79a0bd07d24c622f426e38b1ff3eb0851ff10c90d24b8b7f48dc1b97dd01c11f93960a011c2611df201f3d86c45ce65a
+  metadata.gz: 1be24e74d75f87a001b26f216e320d4a4680c48513e48c42047d2c2168a9404471704731df97ced5954facdc4ca7316580f6078db5670e45067c7e8ed3ee4cd3
+  data.tar.gz: 86f3b995575fc7ff8b6bb83adf368182a684faece1584cffb7b1150bd47ce082adaba5b0d4ce0b83d19d2ec2d795bd31db19d35c990e6d0065698c050161bcd0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v0.4.0 - 2021-01-22
+
+- [7fd6712](https://github.com/tcollier/whirled_peas/tree/7fd6712818c94cdbfd81828277ca67c705e01793): BREAKING: replace `WhirledPeas.start` with command line executable
+- [2535342](https://github.com/tcollier/whirled_peas/tree/25353424f1ab4af4880f44eb7ddd28afefbbb9b2): Add support for loading screen
+- [7388fc2](https://github.com/tcollier/whirled_peas/tree/7388fc2eacdc8045b725311c11d650d6b8654be8): Add support for title fonts
+- [b345155](https://github.com/tcollier/whirled_peas/tree/b345155b1c212cabe73f9a2562ac8dbbedbbb6df): Add command to list title fonts to executable
+- [d3a8324](https://github.com/tcollier/whirled_peas/tree/d3a832496c36985993217ff11b6d83dd4697c4ed): Add commands for debugging application to executable
+
 ## v0.3.0 - 2021-01-21
 
 - [617f802](https://github.com/tcollier/whirled_peas/tree/617f8027d6688a2ec81a3e594e529c94485cee85): BREAKING: send frames directly to EventLoop (`Producer#send` renamed to `Producer#send_frame`)

data/README.md

@@ -24,9 +24,9 @@ Or install it yourself as:
 
 A Whirled Peas application consists of the following pieces
 
-1. [REQUIRED] The driver, which emits lightweight frame events
-1. [REQUIRED] The main template factory, which builds templates to convert frame events from the driver into terminal graphics
-1. [OPTIONAL] A loading screen template factory, which is used while content is loading
+- The driver (required) - the code that is to be visualized, it emits lightweight frame events through a producer
+- The main template factory (required) - builds templates to convert frame events from the driver into terminal graphics
+- A loading screen template factory (optional) - builds templates to display while content is loading
 
 These pieces are configured as following
 
@@ -39,7 +39,7 @@ class TemplateFactory
     WhirledPeas.template do |body|
       body.add_box('Title') do |_, settings|
         settings.underline = true
-        "Hello #{args['name']}"
+        "Hello #{args[:name]}"
       end
       # ...
     end
@@ -48,7 +48,7 @@ end
 
 class Driver
   def start(producer)
-    producer.send_frame('starting', args: { 'name' => 'World' })
+    producer.send_frame('starting', args: { name: 'World' })
     # ...
   end
 end
@@ -67,7 +67,7 @@ $ whirled_peas start visualize.rb
 
 The optional loading screen can be configured like
 
-````ruby
+```ruby
 class LoadingTemplateFactory
   def build
     WhirledPeas.template do |t|
@@ -98,7 +98,7 @@ The driver is the application code to be visualized. This is typically a lightwe
 def start(producer)
   # application code here
 end
-````
+```
 
 The producer provides a single method
 
@@ -107,12 +107,14 @@ The producer provides a single method
 #
 # @param name [String] application defined name for the frame. The template factory will be provided this name
 # @param duration [Number] time in seconds this frame should be displayed for (defaults to 1 frame)
-# @param args [Hash] key value pairs to send as arguments to the template factory
+# @param args [Hash<Symbol, Object>] key value pairs to send as arguments to the template factory
 def send_frame(name, duration:, args:)
   # implementation
 end
 ```
 
+**IMPORTANT**: the keys for arguments must be symbols.
+
 #### Example
 
 Simple application that loads a set of numbers and looks for a pair that adds up to 1,000

data/lib/whirled_peas/command_line.rb

@@ -66,11 +66,13 @@ module WhirledPeas
 
   class ConfigCommand < Command
     def start
-      require args[0]
+      require config
     end
 
     private
 
+    attr_reader :config
+
     def validate!
       if args.length == 0
         @error_text = "#{self.class.command_name} requires a config file"
@@ -78,6 +80,8 @@ module WhirledPeas
         @error_text = "File not found: #{args[0]}"
       elsif args[0][-3..-1] != '.rb'
         @error_text = 'Config file should be a .rb file'
+      else
+        @config = args[0][0] == '/' ? args[0] : File.join(Dir.pwd, args[0])
       end
     end
 

data/lib/whirled_peas/frame/event_loop.rb

@@ -23,8 +23,7 @@ module WhirledPeas
         @running
       end
 
-      def start
-        screen = UI::Screen.new
+      def start(screen=UI::Screen.new)
         wait_for_content(screen)
         play_content(screen)
       rescue
@@ -39,6 +38,7 @@ module WhirledPeas
 
       def stop
         logger.info(LOGGER_ID) { 'Stopping...' }
+        enqueue(Frame::EOF, nil, {})
         @running = false
       end
 

data/lib/whirled_peas/version.rb

@@ -1,3 +1,3 @@
 module WhirledPeas
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whirled_peas
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Tom Collier