whirled_peas 0.4.1 → 0.8.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whirled_peas
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Tom Collier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -70,30 +70,228 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/reset_cursor
+- bin/screen_test
 - bin/setup
-- bin/title_fonts
+- examples/intro.rb
+- examples/scrolling.rb
 - exe/whirled_peas
 - lib/whirled_peas.rb
+- lib/whirled_peas/animator.rb
+- lib/whirled_peas/animator/debug_consumer.rb
+- lib/whirled_peas/animator/easing.rb
+- lib/whirled_peas/animator/frame.rb
+- lib/whirled_peas/animator/frameset.rb
+- lib/whirled_peas/animator/producer.rb
+- lib/whirled_peas/animator/renderer_consumer.rb
+- lib/whirled_peas/command.rb
+- lib/whirled_peas/command/base.rb
+- lib/whirled_peas/command/config_command.rb
+- lib/whirled_peas/command/debug.rb
+- lib/whirled_peas/command/fonts.rb
+- lib/whirled_peas/command/frame_command.rb
+- lib/whirled_peas/command/frames.rb
+- lib/whirled_peas/command/help.rb
+- lib/whirled_peas/command/play.rb
+- lib/whirled_peas/command/record.rb
+- lib/whirled_peas/command/still.rb
 - lib/whirled_peas/command_line.rb
 - lib/whirled_peas/config.rb
+- lib/whirled_peas/device.rb
+- lib/whirled_peas/device/null_device.rb
+- lib/whirled_peas/device/output_file.rb
+- lib/whirled_peas/device/screen.rb
 - lib/whirled_peas/errors.rb
-- lib/whirled_peas/frame.rb
-- lib/whirled_peas/frame/event_loop.rb
-- lib/whirled_peas/frame/print_consumer.rb
-- lib/whirled_peas/frame/producer.rb
+- lib/whirled_peas/graphics.rb
+- lib/whirled_peas/graphics/box_painter.rb
+- lib/whirled_peas/graphics/canvas.rb
+- lib/whirled_peas/graphics/composer.rb
+- lib/whirled_peas/graphics/container_coords.rb
+- lib/whirled_peas/graphics/container_dimensions.rb
+- lib/whirled_peas/graphics/container_painter.rb
+- lib/whirled_peas/graphics/debugger.rb
+- lib/whirled_peas/graphics/grid_painter.rb
+- lib/whirled_peas/graphics/mock_screen.rb
+- lib/whirled_peas/graphics/painter.rb
+- lib/whirled_peas/graphics/renderer.rb
+- lib/whirled_peas/graphics/text_dimensions.rb
+- lib/whirled_peas/graphics/text_painter.rb
 - lib/whirled_peas/null_logger.rb
-- lib/whirled_peas/template.rb
-- lib/whirled_peas/template/element.rb
-- lib/whirled_peas/template/settings.rb
-- lib/whirled_peas/ui.rb
-- lib/whirled_peas/ui/canvas.rb
-- lib/whirled_peas/ui/painter.rb
-- lib/whirled_peas/ui/screen.rb
+- lib/whirled_peas/settings.rb
+- lib/whirled_peas/settings/alignment.rb
+- lib/whirled_peas/settings/bg_color.rb
+- lib/whirled_peas/settings/border.rb
+- lib/whirled_peas/settings/box_settings.rb
+- lib/whirled_peas/settings/color.rb
+- lib/whirled_peas/settings/container_settings.rb
+- lib/whirled_peas/settings/debugger.rb
+- lib/whirled_peas/settings/display_flow.rb
+- lib/whirled_peas/settings/element_settings.rb
+- lib/whirled_peas/settings/grid_settings.rb
+- lib/whirled_peas/settings/margin.rb
+- lib/whirled_peas/settings/padding.rb
+- lib/whirled_peas/settings/position.rb
+- lib/whirled_peas/settings/scrollbar.rb
+- lib/whirled_peas/settings/sizing.rb
+- lib/whirled_peas/settings/spacing.rb
+- lib/whirled_peas/settings/text_color.rb
+- lib/whirled_peas/settings/text_settings.rb
+- lib/whirled_peas/settings/vert_alignment.rb
 - lib/whirled_peas/utils.rb
 - lib/whirled_peas/utils/ansi.rb
