whirled_peas 0.4.1 → 0.8.0

data/lib/whirled_peas/command_line.rb

@@ -1,232 +1,21 @@
-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)
-        msg = %Q(#{msg.class}: #{msg.to_s}\n    #{msg.backtrace.join("\n    ")})
-      end
-      "[#{severity}] #{datetime.strftime('%Y-%m-%dT%H:%M:%S.%L')} (#{progname}) - #{msg}\n"
-    end
-
-    def self.command_name
-      self.name.split('::').last.sub(/Command$/, '').gsub(/([a-z])([A-Z])/, '\1_\2').downcase
-    end
-
-    def self.build_logger(output, level=DEFAULT_LOG_LEVEL, formatter=DEFAULT_FORMATTER)
-      logger = Logger.new(output)
-      logger.level = level
-      logger.formatter = formatter
-      logger
-    end
-
-    attr_reader :args
-
-    def initialize(args)
-      @args = args
-    end
-
-    def valid?
-      @error_text = nil
-      validate!
-      @error_text.nil?
-    end
-
-    def print_error
-      puts @error_text if @error_text
-      print_usage
-    end
-
-    def start
-    end
-
-    private
-
-    def print_usage
-      puts "Usage: #{$0} #{self.class.command_name}"
-    end
-
-    def validate!
-      # Set @error_text if the options are not valid
-    end
-  end
-
-  class TitleFontsCommand < Command
-    def start
-      require 'whirled_peas/utils/title_font'
-
-      Utils::TitleFont.fonts.keys.each do |key|
-        puts Utils::TitleFont.to_s(key.to_s, key)
-        puts key.inspect
-        puts
-      end
-    end
-  end
-
-  class ConfigCommand < Command
-    def start
-      require config
-    end
-
-    private
-
-    attr_reader :config
-
-    def validate!
-      if args.length == 0
-        @error_text = "#{self.class.command_name} requires a config file"
-      elsif !File.exist?(args[0])
-        @error_text = "File not found: #{args[0]}"
-      elsif args[0][-3..-1] != '.rb'
-        @error_text = 'Config file should be a .rb file'
-      else
-        @config = args[0][0] == '/' ? args[0] : File.join(Dir.pwd, args[0])
-      end
-    end
-
-    def print_usage
-      puts "Usage: #{$0} #{self.class.command_name} <config file>"
-    end
-  end
-
-  class StartCommand < ConfigCommand
-    LOGGER_ID = 'MAIN'
-
-    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
-      )
-      Frame::Producer.produce(consumer, 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
-      end
-    end
-  end
-
-  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
-      end
-    end
-  end
-
-  class PlayFrameCommand < ConfigCommand
-    def start
-      super
-
-      if args.last == '--debug'
-        puts WhirledPeas.config.template_factory.build(frame, frame_args).inspect
-        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
-      )
-      Frame::Producer.produce(consumer, logger) do |producer|
-        producer.send_frame(args[1], duration: 5, args: frame_args)
-      end
-    end
-
-    private
-
-    attr_reader :frame, :frame_args
-
-    def validate!
-      super
-      if !@error_text.nil?
-        return
-      elsif args.length < 2
-        @error_text = "#{self.class.command_name} requires a frame name"
-      else
-        require 'json'
-        @frame = args[1]
-        @frame_args = {}
-        JSON.parse(args[2] || '{}').each do |key, value|
-          @frame_args[key.to_sym] = value
-        end
-      end
-    end
-
-    def print_usage
-      puts "Usage: #{$0} #{self.class.command_name} <config file> <frame> [args as a JSON string] [--debug]"
-    end
-  end
-
-  class LoadingCommand < ConfigCommand
-    def start
-      super
-      unless WhirledPeas.config.loading_template_factory
-        puts 'No loading screen configured'
-        exit
-      end
-
-      if args.last == '--debug'
-        puts WhirledPeas.config.loading_template_factory.build.inspect
-        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
-      )
-      Frame::Producer.produce(consumer, logger) { sleep(5) }
-    end
-
-    private
-
-    def print_usage
-      puts "Usage: #{$0} #{self.class.command_name} [--debug]"
-    end
-  end
+require 'whirled_peas/command/debug'
+require 'whirled_peas/command/fonts'
+require 'whirled_peas/command/frames'
+require 'whirled_peas/command/help'
+require 'whirled_peas/command/play'
+require 'whirled_peas/command/record'
+require 'whirled_peas/command/still'
 
+module WhirledPeas
   class CommandLine
     COMMANDS = [
-      StartCommand,
-      ListFramesCommand,
-      PlayFrameCommand,
-      LoadingCommand,
-      TitleFontsCommand
+      Command::Debug,
+      Command::Fonts,
+      Command::Frames,
+      Command::Help,
+      Command::Play,
+      Command::Record,
+      Command::Still
     ].map.with_object({}) { |c, h| h[c.command_name] = c }
 
     def initialize(args)
