whirled_peas 0.4.1 → 0.5.0

data/lib/whirled_peas/command_line.rb

@@ -1,7 +1,15 @@
+require 'json'
+
+require 'whirled_peas/graphics/debugger'
+require 'whirled_peas/graphics/renderer'
+require 'whirled_peas/graphics/screen'
+require 'whirled_peas/frame/debug_consumer'
+require 'whirled_peas/frame/event_loop'
+require 'whirled_peas/frame/producer'
+require 'whirled_peas/template/debugger'
+
 module WhirledPeas
   class Command
-    DEFAULT_REFRESH_RATE = 30
-
     DEFAULT_LOG_LEVEL = Logger::INFO
     DEFAULT_FORMATTER = proc do |severity, datetime, progname, msg|
       if msg.is_a?(Exception)
@@ -95,16 +103,13 @@ module WhirledPeas
 
     def start
       super
-      require 'whirled_peas/frame/event_loop'
-      require 'whirled_peas/frame/producer'
 
       logger = self.class.build_logger(File.open('whirled_peas.log', 'a'))
 
       consumer = Frame::EventLoop.new(
         WhirledPeas.config.template_factory,
         WhirledPeas.config.loading_template_factory,
-        DEFAULT_REFRESH_RATE,
-        logger
+        logger: logger
       )
       Frame::Producer.produce(consumer, logger) do |producer|
         begin
@@ -121,18 +126,9 @@ module WhirledPeas
   class ListFramesCommand < ConfigCommand
     def start
       super
-      require 'whirled_peas/frame/print_consumer'
-      require 'whirled_peas/frame/producer'
 
-      logger = self.class.build_logger(STDOUT)
-      Frame::Producer.produce(Frame::PrintConsumer.new, logger) do |producer|
-        begin
-          WhirledPeas.config.driver.start(producer)
-        rescue => e
-          logger.warn(LOGGER_ID) { 'Driver exited with error, terminating producer...' }
-          logger.error(LOGGER_ID) { e }
-          raise
-        end
+      Frame::Producer.produce(Frame::DebugConsumer.new) do |producer|
+        WhirledPeas.config.driver.start(producer)
       end
     end
   end
@@ -141,24 +137,25 @@ module WhirledPeas
     def start
       super
 
-      if args.last == '--debug'
-        puts WhirledPeas.config.template_factory.build(frame, frame_args).inspect
+      if args.last == '--template'
+        element = WhirledPeas.config.template_factory.build(frame, frame_args)
+        puts Template::Debugger.new(element).debug
+        exit
+      elsif args.last == '--painter'
+        element = WhirledPeas.config.template_factory.build(frame, frame_args)
+        painter = Graphics::Renderer.new(element, *Graphics::Screen.current_dimensions).painter
+        puts Graphics::Debugger.new(painter).debug
         exit
       end
 
-      require 'whirled_peas/frame/event_loop'
-      require 'whirled_peas/frame/producer'
-
       logger = self.class.build_logger(File.open('whirled_peas.log', 'a'))
 
       consumer = Frame::EventLoop.new(
         WhirledPeas.config.template_factory,
-        WhirledPeas.config.loading_template_factory,
-        DEFAULT_REFRESH_RATE,
-        logger
+        logger: logger
       )
       Frame::Producer.produce(consumer, logger) do |producer|
-        producer.send_frame(args[1], duration: 5, args: frame_args)
+        producer.send_frame(frame, args: frame_args)
       end
     end
 
@@ -173,9 +170,9 @@ module WhirledPeas
       elsif args.length < 2
         @error_text = "#{self.class.command_name} requires a frame name"
       else
-        require 'json'
         @frame = args[1]
         @frame_args = {}
+        return if args.length < 3 || args[2][0..1] == '--'
         JSON.parse(args[2] || '{}').each do |key, value|
           @frame_args[key.to_sym] = value
         end
@@ -200,15 +197,11 @@ module WhirledPeas
         exit
       end
 
-      require 'whirled_peas/frame/event_loop'
-      require 'whirled_peas/frame/producer'
-
       logger = self.class.build_logger(File.open('whirled_peas.log', 'a'))
       consumer = Frame::EventLoop.new(
         WhirledPeas.config.template_factory,
         WhirledPeas.config.loading_template_factory,
-        DEFAULT_REFRESH_RATE,
-        logger
+        logger: logger
       )
       Frame::Producer.produce(consumer, logger) { sleep(5) }
     end

data/lib/whirled_peas/debugger.rb

