whirled_peas 0.7.0 → 0.10.0

data/lib/whirled_peas/device/output_file.rb

@@ -0,0 +1,19 @@
+require 'whirled_peas/utils/file_handler'
+
+module WhirledPeas
+  module Device
+    class OutputFile
+      def initialize(file)
+        @file = file
+      end
+
+      def handle_renders(renders)
+        Utils::FileHandler.write(file, renders)
+      end
+
+      private
+
+      attr_reader :file
+    end
+  end
+end

data/lib/whirled_peas/device/screen.rb

@@ -0,0 +1,26 @@
+require 'highline'
+
+module WhirledPeas
+  module Device
+    class Screen
+      def initialize(refresh_rate, output: STDOUT)
+        @refresh_rate = refresh_rate
+        @output = output
+      end
+
+      def handle_renders(renders)
+        renders.each do |strokes|
+          frame_at = Time.now
+          output.print(strokes)
+          output.flush
+          next_frame_at = frame_at + 1.0 / refresh_rate
+          sleep([0, next_frame_at - Time.now].max)
+        end
+      end
+
+      private
+
+      attr_reader :refresh_rate, :output
+    end
+  end
+end

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,25 @@ 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_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 +88,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_painter.rb

@@ -5,6 +5,8 @@ require_relative 'painter'
 
 module WhirledPeas
   module Graphics
+    # Abstract Painter for containers. Containers (as the name implies) contain other child
+    # elements and must delegate painting of the children to the children themselves.
     class ContainerPainter < Painter
       PADDING = ' '
 
@@ -13,38 +15,65 @@ module WhirledPeas
         @children = []
       end
 
+      # Paint the common attributes of containers (e.g. border and background color). Any
+      # class that inherits from this one should call `super` at the start of its #paint
+      # method, before painting its children.
       def paint(canvas, left, top, &block)
         return unless canvas.writable?
         return unless needs_printing?
         canvas_coords = coords(left, top)
+
+        # Paint the border, background color, and scrollbar starting from the top left
+        # border position, moving down row by row until we reach the bottom border
+        # position
         stroke_left = canvas_coords.border_left
         stroke_top = canvas_coords.border_top
+
+        # All strokes will have the same formatting options
         formatting = [*settings.border.color, *settings.bg_color]
+
+        # 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)
           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) : ''
+
+        # Paint each grid row by row
         dimensions.num_rows.times do |row_num|
+          # In a grid with N rows, we will need to paint N - 1 inner horizontal borders.
+          # This code treats the inner horizontal border as the top of each row except for
+          # the first one.
           if row_num > 0 && settings.border.inner_horiz?
             canvas.stroke(stroke_left, stroke_top, middle_border, formatting, &block)
             stroke_top += 1
           end
+
+          # 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)
             stroke_top += 1
           end
+
+          # Paint the horizontal scroll bar is the settings call for it
           if settings.scrollbar.horiz?
             canvas.stroke(stroke_left, stroke_top, bottom_scroll_stroke(canvas_coords), formatting, &block)
             stroke_top += 1
           end
         end
+
+        # 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)
           stroke_top += 1
         end
       end
 
+      # Tightly manage access to the children (rather than simply exposing the underlying
+      # array). This allows subclasses to easily modify behavior based on that element's
+      # specific settings.
       def add_child(child)
         children << child
       end
@@ -65,6 +94,8 @@ module WhirledPeas
 
       attr_reader :children
 
+      # Determine if there is anything to print for the container (this does not accont for
+      # children, just the border, scrollbar, and background color)
       def needs_printing?
         return true if settings.bg_color
         return true if settings.border.outer?
@@ -73,10 +104,15 @@ module WhirledPeas
         settings.scrollbar.horiz? || settings.scrollbar.vert?
       end
 
+      # Return an object that allows easy access to important coordinates within the container,
+      # e.g. the left position where the left border is printed
       def coords(left, top)
         ContainerCoords.new(dimensions, settings, left, top)
       end
 
+      # @return [Array<Integer>] a two-item array, the first being the amount of horizontal
+      #   spacing to paint *before the first* child and the second being the amount of spacing
+      #   to paint *between each* child
       def horiz_justify_offset(containing_width)
         if settings.align_center?
           [(dimensions.content_width - containing_width) / 2, 0]