-- lib/whirled_peas/utils/color.rb
+- lib/whirled_peas/utils/file_handler.rb
+- lib/whirled_peas/utils/formatted_string.rb
 - lib/whirled_peas/utils/title_font.rb
 - lib/whirled_peas/version.rb
+- screen_test/elements/box.frame
+- screen_test/elements/box.rb
+- screen_test/elements/grid.frame
+- screen_test/elements/grid.rb
+- screen_test/elements/screen_overflow_x.frame
+- screen_test/elements/screen_overflow_x.rb
+- screen_test/elements/screen_overflow_y.frame
+- screen_test/elements/screen_overflow_y.rb
+- screen_test/elements/text.frame
+- screen_test/elements/text.rb
+- screen_test/elements/text_multiline.frame
+- screen_test/elements/text_multiline.rb
+- screen_test/settings/align/box_around.frame
+- screen_test/settings/align/box_around.rb
+- screen_test/settings/align/box_between.frame
+- screen_test/settings/align/box_between.rb
+- screen_test/settings/align/box_center.frame
+- screen_test/settings/align/box_center.rb
+- screen_test/settings/align/box_default.frame
+- screen_test/settings/align/box_default.rb
+- screen_test/settings/align/box_evenly.frame
+- screen_test/settings/align/box_evenly.rb
+- screen_test/settings/align/box_left.frame
+- screen_test/settings/align/box_left.rb
+- screen_test/settings/align/box_right.frame
+- screen_test/settings/align/box_right.rb
+- screen_test/settings/align/children_center.frame
+- screen_test/settings/align/children_center.rb
+- screen_test/settings/align/children_left.frame
+- screen_test/settings/align/children_left.rb
+- screen_test/settings/align/children_right.frame
+- screen_test/settings/align/children_right.rb
+- screen_test/settings/align/grid_center.frame
+- screen_test/settings/align/grid_center.rb
+- screen_test/settings/align/grid_default.frame
+- screen_test/settings/align/grid_default.rb
+- screen_test/settings/align/grid_left.frame
+- screen_test/settings/align/grid_left.rb
+- screen_test/settings/align/grid_right.frame
+- screen_test/settings/align/grid_right.rb
+- screen_test/settings/ansi/bold.frame
+- screen_test/settings/ansi/bold.rb
+- screen_test/settings/ansi/color.frame
+- screen_test/settings/ansi/color.rb
+- screen_test/settings/ansi/underline.frame
+- screen_test/settings/ansi/underline.rb
+- screen_test/settings/border.frame
+- screen_test/settings/border.rb
+- screen_test/settings/flow/box_b2t.frame
+- screen_test/settings/flow/box_b2t.rb
+- screen_test/settings/flow/box_l2r.frame
+- screen_test/settings/flow/box_l2r.rb
+- screen_test/settings/flow/box_r2l.frame
+- screen_test/settings/flow/box_r2l.rb
+- screen_test/settings/flow/box_t2b.frame
+- screen_test/settings/flow/box_t2b.rb
+- screen_test/settings/flow/grid_b2t.frame
+- screen_test/settings/flow/grid_b2t.rb
+- screen_test/settings/flow/grid_l2r.frame
+- screen_test/settings/flow/grid_l2r.rb
+- screen_test/settings/flow/grid_r2l.frame
+- screen_test/settings/flow/grid_r2l.rb
+- screen_test/settings/flow/grid_t2b.frame
+- screen_test/settings/flow/grid_t2b.rb
+- screen_test/settings/height/box.frame
+- screen_test/settings/height/box.rb
+- screen_test/settings/height/box_border_sizing.frame
+- screen_test/settings/height/box_border_sizing.rb
+- screen_test/settings/height/grid.frame
+- screen_test/settings/height/grid.rb
+- screen_test/settings/height/overflow_box.frame
+- screen_test/settings/height/overflow_box.rb
+- screen_test/settings/height/overflow_box_l2r.frame
+- screen_test/settings/height/overflow_box_l2r.rb
+- screen_test/settings/height/overflow_box_t2b.frame
+- screen_test/settings/height/overflow_box_t2b.rb
+- screen_test/settings/height/overflow_grid.frame
+- screen_test/settings/height/overflow_grid.rb
+- screen_test/settings/margin.frame
+- screen_test/settings/margin.rb
+- screen_test/settings/padding.frame
+- screen_test/settings/padding.rb
+- screen_test/settings/position/box_left.frame
+- screen_test/settings/position/box_left.rb
+- screen_test/settings/position/box_left_negative.frame
+- screen_test/settings/position/box_left_negative.rb
+- screen_test/settings/position/box_top.frame
+- screen_test/settings/position/box_top.rb
+- screen_test/settings/position/box_top_negative.frame
+- screen_test/settings/position/box_top_negative.rb
+- screen_test/settings/position/grid_left.frame
+- screen_test/settings/position/grid_left.rb
+- screen_test/settings/position/grid_left_negative.frame
+- screen_test/settings/position/grid_left_negative.rb
+- screen_test/settings/position/grid_top.frame
+- screen_test/settings/position/grid_top.rb
+- screen_test/settings/position/grid_top_negative.frame
+- screen_test/settings/position/grid_top_negative.rb
+- screen_test/settings/scroll/horiz_box.frame
+- screen_test/settings/scroll/horiz_box.rb
+- screen_test/settings/scroll/horiz_box_align_center.rb
+- screen_test/settings/scroll/horiz_box_align_right.rb
+- screen_test/settings/scroll/vert_box.frame
+- screen_test/settings/scroll/vert_box.rb
+- screen_test/settings/title_font.frame
+- screen_test/settings/title_font.rb
+- screen_test/settings/valign/box_around.frame
+- screen_test/settings/valign/box_around.rb
+- screen_test/settings/valign/box_between.frame
+- screen_test/settings/valign/box_between.rb
+- screen_test/settings/valign/box_bottom.frame
+- screen_test/settings/valign/box_bottom.rb
+- screen_test/settings/valign/box_default.frame
+- screen_test/settings/valign/box_default.rb
+- screen_test/settings/valign/box_evenly.frame
+- screen_test/settings/valign/box_evenly.rb
+- screen_test/settings/valign/box_middle.frame
+- screen_test/settings/valign/box_middle.rb
+- screen_test/settings/valign/box_top.frame
+- screen_test/settings/valign/box_top.rb
+- screen_test/settings/valign/grid_bottom.frame
+- screen_test/settings/valign/grid_bottom.rb
+- screen_test/settings/valign/grid_default.frame
+- screen_test/settings/valign/grid_default.rb
+- screen_test/settings/valign/grid_middle.frame
+- screen_test/settings/valign/grid_middle.rb
+- screen_test/settings/valign/grid_top.frame
+- screen_test/settings/valign/grid_top.rb
+- screen_test/settings/width/box_border_sizing.frame
+- screen_test/settings/width/box_border_sizing.rb
+- screen_test/settings/width/box_content.frame
+- screen_test/settings/width/box_content.rb
+- screen_test/settings/width/box_default.frame
+- screen_test/settings/width/box_default.rb
+- screen_test/settings/width/grid.frame
+- screen_test/settings/width/grid.rb
+- screen_test/settings/width/overflow_align_center.frame
+- screen_test/settings/width/overflow_align_center.rb
+- screen_test/settings/width/overflow_align_right.frame
+- screen_test/settings/width/overflow_align_right.rb
+- screen_test/settings/width/overflow_box.frame
+- screen_test/settings/width/overflow_box.rb
+- screen_test/settings/width/overflow_box_l2r.frame
+- screen_test/settings/width/overflow_box_l2r.rb
+- screen_test/settings/width/overflow_box_t2b.frame
+- screen_test/settings/width/overflow_box_t2b.rb
+- screen_test/settings/width/overflow_grid.frame
+- screen_test/settings/width/overflow_grid.rb
+- tools/whirled_peas/tools/screen_tester.rb
 - whirled_peas.gemspec
 homepage: https://github.com/tcollier/whirled_peas
 licenses:

