whirled_peas 0.5.0 → 0.9.0

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.rb

@@ -1,5 +1,19 @@
 module WhirledPeas
   module Graphics
+    class << self
+      attr_accessor :debug
+
+      def debugger(string_or_proc)
+        return unless @debug
+        @debugger ||= Logger.new(STDOUT, level: Logger::DEBUG)
+        if string_or_proc.is_a?(Proc)
+          string = string_or_proc.call
+        else
+          string = string_or_proc
+        end
+        @debugger.debug(string)
+      end
+    end
   end
   private_constant :Graphics
 end

data/lib/whirled_peas/graphics/box_painter.rb

@@ -4,13 +4,20 @@ require_relative 'container_dimensions'
 module WhirledPeas
   module Graphics
     class BoxPainter < ContainerPainter
-      def paint(canvas, &block)
+      def paint(canvas, left, top, &block)
         super
-        return unless canvas.writable?
-        if element.settings.horizontal_flow?
-          paint_horizontally(canvas, &block)
+        canvas_coords = coords(left, top)
+        content_canvas = canvas.child(
+          canvas_coords.content_left,
+          canvas_coords.content_top,
+          dimensions.content_width,
+          dimensions.content_height
+        )
+        return unless content_canvas.writable?
+        if settings.horizontal_flow?
+          paint_horizontally(content_canvas, canvas_coords, &block)
         else
-          paint_vertically(canvas, &block)
+          paint_vertically(content_canvas, canvas_coords, &block)
         end
       end
 
@@ -37,61 +44,55 @@ module WhirledPeas
         end
       end
 
+      def each_child(&block)
+        if settings.reverse_flow?
+          children.reverse.each(&block)
+        else
+          super
+        end
+      end
+
       private
 
-      def paint_horizontally(canvas, &block)
-        stroke_top = coords(canvas).content_top
-        stroke_left = coords(canvas).content_left
-        total_child_width = 0
-        each_child { |c| total_child_width += c.dimensions.outer_width }
-        if settings.align_center?
-          stroke_left += (dimensions.content_width - total_child_width) / 2
-        elsif settings.align_right?
-          stroke_left += dimensions.content_width - total_child_width
-        end
-        given_width = 0
+      def paint_horizontally(canvas, canvas_coords, &block)
+        stroke_left = canvas_coords.content_left
+        stroke_top = canvas_coords.content_top
+        children_width = 0
+        each_child { |c| children_width += c.dimensions.outer_width }
+        left_offset, spacing_offset = horiz_justify_offset(children_width)
+        stroke_left += left_offset
         each_child do |child|
-          child_width = [
-            child.dimensions.outer_width,
-            dimensions.content_width - given_width
-          ].min
+          top_offset, _ = vert_justify_offset(child.dimensions.outer_height)
+          child_width = child.dimensions.outer_width
           child_canvas = canvas.child(
-            stroke_left + given_width,
-            stroke_top,
+            stroke_left,
+            stroke_top + top_offset,
             child_width,
-            [dimensions.content_height, child.dimensions.outer_height].min
+            child.dimensions.outer_height
           )
-          child.paint(child_canvas, &block)
-          given_width += child_width
-          break if given_width == dimensions.content_width
+          child.paint(child_canvas, stroke_left, stroke_top + top_offset, &block)
+          stroke_left += child_width + spacing_offset
         end
       end
 
-      def paint_vertically(canvas, &block)
-        stroke_top = coords(canvas).content_top
-        stroke_left = coords(canvas).content_left
-        given_height = 0
+      def paint_vertically(canvas, canvas_coords, &block)
+        stroke_left = canvas_coords.content_left
+        stroke_top = canvas_coords.content_top
+        children_height = 0
+        each_child { |c| children_height += c.dimensions.outer_height }
+        top_offset, spacing_offset = vert_justify_offset(children_height)
+        stroke_top += top_offset
         each_child do |child|
-          if settings.align_center?
-            justify_offset = (dimensions.content_width - child.dimensions.outer_width) / 2
-          elsif settings.align_right?
-            justify_offset = dimensions.content_width - child.dimensions.outer_width
-          else
-            justify_offset = 0
-          end
-          child_height = [
-            child.dimensions.outer_height,
-            dimensions.content_height - given_height
-          ].min
+          left_offset, _ = horiz_justify_offset(child.dimensions.outer_width)
+          child_height = child.dimensions.outer_height
           child_canvas = canvas.child(
-            stroke_left + justify_offset,
-            stroke_top + given_height,
-            [dimensions.content_width, child.dimensions.outer_width].min,
+            stroke_left + left_offset,
+            stroke_top ,
+            child.dimensions.outer_width,
             child_height
           )
