whirled_peas 0.8.0 → 0.11.1

data/lib/whirled_peas/component/list_with_active.rb

@@ -0,0 +1,88 @@
+module WhirledPeas
+  module Component
+    class ListWithActive
+      attr_accessor :active_index, :separator
+
+      attr_reader :items
+
+      attr_writer :flow, :viewport_size
+
+      def items=(value)
+        @items = value.map(&:to_s)
+      end
+
+      def flow
+        @flow || :l2r
+      end
+
+      def total_size
+        @total_size ||= if flow == :l2r
+          size = separator.nil? ? 0 : (items.count - 1) * separator.length
+          items.each { |item| size += item.length }
+          size
+        else
+          items.count + (separator.nil? ? 0 : items.count - 1)
+        end
+      end
+
+      def viewport_size
+        @viewport_size || total_size
+      end
+
+      def compose(composer, settings)
+        %i[items active_index].each do |required_attr|
+          if send(required_attr).nil?
+            raise ArugmentError, "Require field #{required_attr} missing"
+          end
+        end
+
+        composer.add_box('ListWithActive') do |composer, settings|
+          settings.flow = flow
+          settings.align = :left
+          settings.full_border
+          if flow == :l2r
+            settings.width = viewport_size
+            active_start = separator.nil? ? 0 : active_index * separator.length
+            items.first(active_index).each do |item|
+              active_start += item.length
+            end
+            active_size = items[active_index].length
+          else
+            settings.height = viewport_size
+            active_start = active_index + (separator.nil? ? 0 : active_index)
+            active_size = 1
+          end
+
+          if viewport_size < total_size
+            front_padding = (viewport_size - active_size) * 0.667
+            offset = (active_start - front_padding).round
+            if offset < 0
+              offset = 0
+            elsif offset > total_size - viewport_size
+              offset = total_size - viewport_size
+            end
+
+            if flow == :l2r
+              settings.content_start.left = -offset
+              settings.scrollbar.horiz = true
+            else
+              settings.content_start.top = -offset
+              settings.scrollbar.vert = true
+            end
+          end
+
+          items.each.with_index do |item, index|
+            composer.add_text { separator } if !separator.nil? && index > 0
+            composer.add_text do |_, settings|
+              if index == active_index
+                settings.bg_color = :highlight
+                settings.color = :highlight
+              end
+              item
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,8 +1,11 @@
 require 'whirled_peas/settings/box_settings'
+require 'whirled_peas/settings/graph_settings'
 require 'whirled_peas/settings/grid_settings'
 require 'whirled_peas/settings/text_settings'
+require 'whirled_peas/settings/theme_library'
 
 require_relative 'box_painter'
+require_relative 'graph_painter'
 require_relative 'grid_painter'
 require_relative 'text_painter'
 
@@ -23,8 +26,10 @@ module WhirledPeas
         "Element-#{@counter}"
       end
 
-      def self.build
-        settings = Settings::BoxSettings.new
+      def self.build(theme_name=nil, &block)
+        theme_name ||= Settings::ThemeLibrary.default_name
+        theme = Settings::ThemeLibrary.get(theme_name)
+        settings = Settings::BoxSettings.new(theme)
         template = BoxPainter.new('TEMPLATE', settings)
         composer = Composer.new(template)
         value = yield composer, settings
@@ -45,6 +50,7 @@ module WhirledPeas
         child = TextPainter.new(name, child_settings)
         # TextPainters are not composable, so yield nil
         content = yield nil, child_settings
+        child_settings.validate!
         unless self.class.stringable?(content)
           raise ArgumentError, "Unsupported type for text: #{content.class}"
         end
@@ -52,11 +58,29 @@ module WhirledPeas
         painter.add_child(child)
       end
 
+      def add_graph(name=self.class.next_name, &block)
+        child_settings = Settings::GraphSettings.inherit(painter.settings)
+        child = GraphPainter.new(name, child_settings)
+        # GraphPainters are not composable, so yield nil
+        content = yield nil, child_settings
+        child_settings.validate!
+        unless content.is_a?(Array) && content.length > 0
+          raise ArgumentError, 'Graphs require a non-empty array as the content'
+        end
+        child.content = content
+        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)
         composer = self.class.new(child)
         value = yield composer, child.settings
