whirled_peas 0.1.1 → 0.5.0

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,24 @@
+module WhirledPeas
+  module Graphics
+    class Painter
+      attr_reader :name, :settings
+
+      def initialize(element, settings, name)
+        @element = element
+        @settings = settings
+        @name = name
+      end
+
+      def paint(canvas, &block)
+      end
+
+      def dimensions
+      end
+
+      private
+
+      attr_reader :element
+    end
+    private_constant :Painter
+  end
+end

data/lib/whirled_peas/graphics/renderer.rb

@@ -0,0 +1,49 @@
+require 'whirled_peas/template/box_element'
+require 'whirled_peas/template/container'
+require 'whirled_peas/template/grid_element'
+require 'whirled_peas/template/text_element'
+
+require_relative 'box_painter'
+require_relative 'canvas'
+require_relative 'grid_painter'
+require_relative 'text_painter'
+
+module WhirledPeas
+  module Graphics
+    class Renderer
+      PAINTERS = {
+        Template::BoxElement => BoxPainter,
+        Template::GridElement => GridPainter,
+        Template::TextElement => TextPainter
+      }
+      def initialize(template, width, height)
+        @template = template
+        @width = width
+        @height = height
+      end
+
+      def paint(&block)
+        painter.paint(Canvas.new(0, 0, width, height, 0, 0), &block)
+      end
+
+      def painter
+        build(template)
+      end
+
+      private
+
+      attr_reader :template, :width, :height
+
+      def build(element)
+        unless PAINTERS.key?(element.class)
+          raise ArgumentError, "Unable to render #{element.class}"
+        end
+        painter = PAINTERS[element.class].new(element, element.settings, element.name)
+        if element.is_a?(Template::Container)
+          element.each_child { |child| painter.add_child(build(child)) }
+        end
+        painter
+      end
+    end
+  end
+end

data/lib/whirled_peas/graphics/screen.rb

