whirled_peas 0.1.1 → 0.5.0

data/Rakefile

@@ -1,6 +1,40 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+def screen_test(file, method)
+  raise ArgumentError, 'Missing argument: file' unless file
+
+  require 'bundler/setup'
+  require 'whirled_peas'
+  require_relative 'screen_test/screen_tester'
+
+  WhirledPeas::ScreenTester.new(file).send(method)
+end
+
+namespace :screen_test do
+  %i[debug run save view].each do |t|
+    task t, [:file] do |_, args|
+      screen_test(args[:file], t)
+    end
+  end
+
+  task :update_all do
+    require 'bundler/setup'
+    require 'whirled_peas'
+    require_relative 'screen_test/screen_tester'
+
+    WhirledPeas::ScreenTester.update_all
+  end
+end
+
+task :screen_test do
+  require 'bundler/setup'
+  require 'whirled_peas'
+  require_relative 'screen_test/screen_tester'
+
+  WhirledPeas::ScreenTester.run_all
+end
+
+task default: [:screen_test, :spec]

data/bin/debug

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+def print_usage
+  puts "Usage: #{$0} <config file> [options]"
+  puts
+  puts 'options include'
+  puts '    --disable-screen  Disable the screen (useful when printing debug statements)'
+  puts '    --painter         Print the painter debug tree and exit'
+  puts '    --template        Print the template debug tree and exit'
+end
+
+if !(1..2).include?(ARGV.length)
+  print_usage
+  exit(1)
+elsif !File.exist?(ARGV.first)
+  puts "File not found: #{ARGV.first}"
+  print_usage
+  exit(1)
+elsif ARGV.length == 2 && !%w[--disable-screen --template --painter].include?(ARGV[1])
+  puts "Unrecognized option: #{ARGV[1]}"
+  print_usage
+  exit(1)
+end
+
+require 'bundler/setup'
+require 'whirled_peas'
+
+if ARGV.length == 1
+  option = nil
+else
+  option = ARGV[1].sub(/^--/, '').gsub(/-/, '_').to_sym
+end
+
+template_file = ARGV.first[0] == '/' ? ARGV.first : File.join(Dir.pwd, ARGV.first)
+WhirledPeas.debug(template_file, option)

data/exe/whirled_peas

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'whirled_peas'
+require 'whirled_peas/command_line'
+
+WhirledPeas::CommandLine.new(ARGV).start

data/lib/whirled_peas.rb

@@ -1,50 +1,30 @@
 require 'logger'
 
+require 'whirled_peas/errors'
+require 'whirled_peas/config'
+require 'whirled_peas/debugger'
 require 'whirled_peas/frame'
-require 'whirled_peas/ui'
+require 'whirled_peas/graphics'
+require 'whirled_peas/settings'
+require 'whirled_peas/template'
+require 'whirled_peas/utils'
 require 'whirled_peas/version'
 
 module WhirledPeas
-  class Error < StandardError; end
-
-  DEFAULT_HOST = 'localhost'
-  DEFAULT_PORT = 8765
-  DEFAULT_REFRESH_RATE = 30
-
-  LOGGER_ID = 'MAIN'
-
-  def self.start(driver, template_factory, log_level: Logger::INFO, refresh_rate: DEFAULT_REFRESH_RATE, host: DEFAULT_HOST, port: DEFAULT_PORT)
-    logger = Logger.new(File.open('whirled_peas.log', 'a'))
-    logger.level = log_level
-    logger.formatter = proc do |severity, datetime, progname, msg|
-      "[#{severity}] #{datetime.strftime('%Y-%m-%dT%H:%M:%S.%L')} (#{progname}) - #{msg}\n"
-    end
-
-    consumer = Frame::Consumer.new(template_factory, refresh_rate, logger)
-    consumer_thread = Thread.new do
-      Thread.current.report_on_exception = false
-      consumer.start(host: host, port: port)
-    end
+  def self.config
+    @config ||= Config.new
+  end
 
-    Frame::Producer.start(logger: logger, host: host, port: port) do |producer|
-      begin
-        driver.start(producer)
-        producer.stop
-      rescue => e
-        logger.warn(LOGGER_ID) { 'Driver exited with error, terminating producer...' }
-        logger.error(LOGGER_ID) { e }
-        logger.error(LOGGER_ID) { e.backtrace.join("\n") }
-        producer.terminate
-        raise
-      end
-    end
+  def self.configure(&block)
+    yield config
+  end
 
-    consumer_thread.join
+  def self.debug(config_file, option=nil)
+    Debugger.new(config_file, option).debug
   end
 
   def self.template(&block)
-    template = UI::Template.new
-    yield template, template.settings
-    template
+    require 'whirled_peas/template/composer'
+    Template::Composer.build(&block)
   end
 end

data/lib/whirled_peas/command_line.rb

@@ -0,0 +1,263 @@
+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_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
+
+      logger = self.class.build_logger(File.open('whirled_peas.log', 'a'))
+
+      consumer = Frame::EventLoop.new(
+        WhirledPeas.config.template_factory,
+        WhirledPeas.config.loading_template_factory,
+        logger: 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
+
+      Frame::Producer.produce(Frame::DebugConsumer.new) do |producer|
+        WhirledPeas.config.driver.start(producer)
+      end
+    end
+  end
+
+  class PlayFrameCommand < ConfigCommand
+    def start
+      super
+
+      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
+
+      logger = self.class.build_logger(File.open('whirled_peas.log', 'a'))
+
+      consumer = Frame::EventLoop.new(
+        WhirledPeas.config.template_factory,
+        logger: logger
+      )
+      Frame::Producer.produce(consumer, logger) do |producer|
+        producer.send_frame(frame, 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
+        @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
+      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
+
+      logger = self.class.build_logger(File.open('whirled_peas.log', 'a'))
+      consumer = Frame::EventLoop.new(
+        WhirledPeas.config.template_factory,
+        WhirledPeas.config.loading_template_factory,
+        logger: logger
+      )
+      Frame::Producer.produce(consumer, logger) { sleep(5) }
+    end
+
+    private
+
+    def print_usage
+      puts "Usage: #{$0} #{self.class.command_name} [--debug]"
+    end
+  end
+
+  class CommandLine
+    COMMANDS = [
+      StartCommand,
+      ListFramesCommand,
+      PlayFrameCommand,
+      LoadingCommand,
+      TitleFontsCommand
+    ].map.with_object({}) { |c, h| h[c.command_name] = c }
+
+    def initialize(args)
+      @args = args
+    end
+
+    def start
+      if args.length < 1
+        print_usage
+        exit(1)
+      end
+
+      command = args.shift
+
+      unless COMMANDS.key?(command)
+        puts "Unrecognized command: #{command}"
+        print_usage
+        exit(1)
+      end
+
+      cmd = COMMANDS[command].new(args)
+
+      unless cmd.valid?
+        cmd.print_error
+        exit(1)
+      end
+
+      cmd.start
+    end
+
+    private
+
+    attr_reader :args
+
+    def print_usage
+      puts "Usage: #{$0} <command> [command options]"
+      puts
+      puts "Available commands: #{COMMANDS.keys.join(', ')}"
+    end
+  end
+end

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/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