whirled_peas 0.1.0 → 0.4.1

data/lib/whirled_peas/frame/print_consumer.rb

@@ -0,0 +1,33 @@
+require_relative '../null_logger'
+
+module WhirledPeas
+  module Frame
+    class PrintConsumer
+      LOGGER_ID = 'EVENT LOOP'
+
+      def initialize(logger=NullLogger.new)
+        @logger = logger
+      end
+
+      def enqueue(name, duration, args)
+        if name == Frame::EOF
+          puts "EOF frame detected"
+        else
+          displayed_for = duration ? "#{duration} second(s)" : '1 frame'
+          args_str = args.empty? ? '' : " (#{args.inspect})"
+          puts "Frame '#{name}' displayed for #{displayed_for}#{args_str}"
+        end
+      end
+
+      def start
+      end
+
+      def stop
+      end
+
+      private
+
+      attr_reader :logger
+    end
+  end
+end

data/lib/whirled_peas/frame/producer.rb

@@ -1,57 +1,61 @@
 require 'socket'
 require 'json'
 
+require_relative '../null_logger'
+
 module WhirledPeas
   module Frame
     class Producer
-      def self.start(logger: NullLogger.new, host:, port:, &block)
-        server = TCPServer.new(host, port)
-        client = server.accept
-        logger.info('PRODUCER') { "Connected to #{host}:#{port}" }
-        producer = new(client, logger)
+      LOGGER_ID = 'PRODUCER'
+
+      # Manages the EventLoop lifecycle and yields a Producer to send frames to the
+      # EventLoop
+      def self.produce(consumer, logger=NullLogger.new)
+        producer = new(consumer, logger)
+        consumer_thread = Thread.new do
+          Thread.current.report_on_exception = false
+          consumer.start
+        end
         yield producer
-        logger.info('PRODUCER') { "Exited normally" }
+        producer.send_frame(Frame::EOF)
+        producer.flush
       rescue => e
-        logger.warn('PRODUCER') { "Exited with error" }
-        logger.error('PRODUCER') { e.message }
-        logger.error('PRODUCER') { e.backtrace.join("\n") }
+        consumer.stop if consumer
+        logger.warn(LOGGER_ID) { 'Exited with error' }
+        logger.error(LOGGER_ID) { e }
+        raise
       ensure
-        client.close if client
+        consumer_thread.join if consumer_thread
       end
 
-      def initialize(client, logger=NullLogger.new)
-        @client = client
+      def initialize(consumer, logger=NullLogger.new)
+        @consumer = consumer
         @logger = logger
         @queue = Queue.new
       end
 
-      def send(name, duration: nil, args: {})
-        client.puts(JSON.generate('name' => name, 'duration' => duration, **args))
-        logger.debug('PRODUCER') { "Sending frame: #{name}" }
-      end
-
-      def enqueue(name, duration: nil, args: {})
+      # Buffer a frame to be played for the given duration. `#flush` must be called
+      # for frames to get pushed to the EventLoop.
+      #
+      # @param name [String] name of frame, which is passed to #build of the
+      #   TemplateFactory
+      # @param duration [Float|Integer] duration in seconds the frame should be,
+      #   displayed (default is nil, which results in a duration of a single refresh
+      #   cycle)
+      # @param args [Hash] key/value pair of arguments, which is passed to #build of
+      #   the TemplateFactory
+      def send_frame(name, duration: nil, args: {})
         queue.push([name, duration, args])
       end
 
+      # Send any buffered frames to the EventLoop
       def flush
-        while !queue.empty?
-          name, duration, args = queue.pop
-          send(name, duration: duration, args: args)
-        end
-      end
-
-      def stop
-        send(Frame::EOF)
-      end
-
-      def terminate
-        send(Frame::TERMINATE)
+        consumer.enqueue(*queue.pop) while !queue.empty?
       end
 
       private
 
-      attr_reader :client, :logger, :queue
+      attr_reader :consumer, :logger, :queue
     end
   end
 end

data/lib/whirled_peas/template.rb

@@ -0,0 +1,5 @@
+module WhirledPeas
+  module Template
+  end
+  private_constant :Template
+end

data/lib/whirled_peas/template/element.rb

