Class: Cuprum::Cli::Arguments::ClassMethods::Builder

Parent Namespace

Cuprum::Cli::Arguments::ClassMethods

Defined In

lib/cuprum/cli/arguments/class_methods.rb

Table Of Contents

• Overview
• Constructor
• Instance Attributes
  • command_class
  • defined_arguments
• Instance Methods
  • call
  • initialize

Overview

Helper class for defining command arguments.

Back To Top

Constructor

#initialize(command_class:, defined_arguments:) => Builder

Parameters

• command_class (Class) — the command class.
• defined_arguments (Array<Cuprum::Cli::Argument>) — the arguments defined for the command.

Returns

• (Builder) — a new instance of Builder

Back To Top

Instance Attributes

#command_class => Class (readonly)

Returns

• (Class) — the command class.

#defined_arguments => Array<Cuprum::Cli::Argument> (readonly)

Returns

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

Back To Top

Instance Methods

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

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.

Back To Top

---

Back to Documentation | Reference | Cuprum | Cuprum::Cli | Cuprum::Cli::Arguments | Cuprum::Cli::Arguments::ClassMethods