whirled_peas 0.4.0 → 0.7.1

data/lib/whirled_peas/graphics/screen.rb

@@ -0,0 +1,70 @@
+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(width: nil, height: nil, output: STDOUT)
+        @output = output
+        @terminal = HighLine.new.terminal
+        @strokes = []
+        if width && height
+          @width = width
+          @height = height
+        else
+          refresh_size!
+          Signal.trap('SIGWINCH', proc { self.refresh_size! })
+        end
+      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,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

data/lib/whirled_peas/settings/container_settings.rb

@@ -0,0 +1,223 @@
+require_relative 'alignment'
+require_relative 'border'
+require_relative 'display_flow'
+require_relative 'element_settings'
+require_relative 'margin'
+require_relative 'padding'
+require_relative 'position'
+require_relative 'scrollbar'
+require_relative 'sizing'
+require_relative 'vert_alignment'
+
+module WhirledPeas
+  module Settings
+    class ContainerSettings < ElementSettings
+      attr_accessor :width, :height
+
+      def align
+        @_align || Alignment::DEFAULT
+      end
+
+      def align_left?
+        align == Alignment::LEFT
+      end
+
+      def align_center?
+        align == Alignment::CENTER
+      end
+
+      def align_right?
+        align == Alignment::RIGHT
+      end
+
+      def align_between?
+        align == Alignment::BETWEEN
+      end
+
+      def align_around?
+        align == Alignment::AROUND
+      end
+
+      def align_evenly?
+        align == Alignment::EVENLY
+      end
+
+      def align=(align)
+        @_align = Alignment.validate!(align)
+      end
+
+      def valign
+        @_valign || VertAlignment::DEFAULT
+      end
+
+      def valign_top?
+        valign == VertAlignment::TOP
+      end
+
+      def valign_middle?
+        valign == VertAlignment::MIDDLE
+      end
+
+      def valign_bottom?
+        valign == VertAlignment::BOTTOM
+      end
+
+      def valign_between?
+        valign == VertAlignment::BETWEEN
+      end
+
+      def valign_around?
+        valign == VertAlignment::AROUND
+      end
+
+      def valign_evenly?
+        valign == VertAlignment::EVENLY
+      end
+
+      def valign=(valign)
+        @_valign = VertAlignment.validate!(valign)
+      end
+
+      def set_border(
+        left: nil, top: nil, right: nil, bottom: nil, inner_horiz: nil, inner_vert: nil, style: nil, color: nil
+      )
+        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::DEFAULT
+      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, horiz: nil, vert: nil)
+        if horiz && (left || right)
+          raise ArgumentError, 'Cannot set horizontal margin when setting left/right'
+        elsif vert && (top || bottom)
+          raise ArgumentError, 'Cannot set vertical margin when setting top/bottom'
+        end
+
+        if horiz
+          margin.horiz = horiz
+        else
+          margin.left = left if left
+          margin.right = right if right
+        end
+
+        if vert
+          margin.vert = vert
+        else
+          margin.top = top if top
+          margin.bottom = bottom if bottom
+        end
+      end
+
+      def margin
+        @_margin ||= Margin.new
+      end
+
+      def set_padding(left: nil, top: nil, right: nil, bottom: nil, horiz: nil, vert: nil)
+        if horiz && (left || right)
+          raise ArgumentError, 'Cannot set horizontal padding when setting left/right'
+        elsif vert && (top || bottom)
+          raise ArgumentError, 'Cannot set vertical padding when setting top/bottom'
+        end
+
+        if horiz
+          padding.horiz = horiz
+        else
+          padding.left = left if left
+          padding.right = right if right
+        end
+
+        if vert
+          padding.vert = vert
+        else
+          padding.top = top if top
+          padding.bottom = bottom if bottom
+        end
+      end
+
+      def padding
+        @_padding ||= Padding.new
+      end
+
+      def set_position(left: nil, top: nil)
+        position.left = left if left
+        position.top = top if top
+      end
+
+      def position
+        @_position ||= Position.new
+      end
+
+      def set_scrollbar(horiz: nil, vert: nil)
+        scrollbar.horiz = horiz unless horiz.nil?
+        scrollbar.vert = vert unless vert.nil?
+      end
+
+      def scrollbar
+        @_scrollbar ||= Scrollbar.new
+      end
+
+      def sizing
+        @_sizing || Sizing::DEFAULT
+      end
+
+      def border_sizing?
+        @_sizing == Sizing::BORDER
+      end
+
+      def content_sizing?
+        @_sizing == Sizing::CONTENT
+      end
+
+      def sizing=(sizing)
+        @_sizing = Sizing.validate!(sizing)
+      end
+
+      def inherit(parent)
+        super
+        return unless parent.is_a?(ContainerSettings)
+        set_border(color: parent.border.color, style: parent.border.style)
+      end
+
+      protected
+    end
+  end
+end