whirled_peas 0.4.0 → 0.7.1

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/lib/whirled_peas.rb

@@ -1,11 +1,10 @@
 require 'logger'
 
 require 'whirled_peas/errors'
-
 require 'whirled_peas/config'
 require 'whirled_peas/frame'
-require 'whirled_peas/template'
-require 'whirled_peas/ui'
+require 'whirled_peas/graphics'
+require 'whirled_peas/settings'
 require 'whirled_peas/utils'
 require 'whirled_peas/version'
 
@@ -19,10 +18,7 @@ module WhirledPeas
   end
 
   def self.template(&block)
-    require 'whirled_peas/template/element'
-
-    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

@@ -1,7 +1,14 @@
+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_REFRESH_RATE = 30
-
     DEFAULT_LOG_LEVEL = Logger::INFO
     DEFAULT_FORMATTER = proc do |severity, datetime, progname, msg|
       if msg.is_a?(Exception)
@@ -66,11 +73,13 @@ module WhirledPeas
 
   class ConfigCommand < Command
     def start
-      require args[0]
+      require config
     end
 
     private
 
+    attr_reader :config
+
     def validate!
       if args.length == 0
         @error_text = "#{self.class.command_name} requires a config file"
@@ -78,6 +87,8 @@ module WhirledPeas
         @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
 
@@ -91,16 +102,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
@@ -117,18 +125,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
@@ -137,24 +136,18 @@ module WhirledPeas
     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)
+      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
 
@@ -169,9 +162,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
@@ -179,7 +172,7 @@ module WhirledPeas
     end
 
     def print_usage
-      puts "Usage: #{$0} #{self.class.command_name} <config file> <frame> [args as a JSON string] [--debug]"
+      puts "Usage: #{$0} #{self.class.command_name} <config file> <frame> [args as a JSON string] [--template]"
     end
   end
 
@@ -188,31 +181,27 @@ module WhirledPeas
       super
       unless WhirledPeas.config.loading_template_factory
         puts 'No loading screen configured'
-        exit
+        exit(1)
       end
 
-      if args.last == '--debug'
-        puts WhirledPeas.config.loading_template_factory.build.inspect
-        exit
+      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
-
-      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]"
+      puts "Usage: #{$0} #{self.class.command_name} [--template]"
     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/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)
+        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...' }
-        @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