whirled_peas 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 424038cc2fb2f4b48edb6e43219f515eb5564f7e78871506d63ea1bbbc724ff9
-  data.tar.gz: 6f35ac5a2d32f3a37a6876e0b2b7022d9c0f07a1f71eb1f3d628def4840926e7
+  metadata.gz: 7c1c4b2f603c535f98d7578741059e0d949ccff4e315fc88c36c13fc2fa58de5
+  data.tar.gz: a9c92f62d2dcb7c7c1983bf6e6e8fa66bb5a92abcec0ae689ca4efc342083625
 SHA512:
-  metadata.gz: 4bf7a9b822e06e095fed812f5408358dd6562e604fa5da7c4e91a8cfcf9f96f081b9f33198767e0221563b2f2304a70e38e637c10830c16664440d46346cef6f
-  data.tar.gz: 7f402bf1c932d58893df06874f314216b053fdf2019704a13e317d5b0512e20558b0019eafb5d5c7796975e45e6ddc01fc3a0fd70e1c9179485de60f527dc422
+  metadata.gz: 8e746107b95a5176d89792606a76935c84c3686452b2abf99c5383df676263684a096130c18cf07080fbc9ede4dc61b9ae220efe4fd8313e933c230e73d8b1b0
+  data.tar.gz: d5dca0db34f358072134a94ae8b5765abd60d45f18de7496dc0c410cd665c2e9ef91ef33989d00317caef1fd472c210e892af13d8a65bc3126ea37b201dc1b43

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.10.0 - 2021-01-29
+
+- [3063a2b](https://github.com/tcollier/whirled_peas/tree/3063a2becb7680b5e320a1733b3da933e6c65210): Add built-in and user-defined themes
+
 ## v0.9.1 - 2021-01-29
 
 - [c35b134](https://github.com/tcollier/whirled_peas/tree/c35b134e1340b8b5f1d1fb0e6e56dc2a99b52e94): Improve graph plots

data/README.md

@@ -85,7 +85,8 @@ $ whirled_peas play visualize.rb
 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
+# Start the application and pass frame events to the producer to be rendered
+# by the UI
 #
 # @param producer [Producer] frame producer that sends events to the UI
 def start(producer)
@@ -98,15 +99,27 @@ The producer provides the following methods
 ```ruby
 # 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
+# @param name [String] (required) application defined name for the frame. The
+#    template factory will be provided this name
+# @param duration [Number] (optional) time in seconds this frame should be
+#   displayed for (defaults to 1 frame)
+# @param args [Hash<Symbol, Object>] (optional) key/value pairs to send as
+#   arguments to the template factory
 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)
+# 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 given `easing` and `effect`
+# arguments (default is `:linear` easing)
+#
+# @param duration [Number] (required) total duration for which all frames in
+#   frameset will be displayed
+# @param easing [Symbol] (optional) easing function to be used to transition
+#   through all frames (defaults to `:linear`)
+# @param effect [Symbol] (optional) how to apply the easing function (defaults
+#   to `:in_out`, also available are `:in` and `:out`)
+# @yield [Frameset] instance that provides `#add_frame(name, args:)`
 def frameset(duration, easing:, effect:, &block)
 end
 ```
@@ -114,11 +127,13 @@ 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
+# 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
+# @param name [String] (required) application defined name for the frame. The
+#   template factory will be provided this name
+# @param args [Hash<Symbol, Object>] (optional) key/value pairs to send as
+#   arguments to the template factory
 def add_frame(name, args:)
 end
 ```
@@ -232,29 +247,45 @@ end
 
 #### Settings
 
-Each element type has an associated settings type, which provide a custom set of options to format the output. Child settings will inherit from the parent, where applicable
-The available settigs are
+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 table below lists all settings along with which element types the settings can be applied to (`Grid` and `Box` are containers)
 
 | Setting      | Description                                                                      | Default    | Availability | Inherited            |
 | ------------ | -------------------------------------------------------------------------------- | ---------- | ------------ | -------------------- |
-| `align`      | Justifies the content in the horizontal direction                                | `:left`    | `Container`  | No                   |
+| `align`      | Justifies the content in the horizontal direction                                | `:left`    | containers   | 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 |
+| `border`     | Set the border for the lements                                                   | none       | containers,  | 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                   |
+| `flow`       | Flow to display child elements (see [Display Flow](#display-flow))               | `:l2r`     | containers   | 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                   |
+| `margin`     | Set the (left, top, right, bottom) margin of the element                         | `0`        | containers   | 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                   |
+| `padding`    | Set the (left, top, right, bottom) padding of the element                        | `0`        | containers   | No                   |
+| `position`   | Set the (left, top) position of the element relative to parent content area      | `0`        | containers   | 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                   |
+| `valign`     | Justifies the content in the vertical direction                                  | `:top`     | containers   | No                   |
+
+##### Themes
+
+The template builder (`WhirledPeas.template`) takes an optional `theme` argument. You can provide the name of a predefined theme (run `whirled_peas themes` to see a list with samples) or define you own with the following
+You can define your own theme
+
+```ruby
+WhirledPeas.define_theme(:my_theme) do |theme|
+  theme.bg_color = :bright_white
+  theme.color = :blue
+  theme.border_color = :bright_green
+  theme.axis_color = :bright_red
+  theme.title_font = :default
+end
+```
+
+Theme settings will be used as default settings throughout the template, however theme settings can be overridden on any element.
 
 ##### Alignment
 
@@ -1010,6 +1041,7 @@ Available commands:
     play      Play an animation from an application or prerecorded file
     record    Record animation to a file
     still     Show the specified still frame
+    themes    List all themes with sample template rendered in the theme
 ```
 
 #### `debug`
@@ -1098,6 +1130,19 @@ Show the specified still frame
 # Still frame is displayed
 ```
 
+#### `themes`
+
+List all themes and display a small sample screen in each. Running this with no extra command line arguments will display all the built-in themes. Adding the path to a Whirled Peas configuration file will inlcude any themes defined in that configuration.
+
+```
+# Usage: whirled_peas themes [config file]
+% whirled_peas themes
+# Display all system themes
+
+% whirled_peas themes my_app.rb
+# Display app-defined themes and all system themes
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/data/themes.yaml

@@ -0,0 +1,13 @@
+bright:
+  bg_color: :bright_white
+  color: :blue
+  border_color: :bright_blue
+  axis_color: :red
+  title_font: :default
+
+dark:
+  bg_color: :black
+  color: :white
+  border_color: :gray
+  axis_color: :bright_white
+  title_font: :swan

data/lib/whirled_peas.rb

@@ -15,8 +15,16 @@ module WhirledPeas
     yield config
   end
 
-  def self.template(&block)
+  def self.template(theme_name=nil, &block)
     require 'whirled_peas/graphics/composer'
-    Graphics::Composer.build(&block)
+    Graphics::Composer.build(theme_name, &block)
+  end
+
+  def self.define_theme(name, &block)
+    require 'whirled_peas/settings/theme'
+    require 'whirled_peas/settings/theme_library'
+    theme = Settings::Theme.new
+    yield theme
+    Settings::ThemeLibrary.add(name, theme)
   end
 end

data/lib/whirled_peas/command/config_command.rb

@@ -8,9 +8,8 @@ module WhirledPeas
     class ConfigCommand < Base
       def start
         require config_file
-      rescue => e
+      rescue LoadError
         puts "Error loading #{config_file}"
-        puts e.message
         exit(1)
       end
 

data/lib/whirled_peas/command/play.rb

@@ -38,6 +38,9 @@ module WhirledPeas
               config.application.start(producer)
             end
           end
+        rescue LoadError
+          puts "Error loading #{config_file}"
+          exit(1)
         end
 
         private

data/lib/whirled_peas/command/themes.rb

@@ -0,0 +1,76 @@
+require 'whirled_peas/device/screen'
+require 'whirled_peas/graphics/renderer'
+require 'whirled_peas/settings/theme_library'
+
+require_relative 'base'
+
+module WhirledPeas
+  module Command
+    # Display a still frame with the specified arguments.
+    class Themes < Base
+      def self.description
+        'List all themes with sample template rendered in the theme'
+      end
+
+      def start
+        super
+
+        require config_file unless config_file.nil?
+
+        theme_names = Settings::ThemeLibrary.theme_names
+        theme_names.each.with_index do |name, index|
+          template = WhirledPeas.template(name) do |composer, settings|
+            settings.full_border
+            settings.flow = :t2b
+            composer.add_text do |_, settings|
+              settings.title_font = :theme
+              name
+            end
+            composer.add_text do
+              name == Settings::ThemeLibrary.default_name ? ' (default)' : ''
+            end
+            composer.add_graph do |_, settings|
+              settings.height = 12
+              20.times.map { |i| Math.sqrt(i) }
+            end
+          end
+          Utils::Ansi.with_screen do |width, height|
+            rendered = Graphics::Renderer.new(
+              template,
+              80,
+              30
+            ).paint
+            Device::Screen.new(10000).handle_renders([rendered])
+          end
+
+          if index < theme_names.length - 1
+            print 'See next theme? [Y/q] '
+            STDOUT.flush
+            break if gets.chomp == 'q'
+          end
+        end
+      rescue LoadError
+        puts "Error loading #{config_file}"
+        exit(1)
+      end
+
+      private
+
+      attr_reader :config_file
+
+      def validate!
+        super
+        config_file = args.shift
+        @error_text = 'hi'
+        unless config_file.nil?
+          # We think we have a valid ruby config file, set the absolute path to @config
+          @config_file = config_file[0] == '/' ? config_file : File.join(Dir.pwd, config_file)
+        end
+      end
+
+      def options_usage
+        '[config file]'
+      end
+    end
+  end
+end

data/lib/whirled_peas/command_line.rb

@@ -5,6 +5,7 @@ require 'whirled_peas/command/help'
 require 'whirled_peas/command/play'
 require 'whirled_peas/command/record'
 require 'whirled_peas/command/still'
+require 'whirled_peas/command/themes'
 
 module WhirledPeas
   class CommandLine
@@ -15,7 +16,8 @@ module WhirledPeas
       Command::Help,
       Command::Play,
       Command::Record,
-      Command::Still
+      Command::Still,
+      Command::Themes
     ].map.with_object({}) { |c, h| h[c.command_name] = c }
 
     def initialize(args)

data/lib/whirled_peas/graphics/composer.rb

@@ -2,6 +2,7 @@ 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 'whirled_peas/settings/theme_library'
 
 require_relative 'box_painter'
 require_relative 'graph_painter'
@@ -25,8 +26,10 @@ module WhirledPeas
         "Element-#{@counter}"
       end
 
-      def self.build
-        settings = Settings::BoxSettings.new
+      def self.build(theme_name=nil, &block)
+        theme_name ||= Settings::ThemeLibrary.default_name
+        theme = Settings::ThemeLibrary.get(theme_name)
+        settings = Settings::BoxSettings.new(theme)
         template = BoxPainter.new('TEMPLATE', settings)
         composer = Composer.new(template)
         value = yield composer, settings

data/lib/whirled_peas/settings/border.rb

@@ -51,8 +51,20 @@ module WhirledPeas
         end
       end
 
+      def self.inherit(parent)
+        border = new(parent.theme)
+        border.inherit(parent)
+        border
+      end
+
+      attr_reader :theme
+
       attr_writer :left, :top, :right, :bottom, :inner_horiz, :inner_vert
 
+      def initialize(theme)
+        @theme = theme
+      end
+
       def left?
         @left == true
       end
@@ -82,20 +94,29 @@ module WhirledPeas
       end
 
       def style
-        @style || Styles::DEFAULT
+        @_style || Styles::DEFAULT
       end
 
       def style=(val)
-        @style = Styles.validate!(val)
+        @_style = Styles.validate!(val)
       end
 
       def color=(val)
-        @color = TextColor.validate!(val)
+        @_color = TextColor.validate!(val)
       end
 
       def color
-        @color || TextColor::DEFAULT
+        @_color || theme.border_color
       end
+
+      def inherit(parent)
+        @_style = parent._style
+        @_color = parent._color
+      end
+
+      protected
+
+      attr_reader :_style, :_color
     end
   end
 end

data/lib/whirled_peas/settings/container_settings.rb

@@ -96,7 +96,7 @@ module WhirledPeas
       end
 
       def border
-        @_border ||= Border.new
+        @_border ||= Border.new(theme)
       end
 
       def flow=(flow)
@@ -212,7 +212,7 @@ module WhirledPeas
       def inherit(parent)
         super
         return unless parent.is_a?(ContainerSettings)
-        set_border(color: parent.border.color, style: parent.border.style)
+        @_border = Border.inherit(parent.border)
       end
 
       protected

data/lib/whirled_peas/settings/element_settings.rb

@@ -8,18 +8,22 @@ module WhirledPeas
   module Settings
     class ElementSettings
       def self.inherit(parent)
-        child = self.new
+        child = self.new(parent.theme)
         child.inherit(parent)
         child
       end
 
-      attr_accessor :width, :height
+      attr_accessor :theme, :width, :height
+
+      def initialize(theme)
+        @theme = theme
+      end
 
       def validate!
       end
 
       def bg_color
-        @_bg_color || BgColor::DEFAULT
+        @_bg_color || theme.bg_color
       end
 
       def bg_color=(color)
@@ -35,7 +39,7 @@ module WhirledPeas
       end
 
       def color
-        @_color || TextColor::DEFAULT
+        @_color || theme.color
       end
 
       def color=(color)