-          child.paint(child_canvas, &block)
-          given_height += child_height
-          break if given_height == dimensions.content_height
+          child.paint(child_canvas, stroke_left + left_offset, stroke_top, &block)
+          stroke_top += child_height + spacing_offset
         end
       end
     end

data/lib/whirled_peas/graphics/canvas.rb

@@ -4,28 +4,29 @@ module WhirledPeas
   module Graphics
     # Canvas represent the area of the screen a painter can paint on.
     class Canvas
-      attr_reader :left, :top, :width, :height, :start_left, :start_top
+      attr_reader :left, :top, :width, :height
 
       def self.unwritable
-        new(-1, -1, 0, 0, -1, -1)
+        new(-1, -1, 0, 0)
       end
 
-      def initialize(left, top, width, height, start_left, start_top)
+      def initialize(left, top, width, height)
         @left = left
         @top = top
         @width = width
         @height = height
-        @start_left = start_left
-        @start_top = start_top
       end
 
       def writable?
         width > 0 || height > 0
       end
 
-      def child(start_left, start_top, child_width, child_height)
-        child_left = start_left
-        child_top = start_top
+      def child(child_left, child_top, child_width, child_height)
+        Graphics.debugger(
+          proc do
+            "Create child: #{self.inspect}.child(left=#{child_left}, top=#{child_top}, width=#{child_width}, height=#{child_height})"
+          end
+        )
         if child_left >= left + width
           self.class.unwritable
         elsif child_left + child_width <= left
@@ -45,20 +46,25 @@ module WhirledPeas
             child_top = top
           end
           child_height = [height - (child_top - top), child_height].min
-          self.class.new(
+          child_canvas = self.class.new(
             child_left,
             child_top,
             child_width,
             child_height,
-            start_left,
-            start_top
           )
+          Graphics.debugger(proc { "  -> #{child_canvas.inspect}" })
+          child_canvas
         end
       end
 
       # Yields a single line of formatted characters positioned on the canvas,
       # verifying only characters within the canvas are included.
       def stroke(stroke_left, stroke_top, raw, formatting=[], &block)
+        Graphics.debugger(
+          proc do
+            "Stroke: #{self.inspect}.stroke(left=#{stroke_left}, top=#{stroke_top}, length=#{raw.length})"
+          end
+        )
         if stroke_left >= left + width
           # The stroke starts to the right of the canvas
           fstring = Utils::FormattedString.blank
@@ -88,6 +94,11 @@ module WhirledPeas
           end_index = start_index + visible_length - 1
           fstring = Utils::FormattedString.new(raw[start_index..end_index], formatting)
         end
+        Graphics.debugger(
+          proc do
+            "  -> Stroke(left=#{stroke_left}, top=#{stroke_top}, length=#{fstring.length})"
+          end
+        )
         yield stroke_left, stroke_top, fstring
       end
 

data/lib/whirled_peas/graphics/composer.rb

@@ -0,0 +1,98 @@
+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_relative 'box_painter'
+require_relative 'graph_painter'
+require_relative 'grid_painter'
+require_relative 'text_painter'
+
+module WhirledPeas
+  module Graphics
+    class Composer
+      # List of classes that convert nicely to a string
+      STRINGALBE_CLASSES = [FalseClass, Float, Integer, NilClass, String, Symbol, TrueClass]
+      private_constant :STRINGALBE_CLASSES
+
+      def self.stringable?(value)
+        STRINGALBE_CLASSES.include?(value.class)
+      end
+
+      def self.next_name
+        @counter ||= 0
+        @counter += 1
+        "Element-#{@counter}"
+      end
+
+      def self.build
+        settings = Settings::BoxSettings.new
+        template = BoxPainter.new('TEMPLATE', settings)
+        composer = Composer.new(template)
+        value = yield composer, settings
+        if !template.children? && stringable?(value)
+          composer.add_text { value.to_s }
+        end
+        template
+      end
+
+      attr_reader :painter
+
+      def initialize(painter)
+        @painter = painter
+      end
+
+      def add_text(name=self.class.next_name, &block)
+        child_settings = Settings::TextSettings.inherit(painter.settings)
+        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
+        child.content = content.to_s
+        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 }
+        end
+      end
+
+      def add_grid(name=self.class.next_name, &block)
+        child_settings = Settings::GridSettings.inherit(painter.settings)
+        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|
+            composer.add_text("#{name}-Text-#{index}") { value.to_s }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/whirled_peas/graphics/container_coords.rb