@@ -0,0 +1,80 @@
+require 'whirled_peas/frame/event_loop'
+require 'whirled_peas/frame/producer'
+require 'whirled_peas/graphics/debugger'
+require 'whirled_peas/graphics/mock_screen'
+require 'whirled_peas/graphics/renderer'
+require 'whirled_peas/graphics/screen'
+require 'whirled_peas/template/debugger'
+
+module WhirledPeas
+  class Debugger
+    module Option
+      DISABLE_SCREEN = :disable_screen
+      PAINTER = :painter
+      TEMPLATE = :template
+
+      VALID = [DISABLE_SCREEN, PAINTER, TEMPLATE]
+    end
+    private_constant :Option
+
+    FRAME = 'debug'
+    private_constant :FRAME
+
+    def initialize(template_file, option=nil)
+      unless option.nil? || Option::VALID.include?(option)
+        message =
+          "Invalid option: #{option}, expecting one of #{Option::VALID.join(', ')}"
+        raise ArgumentError, message
+      end
+      @template_file = template_file
+      @option = option
+    end
+
+    def debug
+      require template_file
+      template_factory = TemplateFactory.new
+      if play_frame?
+        screen = if disable_screen?
+          Graphics::MockScreen.new(80, 40)
+        else
+          Graphics::Screen.new
+        end
+        consumer = Frame::EventLoop.new(template_factory, screen: screen)
+        Frame::Producer.produce(consumer) do |producer|
+          producer.send_frame(FRAME, args: {})
+        end
+        return
+      end
+
+      template = template_factory.build(FRAME, {})
+      if print_painter?
+        painter = Graphics::Renderer.new(template, *Graphics::Screen.current_dimensions).painter
+        puts Graphics::Debugger.new(painter).debug
+      elsif print_template?
+        puts Template::Debugger.new(template).debug
+      end
+    end
+
+    private
+
+    attr_reader :template_file, :option
+
+    def play_frame?
+      option.nil? || option == Option::DISABLE_SCREEN
+    end
+
+    def disable_screen?
+      !option.nil? && option == Option::DISABLE_SCREEN
+    end
+
+    def print_painter?
+      !option.nil? && option == Option::PAINTER
+    end
+
+    def print_template?
+      !option.nil? && option == Option::TEMPLATE
+    end
+  end
+
+  private_constant :Debugger
+end

data/lib/whirled_peas/errors.rb

@@ -2,4 +2,6 @@ module WhirledPeas
   class Error < StandardError; end
 
   class ConfigurationError < Error; end
+
+  class SettingsError < Error; end
 end

data/lib/whirled_peas/frame.rb

@@ -1,6 +1,5 @@
 module WhirledPeas
   module Frame
-    EOF = '__EOF__'
   end
 
   private_constant :Frame

data/lib/whirled_peas/frame/consumer.rb

@@ -0,0 +1,30 @@
+module WhirledPeas
+  module Frame
+    # Abstract class for consuming frame events.
+    class Consumer
+      EOF = '__EOF__'
+
+      def enqueue(name, duration, args)
+        raise NotImplemented, "#{self.class} must implement #enqueue"
+      end
+
+      def running?
+        @running == true
+      end
+
+      def start
+        self.running = true
+      end
+
+      def stop
+        enqueue(EOF, nil, {})
+      end
+
+      private
+
+      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,17 +1,28 @@
-require_relative '../null_logger'
-require_relative '../ui/screen'
+require 'whirled_peas/null_logger'
+require 'whirled_peas/graphics/screen'
+
+require_relative 'consumer'
 
 module WhirledPeas
   module Frame
-    class EventLoop
+    class EventLoop < Consumer
+      DEFAULT_REFRESH_RATE = 30
+
       LOGGER_ID = 'EVENT LOOP'
 
-      def initialize(template_factory, loading_template_factory, refresh_rate, logger=NullLogger.new)
+      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
         @frame_duration = 1.0 / refresh_rate
         @logger = logger
+        @screen = screen
       end
 
       def enqueue(name, duration, args)
@@ -19,50 +30,38 @@ module WhirledPeas
         queue.push([name, duration || frame_duration, args])
       end
 
-      def running?
-        @running
-      end
-
-      def start(screen=UI::Screen.new)
-        wait_for_content(screen)
-        play_content(screen)
+      def start
+        super
+        wait_for_content
+        play_content
       rescue
+        self.running = false
         logger.warn(LOGGER_ID) { 'Exiting with error' }
         raise
       ensure
-        # We may have exited due to an EOF or a raised exception, set state so that
-        # instance reflects actual state.
-        @running = false
-        screen.finalize if screen
-      end
-
-      def stop
-        logger.info(LOGGER_ID) { 'Stopping...' }
-        enqueue(Frame::EOF, nil, {})
-        @running = false
+        screen.finalize
       end
 
       private
 
-      attr_reader :template_factory, :loading_template_factory, :queue, :frame_duration, :logger
+      attr_reader :template_factory, :loading_template_factory, :queue, :frame_duration, :logger, :screen
 
-      def wait_for_content(screen)
+      def wait_for_content
         if loading_template_factory
-          play_loading_screen(screen)
+          play_loading_screen
         else
           sleep(frame_duration) while queue.empty?
         end
       end
 
-      def play_loading_screen(screen)
+      def play_loading_screen
         while queue.empty?
           screen.paint(loading_template_factory.build)
           sleep(frame_duration)
         end
       end
 
-      def play_content(screen)
-        @running = true
+      def play_content
         template = nil
         frame_until = Time.new(0)  # Tell the loop to immediately pick up a new frame
         while running?
@@ -73,15 +72,15 @@ module WhirledPeas
             screen.refresh
           elsif !queue.empty?
             name, duration, args = queue.pop
-            if name == Frame::EOF
-              @running = false
+            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(screen)
+            wait_for_content
           end
           sleep([0, next_frame_at - Time.now].max)
         end

data/lib/whirled_peas/frame/producer.rb

@@ -1,15 +1,22 @@
 require 'socket'
 require 'json'
 
-require_relative '../null_logger'
+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'
 
-      # Manages the EventLoop lifecycle and yields a Producer to send frames to the
-      # EventLoop
+      # 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
@@ -17,14 +24,13 @@ module WhirledPeas
           consumer.start
         end
         yield producer
-        producer.send_frame(Frame::EOF)
         producer.flush
       rescue => e
-        consumer.stop if consumer
         logger.warn(LOGGER_ID) { 'Exited with error' }
         logger.error(LOGGER_ID) { e }
         raise
       ensure
+        consumer.stop
         consumer_thread.join if consumer_thread
       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,100 @@
+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 element.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
+
+      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