whirled_peas 0.3.0 → 0.7.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whirled_peas
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Tom Collier
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2021-01-21 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -38,10 +38,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: ruby_figlet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: 
 email:
 - tcollier@gmail.com
-executables: []
+executables:
+- whirled_peas
 extensions: []
 extra_rdoc_files: []
 files:
@@ -56,25 +71,208 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/intro.rb
+- examples/scrolling.rb
+- exe/whirled_peas
 - lib/whirled_peas.rb
+- lib/whirled_peas/command_line.rb
+- lib/whirled_peas/config.rb
+- lib/whirled_peas/errors.rb
 - lib/whirled_peas/frame.rb
+- lib/whirled_peas/frame/consumer.rb
+- lib/whirled_peas/frame/debug_consumer.rb
 - lib/whirled_peas/frame/event_loop.rb
 - lib/whirled_peas/frame/producer.rb
+- lib/whirled_peas/graphics.rb
+- lib/whirled_peas/graphics/box_painter.rb
+- lib/whirled_peas/graphics/canvas.rb
+- lib/whirled_peas/graphics/composer.rb
+- 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/debugger.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/screen.rb
+- lib/whirled_peas/graphics/text_dimensions.rb
+- lib/whirled_peas/graphics/text_painter.rb
 - lib/whirled_peas/null_logger.rb
-- lib/whirled_peas/ui.rb
-- lib/whirled_peas/ui/ansi.rb
-- lib/whirled_peas/ui/canvas.rb
-- lib/whirled_peas/ui/color.rb
-- lib/whirled_peas/ui/element.rb
-- lib/whirled_peas/ui/painter.rb
-- lib/whirled_peas/ui/screen.rb
-- lib/whirled_peas/ui/settings.rb
+- lib/whirled_peas/settings.rb
+- lib/whirled_peas/settings/alignment.rb
+- lib/whirled_peas/settings/bg_color.rb
+- lib/whirled_peas/settings/border.rb
+- lib/whirled_peas/settings/box_settings.rb
+- lib/whirled_peas/settings/color.rb
+- lib/whirled_peas/settings/container_settings.rb
+- lib/whirled_peas/settings/debugger.rb
+- lib/whirled_peas/settings/display_flow.rb
+- lib/whirled_peas/settings/element_settings.rb
+- lib/whirled_peas/settings/grid_settings.rb
+- lib/whirled_peas/settings/margin.rb
+- lib/whirled_peas/settings/padding.rb
+- lib/whirled_peas/settings/position.rb
+- lib/whirled_peas/settings/scrollbar.rb
+- lib/whirled_peas/settings/sizing.rb
+- lib/whirled_peas/settings/spacing.rb
+- lib/whirled_peas/settings/text_color.rb
+- lib/whirled_peas/settings/text_settings.rb
+- lib/whirled_peas/settings/vert_alignment.rb
+- lib/whirled_peas/utils.rb
+- lib/whirled_peas/utils/ansi.rb
+- lib/whirled_peas/utils/formatted_string.rb
+- lib/whirled_peas/utils/title_font.rb
 - lib/whirled_peas/version.rb