@@ -0,0 +1,65 @@
+require 'highline'
+
+require 'whirled_peas/utils/ansi'
+
+require_relative 'renderer'
+
+module WhirledPeas
+  module Graphics
+    class Screen
+      def self.current_dimensions
+        width, height = HighLine.new.terminal.terminal_size
+        [width || 0, height || 0]
+      end
+
+      def initialize(output=STDOUT)
+        @output = output
+        @terminal = HighLine.new.terminal
+        @strokes = []
+        refresh_size!
+        Signal.trap('SIGWINCH', proc { self.refresh_size! })
+      end
+
+      def paint(template)
+        @template = template
+        draw
+      end
+
+      def refresh
+        # No need to refresh if the screen dimensions have not changed
+        return if @refreshed_width == width || @refreshed_height == height
+        draw
+      end
+
+      def finalize
+        output.print Utils::Ansi.clear
+        output.print Utils::Ansi.cursor_pos(top: height - 1)
+        output.print Utils::Ansi.cursor_visible(true)
+        output.flush
+      end
+
+      protected
+
+      def refresh_size!
+        @width, @height = self.class.current_dimensions
+      end
+
+      private
+
+      attr_reader :output, :cursor, :terminal, :width, :height
+
+      def draw
+        strokes = [Utils::Ansi.cursor_visible(false), Utils::Ansi.cursor_pos, Utils::Ansi.clear_down]
+        Renderer.new(@template, width, height).paint do |left, top, fstring|
+          next unless fstring.length > 0
+          strokes << Utils::Ansi.cursor_pos(left: left, top: top)
+          strokes << fstring
+        end
+        strokes.each { |stroke| output.print(stroke) }
+        output.flush
+        @refreshed_width = width
+        @refreshed_height = height
+      end
+    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,38 @@
+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
+      def paint(canvas, &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(canvas.start_left, canvas.start_top + index, line, formatting, &block)
+        end
+      end
+
+      def dimensions
+        TextDimensions.new(content)
+      end
+
+      def content
+        if settings.title_font
+          Utils::TitleFont.to_s(
+            element.content, settings.title_font
+          ).split("\n")
+        else
+          element.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/bg_color.rb

@@ -0,0 +1,22 @@
+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
+    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(
+          '╔', '═', '╦', '╗',
+          '║', '╠',
+          '║', '╬', '═',
+          '║', '╣',
+          '╚', '═', '╩', '╝'
+        )
+
+        def self.validate!(style)
+          return unless style
+          if style.is_a?(Symbol)
+            error_message = "Unsupported border style: #{style}"
+            begin
+              style = self.const_get(style.upcase)
+              raise ArgumentError, error_message unless style.is_a?(Style)
+              style
+            rescue NameError
+              raise ArgumentError, error_message
+            end
+          else
+            style
+          end
+        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::BOLD
+      end
+
+      def style=(val)
+        @style = Styles.validate!(val)
+      end
+
+      def color
+        @color || TextColor::WHITE
+      end
+
+      def color=(val)
+        @color = TextColor.validate!(val)
+      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,69 @@
+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 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 + 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

data/lib/whirled_peas/settings/container_settings.rb

@@ -0,0 +1,128 @@
+require_relative 'border'
+require_relative 'display_flow'
+require_relative 'element_settings'
+require_relative 'margin'
+require_relative 'padding'
+require_relative 'position'
+
+module WhirledPeas
+  module Settings
+    class ContainerSettings < ElementSettings
+      attr_accessor :width, :height
+
+      def align
+        @_align || TextAlign::LEFT
+      end
+
+      def align_left?
+        align == TextAlign::LEFT
+      end
+
+      def align_center?
+        align == TextAlign::CENTER
+      end
+
+      def align_right?
+        align == TextAlign::RIGHT
+      end
+
+      def align=(align)
+        @_align = TextAlign.validate!(align)
+      end
+
+      def set_border(
+        left: nil, top: nil, right: nil, bottom: nil, inner_horiz: nil, inner_vert: nil, style: nil, color: nil
+      )
+        @_border = Border.new unless @_border
+        @_border.left = left unless left.nil?
+        @_border.top = top unless top.nil?
+        @_border.right = right unless right.nil?
+        @_border.bottom = bottom unless bottom.nil?
+        @_border.inner_horiz = inner_horiz unless inner_horiz.nil?
+        @_border.inner_vert = inner_vert unless inner_vert.nil?
+        @_border.style = style unless style.nil?
+        @_border.color = color unless color.nil?
+      end
+
+      def full_border(style: nil, color: nil)
+        set_border(
+          left: true, top: true, right: true, bottom: true, inner_horiz: true, inner_vert: true, style: style, color: color
+        )
+      end
+
+      def border
+        @_border || Border.new
+      end
+
+      def flow=(flow)
+        @_flow = DisplayFlow.validate!(flow)
+      end
+
+      def flow
+        @_flow || DisplayFlow::LEFT_TO_RIGHT
+      end
+
+      def horizontal_flow?
+        %i[l2r r2l].include?(flow)
+      end
+
+      def vertical_flow?
+        !horizontal_flow?
+      end
+
+      def forward_flow?
+        %i[l2r t2b].include?(flow)
+      end
+
+      def reverse_flow?
+        !forward_flow?
+      end
+
+      def set_margin(left: nil, top: nil, right: nil, bottom: nil)
+        @_margin = Margin.new unless @_margin
+        @_margin.left = left if left
+        @_margin.top = top if top
+        @_margin.right = right if right
+        @_margin.bottom = bottom if bottom
+      end
+
+      def margin
+        @_margin || Margin.new
+      end
+
+      def set_padding(left: nil, top: nil, right: nil, bottom: nil)
+        @_padding = Padding.new unless @_padding
+        @_padding.left = left if left
+        @_padding.top = top if top
+        @_padding.right = right if right
+        @_padding.bottom = bottom if bottom
+      end
+
+      def padding
+        @_padding || Padding.new
+      end
+
+      def set_position(left: nil, top: nil)
+        @_position = Position.new unless @_position
+        @_position.left = left if left
+        @_position.top = top if top
+      end
+
+      def position
+        @_position || Position.new
+      end
+
+      def inherit(parent)
+        super
+        return unless parent.is_a?(ContainerSettings)
+        @_align = parent._align
+        @_flow = parent._flow
+        set_border(color: parent.border.color, style: parent.border.style)
+      end
+
+      protected
+
+      attr_accessor :_align, :_flow
+    end
+  end
+end