whirled_peas 0.4.1 → 0.8.0

data/lib/whirled_peas/graphics/canvas.rb

@@ -0,0 +1,118 @@
+require 'whirled_peas/utils/formatted_string'
+
+module WhirledPeas
+  module Graphics
+    # Canvas represent the area of the screen a painter can paint on.
+    class Canvas
+      attr_reader :left, :top, :width, :height
+
+      def self.unwritable
+        new(-1, -1, 0, 0)
+      end
+
+      def initialize(left, top, width, height)
+        @left = left
+        @top = top
+        @width = width
+        @height = height
+      end
+
+      def writable?
+        width > 0 || height > 0
+      end
+
+      def child(child_left, child_top, child_width, child_height)
+        Graphics.debugger(
+          proc do
+            "Create child: #{self.inspect}.child(left=#{child_left}, top=#{child_top}, width=#{child_width}, height=#{child_height})"
+          end
+        )
+        if child_left >= left + width
+          self.class.unwritable
+        elsif child_left + child_width <= left
+          self.class.unwritable
+        elsif child_top >= top + height
+          self.class.unwritable
+        elsif child_top + child_height <= top
+          self.class.unwritable
+        else
+          if child_left < left
+            child_width -= left - child_left
+            child_left = left
+          end
+          child_width = [width - (child_left - left), child_width].min
+          if child_top < top
+            child_height -= top - child_top
+            child_top = top
+          end
+          child_height = [height - (child_top - top), child_height].min
+          child_canvas = self.class.new(
+            child_left,
+            child_top,
+            child_width,
+            child_height,
+          )
+          Graphics.debugger(proc { "  -> #{child_canvas.inspect}" })
+          child_canvas
+        end
+      end
+
+      # Yields a single line of formatted characters positioned on the canvas,
+      # verifying only characters within the canvas are included.
+      def stroke(stroke_left, stroke_top, raw, formatting=[], &block)
+        Graphics.debugger(
+          proc do
+            "Stroke: #{self.inspect}.stroke(left=#{stroke_left}, top=#{stroke_top}, length=#{raw.length})"
+          end
+        )
+        if stroke_left >= left + width
+          # The stroke starts to the right of the canvas
+          fstring = Utils::FormattedString.blank
+        elsif stroke_left + raw.length <= left
+          # The stroke ends to the left of the canvas
+          fstring = Utils::FormattedString.blank
+        elsif stroke_top < top
+          # The stroke is above the canvas
+          fstring = Utils::FormattedString.blank
+        elsif stroke_top >= top + height
+          # The stroke is below the canvas
+          fstring = Utils::FormattedString.blank
+        else
+          # In this section, we know that at least part of the stroke should be visible
+          # on the canvas. Chop off parts of the raw string that aren't within the
+          # canvas boundary and ensure the stroke start position is also within the
+          # canvas boundary
+
+          # If the stroke starts to the left of the canvas, set the start index to the
+          # first value that will be on the canvas, then update stroke_left to be on
+          # the canvas
+          start_index = stroke_left < left ? left - stroke_left : 0
+          stroke_left = left if stroke_left <= left
+
+          # Determine how many characters from the stroke will fit on the canvas
+          visible_length = [raw.length, width - (stroke_left - left)].min
+          end_index = start_index + visible_length - 1
+          fstring = Utils::FormattedString.new(raw[start_index..end_index], formatting)
+        end
+        Graphics.debugger(
+          proc do
+            "  -> Stroke(left=#{stroke_left}, top=#{stroke_top}, length=#{fstring.length})"
+          end
+        )
+        yield stroke_left, stroke_top, fstring
+      end
+
+      def hash
+        [left, top, width, height].hash
+      end
+
+      def ==(other)
+        other.is_a?(self.class) && hash == other.hash
+      end
+
+      def inspect
+        "Canvas(left=#{left}, top=#{top}, width=#{width}, height=#{height})"
+      end
+    end
+  end
+end

data/lib/whirled_peas/graphics/composer.rb

