whirled_peas 0.3.0 → 0.7.0

data/Rakefile

@@ -1,6 +1,31 @@
-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_relative 'tools/whirled_peas/tools/screen_tester'
+  WhirledPeas::Tools::ScreenTester.new(file).send(method)
+end
+
+namespace :screen_test do
+  %i[template view run save update debug].each do |t|
+    task t, [:file] do |_, args|
+      screen_test(args[:file], t)
+    end
+  end
+
+  task :update_all do
+    require_relative 'tools/whirled_peas/tools/screen_tester'
+    WhirledPeas::Tools::ScreenTester.update_all
+  end
+end
+
+task :screen_test do
+  require_relative 'tools/whirled_peas/tools/screen_tester'
+  WhirledPeas::Tools::ScreenTester.run_all
+end
+
+task default: :ci
+task ci: %i[spec screen_test]

data/examples/intro.rb

@@ -0,0 +1,52 @@
+require 'bundler/setup'
+require 'whirled_peas'
+
+class TemplateFactory
+  TITLE_FONT = :default #roman
+  PRIMARY_COLOR = :bright_blue
+  SECONDARY_COLOR = :blue
+  BG_COLOR = :bright_white
+
+  def build(name, args)
+    WhirledPeas.template do |composer, settings|
+      settings.set_padding(left: 10, top: 6, right: 10, bottom: 6)
+      settings.align = :center
+      settings.width = 120
+      settings.flow = :t2b
+      settings.bold = true
+      settings.bg_color = BG_COLOR
+
+      composer.add_box do |composer, settings|
+        composer.add_text do |_, settings|
+          settings.title_font = TITLE_FONT
+          settings.color = PRIMARY_COLOR
+          'Visualize'
+        end
+      end
+      composer.add_box do |_, settings|
+        settings.set_margin(top: 1)
+        settings.color = SECONDARY_COLOR
+        "your code's execution with"
+      end
+      composer.add_box do |composer, settings|
+        settings.set_margin(top: 1)
+        composer.add_text do |_, settings|
+          settings.title_font = TITLE_FONT
+          settings.color = PRIMARY_COLOR
+          'Whirled Peas'
+        end
+      end
+    end
+  end
+end
+
+class Driver
+  def start(producer)
+    producer.send_frame('intro', duration: 5)
+  end
+end
+
+WhirledPeas.configure do |config|
+  config.template_factory = TemplateFactory.new
+  config.driver = Driver.new
+end

data/examples/scrolling.rb

@@ -0,0 +1,53 @@
+require 'bundler/setup'
+require 'whirled_peas'
+
+class TemplateFactory
+  HPADDING = 0
+  VPADDING = 0
+  ITEM_COUNT = 64
+
+  def build(name, args)
+    top = args[:top]
+    WhirledPeas.template do |composer, settings|
+      settings.color = :green
+      composer.add_box('Vert') do |composer, settings|
+        settings.bg_color = :bright_red
+        settings.full_border(color: :blue)
+        settings.set_scrollbar(vert: true)
+        settings.height = 12
+        composer.add_box('Inner') do |composer, settings|
+          settings.flow = :t2b
+          settings.set_padding(left: HPADDING, right: HPADDING, top: VPADDING, bottom: VPADDING)
+          settings.set_position(top: top)
+          ITEM_COUNT.times do |i|
+            composer.add_text { "%2d" % i }
+          end
+        end
+      end
+      composer.add_box('Horiz') do |composer, settings|
+        settings.bg_color = :bright_red
+        settings.full_border(color: :blue)
+        settings.set_padding(left: HPADDING, right: HPADDING, top: VPADDING, bottom: VPADDING)
+        settings.set_scrollbar(horiz: true)
+        settings.width = 12
+        composer.add_box('Inner') do |composer, settings|
+          settings.set_position(left: top)
+          ITEM_COUNT.times.map { |i| (i % 10).to_s }.join
+        end
+      end
+    end
+  end
+end
+
+class Driver
+  def start(producer)
+    53.times do |i|
+      producer.send_frame('intro', duration: 0.3, args: { top: -i })
+    end
+  end
+end
+
+WhirledPeas.configure do |config|
+  config.template_factory = TemplateFactory.new
+  config.driver = Driver.new
+end

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,48 +1,24 @@
 require 'logger'
 
+require 'whirled_peas/errors'
+require 'whirled_peas/config'
 require 'whirled_peas/frame'
-require 'whirled_peas/ui'
+require 'whirled_peas/graphics'
+require 'whirled_peas/settings'
+require 'whirled_peas/utils'
 require 'whirled_peas/version'
 
 module WhirledPeas
-  class Error < StandardError; end
-
-  DEFAULT_REFRESH_RATE = 30
-
-  LOGGER_ID = 'MAIN'
-
-  def self.start(driver, template_factory, log_level: Logger::INFO, refresh_rate: DEFAULT_REFRESH_RATE)
-    logger = Logger.new(File.open('whirled_peas.log', 'a'))
-    logger.level = log_level
-    logger.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
-
-    event_loop = Frame::EventLoop.new(template_factory, refresh_rate, logger)
-    event_loop_thread = Thread.new do
-      Thread.current.report_on_exception = false
-      event_loop.start
-    end
-
-    Frame::Producer.produce(event_loop: event_loop, logger: logger) do |producer|
-      begin
-        driver.start(producer)
-      rescue => e
-        logger.warn(LOGGER_ID) { 'Driver exited with error, terminating producer...' }
-        logger.error(LOGGER_ID) { e }
-        raise
-      end
-    end
+  def self.config
+    @config ||= Config.new
+  end
 
-    event_loop_thread.join
+  def self.configure(&block)
+    yield config
   end
 
   def self.template(&block)
-    template = UI::Template.new
-    yield template, template.settings
-    template
+    require 'whirled_peas/graphics/composer'
+    Graphics::Composer.build(&block)
   end
 end

data/lib/whirled_peas/command_line.rb

@@ -0,0 +1,255 @@
+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'
+
+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'
+        template = WhirledPeas.config.template_factory.build(frame, frame_args)
+        puts Graphics::Debugger.new(template).debug
+      else
+        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
+    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] [--template]"
+    end
+  end
+
+  class LoadingCommand < ConfigCommand
+    def start
+      super
+      unless WhirledPeas.config.loading_template_factory
+        puts 'No loading screen configured'
+        exit(1)
+      end
+
+      if args.last == '--template'
+        template = WhirledPeas.config.loading_template_factory.build
+        puts Graphics::Debugger.new(template).debug
+      else
+        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
+    end
+
+    private
+
+    def print_usage
+      puts "Usage: #{$0} #{self.class.command_name} [--template]"
+    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