data/bin/title_fonts

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'whirled_peas'
-
-WhirledPeas.print_title_fonts

data/lib/whirled_peas/frame.rb

@@ -1,7 +0,0 @@
-module WhirledPeas
-  module Frame
-    EOF = '__EOF__'
-  end
-
-  private_constant :Frame
-end

data/lib/whirled_peas/frame/event_loop.rb

@@ -1,91 +0,0 @@
-require_relative '../null_logger'
-require_relative '../ui/screen'
-
-module WhirledPeas
-  module Frame
-    class EventLoop
-      LOGGER_ID = 'EVENT LOOP'
-
-      def initialize(template_factory, loading_template_factory, refresh_rate, logger=NullLogger.new)
-        @template_factory = template_factory
-        @loading_template_factory = loading_template_factory
-        @queue = Queue.new
-        @frame_duration = 1.0 / refresh_rate
-        @logger = logger
-      end
-
-      def enqueue(name, duration, args)
-        # If duration is nil, set it to the duration of a single frame
-        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)
-      rescue
-        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
-      end
-
-      private
-
-      attr_reader :template_factory, :loading_template_factory, :queue, :frame_duration, :logger
-
-      def wait_for_content(screen)
-        if loading_template_factory
-          play_loading_screen(screen)
-        else
-          sleep(frame_duration) while queue.empty?
-        end
-      end
-
-      def play_loading_screen(screen)
-        while queue.empty?
-          screen.paint(loading_template_factory.build)
-          sleep(frame_duration)
-        end
-      end
-
-      def play_content(screen)
-        @running = true
-        template = nil
-        frame_until = Time.new(0)  # Tell the loop to immediately pick up a new frame
-        while running?
-          frame_start = Time.now
-          next_frame_at = frame_start + frame_duration
-          if frame_until > frame_start
-            # While we're still displaying the previous frame, refresh the screen
-            screen.refresh
-          elsif !queue.empty?
-            name, duration, args = queue.pop
-            if name == Frame::EOF
-              @running = false
-            else
-              frame_until = frame_start + duration
-              template = template_factory.build(name, args)
-              screen.paint(template)
-            end
-          else
-            wait_for_content(screen)
-          end
-          sleep([0, next_frame_at - Time.now].max)
-        end
-      end
-    end
-  end
-end

