whirled_peas 0.5.0 → 0.9.0

data/Rakefile

@@ -3,38 +3,10 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(: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
+  require_relative 'tools/whirled_peas/tools/screen_tester'
+  WhirledPeas::Tools::ScreenTester.run_all
 end
 
-task default: [:screen_test, :spec]
+task ci: %i[spec screen_test]
+task default: :ci

data/bin/easing

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'whirled_peas'
+require 'whirled_peas/animator/easing'
+
+module WhirledPeas
+  NUM_POINTS = 60
+
+  Animator::Easing::EASING.keys.each do |func|
+    Animator::Easing::EFFECTS.each do |effect|
+      easing = Animator::Easing.new(func, effect)
+      graph = Array.new(NUM_POINTS / ASPECT_RATIO) { '┃' }
+      NUM_POINTS.times.each do |i|
+        input = i.to_f / (NUM_POINTS - 1)
+        eased_value = ((easing.ease(input) * NUM_POINTS * 2) / ASPECT_RATIO).floor
+        graph.each.with_index do |row, row_num|
+          y_value = NUM_POINTS.to_f / ASPECT_RATIO - row_num - 1
+          row << if eased_value == 2 * y_value
+            '▄'
+          elsif eased_value == 2 * y_value + 1
+            '▀'
+          else
+            ' '
+          end
+        end
+      end
+      graph << '┗' + '━' * NUM_POINTS
+      puts "#{func} (#{effect})"
+      puts graph.join("\n")
+    end
+  end
+end

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/graph.rb

@@ -0,0 +1,54 @@
+require 'bundler/setup'
+require 'whirled_peas'
+require 'whirled_peas/animator/easing'
+
+module WhirledPeas
+  PublicEasing = Animator::Easing
+end
+
+class TemplateFactory
+  INNER_WIDTH = 60
+
+  def build(name, args)
+    WhirledPeas.template do |composer, settings|
+      settings.bg_color = :bright_white
+      settings.align = :center
+      settings.valign = :middle
+      composer.add_grid do |composer, settings|
+        settings.num_cols = 2
+        WhirledPeas::PublicEasing::EASING.keys.each do |func|
+          easing = WhirledPeas::PublicEasing.new(func, :in_out)
+          composer.add_box do |composer, settings|
+            settings.flow = :t2b
+            settings.set_padding(horiz: 4, vert: 2)
+            composer.add_box do |_, settings|
+              settings.margin.bottom = 1
+              settings.color = :blue
+              settings.underline = true
+              "#{func} (in_out)"
+            end
+            composer.add_graph do |composer, settings|
+              settings.axis_color = :black
+              settings.color = :bright_blue
+              settings.height = 15
+              INNER_WIDTH.times.map do |i|
+                easing.ease(i.to_f / (INNER_WIDTH - 1))
+              end
+            end
+          end
+        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/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', args: { 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,12 +1,8 @@
-require 'logger'
-
-require 'whirled_peas/errors'
+require 'whirled_peas/animator'
 require 'whirled_peas/config'
-require 'whirled_peas/debugger'
-require 'whirled_peas/frame'
+require 'whirled_peas/errors'
 require 'whirled_peas/graphics'
 require 'whirled_peas/settings'
-require 'whirled_peas/template'
 require 'whirled_peas/utils'
 require 'whirled_peas/version'
 
@@ -19,12 +15,8 @@ module WhirledPeas
     yield config
   end
 
-  def self.debug(config_file, option=nil)
-    Debugger.new(config_file, option).debug
-  end
-
   def self.template(&block)
-    require 'whirled_peas/template/composer'
-    Template::Composer.build(&block)
+    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