whirled_peas 0.9.1 → 0.13.0

data/lib/whirled_peas/graphics/pixel_grid.rb

@@ -0,0 +1,81 @@
+module WhirledPeas
+  module Graphics
+    class PixelGrid
+      Pixel = Struct.new(:char, :formatting)
+
+      def initialize(width, height)
+        @pixels = Array.new(height) { Array.new(width) { Pixel.new } }
+      end
+
+      def add_stroke(left, top, fstring)
+        fstring.each_char.with_index do |char, offset|
+          pixels[top][left + offset].char = char
+          pixels[top][left + offset].formatting = fstring.formatting
+        end
+      end
+
+      def pixel_at(col, row)
+        pixels[row][col]
+      end
+
+      def diff(other)
+        str = ''
+        formatting = nil
+        chars = ''
+        pixels.each.with_index do |row, row_index|
+          row.each.with_index do |pixel, col_index|
+            if pixel == other.pixel_at(col_index, row_index)
+              if chars != ''
+                str += Utils::FormattedString.new(chars, formatting).to_s
+                chars = ''
+                formatting = nil
+              end
+            elsif chars == ''
+              str += Utils::Ansi.cursor_pos(left: col_index, top: row_index)
+              chars = pixel.char
+              formatting = pixel.formatting
+            elsif formatting != pixel.formatting
+              str += Utils::FormattedString.new(chars, formatting).to_s
+              chars = pixel.char
+              formatting = pixel.formatting
+            else
+              chars += pixel.char
+            end
+          end
+        end
+        if chars != ''
+          str += chars
+          chars = ''
+          formatting = nil
+        end
+        str
+      end
+
+      def to_s
+        str = Utils::Ansi.cursor_pos(left: 0, top: 0) + Utils::Ansi.clear_down
+        formatting = nil
+        chars = ''
+        pixels.each.with_index do |row, row_offset|
+          str += Utils::Ansi.cursor_pos(left: 0, top: row_offset) if row_offset > 0
+          row.each do |pixel|
+            if pixel.formatting != formatting
+              str += Utils::FormattedString.new(chars, formatting).to_s if chars != ''
+              chars = ''
+              formatting = pixel.formatting
+            end
+            chars << pixel.char
+          end
+          if chars != ''
+            str += Utils::FormattedString.new(chars, formatting).to_s
+            chars = ''
+          end
+        end
+        str
+      end
+
+      private
+
+      attr_reader :pixels
+    end
+  end
+end

data/lib/whirled_peas/graphics/renderer.rb

@@ -1,4 +1,5 @@
 require_relative 'canvas'
+require_relative 'pixel_grid'
 
 module WhirledPeas
   module Graphics
@@ -15,13 +16,11 @@ module WhirledPeas
         template.settings.height = height
         template.settings.sizing = :border
         template.settings.set_margin(left: 0, top: 0, right: 0, bottom: 0)
-        strokes = [Utils::Ansi.cursor_visible(false), Utils::Ansi.cursor_pos, Utils::Ansi.clear_down]
+        pixel_grid = PixelGrid.new(width, height)
         template.paint(Canvas.new(0, 0, width, height), 0, 0) do |left, top, fstring|
-          next unless fstring.length > 0
-          strokes << Utils::Ansi.cursor_pos(left: left, top: top)
-          strokes << fstring
+          pixel_grid.add_stroke(left, top, fstring)
         end
-        strokes.join
+        pixel_grid
       end
 
       private

data/lib/whirled_peas/graphics/scrollbar_helper.rb

@@ -0,0 +1,126 @@
+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
+        # Return the characters to paint the horizontal scroll bar with for the given column
+        #
+        # @see #scroll_chars for more details
+        def horiz(col_count, viewable_col_count, first_visible_col)
+          scroll_chars(col_count, viewable_col_count, first_visible_col, HORIZONTAL)
+        end
+
+        # Return the characters to paint the vertical scroll bar with for the given row
+        #
+        # @see #scroll_chars for more details
+        def vert(row_count, viewable_row_count, first_visible_row)
+          scroll_chars(row_count, viewable_row_count, first_visible_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 chars [Array<String>] an array with four 1-character strings, the frist is the
+        #   gutter (i.e. no scrolbar handle visible), then the "second half" scrollbar character,
+        #   then second is the "first half" scrollbar character, and finally the "full"
+        def scroll_chars(total_count, viewable_count, first_visible, chars)
+          # Start by initializing the scroll back to to all gutters
+          scrollbar = Array.new(viewable_count) { chars[0] }
+
+          return scrollbar if total_count == 0
+          return scrollbar if viewable_count == 0
+          return scrollbar 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.
+          length = (viewable_count ** 2).to_f / total_count
+
+          # Round the length to the nearst "scaled" value
+          length = (SCROLL_HANDLE_SCALE * length).round.to_f / SCROLL_HANDLE_SCALE
+
+          # Ensure we have a scrollbar!
+          length = 1.0 / SCROLL_HANDLE_SCALE if length == 0
+
+          # Find the "ideal" position of where the scrollbar should start.
+          start = first_visible * viewable_count.to_f / total_count
+
+          # Round the start to the nearest "scaled" value
+          start = (SCROLL_HANDLE_SCALE * start).round.to_f / SCROLL_HANDLE_SCALE
+
+          # Make sure we didn't scroll off the page!
+          start -= length if start == viewable_count
+
+          (start.floor..[(start + length).floor, viewable_count - 1].min).each do |curr_0|
+            curr_1 = curr_0 + 1.0 / SCROLL_HANDLE_SCALE
+
+            first_half = start <= curr_0 && curr_0 < start + length ? 2 : 0
+            second_half = start <= curr_1 && curr_1 < start + length ? 1 : 0
+
+            scrollbar[curr_0] = chars[second_half | first_half]
+          end
+          scrollbar
+        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/bg_color.rb

@@ -1,12 +1,12 @@
 require 'whirled_peas/utils/ansi'
 
 require_relative 'color'
+require_relative 'text_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)
@@ -19,6 +19,10 @@ module WhirledPeas
       GRAY = BLACK.bright
 
       DEFAULT = nil  # Use system defined default
+
+      def as_text_color
+        TextColor.new(code - BG_OFFSET, bright?)
+      end
     end
   end
 end

data/lib/whirled_peas/settings/border.rb

@@ -34,7 +34,7 @@ module WhirledPeas
           '╚', '═', '╩', '╝'
         )
 