@@ -0,0 +1,230 @@
+require_relative '../utils/title_font'
+
+require_relative 'settings'
+
+module WhirledPeas
+  module UI
+    STRINGALBE_CLASSES = [FalseClass, Float, Integer, NilClass, String, Symbol, TrueClass]
+
+    class Element
+      attr_accessor :preferred_width, :preferred_height
+      attr_reader :name, :settings
+
+      def initialize(name, settings)
+        @name = name
+        @settings = settings
+      end
+    end
+    private_constant :Element
+
+    class TextElement < Element
+      attr_reader :lines
+
+      def initialize(name, settings)
+        super(name, TextSettings.merge(settings))
+      end
+
+      def lines=(val)
+        unless STRINGALBE_CLASSES.include?(val.class)
+          raise ArgmentError, "Unsupported type for TextElement: #{val.class}"
+        end
+        if settings.title_font
+          @lines = Utils::TitleFont.to_s(val.to_s, settings.title_font).split("\n")
+        else
+          @lines = [val.to_s]
+        end
+        @preferred_width = settings.width || @lines.first.length
+        @preferred_height = @lines.length
+      end
+
+      def inspect(indent='')
+        dims = unless preferred_width.nil?
+          "#{indent + '  '}- Dimensions: #{preferred_width}x#{preferred_height}"
+        end
+        [
+          "#{indent}+ #{name} [#{self.class.name}]",
+          dims,
+          "#{indent + '  '}- Settings",
+          settings.inspect(indent + '    ')
+        ].compact.join("\n")
+      end
+    end
+
+    class ComposableElement < Element
+      class << self
+        def next_name
+          @counter ||= 0
+          @counter += 1
+          "Element-#{@counter}"
+        end
+      end
+
+      def initialize(name, settings)
+        super
+      end
+
+      def children
+        @children ||= []
+      end
+
+      def add_text(name=self.class.next_name, &block)
+        element = TextElement.new(name, settings)
+        element.lines = yield nil, element.settings
+        children << element
+      end
+
+      def add_box(name=self.class.next_name, &block)
+        element = BoxElement.new(name, settings)
+        value = yield element, element.settings
+        children << element
+        if element.children.empty? && STRINGALBE_CLASSES.include?(value.class)
+          element.add_text { value.to_s }
+        end
+      end
+
+      def add_grid(name=self.class.next_name, &block)
+        element = GridElement.new(name, settings)
+        values = yield element, element.settings
+        children << element
+        if element.children.empty? && values.is_a?(Array)
+          values.each { |v| element.add_text { v.to_s } }
+        end
+      end
+
+      def inspect(indent='')
+        kids = children.map { |c| c.inspect(indent + '    ') }.join("\n")
+        dims = unless preferred_width.nil?
+          "#{indent + '  '}- Dimensions: #{preferred_width}x#{preferred_height}"
+        end
+        [
+          "#{indent}+ #{name} [#{self.class.name}]",
+          dims,
+          "#{indent + '  '}- Settings",
+          settings.inspect(indent + '    '),
+          "#{indent + '  '}- Children",
+          kids
+        ].compact.join("\n")
+      end
+
+      private
+
+      def margin_width
+        settings.margin.left + settings.margin.right
+      end
+
+      def margin_height
+        settings.margin.top + settings.margin.bottom
+      end
+
+      def outer_border_width
+        (settings.border.left? ? 1 : 0) + (settings.border.right? ? 1 : 0)
+      end
+
+      def outer_border_height
+        (settings.border.top? ? 1 : 0) + (settings.border.bottom? ? 1 : 0)
+      end
+
+      def inner_border_width
+        settings.border.inner_vert? ? 1 : 0
+      end
+
+      def inner_border_height
+        settings.border.inner_horiz? ? 1 : 0
+      end
+
+      def padding_width
+        settings.padding.left + settings.padding.right
+      end
+
+      def padding_height
+        settings.padding.top + settings.padding.bottom
+      end
+    end
+
+    class Template < ComposableElement
+      def initialize(settings=TemplateSettings.new)
+        super('TEMPLATE', settings)
+      end
+    end
+
+    class BoxElement < ComposableElement
+      attr_writer :content_width, :content_height
+
+      def initialize(name, settings)
+        super(name, BoxSettings.merge(settings))
+      end
+
+      def self.from_template(template, width, height)
+        box = new(template.name, template.settings)
+        template.children.each { |c| box.children << c }
+        box.content_width = box.preferred_width = width
+        box.content_height = box.preferred_height = height
+        box
+      end
+
+      def content_width
+        @content_width ||= begin
+          child_widths = children.map(&:preferred_width)
+          width = settings.horizontal_flow? ? child_widths.sum : (child_widths.max || 0)
+          [width, *settings.width].max
+        end
+      end
+
+      def preferred_width
+        @preferred_width ||=
+          margin_width + outer_border_width + padding_width + content_width
+      end
+
+      def content_height
+        @content_height ||= begin
+          child_heights = children.map(&:preferred_height)
+          settings.vertical_flow? ? child_heights.sum : (child_heights.max || 0)
+        end
+      end
+
+      def preferred_height
+        @preferred_height ||=
+          margin_height + outer_border_height + padding_height + content_height
+      end
+    end
+
+    class GridElement < ComposableElement
+      def initialize(name, settings)
+        super(name, GridSettings.merge(settings))
+      end
+
+      def col_width
+        return @col_width if @col_width
+        @col_width = 0
+        children.each do |child|
+          @col_width = child.preferred_width if child.preferred_width > @col_width
+        end
+        @col_width
+      end
+
+      def row_height
+        return @row_height if @row_height
+        @row_height = 0
+        children.each do |child|
+          @row_height = child.preferred_height if child.preferred_height > @row_height
+        end
+        @row_height
+      end
+
+      def preferred_width
+        margin_width +
+          outer_border_width +
+          settings.num_cols * (padding_width + col_width) +
+          (settings.num_cols - 1) * inner_border_width
+      end
+
+      def preferred_height
+        num_rows = (children.length / settings.num_cols).ceil
+        margin_height +
+          outer_border_height +
+          num_rows * (padding_height + row_height) +
+          (num_rows - 1) * inner_border_height
+      end
+    end
+  end
+end

