whirled_peas 0.10.0 → 0.11.0

data/lib/whirled_peas/graphics/box_painter.rb

@@ -55,8 +55,8 @@ module WhirledPeas
       private
 
       def paint_horizontally(canvas, canvas_coords, &block)
-        stroke_left = canvas_coords.content_left
-        stroke_top = canvas_coords.content_top
+        stroke_left = canvas_coords.offset_content_left
+        stroke_top = canvas_coords.offset_content_top
         children_width = 0
         each_child { |c| children_width += c.dimensions.outer_width }
         left_offset, spacing_offset = horiz_justify_offset(children_width)
@@ -76,8 +76,8 @@ module WhirledPeas
       end
 
       def paint_vertically(canvas, canvas_coords, &block)
-        stroke_left = canvas_coords.content_left
-        stroke_top = canvas_coords.content_top
+        stroke_left = canvas_coords.offset_content_left
+        stroke_top = canvas_coords.offset_content_top
         children_height = 0
         each_child { |c| children_height += c.dimensions.outer_height }
         top_offset, spacing_offset = vert_justify_offset(children_height)

data/lib/whirled_peas/graphics/composer.rb

@@ -71,6 +71,10 @@ module WhirledPeas
         painter.add_child(child)
       end
 
+      def add_component(component)
+        component.compose(self, settings)
+      end
+
       def add_box(name=self.class.next_name, &block)
         child_settings = Settings::BoxSettings.inherit(painter.settings)
         child = BoxPainter.new(name, child_settings)

data/lib/whirled_peas/graphics/container_coords.rb

@@ -9,11 +9,11 @@ module WhirledPeas
       end
 
       def left
-        start_left + settings.position.left
+        start_left
       end
 
       def top
-        start_top + settings.position.top
+        start_top
       end
 
       def border_left
@@ -36,10 +36,32 @@ module WhirledPeas
         padding_left + settings.padding.left + col_index * grid_width
       end
 
+      def offset_content_left(col_index=0)
+        if settings.content_start.left
+          content_left(col_index) + settings.content_start.left
+        elsif settings.content_start.right
+          left_offset = dimensions.content_width - dimensions.children_width
+          content_left(col_index) + left_offset - settings.content_start.right
+        else
+          content_left(col_index)
+        end
+      end
+
       def content_top(row_index=0)
         padding_top + settings.padding.top + row_index * grid_height
       end
 
+      def offset_content_top(row_index=0)
+        if settings.content_start.top
+          content_top(row_index) + settings.content_start.top
+        elsif settings.content_start.bottom
+          top_offset = dimensions.content_height - dimensions.children_height
+          content_top(row_index) + top_offset - settings.content_start.bottom
+        else
+          content_top(row_index)
+        end
+      end
+
       def inner_grid_width
         settings.padding.left +
           dimensions.content_width +

data/lib/whirled_peas/graphics/container_painter.rb

@@ -2,6 +2,7 @@ require 'whirled_peas/utils/formatted_string'
 
 require_relative 'container_coords'
 require_relative 'painter'
+require_relative 'scrollbar_helper'
 
 module WhirledPeas
   module Graphics
@@ -216,16 +217,12 @@ module WhirledPeas
           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
+            scrollbar_char = ScrollbarHelper.vert_char(
+              dimensions.children_height + dimensions.padding_height,
+              canvas_coords.inner_grid_height,
+              canvas_coords.top - canvas_coords.offset_content_top,
+              row_within_cell
+            )
             PADDING * canvas_coords.inner_grid_width + scrollbar_char
           else
             PADDING * canvas_coords.inner_grid_width
@@ -241,122 +238,15 @@ module WhirledPeas
           settings.border.style.right_vert,
         ) do
           canvas_coords.inner_grid_width.times.map do |col_within_cell|