+        child_settings.validate!
         painter.add_child(child)
         if !child.children? && self.class.stringable?(value)
           composer.add_text("#{name}-Text") { value.to_s }
@@ -68,6 +92,7 @@ module WhirledPeas
         child = GridPainter.new(name, child_settings)
         composer = self.class.new(child)
         values = yield composer, child.settings
+        child_settings.validate!
         painter.add_child(child)
         if !child.children? && values.is_a?(Array)
           values.each.with_index do |value, index|

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
@@ -33,35 +33,33 @@ module WhirledPeas
       end
 
       def content_left(col_index=0)
-        padding_left + settings.padding.left + col_index * grid_width
+        padding_left + settings.padding.left + col_index * dimensions.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
+      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 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
+      def content_top(row_index=0)
+        padding_top + settings.padding.top + row_index * dimensions.grid_height
       end
 
-      def grid_height
-        (settings.border.inner_horiz? ? 1 : 0) +
-          inner_grid_height +
-          (settings.scrollbar.horiz? ? 1 : 0)
+      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
 
       private

data/lib/whirled_peas/graphics/container_dimensions.rb

@@ -31,6 +31,30 @@ module WhirledPeas
         end
       end
 
+      def inner_grid_width
+        settings.padding.left +
+          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 +
+          content_height +
+          settings.padding.bottom
+      end
+
+      def grid_height
+        (settings.border.inner_horiz? ? 1 : 0) +
+          inner_grid_height +
+          (settings.scrollbar.horiz? ? 1 : 0)
+      end
+
       def outer_width
         @outer_width ||= margin_width +
           outer_border_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
@@ -34,11 +35,17 @@ module WhirledPeas
 
         # 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)
+          canvas.stroke(stroke_left, stroke_top, top_border_stroke, 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) : ''
+        middle_border = dimensions.num_rows > 1 ? middle_border_stroke : ''
+
+        vert_scrollbar = settings.scrollbar.vert? ? ScrollbarHelper.vert(
+          dimensions.children_height + dimensions.padding_height,
+          dimensions.inner_grid_height,
+          canvas_coords.content_top - canvas_coords.offset_content_top,
+        ) : []
 
         # Paint each grid row by row
         dimensions.num_rows.times do |row_num|
@@ -52,8 +59,9 @@ module WhirledPeas
 
           # 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)
+          dimensions.inner_grid_height.times do |row_within_cell|
+            content_line = content_line_stroke(row_within_cell, vert_scrollbar)
+            canvas.stroke(stroke_left, stroke_top, content_line, formatting, &block)
             stroke_top += 1
           end
 
@@ -66,7 +74,7 @@ module WhirledPeas
 
         # 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)
+          canvas.stroke(stroke_left, stroke_top, bottom_border_stroke, formatting, &block)
           stroke_top += 1
         end
       end
@@ -176,59 +184,49 @@ module WhirledPeas
       end
 
       # Return the stroke for the top border
-      def top_border_stroke(canvas_coords)
+      def top_border_stroke
         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))
+          settings.border.style.top_horiz * (dimensions.inner_grid_width + (settings.scrollbar.vert? ? 1 : 0))
         end
       end
 
       # Return the stroke for an inner horizontal border
-      def middle_border_stroke(canvas_coords)
+      def middle_border_stroke
         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))
+          settings.border.style.middle_horiz * (dimensions.inner_grid_width + (settings.scrollbar.vert? ? 1 : 0))
         end
       end
 
       # Return the stroke for the bottom border
-      def bottom_border_stroke(canvas_coords)
+      def bottom_border_stroke
         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))
+          settings.border.style.bottom_horiz * (dimensions.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)
+      def content_line_stroke(row_within_cell, vert_scrollbar)
         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
+            PADDING * dimensions.inner_grid_width + vert_scrollbar[row_within_cell]
           else
-            PADDING * canvas_coords.inner_grid_width
+            PADDING * dimensions.inner_grid_width
           end
         end
       end
@@ -240,121 +238,11 @@ module WhirledPeas
           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
+          ScrollbarHelper.horiz(
+            dimensions.children_width + dimensions.padding_width,
+            dimensions.inner_grid_width,
+            canvas_coords.content_left - canvas_coords.offset_content_left
+          ).join
         end
       end
     end