whirled_peas 0.4.1 → 0.8.0

data/lib/whirled_peas/graphics/debugger.rb

@@ -0,0 +1,52 @@
+require 'whirled_peas/settings/debugger'
+
+require_relative 'container_painter'
+require_relative 'text_painter'
+
+module WhirledPeas
+  module Graphics
+    class Debugger
+      def initialize(painter)
+        @painter = painter
+      end
+
+      def debug(indent='')
+        info = [
+          "#{indent}* #{painter.class}(#{painter.name})",
+        ]
+        info << "#{indent + '  '}- Dimensions(#{dimensions})"
+        info << "#{indent + '  '}- Settings"
+        info << Settings::Debugger.new(painter.settings).debug(indent + '    ')
+        if painter.is_a?(TextPainter)
+          content = if painter.content.length > 1
+            '<multiline>'
+          elsif painter.content.first.length > 12
+            "#{painter.content.first[0..9]}...".inspect
+          else
+            painter.content.first.inspect
+          end
+          info << "#{indent + '  '}- Content(value=#{content})"
+        elsif painter.is_a?(ContainerPainter)
+          info << "#{indent + '  '}- Children"
+          info += painter.each_child.map { |c| Debugger.new(c).debug(indent + '    ') }
+        end
+        info.join("\n")
+      end
+
+      private
+
+      attr_reader :painter
+
+      def dimensions
+        outer = "#{painter.dimensions.outer_width}x#{painter.dimensions.outer_height}"
+        if painter.is_a?(ContainerPainter)
+          content = "#{painter.dimensions.content_width}x#{painter.dimensions.content_height}"
+          grid = "#{painter.dimensions.num_cols}x#{painter.dimensions.num_rows}"
+          "outer=#{outer}, content=#{content}, grid=#{grid}"
+        else
+          "outer=#{outer}"
+        end
+      end
+    end
+  end
+end

data/lib/whirled_peas/graphics/grid_painter.rb

@@ -0,0 +1,69 @@
+require_relative 'container_dimensions'
+require_relative 'container_painter'
+
+module WhirledPeas
+  module Graphics
+    class GridPainter < ContainerPainter
+      def paint(canvas, left, top, &block)
+        super
+        return unless canvas.writable?
+        each_child.with_index do |child, index|
+          col_index, row_index = grid_cell(index)
+          left_offset, _ = horiz_justify_offset(child.dimensions.outer_width)
+          top_offset, _ = vert_justify_offset(child.dimensions.outer_height)
+          child_canvas = canvas.child(
+            coords(left, top).content_left(col_index) + left_offset,
+            coords(left, top).content_top(row_index) + top_offset,
+            [dimensions.content_width, child.dimensions.outer_width].min,
+            [dimensions.content_height, child.dimensions.outer_height].min
+          )
+          child.paint(
+            child_canvas,
+            coords(left, top).content_left(col_index) + left_offset,
+            coords(left, top).content_top(row_index) + top_offset,
+            &block
+          )
+        end
+      end
+
+      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
+          each_child do |child|
+            if child.dimensions.outer_width > content_width
+              content_width = child.dimensions.outer_width
+            end
+          end
+          content_height = 0
+          each_child do |child|
+            if child.dimensions.outer_height > content_height
+              content_height = child.dimensions.outer_height
+            end
+          end
+          ContainerDimensions.new(
+            settings, content_width, content_height, num_cols, num_rows
+          )
+        end
+      end
+
+      private
+
+      def grid_cell(index)
+        if settings.horizontal_flow?
+          col_index, row_index = [index % dimensions.num_cols, index / dimensions.num_cols]
+          col_index = dimensions.num_cols - col_index - 1 if settings.reverse_flow?
+        else
+          col_index, row_index = [index / dimensions.num_rows, index % dimensions.num_rows]
+          row_index = dimensions.num_rows - row_index - 1 if settings.reverse_flow?
+        end
+        [col_index, row_index]
+      end
+    end
+    private_constant :BoxPainter
+  end
+end

data/lib/whirled_peas/graphics/mock_screen.rb

@@ -0,0 +1,26 @@
+require_relative 'renderer'
+
+module WhirledPeas
+  module Graphics
+    class MockScreen
+      def initialize(width:, height:)
+        @width = width
+        @height = height
+      end
+
+      def paint(template)
+        Renderer.new(template, width, height).paint { }
+      end
+
+      def refresh
+      end
+
+      def finalize
+      end
+
+      private
+
+      attr_reader :width, :height
+    end
+  end
+end