-            horiz_scroll_char(
+            ScrollbarHelper.horiz_char(
               dimensions.children_width + dimensions.padding_width,
               canvas_coords.inner_grid_width,
-              -children.first.settings.position.left,
+              canvas_coords.left - canvas_coords.offset_content_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

data/lib/whirled_peas/graphics/debugger.rb

@@ -18,13 +18,7 @@ module WhirledPeas
         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
+          content = painter.content
           info << "#{indent + '  '}- Content(value=#{content})"
         elsif painter.is_a?(ContainerPainter)
           info << "#{indent + '  '}- Children"

data/lib/whirled_peas/graphics/scrollbar_helper.rb

@@ -0,0 +1,124 @@
+module WhirledPeas
+  module Graphics
+    module ScrollbarHelper
+      # Contants to paint scrollbars
+      HORIZONTAL = [' ', '▗', '▖', '▄']
+      VERTICAL = [
+        ' ',
+        '▗',
+        '▝',
+        '▐'
+      ]
+
+      # The number of units of scrollbar a single character can be divided into
+      SCROLL_HANDLE_SCALE = 2
+      private_constant :SCROLL_HANDLE_SCALE
+
+      class << self
+        # Determine the character to paint the horizontal scroll bar with for the given column
+        #
+        # @see #scroll_char for more details
+        def horiz_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_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 chars[0] if total_count == 0
+          return chars[0] if viewable_count == 0
+          return chars[0] if viewable_count >= total_count
+
+          # 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
+
+          # Always use the same length for the scrollbar so it does not give an inchworm effect
+          # as it scrolls along. This will calculate the "ideal" length of the scroll bar if we
+          # could infinitely divide a character.
+          scrollbar_length = (viewable_count ** 2).to_f / total_count
+
+          # Round the length to the nearst "scaled" value
+          scrollbar_length = (SCROLL_HANDLE_SCALE * scrollbar_length).round.to_f / SCROLL_HANDLE_SCALE
+
+          # Ensure we have a scrollbar!
+          scrollbar_length = 1.0 / SCROLL_HANDLE_SCALE if scrollbar_length == 0
+
+          # Find the "ideal" position of where the scrollbar should start.
+          scrollbar_start = first_visible * viewable_count.to_f / total_count
+
+          # Round the start to the nearest "scaled" value
+          scrollbar_start = (SCROLL_HANDLE_SCALE * scrollbar_start).round.to_f / SCROLL_HANDLE_SCALE
+
+          # Make sure we didn't scroll off the page!
+          scrollbar_start -= scrollbar_length if scrollbar_start == viewable_count
+
+          # Create "scaled" indexes for the subdivided current character
+          curr_0 = curr
+          curr_1 = curr + 1.0 / SCROLL_HANDLE_SCALE
+
+          first_half = scrollbar_start <= curr_0 && curr_0 < scrollbar_start + scrollbar_length ? 2 : 0
+          second_half = scrollbar_start <= curr_1 && curr_1 < scrollbar_start + scrollbar_length ? 1 : 0
+
+          chars[second_half | first_half]
+        end
+      end
+    end
+  end
+end

data/lib/whirled_peas/null_logger.rb

@@ -15,6 +15,5 @@ module WhirledPeas
     def warn(*)
     end
   end
-
   private_constant :NullLogger
 end

data/lib/whirled_peas/settings/container_settings.rb

@@ -175,13 +175,20 @@ module WhirledPeas
         @_padding ||= Padding.new
       end
 
-      def set_position(left: nil, top: nil)
-        position.left = left if left
-        position.top = top if top
+      def set_content_start(left: nil, top: nil, right: nil, bottom: nil)
+        if left && right
+          raise ArgumentError, 'Setting left and right content_start is not supported'
+        elsif top && bottom
+          raise ArgumentError, 'Setting top and bottom content_start is not supported'
+        end
+        content_start.left = left if left
+        content_start.top = top if top
+        content_start.right = right if right
+        content_start.bottom = bottom if bottom
       end
 
-      def position
-        @_position ||= Position.new
+      def content_start
+        @_content_start ||= Position.new
       end
 
       def set_scrollbar(horiz: nil, vert: nil)

data/lib/whirled_peas/settings/debugger.rb

@@ -73,7 +73,7 @@ module WhirledPeas
       def border_value(border)
         values = non_defaults(
           border,
-          Border.new,
+          Border.new(settings.theme),
           %i[left? top? right? bottom? inner_horiz? inner_vert? style color]
         )
         return if values == ''

data/lib/whirled_peas/settings/position.rb

@@ -1,14 +1,26 @@
 module WhirledPeas
   module Settings
     class Position
-      attr_writer :left, :top
+      attr_reader :left, :top, :right, :bottom
 
-      def left
-        @left || 0
+      def left=(value)
+        @right = nil
+        @left = value
       end
 
-      def top
-        @top || 0
+      def top=(value)
+        @bottom = nil
+        @top = value
+      end
+
+      def right=(value)
+        @left = nil
+        @right = value
+      end
+
+      def bottom=(value)
+        @top = nil
+        @bottom = value
       end
     end
   end