@@ -247,7 +36,7 @@ module WhirledPeas
         exit(1)
       end
 
-      cmd = COMMANDS[command].new(args)
+      cmd = COMMANDS[command].new(args, WhirledPeas.config)
 
       unless cmd.valid?
         cmd.print_error
@@ -264,7 +53,13 @@ module WhirledPeas
     def print_usage
       puts "Usage: #{$0} <command> [command options]"
       puts
-      puts "Available commands: #{COMMANDS.keys.join(', ')}"
+      puts 'Available commands:'
+      puts
+      max_name_length = 0
+      COMMANDS.keys.each { |c| max_name_length = c.length if c.length > max_name_length }
+      COMMANDS.each do |name, klass|
+        puts "    #{name.ljust(max_name_length, ' ')}    #{klass.description}"
+      end
     end
   end
 end

data/lib/whirled_peas/config.rb

@@ -1,13 +1,47 @@
+require 'logger'
+
 module WhirledPeas
   class Config
-    attr_writer :driver, :template_factory
-    attr_accessor :loading_template_factory
+    # Refreshed rate measured in frames per second
+    DEFAULT_REFRESH_RATE = 30
+
+    DEFAULT_LOG_LEVEL = Logger::INFO
+    DEFAULT_LOG_FILE = 'whirled_peas.log'
 
-    def driver
-      unless @driver
-        raise ConfigurationError, 'driver must be configured'
+    # This formatter expects a loggers to send `progname` in each log call. This value
+    # should be an all uppercase version of the module or class that is invoking the
+    # logger. Ruby's logger supports setting this value on a per-log statement basis
+    # when the log message is passed in through a block:
+    #
+    #   logger.<level>(progname, &block)
+    #
+    # E.g.
+    #
+    #   class Foo
+    #     def bar
+    #       logger.warn('FOO') { 'Something fishy happened in #bar' }
+    #     end
+    #   end
+    #
+    # The block format also has the advantage that the evaluation of the block only
+    # occurs if the message gets logged. So expensive to calculate debug statements
+    # will not impact the performance of the application if the log level is INFO or
+    # higher.
+    DEFAULT_FORMATTER = proc do |severity, datetime, progname, msg|
+      # Convert an instance of an exception into a nicely formatted message string
+      if msg.is_a?(Exception)
+        msg = %Q(#{msg.class}: #{msg.to_s}\n    #{msg.backtrace.join("\n    ")})
       end
-      @driver
+      "[#{severity}] #{datetime.strftime('%Y-%m-%dT%H:%M:%S.%L')} (#{progname}) - #{msg}\n"
+    end
+
+    attr_writer :application, :template_factory, :refresh_rate, :log_level, :log_formatter, :log_file
+
+    def application
+      unless @application
+        raise ConfigurationError, 'application must be configured'
+      end
+      @application
     end
 
     def template_factory
@@ -16,6 +50,22 @@ module WhirledPeas
       end
       @template_factory
     end
+
+    def refresh_rate
+      @refresh_rate || DEFAULT_REFRESH_RATE
+    end
+
+    def log_level
+      @log_level || DEFAULT_LOG_LEVEL
+    end
+
+    def log_formatter
+      @log_formatter || DEFAULT_FORMATTER
+    end
+
+    def log_file
+      @log_file || DEFAULT_LOG_FILE
+    end
   end
   private_constant :Config
 end

data/lib/whirled_peas/device.rb

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

data/lib/whirled_peas/device/null_device.rb

@@ -0,0 +1,8 @@
+module WhirledPeas
+  module Device
+    class NullDevice
+      def handle_renders(*)
+      end
+    end
+  end
+end

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

@@ -0,0 +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

@@ -0,0 +1,101 @@
+require_relative 'container_painter'
+require_relative 'container_dimensions'
+
+module WhirledPeas
+  module Graphics
+    class BoxPainter < ContainerPainter
+      def paint(canvas, left, top, &block)
+        super
+        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(content_canvas, canvas_coords, &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, 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|
+          top_offset, _ = vert_justify_offset(child.dimensions.outer_height)
+          child_width = child.dimensions.outer_width
+          child_canvas = canvas.child(
+            stroke_left,
+            stroke_top + top_offset,
+            child_width,
+            child.dimensions.outer_height
+          )
+          child.paint(child_canvas, stroke_left, stroke_top + top_offset, &block)
+          stroke_left += child_width + spacing_offset
+        end
+      end
+
+      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|
+          left_offset, _ = horiz_justify_offset(child.dimensions.outer_width)
+          child_height = child.dimensions.outer_height
+          child_canvas = canvas.child(
+            stroke_left + left_offset,
+            stroke_top ,
+            child.dimensions.outer_width,
+            child_height
+          )
+          child.paint(child_canvas, stroke_left + left_offset, stroke_top, &block)
+          stroke_top += child_height + spacing_offset
+        end
+      end
+    end
+    private_constant :BoxPainter
+  end
+end