Class: Cuprum::Cli::Commands::EchoCommand

Parent Namespace

Cuprum::Cli::Commands

Inherited Classes

Cuprum::Cli::Command > Cuprum::Command > Object

Defined In

lib/cuprum/cli/commands/echo_command.rb

Table Of Contents

• Overview
• Constants
  • FULL_NAME_FORMAT
• Class Methods
  • argument
  • argument_value
  • argument_values
  • arguments
  • dependency
  • option
  • option_value
  • option_values
  • options
  • resolve_arguments
  • resolve_options
• Constructor
• Instance Methods
  • call
  • initialize

Overview

Outputs the arguments and options passed to the command.

Back To Top

Constants

FULL_NAME_FORMAT

= /\A[a-z_]+(:[a-z_]+)*\z/

Inherited From

Cuprum::Cli::Metadata

Format used to validate command names.

Back To Top

Class Methods

.argument(name, default: nil, description: nil, required: false, type: :string, variadic: false, **options) => Object

Inherited From

Cuprum::Cli::Command

Defines an argument for the command class.

Parameters

• name (String, Symbol) — the name of the argument.
• default (Object, Proc) — the default value for the argument. If given and the value of the argument is nil, sets the argument value to the default value.
• description (String) — a short, human-readable description of the argument.
• required (true, false) — if true, raises an exception if the argument is not provided to the command. Defaults to false.
• type (Class, String, Symbol) — the expected type of the argument value as a Class or class name. If given, raises an exception if the argument value is not an instance of the type. Defaults to :string.
• variadic (true, false) — if true, the argument is variadic and represents an array of arguments provided to the command. Defaults to false.
• options (Hash) — additional options for defining the argument.

Options Hash (options)

• define_method (true, false) — if true, defines a reader method for the argument. Defaults to false for boolean arguments and true for all other arguments.
• define_predicate (true, false) — if true, defines a predicate method for the argument, which returns true if the argument is not nil and not empty. Defaults to true for boolean arguments and false for all other arguments.

Raises

• (ArgumentError) — if variadic is true and the command already defines a variadic argument.

.argument_value(value) => void

Inherited From

Cuprum::Cli::Arguments::ClassMethods

Appends a predefined argument value for the command.

Parameters

• value (Object) — the argument value to append.

Returns

• (void)

.argument_values => Array<Object>

Inherited From

Cuprum::Cli::Arguments::ClassMethods

Returns

• (Array<Object>) — predefined argument values for the command.

.arguments() => Array<Cuprum::Cli::Argument>
.arguments(name, default: nil, description: nil, required: false, type: :string, **options) => Object

Inherited From

Cuprum::Cli::Arguments::ClassMethods

Overloads

.arguments() => Array<Cuprum::Cli::Argument>

The defined arguments for the command class.

Returns

• (Array<Cuprum::Cli::Argument>) — the defined arguments.

.arguments(name, default: nil, description: nil, required: false, type: :string, **options) => Object

Defines a variadic argument for the command class.

Parameters

• name (String, Symbol) — the name of the argument.
• default (Object, Proc) — the default value for the argument. If given and the value of the argument is nil, sets the argument value to the default value.
• description (String) — a short, human-readable description of the argument.
• required (true, false) — if true, raises an exception if the argument is not provided to the command.
• type (Class, String, Symbol) — the expected type of the argument value as a Class or class name. If given, raises an exception if the argument value is not an instance of the type. Defaults to :string.
• options (Hash) — additional options for defining the argument.

Options Hash (options)

• define_method (true, false) — if true, defines a reader method for the argument. Defaults to false for boolean arguments and true for all other arguments.
• define_predicate (true, false) — if true, defines a predicate method for the argument, which returns true if the argument is not nil and not empty. Defaults to true for boolean arguments and false for all other arguments.

.dependency(dependency_name, **) => Object

Inherited From

Cuprum::Cli::Command

Raises

• (Cuprum::Cli::Metadata::AbstractCommandError)

.option(option_name, **) => Object

Inherited From

Cuprum::Cli::Command

Raises

• (Cuprum::Cli::Metadata::AbstractCommandError)

.option_value(option, value) => void

Inherited From

Cuprum::Cli::Options::ClassMethods

Assigns a predefined option value for the command.

Parameters

• option (String, Symbol) — the option to set.
• value (Object) — the option value to append.

Returns

• (void)

.option_values => Hash{Symbol => Object}

Inherited From

Cuprum::Cli::Options::ClassMethods

Returns

• (Hash{Symbol => Object}) — predefined option values for the command.

.options => Hash{Symbol => Cuprum::Cli::Option}

Inherited From

Cuprum::Cli::Options::ClassMethods

The defined options, including options defined on ancestor classes.

Returns

• (Hash{Symbol => Cuprum::Cli::Option}) — the defined options.

.resolve_arguments(*values) => Array

Inherited From

Cuprum::Cli::Arguments::ClassMethods

Validates the given argument values against the defined class arguments.

Also applies any default values from the defined arguments.

Parameters

• values (Array) — the arguments values to resolve.

Returns

• (Array) — the arguments values with applied defaults.

Raises

• (Cuprum::Cli::Arguments::ExtraArgumentsError) — if provided more arguments than the command class defines arguments.
• (Cuprum::Cli::Arguments::InvalidArgumentError) — if any value does not match the expected argument type, or any required value is missing.

.resolve_options(**values) => Hash

Inherited From

Cuprum::Cli::Options::ClassMethods

Validates the given option values against the defined class options.

Also applies any default values from the defined options.

Parameters

• values (Hash) — the option values to resolve.

Returns

• (Hash) — the option values with applied defaults.

Raises

• (Cuprum::Cli::Options::UnknownOptionError) — if any value does not have a corresponding defined option.
• (Cuprum::Cli::Options::InvalidOptionError) — if any value does not match the expected option type, or any required value is missing.

Back To Top

Constructor

#initialize(**) => Command

Inherited From

Cuprum::Cli::Command

Returns

• (Command) — a new instance of Command

Back To Top

Instance Methods

#call(*arguments, **options) => Cuprum::Result
#call(resolved_arguments:, resolved_options:) => Cuprum::Result

Inherited From

Cuprum::Cli::Command

Overloads

#call(*arguments, **options) => Cuprum::Result

Resolves the parameters and calls the command.

Parameters

• arguments (Array) — arguments passed to the command.
• options (Hash) — options passed to the command.

Returns

• (Cuprum::Result) — the command result.

Raises

• (Cuprum::Cli::Arguments::ExtraArgumentsError) — when given too many positional arguments.
• (Cuprum::Cli::Arguments::InvalidArgumentError) — when given an invalid value for an argument.
• (Cuprum::Cli::Options::InvalidOptionError) — when given an invalid value for an option.
• (Cuprum::Cli::Options::UnknownOptionError) — when given a value for an undefined option.

#call(resolved_arguments:, resolved_options:) => Cuprum::Result

Calls the command with the given arguments and options.

This variant assumes that the arguments and options have already been parsed and validated against the command’s expected parameters.

Parameters

• resolved_arguments (Hash) — the arguments passed to the command, formatted as an Hash with the matching argument name as key and the argument value as the corresponding value.
• resolved_options (Hash) — the options passed to the command.

Returns

• (Cuprum::Result) — the command result.

Back To Top

---

Back to Documentation | Reference | Cuprum | Cuprum::Cli | Cuprum::Cli::Commands