whirled_peas 0.2.0 → 0.6.0

data/lib/whirled_peas/config.rb

@@ -0,0 +1,21 @@
+module WhirledPeas
+  class Config
+    attr_writer :driver, :template_factory
+    attr_accessor :loading_template_factory
+
+    def driver
+      unless @driver
+        raise ConfigurationError, 'driver must be configured'
+      end
+      @driver
+    end
+
+    def template_factory
+      unless @template_factory
+        raise ConfigurationError, 'template_factory must be configured'
+      end
+      @template_factory
+    end
+  end
+  private_constant :Config
+end

data/lib/whirled_peas/errors.rb

@@ -0,0 +1,7 @@
+module WhirledPeas
+  class Error < StandardError; end
+
+  class ConfigurationError < Error; end
+
+  class SettingsError < Error; end
+end

data/lib/whirled_peas/frame.rb

@@ -1,13 +1,5 @@
-require_relative 'frame/consumer'
-require_relative 'frame/producer'
-
 module WhirledPeas
   module Frame
-    TERMINATE = '__term__'
-    EOF = '__EOF__'
-
-    DEFAULT_ADDRESS = 'localhost'
-    DEFAULT_PORT = 8765
   end
 
   private_constant :Frame

data/lib/whirled_peas/frame/consumer.rb

@@ -1,66 +1,30 @@
-require 'socket'
-require 'json'
-
-require_relative 'event_loop'
-
 module WhirledPeas
   module Frame
+    # Abstract class for consuming frame events.
     class Consumer
-      LOGGER_ID = 'CONSUMER'
+      EOF = '__EOF__'
 
-      def initialize(template_factory, refresh_rate, logger=NullLogger.new)
-        @event_loop = EventLoop.new(template_factory, refresh_rate, logger)
-        @logger = logger
-        @running = false
-        @mutex = Mutex.new
+      def enqueue(name, duration, args)
+        raise NotImplemented, "#{self.class} must implement #enqueue"
       end
 
-      def start(host:, port:)
-        mutex.synchronize { @running = true }
-        loop_thread = Thread.new do
-          Thread.current.report_on_exception = false
-          event_loop.start
-        end
-        socket = TCPSocket.new(host, port)
-        logger.info(LOGGER_ID) { "Connected to #{host}:#{port}" }
-        while @running && event_loop.running?
-          line = socket.gets
-          if line.nil?
-            sleep(0.001)
-            next
-          end
-          args = JSON.parse(line)
-          name = args.delete('name')
-          if [Frame::EOF, Frame::TERMINATE].include?(name)
-            logger.info(LOGGER_ID) { "Received #{name} event, stopping..." }
-            event_loop.stop if name == Frame::TERMINATE
-            @running = false
-          else
-            duration = args.delete('duration')
-            event_loop.enqueue(name, duration, args)
-          end
-        end
-        logger.info(LOGGER_ID) { 'Exited normally' }
-        logger.info(LOGGER_ID) { 'Waiting for loop thread to exit' }
-        loop_thread.join
-      rescue => e
-        event_loop.stop if event_loop.running?
-        logger.warn(LOGGER_ID) { 'Exited with error' }
-        logger.error(LOGGER_ID) { e }
-        raise
-      ensure
-        logger.info(LOGGER_ID) { 'Closing socket' }
-        socket.close if socket
+      def running?
+        @running == true
+      end
+
+      def start
+        self.running = true
       end
 
       def stop
-        logger.info(LOGGER_ID) { 'Stopping...' }
-        mutex.synchronize { @running = false }
+        enqueue(EOF, nil, {})
       end
 
       private
 
-      attr_reader :event_loop, :logger, :mutex
+      attr_writer :running
     end
+
+    private_constant :Consumer
   end
 end

data/lib/whirled_peas/frame/debug_consumer.rb

