whirled_peas 0.4.1 → 0.8.0

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

data/lib/whirled_peas/command/frames.rb

@@ -0,0 +1,24 @@
+require_relative 'config_command'
+
+module WhirledPeas
+  module Command
+    class Frames < ConfigCommand
+      def self.description
+        'Print out list of frames generated by application'
+      end
+
+      def start
+        super
+
+        require 'whirled_peas/animator/debug_consumer'
+        require 'whirled_peas/animator/producer'
+
+        Animator::Producer.produce(
+          Animator::DebugConsumer.new, WhirledPeas.config.refresh_rate
+        ) do |producer|
+          config.application.start(producer)
+        end
+      end
+    end
+  end
+end

data/lib/whirled_peas/command/help.rb

@@ -0,0 +1,38 @@
+require_relative 'base'
+
+module WhirledPeas
+  module Command
+    class Help < Base
+      def self.description
+        'Show detailed help for a command'
+      end
+
+      def start
+        class_name = cmd.split('_').map(&:capitalize).join
+        klass = Command.const_get(class_name)
+        klass.print_usage
+      rescue NameError
+        puts "Unrecognized command: #{cmd}"
+        exit(1)
+      end
+
+      private
+
+      attr_reader :cmd
+
+      def validate!
+        super
+        cmd = args.shift
+        if cmd.nil?
+          @error_text = "#{command_name} requires a command"
+        else
+          @cmd = cmd
+        end
+      end
+
+      def options_usage
+        [*super, '<command>'].join(' ')
+      end
+    end
+  end
+end

data/lib/whirled_peas/command/play.rb

@@ -0,0 +1,108 @@
+
+require_relative 'base'
+
+module WhirledPeas
+  module Command
+    # Start the animation
+    class Play < Base
+      class NullPlayer
+        def play
+        end
+      end
+
+      class ApplicationPlayer
+        def initialize(app_config_file, config, logger)
+          @app_config_file = app_config_file
+          @config = config
+          @logger = logger
+        end
+
+        def play
+          require app_config_file
+
+          require 'whirled_peas/animator/renderer_consumer'
+          require 'whirled_peas/animator/producer'
+          require 'whirled_peas/device/screen'
+          require 'whirled_peas/utils/ansi'
+
+          Utils::Ansi.with_screen do |width, height|
+            consumer = Animator::RendererConsumer.new(
+              WhirledPeas.config.template_factory,
+              Device::Screen.new(WhirledPeas.config.refresh_rate),
+              width,
+              height
+            )
+            Animator::Producer.produce(
+              consumer, WhirledPeas.config.refresh_rate
+            ) do |producer|
+              config.application.start(producer)
+            end
+          end
+        end
+
+        private
+
+        attr_reader :app_config_file, :config, :logger
+      end
+
+      class FilePlayer
+        def initialize(wpz_file)
+          @wpz_file = wpz_file
+        end
+
+        def play
+          require 'whirled_peas/device/screen'
+          require 'whirled_peas/utils/ansi'
+          require 'whirled_peas/utils/file_handler'
+
+          Utils::Ansi.with_screen do
+            screen = Device::Screen.new(WhirledPeas.config.refresh_rate)
+            renders = Utils::FileHandler.read(wpz_file)
+            screen.handle_renders(renders)
+          end
+        end
+
+        private
+
+        attr_reader :wpz_file
+      end
+
+      def self.description
+        'Play an animation from an application or prerecorded file'
+      end
+
+      def start
+        super
+        player.play
+      end
+
+      private
+
+      attr_reader :player
+
+      def validate!
+        super
+        @player = NullPlayer
+        file = args.shift
+        if file.nil?
+          @error_text = "#{command_name} requires an config file or frames file file"
+        elsif !File.exist?(file)
+          @error_text = "File not found: #{file}"
+        else
+          full_path_file = file[0] == '/' ? file : File.join(Dir.pwd, file)
+          if full_path_file.end_with?('.wpz')
+            @player = FilePlayer.new(full_path_file)
+          elsif full_path_file.end_with?('.rb')
+            @player = ApplicationPlayer.new(full_path_file, config, build_logger)
+          else
+            @error_text = "Unsupported file type: .#{file.split('.').last}, epxecting .rb or .wpz"
+          end
+        end
+      end
+
+      def options_usage
+        '<config/wpz file>'
+      end
+    end
+  end
+end

data/lib/whirled_peas/command/record.rb

@@ -0,0 +1,57 @@
+require_relative 'config_command'
+
+module WhirledPeas
+  module Command
+    class Record < ConfigCommand
+      def self.description
+        'Record animation to a file'
+      end
+
+      def start
+        super
+        require 'highline'
+        require 'whirled_peas/animator/renderer_consumer'
+        require 'whirled_peas/animator/producer'
+        require 'whirled_peas/device/output_file'
+
+        width, height = HighLine.new.terminal.terminal_size
+        consumer = Animator::RendererConsumer.new(
+          WhirledPeas.config.template_factory,
+          Device::OutputFile.new(out_file),
+          width,
+          height
+        )
+        Animator::Producer.produce(
+          consumer, WhirledPeas.config.refresh_rate
+        ) do |producer|
+          config.application.start(producer)
+        end
+      end
+
+      private
+
+      attr_reader :out_file
+
+      def validate!
+        super
+        return unless @error_text.nil?
+
+        out_file = args.shift
+        if out_file.nil?
+          @error_text = "#{command_name} requires an output file"
+        elsif !out_file.end_with?('.wpz')
+          if out_file.split('/').last =~ /\./
+            extra = ", found: .#{out_file.split('.').last}"
+          end
+          @error_text = "Expecting output file with .wpz extension#{extra}"
+        else
+          @out_file = out_file[0] == '/' ? out_file : File.join(Dir.pwd, out_file)
+        end
+      end
+
+      def options_usage
+        [*super, '<output file>'].join(' ')
+      end
+    end
+  end
+end

data/lib/whirled_peas/command/still.rb

@@ -0,0 +1,29 @@
+require_relative 'frame_command'
+
+module WhirledPeas
+  module Command
+    # Display a still frame with the specified arguments.
+    class Still < FrameCommand
+      def self.description
+        'Show the specified still frame'
+      end
+
+      def start
+        super
+
+        require 'whirled_peas/device/screen'
+        require 'whirled_peas/graphics/renderer'
+        require 'whirled_peas/utils/ansi'
+
+        Utils::Ansi.with_screen do |width, height|
+          rendered = Graphics::Renderer.new(
+            WhirledPeas.config.template_factory.build(frame, frame_args),
+            width,
+            height
+          ).paint
+          Device::Screen.new(10000).handle_renders([rendered])
+        end
+      end
+    end
+  end
+end