whirled_peas 0.4.1 → 0.5.0

data/lib/whirled_peas/graphics/canvas.rb

@@ -0,0 +1,107 @@
+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, :start_left, :start_top
+
+      def self.unwritable
+        new(-1, -1, 0, 0, -1, -1)
+      end
+
+      def initialize(left, top, width, height, start_left, start_top)
+        @left = left
+        @top = top
+        @width = width
+        @height = height
+        @start_left = start_left
+        @start_top = start_top
+      end
+
+      def writable?
+        width > 0 || height > 0
+      end
+
+      def child(start_left, start_top, child_width, child_height)
+        child_left = start_left
+        child_top = start_top
+        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
+          self.class.new(
+            child_left,
+            child_top,
+            child_width,
+            child_height,
+            start_left,
+            start_top
+          )
+        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)
+        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
+        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/container_coords.rb

@@ -0,0 +1,61 @@
+module WhirledPeas
+  module Graphics
+    class ContainerCoords
+      def initialize(canvas, dimensions, settings)
+        @canvas = canvas
+        @dimensions = dimensions
+        @settings = settings
+      end
+
+      def left
+        canvas.start_left + settings.position.left
+      end
+
+      def top
+        canvas.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(true)
+      end
+
+      def content_top(row_index=0)
+        padding_top + settings.padding.top + row_index * grid_height(true)
+      end
+
+      def grid_width(include_border)
+        (include_border && settings.border.inner_vert? ? 1 : 0) +
+          settings.padding.left +
+          dimensions.content_width +
+          settings.padding.right
+      end
+
+      def grid_height(include_border)
+        (include_border && settings.border.inner_horiz? ? 1 : 0) +
+          settings.padding.top +
+          dimensions.content_height +
+          settings.padding.bottom
+      end
+
+      private
+
+      attr_reader :canvas, :settings, :dimensions
+    end
+  end
+end

data/lib/whirled_peas/graphics/container_dimensions.rb

@@ -0,0 +1,65 @@
+module WhirledPeas
+  module Graphics
+    class ContainerDimensions
+      attr_reader :content_width, :content_height, :num_cols, :num_rows
+
+      def initialize(settings, content_width, content_height, num_cols=1, num_rows=1)
+        @content_width = settings.width || content_width
+        @content_height = settings.height || content_height
+        @num_cols = num_cols
+        @num_rows = num_rows
+        @settings = settings
+      end
+
+      def outer_width
+        @outer_width ||= margin_width +
+          outer_border_width +
+          num_cols * (padding_width + content_width) +
+          (num_cols - 1) * inner_border_width
+      end
+
+      def outer_height
+        @outer_height ||= margin_height +
+          outer_border_height +
+          num_rows * (padding_height + content_height) +
+          (num_rows - 1) * inner_border_height
+      end
+
+      private
+
+      attr_reader :settings
+
+      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
+    end
+  end
+end

data/lib/whirled_peas/graphics/container_painter.rb

@@ -0,0 +1,116 @@
+require 'whirled_peas/utils/formatted_string'
+
+require_relative 'container_coords'
+require_relative 'painter'
+
+module WhirledPeas
+  module Graphics
+    class ContainerPainter < Painter
+      PADDING = ' '
+
+      def initialize(element, settings, name)
+        super
+        @children = []
+      end
+
+      def paint(canvas, &block)
+        return unless canvas.writable?
+        has_inner_vert = dimensions.num_cols > 1 && settings.border.inner_vert?
+        has_inner_horiz = dimensions.num_rows > 1 && settings.border.inner_horiz?
+        has_border = settings.border.outer? || has_inner_vert || has_inner_horiz
+        return unless settings.bg_color || has_border
+        stroke_left = coords(canvas).border_left
+        stroke_top = coords(canvas).border_top
+        formatting = [*settings.border.color, *settings.bg_color]
+        if settings.border.top?
+          canvas.stroke(stroke_left, stroke_top, top_border_stroke, formatting, &block)
+          stroke_top += 1
+        end
+        content_line = content_line_stroke
+        middle_border = dimensions.num_rows > 1 ? middle_border_stroke : ''
+        dimensions.num_rows.times do |row_num|
+          if row_num > 0 && settings.border.inner_horiz?
+            canvas.stroke(stroke_left, stroke_top, middle_border, formatting, &block)
+            stroke_top += 1
+          end
+          coords(canvas).grid_height(false).times do
+            canvas.stroke(stroke_left, stroke_top, content_line, formatting, &block)
+            stroke_top += 1
+          end
+        end
+        if settings.border.bottom?
+          canvas.stroke(stroke_left, stroke_top, bottom_border_stroke, formatting, &block)
+          stroke_top += 1
+        end
+      end
+
+      def add_child(child)
+        children << child
+      end
+
+      def num_children
+        children.length
+      end
+
+      def each_child(&block)
+        children.each(&block)
+      end
+
+      private
+
+      attr_reader :children
+
+      def coords(canvas)
+        ContainerCoords.new(canvas, dimensions, settings)
+      end
+
+      def line_stroke(left_border, horiz_border, junc_border, right_border)
+        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 += horiz_border * (dimensions.content_width + settings.padding.left + settings.padding.right)
+        end
+        stroke += right_border if settings.border.right?
+        stroke
+      end
+
+      def top_border_stroke
+        line_stroke(
+          settings.border.style.top_left,
+          settings.border.style.top_horiz,
+          settings.border.style.top_junc,
+          settings.border.style.top_right
+        )
+      end
+
+      def content_line_stroke
+        line_stroke(
+          settings.border.style.left_vert,
+          PADDING,
+          settings.border.style.middle_vert,
+          settings.border.style.right_vert
+        )
+      end
+
+      def middle_border_stroke
+        line_stroke(
+          settings.border.style.left_junc,
+          settings.border.style.middle_horiz,
+          settings.border.style.cross_junc,
+          settings.border.style.right_junc
+        )
+      end
+
+      def bottom_border_stroke
+        line_stroke(
+          settings.border.style.bottom_left,
+          settings.border.style.bottom_horiz,
+          settings.border.style.bottom_junc,
+          settings.border.style.bottom_right
+        )
+      end
+    end
+    private_constant :ContainerPainter
+  end
+end

data/lib/whirled_peas/graphics/debugger.rb

@@ -0,0 +1,43 @@
+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?(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,56 @@
+require_relative 'container_dimensions'
+require_relative 'container_painter'
+
+module WhirledPeas
+  module Graphics
+    class GridPainter < ContainerPainter
+      def paint(canvas, &block)
+        super
+        return unless canvas.writable?
+        each_child.with_index do |child, index|
+          col_index = index % dimensions.num_cols
+          row_index = index / dimensions.num_cols
+          content_left = coords(canvas).content_left(col_index)
+          if settings.align_center?
+            content_left += (dimensions.content_width - child.dimensions.outer_width) / 2
+          elsif settings.align_right?
+            content_left += dimensions.content_width - child.dimensions.outer_width
+          end
+          child_canvas = canvas.child(
+            content_left,
+            coords(canvas).content_top(row_index),
+            [dimensions.content_width, child.dimensions.outer_width].min,
+            [dimensions.content_height, child.dimensions.outer_height].min
+          )
+          child.paint(child_canvas, &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
+    end
+    private_constant :BoxPainter
+  end
+end