@@ -0,0 +1,30 @@
+require 'whirled_peas/null_logger'
+
+require_relative 'consumer'
+
+module WhirledPeas
+  module Frame
+    class DebugConsumer < Consumer
+      LOGGER_ID = 'PRINTER'
+
+      def initialize(output=STDOUT, logger=NullLogger.new)
+        @output = output
+        @logger = logger
+      end
+
+      def enqueue(name, duration, args)
+        if name == EOF
+          output.puts "EOF frame detected"
+        else
+          displayed_for = duration ? "#{duration} second(s)" : '1 frame'
+          args_str = args.empty? ? '' : " '#{JSON.generate(args)}'"
+          output.puts "Frame '#{name}' displayed for #{displayed_for}#{args_str}"
+        end
+      end
+
+      private
+
+      attr_reader :output, :logger
+    end
+  end
+end

data/lib/whirled_peas/frame/event_loop.rb

@@ -1,60 +1,90 @@
+require 'whirled_peas/null_logger'
+require 'whirled_peas/graphics/screen'
+
+require_relative 'consumer'
+
 module WhirledPeas
   module Frame
-    class EventLoop
-      def initialize(template_factory, refresh_rate, logger=NullLogger.new)
+    class EventLoop < Consumer
+      DEFAULT_REFRESH_RATE = 30
+
+      LOGGER_ID = 'EVENT LOOP'
+
+      def initialize(
+        template_factory,
+        loading_template_factory=nil,
+        refresh_rate: DEFAULT_REFRESH_RATE,
+        logger: NullLogger.new,
+        screen: Graphics::Screen.new
+      )
         @template_factory = template_factory
+        @loading_template_factory = loading_template_factory
         @queue = Queue.new
-        @refresh_rate = refresh_rate
+        @frame_duration = 1.0 / refresh_rate
         @logger = logger
+        @screen = screen
       end
 
       def enqueue(name, duration, args)
-        queue.push([name, duration, args])
-      end
-
-      def running?
-        @running
+        # If duration is nil, set it to the duration of a single frame
+        queue.push([name, duration || frame_duration, args])
       end
 
       def start
-        logger.info('EVENT LOOP') { 'Starting' }
-        @running = true
-        screen = UI::Screen.new
-        sleep(0.01) while queue.empty?  # Wait for the first event
-        remaining_frames = 1
-        template = nil
-        while @running && remaining_frames > 0
-          frame_at = Time.now
-          next_frame_at = frame_at + 1.0 / refresh_rate
-          remaining_frames -= 1
-          if remaining_frames > 0
-            screen.refresh if screen.needs_refresh?
-          elsif !queue.empty?
-            name, duration, args = queue.pop
-            remaining_frames = duration ? duration * refresh_rate : 1
-            template = template_factory.build(name, args)
-            screen.paint(template)
-          end
-          sleep([0, next_frame_at - Time.now].max)
-        end
-        logger.info('EVENT LOOP') { 'Exiting normally' }
+        super
+        wait_for_content
+        play_content
       rescue
-        logger.warn('EVENT LOOP') { 'Exiting with error' }
-        @running = false
+        self.running = false
+        logger.warn(LOGGER_ID) { 'Exiting with error' }
         raise
       ensure
-        screen.finalize if screen
+        screen.finalize
       end
 
-      def stop
-        logger.info('EVENT LOOP') { 'Stopping...' }
-        @running = false
+      private
+
+      attr_reader :template_factory, :loading_template_factory, :queue, :frame_duration, :logger, :screen
+
+      def wait_for_content
+        if loading_template_factory
+          play_loading_screen
+        else
+          sleep(frame_duration) while queue.empty?
+        end
       end
 
-      private
+      def play_loading_screen
+        while queue.empty?
+          screen.paint(loading_template_factory.build)
+          sleep(frame_duration)
+        end
+      end
 