@@ -0,0 +1,80 @@
+require 'whirled_peas/settings/box_settings'
+require 'whirled_peas/settings/grid_settings'
+require 'whirled_peas/settings/text_settings'
+
+require_relative 'box_painter'
+require_relative 'grid_painter'
+require_relative 'text_painter'
+
+module WhirledPeas
+  module Graphics
+    class Composer
+      # List of classes that convert nicely to a string
+      STRINGALBE_CLASSES = [FalseClass, Float, Integer, NilClass, String, Symbol, TrueClass]
+      private_constant :STRINGALBE_CLASSES
+
+      def self.stringable?(value)
+        STRINGALBE_CLASSES.include?(value.class)
+      end
+
+      def self.next_name
+        @counter ||= 0
+        @counter += 1
+        "Element-#{@counter}"
+      end
+
+      def self.build
+        settings = Settings::BoxSettings.new
+        template = BoxPainter.new('TEMPLATE', settings)
+        composer = Composer.new(template)
+        value = yield composer, settings
+        if !template.children? && stringable?(value)
+          composer.add_text { value.to_s }
+        end
+        template
+      end
+
+      attr_reader :painter
+
+      def initialize(painter)
+        @painter = painter
+      end
+
+      def add_text(name=self.class.next_name, &block)
+        child_settings = Settings::TextSettings.inherit(painter.settings)
+        child = TextPainter.new(name, child_settings)
+        # TextPainters are not composable, so yield nil
+        content = yield nil, child_settings
+        unless self.class.stringable?(content)
+          raise ArgumentError, "Unsupported type for text: #{content.class}"
+        end
+        child.content = content.to_s
+        painter.add_child(child)
+      end
+
+      def add_box(name=self.class.next_name, &block)
+        child_settings = Settings::BoxSettings.inherit(painter.settings)
+        child = BoxPainter.new(name, child_settings)
+        composer = self.class.new(child)
+        value = yield composer, child.settings
+        painter.add_child(child)
+        if !child.children? && self.class.stringable?(value)
+          composer.add_text("#{name}-Text") { value.to_s }
+        end
+      end
+
+      def add_grid(name=self.class.next_name, &block)
+        child_settings = Settings::GridSettings.inherit(painter.settings)
+        child = GridPainter.new(name, child_settings)
+        composer = self.class.new(child)
+        values = yield composer, child.settings
+        painter.add_child(child)
+        if !child.children? && values.is_a?(Array)
+          values.each.with_index do |value, index|
+            composer.add_text("#{name}-Text-#{index}") { value.to_s }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/whirled_peas/graphics/container_coords.rb

@@ -0,0 +1,72 @@
+module WhirledPeas
+  module Graphics
+    class ContainerCoords
+      def initialize(dimensions, settings, start_left, start_top)
+        @dimensions = dimensions
+        @settings = settings
+        @start_left = start_left
+        @start_top = start_top
+      end
+
+      def left
+        start_left + settings.position.left
+      end
+
+      def top
+        start_top + settings.position.top
+      end
+
+      def border_left
+        left + settings.margin.left
+      end
+
+      def border_top
+        top + settings.margin.top
+      end
+
+      def padding_left
+        border_left + (settings.border.left? ? 1 : 0)
+      end
+
+      def padding_top
+        border_top + (settings.border.top? ? 1 : 0)
+      end
+
+      def content_left(col_index=0)
+        padding_left + settings.padding.left + col_index * grid_width
+      end
+
+      def content_top(row_index=0)
+        padding_top + settings.padding.top + row_index * grid_height
+      end
+
+      def inner_grid_width
+        settings.padding.left +
+          dimensions.content_width +
+          settings.padding.right
+      end
+
+      def grid_width
+        (settings.border.inner_vert? ? 1 : 0) +
+          inner_grid_width +
+          (settings.scrollbar.vert? ? 1 : 0)
+      end
+
+      def inner_grid_height
+        settings.padding.top +
+          dimensions.content_height +
+          settings.padding.bottom
+      end
+
+      def grid_height
+        (settings.border.inner_horiz? ? 1 : 0) +
+          inner_grid_height +
+          (settings.scrollbar.horiz? ? 1 : 0)
+      end
+
+      private
+
+      attr_reader :settings, :dimensions, :start_left, :start_top
+    end
+  end
+end