@@ -1,18 +1,19 @@
 module WhirledPeas
   module Graphics
     class ContainerCoords
-      def initialize(canvas, dimensions, settings)
-        @canvas = canvas
+      def initialize(dimensions, settings, start_left, start_top)
         @dimensions = dimensions
         @settings = settings
+        @start_left = start_left
+        @start_top = start_top
       end
 
       def left
-        canvas.start_left + settings.position.left
+        start_left + settings.position.left
       end
 
       def top
-        canvas.start_top + settings.position.top
+        start_top + settings.position.top
       end
 
       def border_left
@@ -32,30 +33,40 @@ module WhirledPeas
       end
 
       def content_left(col_index=0)
-        padding_left + settings.padding.left + col_index * grid_width(true)
+        padding_left + settings.padding.left + col_index * grid_width
       end
 
       def content_top(row_index=0)
-        padding_top + settings.padding.top + row_index * grid_height(true)
+        padding_top + settings.padding.top + row_index * grid_height
       end
 
-      def grid_width(include_border)
-        (include_border && settings.border.inner_vert? ? 1 : 0) +
-          settings.padding.left +
+      def inner_grid_width
+        settings.padding.left +
           dimensions.content_width +
           settings.padding.right
       end
 
-      def grid_height(include_border)
-        (include_border && settings.border.inner_horiz? ? 1 : 0) +
-          settings.padding.top +
+      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
       end
 
+      def grid_height
+        (settings.border.inner_horiz? ? 1 : 0) +
+          inner_grid_height +
+          (settings.scrollbar.horiz? ? 1 : 0)
+      end
+
       private
 
-      attr_reader :canvas, :settings, :dimensions
+      attr_reader :settings, :dimensions, :start_left, :start_top
     end
   end
 end

data/lib/whirled_peas/graphics/container_dimensions.rb

@@ -1,34 +1,50 @@
 module WhirledPeas
   module Graphics
     class ContainerDimensions
-      attr_reader :content_width, :content_height, :num_cols, :num_rows
+      attr_reader :children_width, :children_height, :num_cols, :num_rows
 
       def initialize(settings, content_width, content_height, num_cols=1, num_rows=1)
-        @content_width = settings.width || content_width
-        @content_height = settings.height || content_height
+        @orig_content_width = content_width
+        @orig_content_height = content_height
+        @children_width = content_width
+        @children_height = content_height
         @num_cols = num_cols
         @num_rows = num_rows
         @settings = settings
       end
 
+      def content_width
+        return orig_content_width unless settings.width
+        if settings.border_sizing?
+          settings.width - outer_border_width - scrollbar_width - padding_width
+        else
+          settings.width
+        end
+      end
+
+      def content_height
+        return orig_content_height unless settings.height
+        if settings.border_sizing?
+          settings.height - outer_border_height - scrollbar_height - padding_height
+        else
+          settings.height
+        end
+      end
+
       def outer_width
         @outer_width ||= margin_width +
           outer_border_width +
-          num_cols * (padding_width + content_width) +
+          num_cols * (padding_width + content_width + scrollbar_width) +
           (num_cols - 1) * inner_border_width
       end
 
       def outer_height
         @outer_height ||= margin_height +
           outer_border_height +
-          num_rows * (padding_height + content_height) +
+          num_rows * (padding_height + content_height + scrollbar_height) +
           (num_rows - 1) * inner_border_height
       end
 
-      private
-
-      attr_reader :settings
-
       def margin_width
         settings.margin.left + settings.margin.right
       end
@@ -60,6 +76,18 @@ module WhirledPeas
       def padding_height
         settings.padding.top + settings.padding.bottom
       end
+
+      def scrollbar_width
+        settings.scrollbar.vert? ? 1 : 0
+      end
+
+      def scrollbar_height
+        settings.scrollbar.horiz? ? 1 : 0
+      end
+
+      private
+
+      attr_reader :settings, :orig_content_width, :orig_content_height
     end
   end
 end