@@ -96,6 +132,9 @@ module WhirledPeas
         end
       end
 
+      # @return [Array<Integer>] a two-item array, the first being the amount of vertical
+      #   spacing to paint *above the first* child and the second being the amount of spacing
+      #   to paint *between each* child
       def vert_justify_offset(containing_height)
         if settings.valign_middle?
           [(dimensions.content_height - containing_height) / 2, 0]
@@ -115,6 +154,16 @@ module WhirledPeas
         end
       end
 
+      # Return a stroke for one line of the container
+      #
+      # @param left_border [String] the character to print as the first character if there
+      #   is a left border
+      # @param junc_border [String] the character to print as the junction between two grid
+      #   columns if there is an inner vertical border
+      # @param right_border [String] the character to print as the last character if there
+      #   is a right border
+      # @block [String] the block should yield a string that represents the interior
+      #   (including padding) of a grid cell
       def line_stroke(left_border, junc_border, right_border, &block)
         stroke = ''
         stroke += left_border if settings.border.left?
@@ -126,6 +175,7 @@ module WhirledPeas
         stroke
       end
 
+      # Return the stroke for the top border
       def top_border_stroke(canvas_coords)
         line_stroke(
           settings.border.style.top_left,
@@ -136,6 +186,7 @@ module WhirledPeas
         end
       end
 
+      # Return the stroke for an inner horizontal border
       def middle_border_stroke(canvas_coords)
         line_stroke(
           settings.border.style.left_junc,
@@ -146,6 +197,7 @@ module WhirledPeas
         end
       end
 
+      # Return the stroke for the bottom border
       def bottom_border_stroke(canvas_coords)
         line_stroke(
           settings.border.style.bottom_left,
@@ -156,6 +208,7 @@ module WhirledPeas
         end
       end
 
+      # Return the stroke for a grid row between any borders
       def content_line_stroke(canvas_coords, row_within_cell)
         line_stroke(
           settings.border.style.left_vert,
@@ -180,6 +233,7 @@ module WhirledPeas
         end
       end
 
+      # Return the stroke for the horizontal scroll bar
       def bottom_scroll_stroke(canvas_coords)
         line_stroke(
           settings.border.style.left_vert,
@@ -197,6 +251,7 @@ module WhirledPeas
         end
       end
 
+      # Contants to paint scrollbars
       GUTTER = ' '
       HORIZONTAL = %w[▗ ▄ ▖]
       VERTICAL = %w[
@@ -205,16 +260,33 @@ module WhirledPeas
         ▝
       ]
 
+      # 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
@@ -239,6 +311,25 @@ module WhirledPeas
         #    |                             *                   *
         #    +---------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

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/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,97 @@
+require 'whirled_peas/utils/ansi'
+
+require_relative 'content_painter'
+
+module WhirledPeas
+  module Graphics
+    class GraphPainter < ContentPainter
+      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.times.map do |i|
+            x = (i * (content.length - 1).to_f / inner_width).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
+        scaled = interpolated.map do |y|
+          (2 * inner_height * (y - min_y).to_f / (max_y - min_y)).floor
+        end
+        @plot_lines = Array.new(inner_height) { '' }
+        scaled.each.with_index do |y, x_index|
+          @plot_lines.each.with_index do |row, row_index|
+            bottom_half_index = 2 * (inner_height - row_index - 1)
+            top_half_index = bottom_half_index + 1
+
+            asc, next_y = if scaled.length == 1
+              [true, y]
+            elsif x_index == scaled.length - 1
+              y >= scaled[x_index - 1]
+              [true, y]
+            else
+              scaled[x_index + 1] >= y
+              [true, scaled[x_index + 1]]
+            end
+            if asc
+              top_half = y == top_half_index || (y...next_y).include?(top_half_index)
+              bottom_half = y == bottom_half_index || (y...next_y).include?(bottom_half_index)
+            else
+              top_half = y == top_half_index || (next_y...y).include?(top_half_index)
+              bottom_half = y == bottom_half_index || (next_y...y).include?(bottom_half_index)
+            end
+            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