Contents

require_relative 'action/help'
require_relative 'action/history'
require_relative 'action/quit'

module Commando
  ActionConfig = Struct.new(:action_class, :description)

  # Manage the configuration for the actions available to the CLI
  class Config
    DEFAULT_PROMPT = 'commando> '
    DEFAULT_GREETING =
      'Welcome to the commando interface. Type "help" to list available commands'

    attr_writer :prompt, :greeting

    def initialize
      @mapping = {}

      # Register the default actions
      register('help',    Commando::Action::Help,    'Print this message')
      register('history', Commando::Action::History, 'Print the history of commands')
      register('quit',    Commando::Action::Quit,    'Exit the program')
    end

    def prompt
      @prompt || DEFAULT_PROMPT
    end

    def greeting
      @greeting || DEFAULT_GREETING
    end

    # Register a new command/action to be available to the CLI
    #
    # @param command [String] the string that a user will type to execute the
    #   action, e.g. "help" for the command the will print out help info.
    # @param action_class [Class] the class that will execute the logic for
    #   the given command.
    def register(command, action_class, description)
      mapping[command] = ActionConfig.new(action_class, description)
    end

    # @return [Array<String>] the list of all configured actions.
    def commands
      @mapping.keys
    end

    # @param command [String] the command to find an action class for.
    # @return [Class] the action class that is registered for the command,
    #   nil if none is registered.
    def lookup(command)
      mapping[command]&.action_class
    end

    # Iterate through each of the registered commands, yielding the command
    # string and the description
    def each_action(&block)
      mapping.each do |command, action_config|
        yield command, action_config.description
      end
    end

    private

    attr_reader :mapping
  end

  private_constant :Config
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
tcollier-commando-0.1.0	lib/commando/config.rb