whirled_peas 0.4.1 → 0.8.0

data/Rakefile

@@ -1,6 +1,12 @@
-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
+task :screen_test do
+  require_relative 'tools/whirled_peas/tools/screen_tester'
+  WhirledPeas::Tools::ScreenTester.run_all
+end
+
+task ci: %i[spec screen_test]
+task default: :ci

data/bin/reset_cursor

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'whirled_peas'
+require 'whirled_peas/utils/ansi'
+
+module WhirledPeas
+  print Utils::Ansi.clear
+  print Utils::Ansi.cursor_visible(true)
+  STDOUT.flush
+end

data/bin/screen_test

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'whirled_peas'
+require 'whirled_peas/utils/formatted_string'
+
+require_relative '../tools/whirled_peas/tools/screen_tester'
+
+def print_usage(exit_code=0)
+  puts "Usage: #{$0} [file] [options]"
+  puts
+  puts 'If not file or options are provide, all tests are run'
+  puts
+  puts 'If no file is provided, the supported options are'
+  puts '    --help             print this usage statement and exit'
+  puts '    --view-pending     interactively display and optionally save rendered output for each pending test'
+  puts '    --view-failed      interactively display and optionally save rendered output for each faiing test'
+  puts
+  puts 'If a screen test file is provided as the first argument, the supported options are'
+  puts '    --run        run screen test for given file'
+  puts '    --view       interactively display and optionally save the file\'s test output'
+  puts '    --template   print out template tree for the test template'
+  puts '    --debug      render the test template without displying it, printing out debug information'
+  exit(exit_code)
+end
+
+module WhirledPeas
+  if ARGV.length == 0
+    Tools::ScreenTester.run_all
+  elsif ARGV.length == 1
+    option = ARGV[0]
+    case option
+    when '--help'
+      print_usage
+    when '--view-pending'
+      Tools::ScreenTester.view_pending
+    when '--view-failed'
+      Tools::ScreenTester.view_failed
+    else
+      print_usage(1)
+    end
+  elsif ARGV.length == 2
+    file, option = ARGV
+    case option
+    when '--run'
+      tester = Tools::ScreenTester.new(file)
+      if tester.pending?
+        puts Utils::FormattedString.new('Pending', Settings::TextColor::YELLOW)
+        puts "Run `#{$0} #{file} --view` to view and optionally save ouput."
+      elsif tester.failed?
+        puts Utils::FormattedString.new('Failed', Settings::TextColor::RED)
+        puts "Run `#{$0} #{file} --view` to compare and optionally save ouput."
+      else
+        puts Utils::FormattedString.new('Pass', Settings::TextColor::GREEN)
+      end
+    when '--view'
+      Tools::ScreenTester.new(file).view
+    when '--template'
+      Tools::ScreenTester.new(file).template
+    when '--debug'
+      Tools::ScreenTester.new(file).debug
+    else
+      print_usage(1)
+    end
+  else
+    print_usage(1)
+  end
+end

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 Application
+  def start(producer)
+    producer.add_frame('intro', duration: 5)
+  end
+end
+
+WhirledPeas.configure do |config|
+  config.template_factory = TemplateFactory.new
+  config.application = Application.new
+end

data/examples/scrolling.rb

@@ -0,0 +1,54 @@
+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 Application
+  def start(producer)
+    producer.frameset(5, easing: :bezier) do |fs|
+      53.times { |i| fs.add_frame('intro', { top: -i }) }
+    end
+    producer.add_frame('hold', duration: 1, args: { top: -52})
+  end
+end
+
+WhirledPeas.configure do |config|
+  config.template_factory = TemplateFactory.new
+  config.application = Application.new
+end

data/lib/whirled_peas.rb

@@ -1,11 +1,8 @@
-require 'logger'
-
-require 'whirled_peas/errors'
-
+require 'whirled_peas/animator'
 require 'whirled_peas/config'
-require 'whirled_peas/frame'
-require 'whirled_peas/template'
-require 'whirled_peas/ui'
+require 'whirled_peas/errors'
+require 'whirled_peas/graphics'
+require 'whirled_peas/settings'
 require 'whirled_peas/utils'
 require 'whirled_peas/version'
 
@@ -19,10 +16,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/animator.rb

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

data/lib/whirled_peas/animator/debug_consumer.rb

@@ -0,0 +1,17 @@
+module WhirledPeas
+  module Animator
+    class DebugConsumer
+      def add_frameset(frameset)
+        require 'json'
+
+        frameset.each_frame do |frame, args|
+          puts [frame, *(JSON.generate(args) unless args.empty?)].join(' ')
+        end
+      end
+
+      def process
+        # no op
+      end
+    end
+  end
+end

data/lib/whirled_peas/animator/easing.rb