-- sandbox/auto.rb
-- sandbox/box.rb
-- sandbox/grid.rb
-- sandbox/sandbox.rb
-- sandbox/text.rb
+- screen_test/elements/box.frame
+- screen_test/elements/box.rb
+- screen_test/elements/grid.frame
+- screen_test/elements/grid.rb
+- screen_test/elements/screen_overflow_x.frame
+- screen_test/elements/screen_overflow_x.rb
+- screen_test/elements/screen_overflow_y.frame
+- screen_test/elements/screen_overflow_y.rb
+- screen_test/elements/text.frame
+- screen_test/elements/text.rb
+- screen_test/elements/text_multiline.frame
+- screen_test/elements/text_multiline.rb
+- screen_test/settings/align/box_around.frame
+- screen_test/settings/align/box_around.rb
+- screen_test/settings/align/box_between.frame
+- screen_test/settings/align/box_between.rb
+- screen_test/settings/align/box_center.frame
+- screen_test/settings/align/box_center.rb
+- screen_test/settings/align/box_default.frame
+- screen_test/settings/align/box_default.rb
+- screen_test/settings/align/box_evenly.frame
+- screen_test/settings/align/box_evenly.rb
+- screen_test/settings/align/box_left.frame
+- screen_test/settings/align/box_left.rb
+- screen_test/settings/align/box_right.frame
+- screen_test/settings/align/box_right.rb
+- screen_test/settings/align/children_center.frame
+- screen_test/settings/align/children_center.rb
+- screen_test/settings/align/children_left.frame
+- screen_test/settings/align/children_left.rb
+- screen_test/settings/align/children_right.frame
+- screen_test/settings/align/children_right.rb
+- screen_test/settings/align/grid_center.frame
+- screen_test/settings/align/grid_center.rb
+- screen_test/settings/align/grid_default.frame
+- screen_test/settings/align/grid_default.rb
+- screen_test/settings/align/grid_left.frame
+- screen_test/settings/align/grid_left.rb
+- screen_test/settings/align/grid_right.frame
+- screen_test/settings/align/grid_right.rb
+- screen_test/settings/ansi/bold.frame
+- screen_test/settings/ansi/bold.rb
+- screen_test/settings/ansi/color.frame
+- screen_test/settings/ansi/color.rb
+- screen_test/settings/ansi/underline.frame
+- screen_test/settings/ansi/underline.rb
+- screen_test/settings/border.frame
+- screen_test/settings/border.rb
+- screen_test/settings/flow/box_b2t.frame
+- screen_test/settings/flow/box_b2t.rb
+- screen_test/settings/flow/box_l2r.frame
+- screen_test/settings/flow/box_l2r.rb
+- screen_test/settings/flow/box_r2l.frame
+- screen_test/settings/flow/box_r2l.rb
+- screen_test/settings/flow/box_t2b.frame
+- screen_test/settings/flow/box_t2b.rb
+- screen_test/settings/flow/grid_b2t.frame
+- screen_test/settings/flow/grid_b2t.rb
+- screen_test/settings/flow/grid_l2r.frame
+- screen_test/settings/flow/grid_l2r.rb
+- screen_test/settings/flow/grid_r2l.frame
+- screen_test/settings/flow/grid_r2l.rb
+- screen_test/settings/flow/grid_t2b.frame
+- screen_test/settings/flow/grid_t2b.rb
+- screen_test/settings/height/box.frame
+- screen_test/settings/height/box.rb
+- screen_test/settings/height/box_border_sizing.frame
+- screen_test/settings/height/box_border_sizing.rb
+- screen_test/settings/height/grid.frame
+- screen_test/settings/height/grid.rb
+- screen_test/settings/height/overflow_box.frame
+- screen_test/settings/height/overflow_box.rb
+- screen_test/settings/height/overflow_box_l2r.frame
+- screen_test/settings/height/overflow_box_l2r.rb
+- screen_test/settings/height/overflow_box_t2b.frame
+- screen_test/settings/height/overflow_box_t2b.rb
+- screen_test/settings/height/overflow_grid.frame
+- screen_test/settings/height/overflow_grid.rb
+- screen_test/settings/margin.frame
+- screen_test/settings/margin.rb
+- screen_test/settings/padding.frame
+- screen_test/settings/padding.rb
+- screen_test/settings/position/box_left.frame
+- screen_test/settings/position/box_left.rb
+- screen_test/settings/position/box_left_negative.frame
+- screen_test/settings/position/box_left_negative.rb
+- screen_test/settings/position/box_top.frame
+- screen_test/settings/position/box_top.rb
+- screen_test/settings/position/box_top_negative.frame
+- screen_test/settings/position/box_top_negative.rb
+- screen_test/settings/position/grid_left.frame
+- screen_test/settings/position/grid_left.rb
+- screen_test/settings/position/grid_left_negative.frame
+- screen_test/settings/position/grid_left_negative.rb
+- screen_test/settings/position/grid_top.frame
+- screen_test/settings/position/grid_top.rb
+- screen_test/settings/position/grid_top_negative.frame
+- screen_test/settings/position/grid_top_negative.rb
+- screen_test/settings/scroll/horiz_box.frame
+- screen_test/settings/scroll/horiz_box.rb
+- screen_test/settings/scroll/horiz_box_align_center.rb
+- screen_test/settings/scroll/horiz_box_align_right.rb
+- screen_test/settings/scroll/vert_box.frame
+- screen_test/settings/scroll/vert_box.rb
+- screen_test/settings/title_font.frame
+- screen_test/settings/title_font.rb
+- screen_test/settings/valign/box_around.frame
+- screen_test/settings/valign/box_around.rb
+- screen_test/settings/valign/box_between.frame
+- screen_test/settings/valign/box_between.rb
+- screen_test/settings/valign/box_bottom.frame
+- screen_test/settings/valign/box_bottom.rb
+- screen_test/settings/valign/box_default.frame
+- screen_test/settings/valign/box_default.rb
+- screen_test/settings/valign/box_evenly.frame
+- screen_test/settings/valign/box_evenly.rb
+- screen_test/settings/valign/box_middle.frame
+- screen_test/settings/valign/box_middle.rb
+- screen_test/settings/valign/box_top.frame
+- screen_test/settings/valign/box_top.rb
+- screen_test/settings/valign/grid_bottom.frame
+- screen_test/settings/valign/grid_bottom.rb
+- screen_test/settings/valign/grid_default.frame
+- screen_test/settings/valign/grid_default.rb
+- screen_test/settings/valign/grid_middle.frame
+- screen_test/settings/valign/grid_middle.rb
+- screen_test/settings/valign/grid_top.frame
+- screen_test/settings/valign/grid_top.rb
+- screen_test/settings/width/box_border_sizing.frame
+- screen_test/settings/width/box_border_sizing.rb
+- screen_test/settings/width/box_content.frame
+- screen_test/settings/width/box_content.rb
+- screen_test/settings/width/box_default.frame
+- screen_test/settings/width/box_default.rb
+- screen_test/settings/width/grid.frame
+- screen_test/settings/width/grid.rb
+- screen_test/settings/width/overflow_align_center.frame
+- screen_test/settings/width/overflow_align_center.rb
+- screen_test/settings/width/overflow_align_right.frame
+- screen_test/settings/width/overflow_align_right.rb
+- screen_test/settings/width/overflow_box.frame
+- screen_test/settings/width/overflow_box.rb
+- screen_test/settings/width/overflow_box_l2r.frame
+- screen_test/settings/width/overflow_box_l2r.rb
+- screen_test/settings/width/overflow_box_t2b.frame
+- screen_test/settings/width/overflow_box_t2b.rb
+- screen_test/settings/width/overflow_grid.frame
+- screen_test/settings/width/overflow_grid.rb
+- tools/whirled_peas/tools/screen_tester.rb
 - whirled_peas.gemspec
 homepage: https://github.com/tcollier/whirled_peas
 licenses:

data/lib/whirled_peas/ui.rb

@@ -1,7 +0,0 @@
-require_relative 'ui/element'
-require_relative 'ui/screen'
-
-module WhirledPeas
-  module UI
-  end
-end

data/lib/whirled_peas/ui/ansi.rb

@@ -1,103 +0,0 @@
-module WhirledPeas
-  module UI
-    # Helper module for working with ANSI escape codes. The most useful ANSI escape codes
-    # relate to text formatting.
-    #
-    # @see https://en.wikipedia.org/wiki/ANSI_escape_code
-    module Ansi
-      ESC = "\033"
-
-      # Text formatting constants
-      BOLD = 1
-      UNDERLINE = 4
-
-      # Text and background color constants
-      BLACK = 30
-      RED = 31
-      GREEN = 32
-      YELLOW = 33
-      BLUE = 34
-      MAGENTA = 35
-      CYAN = 36
-      WHITE = 37
-
-      END_FORMATTING = 0
-      private_constant :END_FORMATTING
-
-      class << self
-        def cursor_pos(top: 0, left: 0)
-          "#{ESC}[#{top + 1};#{left + 1}H"
-        end
-
-        def cursor_visible(visible)
-          visible ? "#{ESC}[?25h" : "#{ESC}[?25l"
-        end
-
-        def clear_down
-          "#{ESC}[J"
-        end
-
-        # Format the string with the ANSI escapes codes for the given integer codes
-        #
-        # @param str [String] the string to format
-        # @param codes [Array<Integer>] the integer part of the ANSI escape code (see
-        #   constants in this module for codes and meanings)
-        def format(str, codes)
-          if str.empty? || codes.length == 0
-            str
-          else
-            start_formatting = codes.map(&method(:esc_seq)).join
-            "#{start_formatting}#{str}#{esc_seq(END_FORMATTING)}"
-          end
-        end
-
-        def clear
-          esc_seq(END_FORMATTING)
-        end
-
-        # If the string has unclosed formatting, add the end formatting characters to
-        # the end of the string
-        def close_formatting(str)
-          codes = str.scan(/#{ESC}\[(\d+)m/)
-          if codes.length > 0 && codes.last[0] != END_FORMATTING.to_s
-            "#{str}#{esc_seq(END_FORMATTING)}"
-          else
-            str
-          end
-        end
-
-        # Return a substring of the input string that preservse the formatting
-        #
-        # @param str [String] the (possibly formatted) string
-        # @param first_visible_character [Integer] the index of the first character to
-        #   include in the substring (ignoring all hidden formatting characters)
-        # @param num_visible_chars [Integer] the maximum number of visible characters to
-        #   include in the substring (ignoring all hidden formatting characters)
-        def substring(str, first_visible_character, num_visible_chars)
-          substr = ''
-          is_visible = true
-          visible_index = 0
-          substr_visible_len = 0
-          str.chars.each do |char|
-            in_substring = (visible_index >= first_visible_character)
-            is_visible = false if is_visible && char == ESC
-            visible_index += 1 if is_visible
-            if !is_visible || in_substring
-              substr += char
-              substr_visible_len += 1 if is_visible
-            end
-            is_visible = true if !is_visible && char == 'm'
-            break if substr_visible_len == num_visible_chars
-          end
-          close_formatting(substr)
-        end
-
-        private
-
-        def esc_seq(code)
-          "#{ESC}[#{code}m"
-        end
-      end
-    end
-  end
-end

data/lib/whirled_peas/ui/canvas.rb

@@ -1,68 +0,0 @@
-require_relative 'ansi'
-
-module WhirledPeas
-  module UI
-    # Canvas represent the area of the screen a painter can paint on.
-    class Canvas
-      # A Stroke is a single line, formatted string of characters that is painted at
-      # a given position on a Canvas. This class is not meant to be instantiated
-      # directly. Instead, use Canvas#stroke to create a new Stroke.
-      class Stroke
-        attr_reader :left, :top, :chars
-
-        def initialize(left, top, chars)
-          @left = left
-          @top = top
-          @chars = chars
-        end
-
-        def hash
-          [left, top, chars].hash
-        end
-
-        def ==(other)
-          other.is_a?(self.class) && self.hash == other.hash
-        end
-
-        def inspect
-          "Stroke(left=#{left}, top=#{top}, chars=#{chars})"
-        end
-
-        alias_method :eq?, :==
-      end
-      private_constant :Stroke
-
-      EMPTY_STROKE = Stroke.new(nil, nil, nil)
-
-      attr_reader :left, :top, :width, :height
-
-      def initialize(left, top, width, height)
-        @left = left
-        @top = top
-        @width = width
-        @height = height
-      end
-
-      # Return a new Stroke instance, verifying only characters within the canvas
-      # are included in the stroke.
-      def stroke(left, top, chars)
-        if left >= self.left + self.width || left + chars.length <= self.left
-          EMPTY_STROKE
-        elsif top < self.top || top >= self.top + self.height
-          EMPTY_STROKE
-        else
-          if left < self.left
-            chars = chars[self.left - left..-1]
-            left = self.left
-          end
-          num_chars = [self.left + self.width, left + chars.length].min - left
-          Stroke.new(left, top, Ansi.substring(chars, 0, num_chars))
-        end
-      end
-
-      def inspect
-        "Canvas(left=#{left}, top=#{top}, width=#{width}, height=#{height})"
-      end
-    end
-  end
-end

data/lib/whirled_peas/ui/color.rb

@@ -1,101 +0,0 @@
-require_relative 'ansi'
-
-module WhirledPeas
-  module UI
-    # An abstract class that encapsulates colors for a specific use case
-    class Color
-      # The ANSI codes for bright colors are offset by this much from their
-      # standard versions
-      BRIGHT_OFFSET = 60
-      private_constant :BRIGHT_OFFSET
-
-      # Validate the `color` argument is either (1) nil, (2) a valid Color constant in
-      # this class or (3) a symbol that maps to valid Color constant. E.g. if there
-      # is a RED constant in an implementing class, then :red or :bright_red are
-      # valid values for `color`
-      #
-      # @param color [Color|Symbol]
-      # @return [Color|Symbol] the value passed in if valid, otherwise an ArgumentError
-      #   is raised.
-      def self.validate!(color)
-        return unless color
-        if color.is_a?(Symbol)
-          error_message = "Unsupported #{self.name.split('::').last}: #{color.inspect}"
-          match = color.to_s.match(/^(bright_)?(\w+)$/)
-          begin
-            color = self.const_get(match[2].upcase)
-            raise ArgumentError, error_message unless color.is_a?(Color)
-            if match[1]
-              raise ArgumentError, error_message if color.bright?
-              color.bright
-            else
-              color
-            end
-          rescue NameError
-            raise ArgumentError, error_message
-          end
-        else
-          color
-        end
-      end
-
-      def initialize(code, bright=false)
-        @code = code
-        @bright = bright
-      end
-
-      def bright?
-        @bright
-      end
-
-      def bright
-        bright? ? self : self.class.new(@code + BRIGHT_OFFSET, true)
-      end
-
-      def hash
-        [@code, @bright].hash
-      end
-
-      def ==(other)
-        other.is_a?(self.class) && self.hash == other.hash
-      end
-      alias_method :eq?, :==
-
-      def to_s
-        @code.to_s
-      end
-
-      def inspect
-        "#{self.class.name.split('::').last}(code=#{@code}, bright=#{@bright})"
-      end
-    end
-    private_constant :Color
-
-    class BgColor < Color
-      BG_OFFSET = 10
-      private_constant :BG_OFFSET
-
-      BLACK = new(Ansi::BLACK + BG_OFFSET)
-      RED = new(Ansi::RED + BG_OFFSET)
-      GREEN = new(Ansi::GREEN + BG_OFFSET)
-      YELLOW = new(Ansi::YELLOW + BG_OFFSET)
-      BLUE = new(Ansi::BLUE + BG_OFFSET)
-      MAGENTA = new(Ansi::MAGENTA + BG_OFFSET)
-      CYAN = new(Ansi::CYAN + BG_OFFSET)
-      WHITE = new(Ansi::WHITE + BG_OFFSET)
-      GRAY = BLACK.bright
-    end
-
-    class TextColor < Color
-      BLACK = new(Ansi::BLACK)
-      RED = new(Ansi::RED)
-      GREEN = new(Ansi::GREEN)
-      YELLOW = new(Ansi::YELLOW)
-      BLUE = new(Ansi::BLUE)
-      MAGENTA = new(Ansi::MAGENTA)
-      CYAN = new(Ansi::CYAN)
-      WHITE = new(Ansi::WHITE)
-      GRAY = BLACK.bright
-    end
-  end
-end