-      attr_reader :template_factory, :queue, :refresh_rate, :logger
+      def play_content
+        template = nil
+        frame_until = Time.new(0)  # Tell the loop to immediately pick up a new frame
+        while running?
+          frame_start = Time.now
+          next_frame_at = frame_start + frame_duration
+          if frame_until > frame_start
+            # While we're still displaying the previous frame, refresh the screen
+            screen.refresh
+          elsif !queue.empty?
+            name, duration, args = queue.pop
+            if name == EOF
+              self.running = false
+            else
+              frame_until = frame_start + duration
+              template = template_factory.build(name, args)
+              screen.paint(template)
+            end
+          else
+            wait_for_content
+          end
+          sleep([0, next_frame_at - Time.now].max)
+        end
+      end
     end
-    private_constant :EventLoop
   end
 end

data/lib/whirled_peas/frame/producer.rb

@@ -1,63 +1,67 @@
 require 'socket'
 require 'json'
 
+require 'whirled_peas/null_logger'
+
 module WhirledPeas
   module Frame
+    # A Producer is the object given to the driver as the interface that allows
+    # the driver to emit frame events. The recommended way of creating a Producer
+    # is by invoking `Producer.produce` as it handles the lifecycle methods of
+    # the consumer.
     class Producer
       LOGGER_ID = 'PRODUCER'
 
-      def self.start(logger: NullLogger.new, host:, port:, &block)
-        server = TCPServer.new(host, port)
-        client = server.accept
-        logger.info(LOGGER_ID) { "Connected to #{host}:#{port}" }
-        producer = new(client, logger)
+      # Manages the consumer lifecycle and yields a Producer to send frames to the
+      # consumer
+      #
+      # @param consumer [Consumer] instance that consumes frame events through
+      #   `#enqueue`
+      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(LOGGER_ID) { 'Exited normally' }
+        producer.flush
       rescue => e
-        producer.terminate
         logger.warn(LOGGER_ID) { 'Exited with error' }
         logger.error(LOGGER_ID) { e }
         raise
       ensure
-        if client
-          logger.info(LOGGER_ID) { 'Closing connection'}
-          client.close
-        end
+        consumer.stop
+        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(LOGGER_ID) { "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/graphics.rb

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

data/lib/whirled_peas/graphics/box_painter.rb

@@ -0,0 +1,108 @@
+require_relative 'container_painter'
+require_relative 'container_dimensions'
+
+module WhirledPeas
+  module Graphics
+    class BoxPainter < ContainerPainter
+      def paint(canvas, &block)
+        super
+        return unless canvas.writable?
+        if settings.horizontal_flow?
+          paint_horizontally(canvas, &block)
+        else
+          paint_vertically(canvas, &block)
+        end
+      end
+
+      def dimensions
+        @dimensions ||= begin
+          content_width = 0
+          content_height = 0
+          if settings.horizontal_flow?
+            each_child do |child|
+              content_width += child.dimensions.outer_width
+              if child.dimensions.outer_height > content_height
+                content_height = child.dimensions.outer_height
+              end
+            end
+          else
+            each_child do |child|
+              if child.dimensions.outer_width > content_width
+                content_width = child.dimensions.outer_width
+              end
+              content_height += child.dimensions.outer_height
+            end
+          end
+          ContainerDimensions.new(settings, content_width, content_height)
+        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
+        each_child do |child|
+          child_width = [
+            child.dimensions.outer_width,
+            dimensions.content_width - given_width
+          ].min
+          child_canvas = canvas.child(
+            stroke_left + given_width,
+            stroke_top,
+            child_width,
+            [dimensions.content_height, child.dimensions.outer_height].min
+          )
+          child.paint(child_canvas, &block)
+          given_width += child_width
+          break if given_width == dimensions.content_width
+        end
+      end
+
+      def paint_vertically(canvas, &block)
+        stroke_top = coords(canvas).content_top
+        stroke_left = coords(canvas).content_left
+        given_height = 0
+        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
+          child_canvas = canvas.child(
+            stroke_left + justify_offset,
+            stroke_top + given_height,
+            [dimensions.content_width, child.dimensions.outer_width].min,
+            child_height
+          )
+          child.paint(child_canvas, &block)
+          given_height += child_height
+          break if given_height == dimensions.content_height
+        end
+      end
+    end
+    private_constant :BoxPainter
+  end
+end