data/lib/whirled_peas/graphics/painter.rb

@@ -0,0 +1,33 @@
+module WhirledPeas
+  module Graphics
+    # Abstract base Painter class. Given a canvas and start coordinates (left, top), a painter
+    # is responsible for generating the "strokes" that display the element.
+    class Painter
+      attr_reader :name, :settings
+
+      def initialize(name, settings)
+        @settings = settings
+        @name = name
+      end
+
+      # Paint the element onto the canvas by yielding strokes to the block. A stroke is composed
+      # of a left, top, and chars. E.g.
+      #
+      #   yield 10, 3, 'Hello World!'
+      #
+      # paints the string "Hello World!" in the 10th column from the left, 3rd row down.
+      def paint(canvas, left, top, &block)
+      end
+
+      # Return a dimension object that provider the `outer_width` and `outer_height` of the
+      # element being painted.
+      def dimensions
+      end
+
+      def inspect
+        "#{self.class.name.split('::').last}(name=#{name.inspect})"
+      end
+    end
+    private_constant :Painter
+  end
+end

data/lib/whirled_peas/graphics/renderer.rb

@@ -0,0 +1,32 @@
+require_relative 'canvas'
+
+module WhirledPeas
+  module Graphics
+    class Renderer
+      def initialize(template, width, height)
+        @template = template
+        @width = width
+        @height = height
+      end
+
+      def paint
+        # Modify the template's settings so that it fills the entire screen
+        template.settings.width = width
+        template.settings.height = height
+        template.settings.sizing = :border
+        template.settings.set_margin(left: 0, top: 0, right: 0, bottom: 0)
+        strokes = [Utils::Ansi.cursor_visible(false), Utils::Ansi.cursor_pos, Utils::Ansi.clear_down]
+        template.paint(Canvas.new(0, 0, width, height), 0, 0) do |left, top, fstring|
+          next unless fstring.length > 0
+          strokes << Utils::Ansi.cursor_pos(left: left, top: top)
+          strokes << fstring
+        end
+        strokes.join
+      end
+
+      private
+
+      attr_reader :template, :width, :height
+    end
+  end
+end

data/lib/whirled_peas/graphics/text_dimensions.rb

@@ -0,0 +1,15 @@
+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

data/lib/whirled_peas/graphics/text_painter.rb

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

data/lib/whirled_peas/settings.rb

@@ -0,0 +1,5 @@
+module WhirledPeas
+  module Settings
+  end
+  private_constant :Settings
+end

data/lib/whirled_peas/settings/alignment.rb

@@ -0,0 +1,24 @@
+module WhirledPeas
+  module Settings
+    module Alignment
+      LEFT = :left
+      CENTER = :center
+      RIGHT = :right
+      BETWEEN = :between
+      AROUND = :around
+      EVENLY = :evenly
+
+      DEFAULT = LEFT
+
+      VALID = [LEFT, CENTER, RIGHT, BETWEEN, AROUND, EVENLY]
+      private_constant :VALID
+
+      def self.validate!(align)
+        return if align.nil?
+        return align if VALID.include?(align)
+        raise ArgumentError, "Unsupported alignment: #{align.inspect}"
+      end
+    end
+    private_constant :Alignment
+  end
+end

data/lib/whirled_peas/settings/bg_color.rb

@@ -0,0 +1,24 @@
+require 'whirled_peas/utils/ansi'
+
+require_relative 'color'
+
+module WhirledPeas
+  module Settings
+    class BgColor < Color
+      BG_OFFSET = 10
+      private_constant :BG_OFFSET
+
+      BLACK = new(Utils::Ansi::BLACK + BG_OFFSET)
+      RED = new(Utils::Ansi::RED + BG_OFFSET)
+      GREEN = new(Utils::Ansi::GREEN + BG_OFFSET)
+      YELLOW = new(Utils::Ansi::YELLOW + BG_OFFSET)
+      BLUE = new(Utils::Ansi::BLUE + BG_OFFSET)
+      MAGENTA = new(Utils::Ansi::MAGENTA + BG_OFFSET)
+      CYAN = new(Utils::Ansi::CYAN + BG_OFFSET)
+      WHITE = new(Utils::Ansi::WHITE + BG_OFFSET)
+      GRAY = BLACK.bright
+
+      DEFAULT = nil  # Use system defined default
+    end
+  end
+end