@@ -0,0 +1,72 @@
+module WhirledPeas
+  module Animator
+    class Easing
+      # Implementations of available ease-in functions. Ease-out and ease-in-out can all be
+      # derived from ease-in.
+      EASING = {
+        bezier: proc do |value|
+          value /= 2
+          2 * value * value * (3 - 2 * value)
+        end,
+        linear: proc { |value| value },
+        parametric: proc do |value|
+          value /= 2
+          squared = value * value
+          2 * squared / (2 * (squared - value) + 1)
+        end,
+        quadratic: proc do |value|
+          value * value
+        end
+      }
+
+      EFFECTS = %i[in out in_out]
+
+      def initialize(easing=:linear, effect=:in_out)
+        unless EASING.key?(easing)
+          raise ArgumentError,
+                "Invalid easing function: #{easing}, expecting one of #{EASING.keys.join(', ')}"
+        end
+        unless EFFECTS.include?(effect)
+          raise ArgumentError,
+                "Invalid effect: #{effect}, expecting one of #{EFFECTS.join(', ')}"
+        end
+        @easing = easing
+        @effect = effect
+      end
+
+      def ease(value)
+        case effect
+        when :in
+          ease_in(value)
+        when :out
+          ease_out(value)
+        else
+          ease_in_out(value)
+        end
+      end
+
+      private
+
+      attr_reader :easing, :effect
+
+      # The procs in EASING define the ease-in functions, so we simply need
+      # to invoke the function with the given normalized value
+      def ease_in(value)
+        EASING[easing].call(value)
+      end
+
+      # The ease-out function will be the ease-in function rotated 180 degrees.
+      def ease_out(value)
+        1 - EASING[easing].call(1 - value)
+      end
+
+      def ease_in_out(value)
+        if value < 0.5
+          ease_in(value * 2) / 2
+        else
+          0.5 + ease_out(2 * value - 1) / 2
+        end
+      end
+    end
+  end
+end

data/lib/whirled_peas/animator/frame.rb

@@ -0,0 +1,5 @@
+module WhirledPeas
+  module Animator
+    Frame = Struct.new(:name, :args)
+  end
+end

data/lib/whirled_peas/animator/frameset.rb

@@ -0,0 +1,33 @@
+require_relative 'easing'
+require_relative 'frame'
+
+module WhirledPeas
+  module Animator
+    class Frameset
+      def initialize(frame_slots, easing, effect)
+        @frame_slots = frame_slots
+        @easing = Easing.new(easing, effect)
+        @frames = []
+      end
+
+      def add_frame(name, args={})
+        frames << [name, args]
+      end
+
+      # Yield each frame in an "eased" order
+      def each_frame(&block)
+        frame_slots.times do |i|
+          input = i.to_f / (frame_slots - 1)
+          eased_value = @easing.ease(input)
+          index = (eased_value * (frames.length - 1)).floor
+          yield *frames[index]
+        end
+      end
+
+      private
+
+      attr_reader :frame_slots, :easing, :frames
+    end
+    private_constant :Frameset
+  end
+end

data/lib/whirled_peas/animator/producer.rb

@@ -0,0 +1,35 @@
+require_relative 'easing'
+require_relative 'frameset'
+
+module WhirledPeas
+  module Animator
+    class Producer
+      def self.produce(consumer, refresh_rate)
+        producer = new(consumer, refresh_rate)
+        yield producer
+        consumer.process
+      end
+
+      def initialize(consumer, refresh_rate)
+        @consumer = consumer
+        @refresh_rate = refresh_rate
+      end
+
+      def add_frame(name, duration: nil, args: {})
+        frameset(duration || 1 / refresh_rate) do |fs|
+          fs.add_frame(name, args)
+        end
+      end
+
+      def frameset(duration, easing: :linear, effect: :in_out, &block)
+        fs = Frameset.new((duration * refresh_rate).round, easing, effect)
+        yield fs
+        consumer.add_frameset(fs)
+      end
+
+      private
+
+      attr_reader :consumer, :refresh_rate
+    end
+  end
+end

data/lib/whirled_peas/animator/renderer_consumer.rb

@@ -0,0 +1,31 @@
+require 'whirled_peas/graphics/renderer'
+require 'whirled_peas/utils/ansi'
+
+module WhirledPeas
+  module Animator
+    class RendererConsumer
+      def initialize(template_factory, device, width, height)
+        @template_factory = template_factory
+        @device = device
+        @width = width
+        @height = height
+        @renders = []
+      end
+
+      def add_frameset(frameset)
+        frameset.each_frame do |frame, args|
+          template = template_factory.build(frame, args)
+          renders << Graphics::Renderer.new(template, width, height).paint
+        end
+      end
+
+      def process
+        device.handle_renders(renders)
+      end
+
+      private
+
+      attr_reader :template_factory, :device, :width, :height, :renders
+    end
+  end
+end

data/lib/whirled_peas/command.rb

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