data/lib/whirled_peas/frame/print_consumer.rb

@@ -1,33 +0,0 @@
-require_relative '../null_logger'
-
-module WhirledPeas
-  module Frame
-    class PrintConsumer
-      LOGGER_ID = 'EVENT LOOP'
-
-      def initialize(logger=NullLogger.new)
-        @logger = logger
-      end
-
-      def enqueue(name, duration, args)
-        if name == Frame::EOF
-          puts "EOF frame detected"
-        else
-          displayed_for = duration ? "#{duration} second(s)" : '1 frame'
-          args_str = args.empty? ? '' : " (#{args.inspect})"
-          puts "Frame '#{name}' displayed for #{displayed_for}#{args_str}"
-        end
-      end
-
-      def start
-      end
-
-      def stop
-      end
-
-      private
-
-      attr_reader :logger
-    end
-  end
-end

data/lib/whirled_peas/frame/producer.rb

@@ -1,61 +0,0 @@
-require 'socket'
-require 'json'
-
-require_relative '../null_logger'
-
-module WhirledPeas
-  module Frame
-    class Producer
-      LOGGER_ID = 'PRODUCER'
-
-      # Manages the EventLoop lifecycle and yields a Producer to send frames to the
-      # EventLoop
-      def self.produce(consumer, logger=NullLogger.new)
-        producer = new(consumer, logger)
-        consumer_thread = Thread.new do
-          Thread.current.report_on_exception = false
-          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_thread.join if consumer_thread
-      end
-
-      def initialize(consumer, logger=NullLogger.new)
-        @consumer = consumer
-        @logger = logger
-        @queue = Queue.new
-      end
-
-      # Buffer a frame to be played for the given duration. `#flush` must be called
-      # for frames to get pushed to the EventLoop.
-      #
-      # @param name [String] name of frame, which is passed to #build of the
-      #   TemplateFactory
-      # @param duration [Float|Integer] duration in seconds the frame should be,
-      #   displayed (default is nil, which results in a duration of a single refresh
-      #   cycle)
-      # @param args [Hash] key/value pair of arguments, which is passed to #build of
-      #   the TemplateFactory
-      def send_frame(name, duration: nil, args: {})
-        queue.push([name, duration, args])
-      end
-
-      # Send any buffered frames to the EventLoop
-      def flush
-        consumer.enqueue(*queue.pop) while !queue.empty?
-      end
-
-      private
-
-      attr_reader :consumer, :logger, :queue
-    end
-  end
-end