data/lib/whirled_peas/settings/border.rb

@@ -0,0 +1,101 @@
+require_relative 'text_color'
+
+module WhirledPeas
+  module Settings
+    class Border
+      Style = Struct.new(
+        :top_left, :top_horiz, :top_junc, :top_right,
+        :left_vert, :left_junc,
+        :middle_vert, :cross_junc, :middle_horiz,
+        :right_vert, :right_junc,
+        :bottom_left, :bottom_horiz, :bottom_junc, :bottom_right
+      )
+
+      module Styles
+        BOLD = Style.new(
+          '┏', '━', '┳', '┓',
+          '┃', '┣',
+          '┃', '╋', '━',
+          '┃', '┫',
+          '┗', '━', '┻', '┛'
+        )
+        SOFT = Style.new(
+          '╭', '─', '┬', '╮',
+          '│', '├',
+          '│', '┼', '─',
+          '│', '┤',
+          '╰', '─', '┴', '╯'
+        )
+        DOUBLE = Style.new(
+          '╔', '═', '╦', '╗',
+          '║', '╠',
+          '║', '╬', '═',
+          '║', '╣',
+          '╚', '═', '╩', '╝'
+        )
+
+        DEFAULT = BOLD
+
+        def self.validate!(style)
+          return if style.nil?
+          return style if style.is_a?(Border::Style)
+          if style.is_a?(Symbol)
+            style_class = self.const_get(style.upcase)
+            return style_class if style_class.is_a?(Border::Style)
+          end
+          error_message = "Unsupported border style: #{style.inspect}"
+          raise ArgumentError, error_message
+        rescue NameError
+          error_message = "Unsupported border style: #{style.inspect}"
+          raise ArgumentError, error_message
+        end
+      end
+
+      attr_writer :left, :top, :right, :bottom, :inner_horiz, :inner_vert
+
+      def left?
+        @left == true
+      end
+
+      def top?
+        @top == true
+      end
+
+      def right?
+        @right == true
+      end
+
+      def bottom?
+        @bottom == true
+      end
+
+      def inner_horiz?
+        @inner_horiz == true
+      end
+
+      def inner_vert?
+        @inner_vert == true
+      end
+
+      def outer?
+        left? || top? || right? || bottom?
+      end
+
+      def style
+        @style || Styles::DEFAULT
+      end
+
+      def style=(val)
+        @style = Styles.validate!(val)
+      end
+
+      def color=(val)
+        @color = TextColor.validate!(val)
+      end
+
+      def color
+        @color || TextColor::DEFAULT
+      end
+    end
+  end
+end

data/lib/whirled_peas/settings/box_settings.rb

@@ -0,0 +1,8 @@
+require_relative 'container_settings'
+
+module WhirledPeas
+  module Settings
+    class BoxSettings < ContainerSettings
+    end
+  end
+end

data/lib/whirled_peas/settings/color.rb

@@ -0,0 +1,68 @@
+require 'whirled_peas/utils/ansi'
+
+module WhirledPeas
+  module Settings
+    # An abstract class that encapsulates colors for a specific use case
+    class Color
+      # 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 if color.nil?
+        return color if color.is_a?(self)
+        if color.is_a?(Symbol)
+          match = color.to_s.match(/^(bright_)?(\w+)$/)
+          color_class = self.const_get(match[2].upcase)
+          if color_class.is_a?(self)
+            if !match[1]
+              return color_class
+            elsif !color_class.bright?
+              return color_class.bright
+            end
+          end
+        end
+        error_message = "Unsupported #{self.name.split('::').last}: #{color.inspect}"
+        raise ArgumentError, error_message
+      rescue NameError
+        error_message = "Unsupported #{self.name.split('::').last}: #{color.inspect}"
+        raise ArgumentError, error_message
+      end
+
+      def initialize(code, bright=false)
+        @code = code
+        @bright = bright
+      end
+
+      def bright?
+        @bright
+      end
+
+      def bright
+        bright? ? self : self.class.new(@code + Utils::Ansi::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
+  end
+end