whirled_peas 0.8.0 → 0.11.1

data/lib/whirled_peas/graphics/content_dimensions.rb

@@ -0,0 +1,19 @@
+module WhirledPeas
+  module Graphics
+    class ContentDimensions
+      attr_reader :outer_width, :outer_height
+
+      def initialize(settings, content)
+        if settings.width
+          @outer_width = settings.width
+        else
+          @outer_width = 0
+          content.each do |line|
+            @outer_width = line.length if line.length > @outer_width
+          end
+        end
+        @outer_height = settings.height || content.length
+      end
+    end
+  end
+end

data/lib/whirled_peas/graphics/content_painter.rb

@@ -0,0 +1,20 @@
+require_relative 'painter'
+
+module WhirledPeas
+  module Graphics
+    class ContentPainter < Painter
+      attr_accessor :content
+
+      def dimensions
+        ContentDimensions.new(settings, content_lines)
+      end
+
+      private
+
+      def content_lines
+        raise NotImplementedError, "#{self.class} must implement #content_lines"
+      end
+    end
+    private_constant :ContentPainter
+  end
+end

data/lib/whirled_peas/graphics/debugger.rb

@@ -15,16 +15,11 @@ module WhirledPeas
           "#{indent}* #{painter.class}(#{painter.name})",
         ]
         info << "#{indent + '  '}- Dimensions(#{dimensions})"
+        info << "#{indent + '  '}- Theme=#{painter.settings.theme.inspect}" if indent == ''
         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/graph_dimensions.rb

@@ -0,0 +1,12 @@
+module WhirledPeas
+  module Graphics
+    class TextDimensions
+      attr_reader :outer_width, :outer_height
+
+      def initialize(settings, content)
+        @outer_width = settings.width
+        @outer_height = settings.height
+      end
+    end
+  end
+end

data/lib/whirled_peas/graphics/graph_painter.rb

@@ -0,0 +1,104 @@
+require 'whirled_peas/utils/ansi'
+
+require_relative 'content_painter'
+
+module WhirledPeas
+  module Graphics
+    class GraphPainter < ContentPainter
+      # The number of units along the Y-axis a single character can be divided into
+      Y_AXIS_SCALE = 2
+      private_constant :Y_AXIS_SCALE
+
+      def paint(canvas, left, top, &block)
+        axis_formatting = [*settings.axis_color, *settings.bg_color]
+        plot_formatting = [*settings.color, *settings.bg_color]
+        axes_lines.each.with_index do |axis_line, row_index|
+          canvas.stroke(left, top + row_index, axis_line, axis_formatting, &block)
+          next if row_index >= plot_lines.length
+          canvas.stroke(left + 1, top + row_index, plot_lines[row_index], plot_formatting, &block)
+        end
+      end
+
+      private
+
+      def content_lines
+        axes_lines
+      end
+
+      def plot_lines
+        return @plot_lines if @plot_lines
+        min_y = 1.0 / 0
+        max_y = -1.0 / 0
+        if settings.width
+          interpolated = (inner_width + 1).times.map do |i|
+            x = (i * (content.length - 1).to_f / (inner_width + 1)).floor
+            max_y = content[x] if content[x] > max_y
+            min_y = content[x] if content[x] < min_y
+            content[x]
+          end
+        else
+          interpolated = content
+          content.each do |y|
+            max_y = y if y > max_y
+            min_y = y if y < min_y
+          end
+        end
+        if min_y == max_y
+          min_y -= 1
+          max_y += 1
+        end
+        scaled = interpolated.map do |y|
+          inner_height * (y - min_y).to_f / (max_y - min_y)
+        end
+
+        @plot_lines = Array.new(inner_height) { '' }
+        scaled[0..-2].each.with_index do |y, x_index|
+          last = x_index == scaled.length - 2
+
+          prev_y = x_index == 0 ? y : scaled[x_index - 1]
+          next_y = scaled[x_index + 1]
+
+          min_y = [(prev_y + y) / 2, y, last ? next_y : (y + next_y) / 2].min
+          min_y = (Y_AXIS_SCALE * min_y).round.to_f / Y_AXIS_SCALE
+
+          max_y = [(prev_y + y) / 2, y, last ? next_y : (y + next_y) / 2].max
+          max_y = (Y_AXIS_SCALE * max_y).round.to_f / Y_AXIS_SCALE
+
+          @plot_lines.each.with_index do |row, row_index|
+            bottom_value = inner_height - row_index - 1
+            top_value = bottom_value + 1.0 / Y_AXIS_SCALE
+
+            top_half =  min_y == top_value || (min_y <= top_value && top_value < max_y)
+            bottom_half = min_y == bottom_value || (min_y <= bottom_value && bottom_value < max_y)
+
+            row << if top_half && bottom_half
+              '█'
+            elsif top_half
+              '▀'
+            elsif bottom_half
+              '▄'
+            else
+              ' '
+            end
+          end
+        end
+        @plot_lines
+      end
+
+      def inner_height
+        settings.height - 1
+      end
+
+      def inner_width
+        (settings.width.nil? ? content.length : settings.width) - 1
+      end
+
+      def axes_lines
+        return @axes_lines if @axes_lines
+        @axes_lines = inner_height.times.map { '┃' }
+        @axes_lines << '┗' + '━' * inner_width
+        @axes_lines
+      end
+    end
+  end
+end

data/lib/whirled_peas/graphics/grid_painter.rb

@@ -28,9 +28,6 @@ module WhirledPeas
 
       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

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/graphics/text_painter.rb

@@ -1,14 +1,12 @@
 require 'whirled_peas/utils/formatted_string'
 require 'whirled_peas/utils/title_font'
 
-require_relative 'painter'
-require_relative 'text_dimensions'
+require_relative 'content_dimensions'
+require_relative 'content_painter'
 
 module WhirledPeas
   module Graphics
-    class TextPainter < Painter
-      attr_reader :content
-
+    class TextPainter < ContentPainter
       def paint(canvas, left, top, &block)
         return unless canvas.writable?
         formatting = [*settings.color, *settings.bg_color]
@@ -16,17 +14,15 @@ module WhirledPeas
         if settings.underline? && settings.title_font.nil?
           formatting << Utils::Ansi::UNDERLINE
         end
-        content.each.with_index do |line, index|
+        content_lines.each.with_index do |line, index|
           canvas.stroke(left, top + index, line, formatting, &block)
         end
       end
 
-      def dimensions
-        TextDimensions.new(content)
-      end
+      private
 
-      def content=(content)
-        @content = if settings.title_font
+      def content_lines
+        @content_lines = if settings.title_font
           Utils::TitleFont.to_s(
             content, settings.title_font
           ).split("\n")

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

@@ -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
       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