data/lib/whirled_peas/graphics/container_dimensions.rb

@@ -0,0 +1,93 @@
+module WhirledPeas
+  module Graphics
+    class ContainerDimensions
+      attr_reader :children_width, :children_height, :num_cols, :num_rows
+
+      def initialize(settings, content_width, content_height, num_cols=1, num_rows=1)
+        @orig_content_width = content_width
+        @orig_content_height = content_height
+        @children_width = content_width
+        @children_height = content_height
+        @num_cols = num_cols
+        @num_rows = num_rows
+        @settings = settings
+      end
+
+      def content_width
+        return orig_content_width unless settings.width
+        if settings.border_sizing?
+          settings.width - outer_border_width - scrollbar_width - padding_width
+        else
+          settings.width
+        end
+      end
+
+      def content_height
+        return orig_content_height unless settings.height
+        if settings.border_sizing?
+          settings.height - outer_border_height - scrollbar_height - padding_height
+        else
+          settings.height
+        end
+      end
+
+      def outer_width
+        @outer_width ||= margin_width +
+          outer_border_width +
+          num_cols * (padding_width + content_width + scrollbar_width) +
+          (num_cols - 1) * inner_border_width
+      end
+
+      def outer_height
+        @outer_height ||= margin_height +
+          outer_border_height +
+          num_rows * (padding_height + content_height + scrollbar_height) +
+          (num_rows - 1) * inner_border_height
+      end
+
+      def margin_width
+        settings.margin.left + settings.margin.right
+      end
+
+      def margin_height
+        settings.margin.top + settings.margin.bottom
+      end
+
+      def outer_border_width
+        (settings.border.left? ? 1 : 0) + (settings.border.right? ? 1 : 0)
+      end
+
+      def outer_border_height
+        (settings.border.top? ? 1 : 0) + (settings.border.bottom? ? 1 : 0)
+      end
+
+      def inner_border_width
+        settings.border.inner_vert? ? 1 : 0
+      end
+
+      def inner_border_height
+        settings.border.inner_horiz? ? 1 : 0
+      end
+
+      def padding_width
+        settings.padding.left + settings.padding.right
+      end
+
+      def padding_height
+        settings.padding.top + settings.padding.bottom
+      end
+
+      def scrollbar_width
+        settings.scrollbar.vert? ? 1 : 0
+      end
+
+      def scrollbar_height
+        settings.scrollbar.horiz? ? 1 : 0
+      end
+
+      private
+
+      attr_reader :settings, :orig_content_width, :orig_content_height
+    end
+  end
+end

data/lib/whirled_peas/graphics/container_painter.rb

