whirled_peas 0.7.1 → 0.8.0

data/examples/intro.rb

@@ -40,13 +40,13 @@ class TemplateFactory
   end
 end
 
-class Driver
+class Application
   def start(producer)
-    producer.send_frame('intro', duration: 5)
+    producer.add_frame('intro', duration: 5)
   end
 end
 
 WhirledPeas.configure do |config|
   config.template_factory = TemplateFactory.new
-  config.driver = Driver.new
+  config.application = Application.new
 end

data/examples/scrolling.rb

@@ -39,15 +39,16 @@ class TemplateFactory
   end
 end
 
-class Driver
+class Application
   def start(producer)
-    53.times do |i|
-      producer.send_frame('intro', duration: 0.3, args: { top: -i })
+    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.driver = Driver.new
+  config.application = Application.new
 end

data/lib/whirled_peas.rb

@@ -1,8 +1,6 @@
-require 'logger'
-
-require 'whirled_peas/errors'
+require 'whirled_peas/animator'
 require 'whirled_peas/config'
-require 'whirled_peas/frame'
+require 'whirled_peas/errors'
 require 'whirled_peas/graphics'
 require 'whirled_peas/settings'
 require 'whirled_peas/utils'

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

data/lib/whirled_peas/command/base.rb

@@ -0,0 +1,86 @@
+module WhirledPeas
+  module Command
+    # Abstract base class for all commands
+    class Base
+      # Returns the name of the command as expected by the command line script. By convention,
+      # this name is snake case version of the class name, e.g. the command `do_something`
+      # would be implemented by `WhirledPeas::Command::DoSomething`, which needs to inherit
+      # from this class.
+      def self.command_name
+        name.split('::').last.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
+      end
+
+      def self.description
+      end
+
+      def self.print_usage
+        puts description
+      end
+
+      attr_reader :args
+
+      def initialize(args, config)
+        @args = args
+        @config = config
+      end
+
+      # Returns the name of the command as expected by the command line script. By convention,
+      # this name is snake case version of the class name, e.g. the command `do_something`
+      # would be implemented by `WhirledPeas::Command::DoSomething`, which needs to inherit
+      # from this class.
+      def command_name
+        self.class.command_name
+      end
+
+      def build_logger
+        require 'logger'
+
+        if config.log_file.is_a?(IO)
+          output = config.log_file
+        else
+          File.open(config.log_file, 'a')
+        end
+
+        logger = Logger.new(output)
+        logger.level = config.log_level
+        logger.formatter = config.log_formatter
+        logger
+      end
+
+      # @return [true|false] true if all of the required options were provided
+      def valid?
+        @error_text = nil
+        validate!
+        @error_text.nil?
+      end
+
+      # Display the validation error and print a usage statement
+      def print_error
+        puts @error_text if @error_text
+        print_usage
+      end
+
+      # Commands that inherit from this class must override this method
+      def start
+      end
+
+      private
+
+      attr_reader :config
+
+      def print_usage
+        puts ["Usage: #{$0} #{command_name}", *options_usage].join(' ')
+      end
+
+      # Commands that inherit from this class can override this method to validate
+      # command line options
+      def validate!
+        # Set @error_text if the options are not valid
+      end
+
+      def options_usage
+      end
+    end
+    private_constant :Base
+  end
+end

data/lib/whirled_peas/command/config_command.rb

@@ -0,0 +1,44 @@
+require_relative 'base'
+
+module WhirledPeas
+  module Command
+    # Abstract command that expects a config file as an argument and then requires the
+    # specified file. All implementing classes must call `super` if they override `start`
+    # or `validate!`
+    class ConfigCommand < Base
+      def start
+        require config_file
+      rescue => e
+        puts "Error loading #{config_file}"
+        puts e.message
+        exit(1)
+      end
+
+      private
+
+      attr_reader :config_file
+
+      def validate!
+        super
+        # Note that the main script consumes the <command> argument from ARGV, so we
+        # expect the config file to be at index 0.
+        config_file = args.shift
+        if config_file.nil?
+          @error_text = "#{command_name} requires a config file"
+        elsif !File.exist?(config_file)
+          @error_text = "File not found: #{config_file}"
+        elsif config_file[-3..-1] != '.rb'
+          @error_text = 'Config file should be a .rb file'
+        else
+          # We think we have a valid ruby config file, set the absolute path to @config
+          @config_file = config_file[0] == '/' ? config_file : File.join(Dir.pwd, config_file)
+        end
+      end
+
+      def options_usage
+        '<config file>'
+      end
+    end
+    private_constant :ConfigCommand
+  end
+end

data/lib/whirled_peas/command/debug.rb

@@ -0,0 +1,21 @@
+require_relative 'frame_command'
+
+module WhirledPeas
+  module Command
+    # Display the template tree for a single frame with the specified arguments.
+    class Debug < FrameCommand
+      def self.description
+        'Print template tree for specified frame'
+      end
+
+      def start
+        super
+
+        require 'whirled_peas/graphics/debugger'
+
+        template = config.template_factory.build(frame, frame_args)
+        puts Graphics::Debugger.new(template).debug
+      end
+    end
+  end
+end

data/lib/whirled_peas/command/fonts.rb

@@ -0,0 +1,22 @@
+require_relative 'base'
+
+module WhirledPeas
+  module Command
+    # List title fonts installed on the user's system and print sample text in each.
+    class Fonts < Base
+      def self.description
+        'List installed title fonts with sample text'
+      end
+
+      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
+  end
+end

data/lib/whirled_peas/command/frame_command.rb

@@ -0,0 +1,34 @@
+require_relative 'config_command'
+
+module WhirledPeas
+  module Command
+    class FrameCommand < ConfigCommand
+      private
+
+      attr_reader :frame, :frame_args
+
+      def validate!
+        super
+        frame = args.shift
+        raw_args = args.shift
+        if frame.nil?
+          @error_text = "#{command_name} requires a frame name"
+        else
+          @frame = frame
+          @frame_args = {}
+          return if raw_args.nil?
+
+          require 'json'
+
+          JSON.parse(raw_args || '{}').each do |key, value|
+            @frame_args[key.to_sym] = value
+          end
+        end
+      end
+
+      def options_usage
+        "#{super} <frame> [args as a JSON string]"
+      end
+    end
+  end
+end