Method: CliApplication::App#set_argv

Defined in:
lib/cli_application/app.rb

#set_argv(action, key, default, description) ⇒ Object

Метод добавления аргумента командной строки. Вызывается при инициализации приложения, служит для определения списка аргументов командной строки, формирвоания подсказок и установки значения по умолчанию. В классе принят не традиционный для Linux формат командной строки. Пример вызова: add_city.rb user_id=123 name=Максим city=‘Верхние Луки’.

Параметры, добавленные данным методом доступны через переменную argv (см. примеры)

Examples:

Примеры использования

app = CliApplication.new(ARGV, __dir__)
app.set_argv(:integer, 'user_id', 0, 'Идентификатор пользователя')
app.set_argv(:string, 'name', 'Без имени', 'Имя пользователя')
app.set_argv(:caps, 'city', 'москВА', 'Город проживания пользователя')

def main
  puts argv.user_id      #=> 0
  puts argv.name         #=> 'Без имени'
  puts argv.city         #=> 'Москва'
end

Parameters:

  • action (Sym) —

    параметр определяет действие, которое надо произвести над параметром командной строки.

  • key (String) —

    название ключа, напрмиер ‘user_id’, ‘name’, ‘city’.

  • default (Object) —

    значение по умочланию, “подставляемое” при отсутствии заданного пользователем параметра

  • description (String) —

    описание параметра (подсказка)



213
214
215
 
# File 'lib/cli_application/app.rb', line 213

def set_argv(action, key, default, description)
  @argv.set_argv(action, key, default, description)
end