-        DEFAULT = BOLD
+        DEFAULT = SOFT
 
         def self.validate!(style)
           return if style.nil?
@@ -51,8 +51,20 @@ module WhirledPeas
         end
       end
 
+      def self.inherit(parent)
+        border = new(parent.theme)
+        border.inherit(parent)
+        border
+      end
+
+      attr_reader :theme
+
       attr_writer :left, :top, :right, :bottom, :inner_horiz, :inner_vert
 
+      def initialize(theme)
+        @theme = theme
+      end
+
       def left?
         @left == true
       end
@@ -82,20 +94,29 @@ module WhirledPeas
       end
 
       def style
-        @style || Styles::DEFAULT
+        @_style || theme.border_style || Styles::DEFAULT
       end
 
       def style=(val)
-        @style = Styles.validate!(val)
+        @_style = Styles.validate!(val)
       end
 
       def color=(val)
-        @color = TextColor.validate!(val)
+        @_color = TextColor.validate!(val)
       end
 
       def color
-        @color || TextColor::DEFAULT
+        @_color || theme.border_color
       end
+
+      def inherit(parent)
+        @_style = parent._style
+        @_color = parent._color
+      end
+
+      protected
+
+      attr_reader :_style, :_color
     end
   end
 end

data/lib/whirled_peas/settings/color.rb

@@ -43,11 +43,11 @@ module WhirledPeas
       end
 
       def bright
-        bright? ? self : self.class.new(@code + Utils::Ansi::BRIGHT_OFFSET, true)
+        bright? ? self : self.class.new(code + Utils::Ansi::BRIGHT_OFFSET, true)
       end
 
       def hash
-        [@code, @bright].hash
+        [code, bright].hash
       end
 
       def ==(other)
@@ -56,12 +56,16 @@ module WhirledPeas
       alias_method :eq?, :==
 
       def to_s
-        @code.to_s
+        code.to_s
       end
 
       def inspect
-        "#{self.class.name.split('::').last}(code=#{@code}, bright=#{@bright})"
+        "#{self.class.name.split('::').last}(code=#{code}, bright=#{bright?})"
       end
+
+      private
+
+      attr_reader :code
     end
     private_constant :Color
   end

data/lib/whirled_peas/settings/container_settings.rb

@@ -96,7 +96,7 @@ module WhirledPeas
       end
 
       def border
-        @_border ||= Border.new
+        @_border ||= Border.new(theme)
       end
 
       def flow=(flow)
@@ -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)
@@ -212,7 +219,7 @@ module WhirledPeas
       def inherit(parent)
         super
         return unless parent.is_a?(ContainerSettings)
-        set_border(color: parent.border.color, style: parent.border.style)
+        @_border = Border.inherit(parent.border)
       end
 
       protected

data/lib/whirled_peas/settings/debugger.rb

@@ -34,6 +34,8 @@ module WhirledPeas
       def debug_value(value)
         return if value.nil?
         case value
+        when Theme
+          nil
         when Position
           position_value(value)
         when Margin
@@ -73,7 +75,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/element_settings.rb

@@ -8,22 +8,30 @@ module WhirledPeas
   module Settings
     class ElementSettings
       def self.inherit(parent)
-        child = self.new
+        child = self.new(parent.theme)
         child.inherit(parent)
         child
       end
 
-      attr_accessor :width, :height
+      attr_accessor :theme, :width, :height
+
+      def initialize(theme)
+        @theme = theme
+      end
 
       def validate!
       end
 
       def bg_color
-        @_bg_color || BgColor::DEFAULT
+        @_bg_color || theme.bg_color
       end
 
       def bg_color=(color)
-        @_bg_color = BgColor.validate!(color)
+        if color == :highlight
+          @_bg_color = theme.highlight_bg_color
+        else
+          @_bg_color = BgColor.validate!(color)
+        end
       end
 
       def bold?
@@ -35,11 +43,15 @@ module WhirledPeas
       end
 
       def color
-        @_color || TextColor::DEFAULT
+        @_color || theme.color
       end
 
       def color=(color)
-        @_color = TextColor.validate!(color)
+        if color == :highlight
+          @_color = theme.highlight_color
+        else
+          @_color = TextColor.validate!(color)
+        end
       end
 
       def underline?