data/lib/whirled_peas/{ui → template}/settings.rb

@@ -1,5 +1,8 @@
 require 'json'
 
+require_relative '../utils/color'
+require_relative '../utils/title_font'
+
 module WhirledPeas
   module UI
     module TextAlign
@@ -305,11 +308,11 @@ module WhirledPeas
     end
     private_constant :ElementSettings
 
-    module WidthSetting
+    module WidthSettings
       attr_accessor :width
     end
 
-    module AlignSetting
+    module AlignSettings
       def align
         @_align || TextAlign::LEFT
       end
@@ -322,7 +325,7 @@ module WhirledPeas
         merged = super
         merged._align = if @_align
           @_align
-        elsif parent.is_a?(AlignSetting)
+        elsif parent.is_a?(AlignSettings)
           parent._align
         end
         merged
@@ -342,6 +345,11 @@ module WhirledPeas
         @_margin.bottom = bottom if bottom
       end
 
+      def clear_margin
+        set_margin(left: 0, top: 0, right: 0, bottom: 0)
+        @_auto_margin = nil
+      end
+
       def margin
         @_margin || Margin.new
       end
@@ -387,7 +395,7 @@ module WhirledPeas
         @_border.color = color unless color.nil?
       end
 
-      def no_border
+      def clear_border
         set_border(
           left: false, top: false, right: false, bottom: false, inner_horiz: false, inner_vert: false
         )
@@ -424,6 +432,10 @@ module WhirledPeas
         @_padding.bottom = bottom if bottom
       end
 
+      def clear_padding
+        set_padding(left: 0, top: 0, right: 0, bottom: 0)
+      end
+
       def padding
         @_padding || Padding.new
       end
@@ -444,8 +456,14 @@ module WhirledPeas
     end
 
     class TextSettings < ElementSettings
-      include WidthSetting
-      include AlignSetting
+      include WidthSettings
+      include AlignSettings
+
+      attr_reader :title_font
+
+      def title_font=(font)
+        @title_font = Utils::TitleFont.validate!(font)
+      end
     end
 
     class ContainerSettings < ElementSettings
@@ -455,8 +473,8 @@ module WhirledPeas
     end
 
     class BoxSettings < ContainerSettings
-      include WidthSetting
-      include AlignSetting
+      include WidthSettings
+      include AlignSettings
 
       def flow=(flow)
         @_flow = DisplayFlow.validate!(flow)
@@ -498,8 +516,8 @@ module WhirledPeas
     end
 
     class GridSettings < ContainerSettings
-      include WidthSetting
-      include AlignSetting
+      include WidthSettings
+      include AlignSettings
 
       attr_accessor :num_cols
       attr_writer :transpose