@@ -0,0 +1,363 @@
+require 'whirled_peas/utils/formatted_string'
+
+require_relative 'container_coords'
+require_relative 'painter'
+
+module WhirledPeas
+  module Graphics
+    # Abstract Painter for containers. Containers (as the name implies) contain other child
+    # elements and must delegate painting of the children to the children themselves.
+    class ContainerPainter < Painter
+      PADDING = ' '
+
+      def initialize(name, settings)
+        super
+        @children = []
+      end
+
+      # Paint the common attributes of containers (e.g. border and background color). Any
+      # class that inherits from this one should call `super` at the start of its #paint
+      # method, before painting its children.
+      def paint(canvas, left, top, &block)
+        return unless canvas.writable?
+        return unless needs_printing?
+        canvas_coords = coords(left, top)
+
+        # Paint the border, background color, and scrollbar starting from the top left
+        # border position, moving down row by row until we reach the bottom border
+        # position
+        stroke_left = canvas_coords.border_left
+        stroke_top = canvas_coords.border_top
+
+        # All strokes will have the same formatting options
+        formatting = [*settings.border.color, *settings.bg_color]
+
+        # Paint the top border if the settings call for it
+        if settings.border.top?
+          canvas.stroke(stroke_left, stroke_top, top_border_stroke(canvas_coords), formatting, &block)
+          stroke_top += 1
+        end
+        # Precalculate the middle border container grids with more than 1 row
+        middle_border = dimensions.num_rows > 1 ? middle_border_stroke(canvas_coords) : ''
+
+        # Paint each grid row by row
+        dimensions.num_rows.times do |row_num|
+          # In a grid with N rows, we will need to paint N - 1 inner horizontal borders.
+          # This code treats the inner horizontal border as the top of each row except for
+          # the first one.
+          if row_num > 0 && settings.border.inner_horiz?
+            canvas.stroke(stroke_left, stroke_top, middle_border, formatting, &block)
+            stroke_top += 1
+          end
+
+          # Paint the interior of each row (horizontal borders, veritical scroll bar and
+          # background color for the padding and content area)
+          canvas_coords.inner_grid_height.times do |row_within_cell|
+            canvas.stroke(stroke_left, stroke_top, content_line_stroke(canvas_coords, row_within_cell), formatting, &block)
+            stroke_top += 1
+          end
+
+          # Paint the horizontal scroll bar is the settings call for it
+          if settings.scrollbar.horiz?
+            canvas.stroke(stroke_left, stroke_top, bottom_scroll_stroke(canvas_coords), formatting, &block)
+            stroke_top += 1
+          end
+        end
+
+        # Paint the bottom border if the settings call for it
+        if settings.border.bottom?
+          canvas.stroke(stroke_left, stroke_top, bottom_border_stroke(canvas_coords), formatting, &block)
+          stroke_top += 1
+        end
+      end
+
+      # Tightly manage access to the children (rather than simply exposing the underlying
+      # array). This allows subclasses to easily modify behavior based on that element's
+      # specific settings.
+      def add_child(child)
+        children << child
+      end
+
+      def num_children
+        children.length
+      end
+
+      def children?
+        num_children > 0
+      end
+
+      def each_child(&block)
+        children.each(&block)
+      end
+
+      private
+
+      attr_reader :children
+
+      # Determine if there is anything to print for the container (this does not accont for
+      # children, just the border, scrollbar, and background color)
+      def needs_printing?
+        return true if settings.bg_color
+        return true if settings.border.outer?
+        return true if dimensions.num_cols > 1 && settings.border.inner_vert?
+        return true if dimensions.num_rows > 1 && settings.border.inner_horiz?
+        settings.scrollbar.horiz? || settings.scrollbar.vert?
+      end
+
+      # Return an object that allows easy access to important coordinates within the container,
+      # e.g. the left position where the left border is printed
+      def coords(left, top)
+        ContainerCoords.new(dimensions, settings, left, top)
+      end
+
+      # @return [Array<Integer>] a two-item array, the first being the amount of horizontal
+      #   spacing to paint *before the first* child and the second being the amount of spacing
+      #   to paint *between each* child
+      def horiz_justify_offset(containing_width)
+        if settings.align_center?
+          [(dimensions.content_width - containing_width) / 2, 0]
+        elsif settings.align_right?
+          [dimensions.content_width - containing_width, 0]
+        elsif settings.align_between?
+          return [0, 0] if num_children == 1
+          [0, (dimensions.content_width - containing_width) / (num_children - 1)]
+        elsif settings.align_around?
+          full_spacing = (dimensions.content_width - containing_width) / num_children
+          [full_spacing / 2, full_spacing]
+        elsif settings.align_evenly?
+          spacing = (dimensions.content_width - containing_width) / (num_children + 1)
+          [spacing, spacing]
+        else
+          [0, 0]
+        end
+      end
+
+      # @return [Array<Integer>] a two-item array, the first being the amount of vertical
+      #   spacing to paint *above the first* child and the second being the amount of spacing
+      #   to paint *between each* child
+      def vert_justify_offset(containing_height)
+        if settings.valign_middle?
+          [(dimensions.content_height - containing_height) / 2, 0]
+        elsif settings.valign_bottom?
+          [dimensions.content_height - containing_height, 0]
+        elsif settings.valign_between?
+          return [0, 0] if num_children == 1
+          [0, (dimensions.content_height - containing_height) / (num_children - 1)]
+        elsif settings.valign_around?
+          full_spacing = (dimensions.content_height - containing_height) / num_children
+          [full_spacing / 2, full_spacing]
+        elsif settings.valign_evenly?
+          spacing = (dimensions.content_height - containing_height) / (num_children + 1)
+          [spacing, spacing]
+        else
+          [0, 0]
+        end
+      end
+
+      # Return a stroke for one line of the container
+      #
+      # @param left_border [String] the character to print as the first character if there
+      #   is a left border
+      # @param junc_border [String] the character to print as the junction between two grid
+      #   columns if there is an inner vertical border
+      # @param right_border [String] the character to print as the last character if there
+      #   is a right border
+      # @block [String] the block should yield a string that represents the interior
+      #   (including padding) of a grid cell
+      def line_stroke(left_border, junc_border, right_border, &block)
+        stroke = ''
+        stroke += left_border if settings.border.left?
+        dimensions.num_cols.times do |col_num|
+          stroke += junc_border if col_num > 0 && settings.border.inner_vert?
+          stroke += yield
+        end
+        stroke += right_border if settings.border.right?
+        stroke
+      end
+
+      # Return the stroke for the top border
+      def top_border_stroke(canvas_coords)
+        line_stroke(
+          settings.border.style.top_left,
+          settings.border.style.top_junc,
+          settings.border.style.top_right
+        ) do
+          settings.border.style.top_horiz * (canvas_coords.inner_grid_width + (settings.scrollbar.vert? ? 1 : 0))
+        end
+      end
+
+      # Return the stroke for an inner horizontal border
+      def middle_border_stroke(canvas_coords)
+        line_stroke(
+          settings.border.style.left_junc,
+          settings.border.style.cross_junc,
+          settings.border.style.right_junc
+        ) do
+          settings.border.style.middle_horiz * (canvas_coords.inner_grid_width + (settings.scrollbar.vert? ? 1 : 0))
+        end
+      end
+
+      # Return the stroke for the bottom border
+      def bottom_border_stroke(canvas_coords)
+        line_stroke(
+          settings.border.style.bottom_left,
+          settings.border.style.bottom_junc,
+          settings.border.style.bottom_right
+        ) do
+          settings.border.style.bottom_horiz * (canvas_coords.inner_grid_width + (settings.scrollbar.vert? ? 1 : 0))
+        end
+      end
+
+      # Return the stroke for a grid row between any borders
+      def content_line_stroke(canvas_coords, row_within_cell)
+        line_stroke(
+          settings.border.style.left_vert,
+          settings.border.style.middle_vert,
+          settings.border.style.right_vert,
+        ) do
+          if settings.scrollbar.vert?
+            if dimensions.children_height <= canvas_coords.grid_height || children.first.settings.position.top > 0
+              scrollbar_char = GUTTER
+            else
+              scrollbar_char = vert_scroll_char(
+                dimensions.children_height + dimensions.padding_height,
+                canvas_coords.inner_grid_height,
+                -children.first.settings.position.top,
+                row_within_cell
+              )
+            end
+            PADDING * canvas_coords.inner_grid_width + scrollbar_char
+          else
+            PADDING * canvas_coords.inner_grid_width
+          end
+        end
+      end
+
+      # Return the stroke for the horizontal scroll bar
+      def bottom_scroll_stroke(canvas_coords)
+        line_stroke(
+          settings.border.style.left_vert,
+          settings.border.style.middle_vert,
+          settings.border.style.right_vert,
+        ) do
+          canvas_coords.inner_grid_width.times.map do |col_within_cell|
+            horiz_scroll_char(
+              dimensions.children_width + dimensions.padding_width,
+              canvas_coords.inner_grid_width,
+              -children.first.settings.position.left,
+              col_within_cell
+            )
+          end.join
+        end
+      end
+
+      # Contants to paint scrollbars
+      GUTTER = ' '
+      HORIZONTAL = %w[▗ ▄ ▖]
+      VERTICAL = %w[
+        ▗
+        ▐
+        ▝
+      ]
+
+      # Determine the character to paint the horizontal scroll bar with for the given column
+      #
+      # @see #scroll_char for more details
+      def horiz_scroll_char(col_count, viewable_col_count, first_visible_col, curr_col)
+        scroll_char(col_count, viewable_col_count, first_visible_col, curr_col, HORIZONTAL)
+      end
+
+      # Determine the character to paint the vertical scroll bar with for the given row
+      #
+      # @see #scroll_char for more details
+      def vert_scroll_char(row_count, viewable_row_count, first_visible_row, curr_row)
+        scroll_char(row_count, viewable_row_count, first_visible_row, curr_row, VERTICAL)
+      end
+
+      private
+
+      # Determine which character to paint a for a scrollbar
+      #
+      # @param total_count [Integer] total number of rows/columns in the content
+      # @param viewable_count [Integer] number of rows/columns visible in the viewport
+      # @param first_visible [Integer] zero-based index of the first row/column that is visible
+      #   in the viewport
+      # @param curr [Integer] zero-based index of the row/column (relative to the first visible
+      #   row/column) that the painted character is being requested for
+      # @param chars [Array<String>] an array with three 1-character strings, the frist is the
+      #   "second half" scrollbar character, the second is the "full" scrollbar character, and
+      #   the third is the "first half" scrollbar character.
+      def scroll_char(total_count, viewable_count, first_visible, curr, chars)
+        return GUTTER unless total_count > 0 && viewable_count > 0
+        # The scroll handle has the exact same relative size and position in the scroll gutter
+        # that the viewable content has in the total content area. For example, a content area
+        # that is 50 columns wide with a view port that is 20 columns wide might look like
+        #
+        #    +---------1-----****2*********3******---4---------+
+        #    |               *                   *             |
+        #    |   hidden      *     viewable      *   hidden    |
+        #    |               *                   *             |
+        #    +---------1-----****2*********3******---4---------+
+        #
+        # The scoll gutter, would look like
+        #
+        #                    |......********.....|
+        #
+        # Scrolling all the way to the right results in
+        #
+        #    +---------1---------2---------3*********4*********+
+        #    |                             *                   *
+        #    |            hidden           *     viewable      *
+        #    |                             *                   *
+        #    +---------1---------2---------3*********4*********+
+        #                                  |...........********|
+        #
+        # Returning to the first example, we can match up the arguments to this method to the
+        # diagram
+        #
+        #                       total_count = 50
+        #    |<----------------------------------------------->|
+        #    |                                                 |
+        #    |                veiwable_count = 20              |
+        #    |               |<----------------->|             |
+        #    ↓               ↓                   ↓             ↓
+        #    +---------1-----****2*********3******---4---------+
+        #    |               *                   *             |
+        #    |   hidden      *     viewable      *   hidden    |
+        #    |               *                   *             |
+        #    +---------1-----****2*********3******---4---------+
+        #                    |......****?***.....|
+        #                    ↑          ↑
+        #      first_visible = 16       |
+        #                             curr = 11
+
+        # The first task of determining how much of the handle is visible in a row/column is to
+        # calculate the range (as a precentage of the total) of viewable items
+        viewable_start = first_visible.to_f / total_count
+        viewable_end = (first_visible + viewable_count).to_f / total_count
+
+        # Always use the same length for the scroll bar so it does not give an inchworm effect
+        # as it scrolls along.
+        #
+        # Also, double the value now to get granularity for half width
+        # scrollbar characters.
+        scrollbar_length = ((2 * viewable_count ** 2).to_f / total_count).ceil
+        scrollbar_start = ((2 * first_visible * viewable_count).to_f / total_count).floor
+
+        first_half = (scrollbar_start...scrollbar_start + scrollbar_length).include?(2 * curr)
+        second_half = (scrollbar_start...scrollbar_start + scrollbar_length).include?(2 * curr + 1)
+
+        if first_half && second_half
+          chars[1]
+        elsif first_half
+          chars[2]
+        elsif second_half
+          chars[0]
+        else
+          GUTTER
+        end
+      end
+    end
+    private_constant :ContainerPainter
+  end
+end