Class: Aspera::Cli::Manager

Inherits:
Object
  • Object
show all
Defined in:
lib/aspera/cli/manager.rb

Overview

parse command line options arguments options start with ‘-’, others are commands resolves on extended value syntax

Constant Summary collapse

BOOLEAN_SIMPLE =

boolean options are set to true/false from the following values

%i[no yes].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(program_name, argv = nil) ⇒ Manager

Returns a new instance of Manager.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/aspera/cli/manager.rb', line 131

def initialize(program_name, argv = nil)
  # command line values *not* starting with '-'
  @unprocessed_cmd_line_arguments = []
  # command line values starting with '-'
  @unprocessed_cmd_line_options = []
  # a copy of all initial options
  @initial_cli_options = []
  # option description: key = option symbol, value=Hash, :read_write, :accessor, :value, :accepted
  @declared_options = {}
  # do we ask missing options and arguments to user ?
  @ask_missing_mandatory = false # STDIN.isatty
  # ask optional options if not provided and in interactive
  @ask_missing_optional = false
  # get_option fails if a mandatory parameter is asked
  @fail_on_missing_mandatory = true
  # Array of [key(sym), value]
  # those must be set before parse
  # parse consumes those defined only
  @option_pairs_batch = {}
  @option_pairs_env = {}
  # NOTE: was initially inherited but it is preferred to have specific methods
  @parser = OptionParser.new
  @parser.program_name = program_name
  # options can also be provided by env vars : --param-name -> ASCLI_PARAM_NAME
  env_prefix = program_name.upcase + OPTION_SEP_SYMBOL
  ENV.each do |k, v|
    @option_pairs_env[k[env_prefix.length..-1].downcase.to_sym] = v if k.start_with?(env_prefix)
  end
  Log.log.debug{"env=#{@option_pairs_env}".red}
  @unprocessed_cmd_line_options = []
  @unprocessed_cmd_line_arguments = []
  return if argv.nil?
  # true until `--` is found (stop options)
  process_options = true
  until argv.empty?
    value = argv.shift
    if process_options && value.start_with?('-')
      Log.log.trace1{"opt: #{value}"}
      if value.eql?(OPTIONS_STOP)
        process_options = false
      else
        @unprocessed_cmd_line_options.push(value)
      end
    else
      Log.log.trace1{"arg: #{value}"}
      @unprocessed_cmd_line_arguments.push(value)
    end
  end
  @initial_cli_options = @unprocessed_cmd_line_options.dup.freeze
  Log.log.trace1{"add_cmd_line_options:commands/arguments=#{@unprocessed_cmd_line_arguments},options=#{@unprocessed_cmd_line_options}".red}
  @parser.separator('')
  @parser.separator('OPTIONS: global')
  declare(:interactive, 'Use interactive input of missing params', values: :bool, handler: {o: self, m: :ask_missing_mandatory})
  declare(:ask_options, 'Ask even optional options', values: :bool, handler: {o: self, m: :ask_missing_optional})
  declare(:struct_parser, 'Default parser when expected value is a struct', values: %i[json ruby])
  # do not parse options yet, let's wait for option `-h` to be overridden
end

Instance Attribute Details

#ask_missing_mandatory ⇒ Object

Returns the value of attribute ask_missing_mandatory.



128
129
130
 
# File 'lib/aspera/cli/manager.rb', line 128

def ask_missing_mandatory
  @ask_missing_mandatory
end

#ask_missing_optional ⇒ Object

Returns the value of attribute ask_missing_optional.



128
129
130
 
# File 'lib/aspera/cli/manager.rb', line 128

def ask_missing_optional
  @ask_missing_optional
end

#fail_on_missing_mandatory=(value) ⇒ Object (writeonly)

Sets the attribute fail_on_missing_mandatory

Parameters:

  • value —

    the value to set the attribute fail_on_missing_mandatory to.



129
130
131
 
# File 'lib/aspera/cli/manager.rb', line 129

def fail_on_missing_mandatory=(value)
  @fail_on_missing_mandatory = value
end

#parser ⇒ Object (readonly)

Returns the value of attribute parser.



127
128
129
 
# File 'lib/aspera/cli/manager.rb', line 127

def parser
  @parser
end

Class Method Details

.enum_to_bool(enum) ⇒ Object 



72
73
74
75
 
# File 'lib/aspera/cli/manager.rb', line 72

def enum_to_bool(enum)
  Aspera.assert_values(enum, BOOLEAN_VALUES){'boolean'}
  return TRUE_VALUES.include?(enum)
end

.get_from_list(short_value, descr, allowed_values) ⇒ Object

find shortened string value in allowed symbol list



82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/aspera/cli/manager.rb', line 82

def get_from_list(short_value, descr, allowed_values)
  Aspera.assert_type(short_value, String)
  # we accept shortcuts
  matching_exact = allowed_values.select{ |i| i.to_s.eql?(short_value)}
  return matching_exact.first if matching_exact.length == 1
  matching = allowed_values.select{ |i| i.to_s.start_with?(short_value)}
  multi_choice_assert(!matching.empty?, "unknown value for #{descr}: #{short_value}", allowed_values)
  multi_choice_assert(matching.length.eql?(1), "ambiguous shortcut for #{descr}: #{short_value}", matching)
  return enum_to_bool(matching.first) if allowed_values.eql?(BOOLEAN_VALUES)
  return matching.first
end

.multi_choice_assert(assertion, error_msg, accept_list) ⇒ Object

Generates error message with list of allowed values

Parameters:

  • error_msg (String) —

    error message

  • accept_list (Array) —

    list of allowed values

Raises:



97
98
99
 
# File 'lib/aspera/cli/manager.rb', line 97

def multi_choice_assert(assertion, error_msg, accept_list)
  raise Cli::BadArgument, [error_msg, 'Use:'].concat(accept_list.map{ |c| "- #{c}"}.sort).join("\n") unless assertion
end

.option_line_to_name(name) ⇒ Object

change option name with dash to name with underscore



102
103
104
 
# File 'lib/aspera/cli/manager.rb', line 102

def option_line_to_name(name)
  return name.gsub(OPTION_SEP_LINE, OPTION_SEP_SYMBOL)
end

.option_name_to_line(name) ⇒ Object 



106
107
108
 
# File 'lib/aspera/cli/manager.rb', line 106

def option_name_to_line(name)
  return "#{OPTION_PREFIX}#{name.to_s.gsub(OPTION_SEP_SYMBOL, OPTION_SEP_LINE)}"
end

.time_to_string(time) ⇒ Object 



77
78
79
 
# File 'lib/aspera/cli/manager.rb', line 77

def time_to_string(time)
  return time.strftime('%Y-%m-%d %H:%M:%S')
end

.validate_type(what, descr, to_check, type_list, check_array: false) ⇒ Object

Parameters:

  • what (Symbol) —

    :option or :argument

  • descr (String) —

    description for help

  • to_check (Object) —

    value to check

  • type_list (NilClass, Class, Array[Class]) —

    accepted value type(s)

  • check_array (bool) (defaults to: false) —

    set to true if it is a list of values to check



115
116
117
118
119
120
121
122
123
124
 
# File 'lib/aspera/cli/manager.rb', line 115

def validate_type(what, descr, to_check, type_list, check_array: false)
  return if type_list.nil?
  Aspera.assert(type_list.is_a?(Array) && type_list.all?(Class)){'types must be a Class Array'}
  value_list = check_array ? to_check : [to_check]
  value_list.each do |value|
    raise Cli::BadArgument,
      "#{what.to_s.capitalize} #{descr} is a #{value.class} but must be #{'one of: ' if type_list.length > 1}#{type_list.map(&:name).join(', ')}" unless
      type_list.any?{ |t| value.is_a?(t)}
  end
end

Instance Method Details

#add_option_preset(preset_hash, where, override: true) ⇒ Object

Adds each of the keys of specified hash as an option

Parameters:

  • preset_hash (Hash) —

    hash of options to add



383
384
385
386
387
388
389
390
 
# File 'lib/aspera/cli/manager.rb', line 383

def add_option_preset(preset_hash, where, override: true)
  Aspera.assert_type(preset_hash, Hash)
  Log.log.debug{"add_option_preset: #{preset_hash}, #{where}, #{override}"}
  preset_hash.each do |k, v|
    option_symbol = k.to_sym
    @option_pairs_batch[option_symbol] = v if override || !@option_pairs_batch.key?(option_symbol)
  end
end

#command_or_arg_empty? ⇒ Boolean

check if there were unprocessed values to generate error

Returns:

  • (Boolean) 


398
399
400
 
# File 'lib/aspera/cli/manager.rb', line 398

def command_or_arg_empty?
  return @unprocessed_cmd_line_arguments.empty?
end

#declare(option_symbol, description, handler: nil, default: nil, values: nil, short: nil, coerce: nil, types: nil, deprecation: nil, &block) ⇒ Object

declare an option

Parameters:

  • option_symbol (Symbol) —

    option name

  • description (String) —

    description for help

  • handler (Hash) (defaults to: nil) —

    handler for option value: keys: o (object) and m (method)

  • default (Object) (defaults to: nil) —

    default value

  • values (nil, Array, :bool, :date, :none) (defaults to: nil) —

    list of allowed values, :bool for true/false, :date for dates, :none for on/off switch

  • short (String) (defaults to: nil) —

    short option name

  • coerce (Class) (defaults to: nil) —

    one of the coerce types accepted by option parser

  • types (Class, Array) (defaults to: nil) —

    accepted value type(s)

  • block (Proc) —

    block to execute when option is found



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/aspera/cli/manager.rb', line 309

def declare(option_symbol, description, handler: nil, default: nil, values: nil, short: nil, coerce: nil, types: nil, deprecation: nil, &block)
  Aspera.assert_type(option_symbol, Symbol)
  Aspera.assert(!@declared_options.key?(option_symbol)){"#{option_symbol} already declared"}
  Aspera.assert(description[-1] != '.'){"#{option_symbol} ends with dot"}
  Aspera.assert(description[0] == description[0].upcase){"#{option_symbol} description does not start with an uppercase"}
  Aspera.assert(!['hash', 'extended value'].any?{ |s| description.downcase.include?(s)}){"#{option_symbol} shall use :types"}
  opt = @declared_options[option_symbol] = {
    read_write: handler.nil? ? :value : :accessor,
    # by default passwords and secrets are sensitive, else specify when declaring the option
    sensitive:  SecretHider.instance.secret?(option_symbol, '')
  }
  if !types.nil?
    types = [types] unless types.is_a?(Array)
    Aspera.assert(types.all?(Class)){"types must be (Array of) Class: #{types}"}
    opt[:types] = types
    description = "#{description} (#{types.map(&:name).join(', ')})"
  end
  if deprecation
    opt[:deprecation] = deprecation
    description = "#{description} (#{'deprecated'.blue}: #{deprecation})"
  end
  Log.log.trace1{"declare: #{option_symbol}: #{opt[:read_write]}".green}
  if opt[:read_write].eql?(:accessor)
    Aspera.assert_type(handler, Hash)
    Aspera.assert(handler.keys.sort.eql?(%i[m o]))
    Log.log.trace1{"set attr obj: #{option_symbol} (#{handler[:o]},#{handler[:m]})"}
    opt[:accessor] = AttrAccessor.new(handler[:o], handler[:m], option_symbol)
  end
  set_option(option_symbol, default, where: 'default') unless default.nil?
  on_args = [description]
  case values
  when nil
    on_args.push(symbol_to_option(option_symbol, 'VALUE'))
    on_args.push("-#{short}VALUE") unless short.nil?
    on_args.push(coerce) unless coerce.nil?
    @parser.on(*on_args){ |v| set_option(option_symbol, v, where: SOURCE_USER)}
  when Array, :bool
    if values.eql?(:bool)
      values = BOOLEAN_VALUES
      set_option(option_symbol, Manager.enum_to_bool(default), where: 'default') unless default.nil?
    end
    # this option value must be a symbol
    opt[:values] = values
    value = get_option(option_symbol)
    help_values = values.map{ |i| i.eql?(value) ? highlight_current(i) : i}.join(', ')
    if values.eql?(BOOLEAN_VALUES)
      help_values = BOOLEAN_SIMPLE.map{ |i| (i.eql?(:yes) && value) || (i.eql?(:no) && !value) ? highlight_current(i) : i}.join(', ')
    end
    on_args[0] = "#{description}: #{help_values}"
    on_args.push(symbol_to_option(option_symbol, 'ENUM'))
    on_args.push(values)
    @parser.on(*on_args){ |v| set_option(option_symbol, self.class.get_from_list(v.to_s, description, values), where: SOURCE_USER)}
  when :date
    on_args.push(symbol_to_option(option_symbol, 'DATE'))
    @parser.on(*on_args) do |v|
      time_string = case v
      when 'now' then Manager.time_to_string(Time.now)
      when /^-([0-9]+)h/ then Manager.time_to_string(Time.now - (Regexp.last_match(1).to_i * 3600))
      else v
      end
      set_option(option_symbol, time_string, where: SOURCE_USER)
    end
  when :none
    Aspera.assert(!block.nil?){"missing block for #{option_symbol}"}
    on_args.push(symbol_to_option(option_symbol))
    on_args.push("-#{short}") if short.is_a?(String)
    @parser.on(*on_args, &block)
  else Aspera.error_unexpected_value(values)
  end
  Log.log.trace1{"on_args=#{on_args}"}
end

#final_errors ⇒ Object

unprocessed options or arguments ?



403
404
405
406
407
408
 
# File 'lib/aspera/cli/manager.rb', line 403

def final_errors
  result = []
  result.push("unprocessed options: #{@unprocessed_cmd_line_options}") unless @unprocessed_cmd_line_options.empty?
  result.push("unprocessed values: #{@unprocessed_cmd_line_arguments}") unless @unprocessed_cmd_line_arguments.empty?
  return result
end

#get_interactive(descr, option: false, multiple: false, accept_list: nil) ⇒ Object

Prompt user for input in a list of symbols

Parameters:

  • descr (String) —

    description for help

  • option (Boolean) (defaults to: false) —

    true if command line option

  • multiple (Boolean) (defaults to: false) —

    true if multiple values expected

  • accept_list (Array) (defaults to: nil) —

    list of expected values



507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/aspera/cli/manager.rb', line 507

def get_interactive(descr, option: false, multiple: false, accept_list: nil)
  what = option ? 'option' : 'argument'
  if !@ask_missing_mandatory
    message = "missing #{what}: #{descr}"
    if accept_list.nil?
      raise Cli::BadArgument, message
    else
      self.class.multi_choice_assert(false, message, accept_list)
    end
  end
  sensitive = option && @declared_options[descr.to_sym].is_a?(Hash) && @declared_options[descr.to_sym][:sensitive]
  default_prompt = "#{what}: #{descr}"
  # ask interactively
  result = []
  puts(' (one per line, end with empty line)') if multiple
  loop do
    prompt = default_prompt
    prompt = "#{accept_list.join(' ')}\n#{default_prompt}" if accept_list
    entry = prompt_user_input(prompt, sensitive: sensitive)
    break if entry.empty? && multiple
    entry = ExtendedValue.instance.evaluate(entry)
    entry = self.class.get_from_list(entry, descr, accept_list) if accept_list
    return entry unless multiple
    result.push(entry)
  end
  return result
end

#get_next_argument(descr, mandatory: true, multiple: false, accept_list: nil, validation: String, aliases: nil, default: nil) ⇒ Object

Returns one value, list or nil (if optional and no default).

Parameters:

  • descr (String) —

    description for help

  • mandatory (Boolean) (defaults to: true) —

    if true, raise error if option not set

  • multiple (Boolean) (defaults to: false) —

    if true, return remaining arguments (Array)

  • accept_list (Array) (defaults to: nil) —

    list of allowed values (Symbol)

  • validation (Class, Array) (defaults to: String) —

    accepted value type(s) or list of Symbols

  • aliases (Hash) (defaults to: nil) —

    map of aliases: key = alias, value = real value

  • default (Object) (defaults to: nil) —

    default value

Returns:

  • one value, list or nil (if optional and no default)



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/aspera/cli/manager.rb', line 197

def get_next_argument(descr, mandatory: true, multiple: false, accept_list: nil, validation: String, aliases: nil, default: nil)
  Aspera.assert(accept_list.nil? || (accept_list.is_a?(Array) && accept_list.all?(Symbol)))
  validation = Symbol if accept_list
  Aspera.assert(validation.nil? || validation.is_a?(Class) || (validation.is_a?(Array) && validation.all?(Class))){'validation must be Class or Array of Class'}
  Aspera.assert(aliases.nil? || (aliases.is_a?(Hash) && aliases.keys.all?(Symbol) && aliases.values.all?(Symbol))){'aliases must be Hash:Symbol: Symbol'}
  allowed_types = validation
  unless allowed_types.nil?
    allowed_types = [allowed_types] unless allowed_types.is_a?(Array)
    descr = "#{descr} (#{allowed_types.join(', ')})"
  end
  result =
    if !@unprocessed_cmd_line_arguments.empty?
      how_many = multiple ? @unprocessed_cmd_line_arguments.length : 1
      values = @unprocessed_cmd_line_arguments.shift(how_many)
      values = values.map{ |v| evaluate_extended_value(v, allowed_types)}
      # if expecting list and only one arg of type array : it is the list
      values = values.first if multiple && values.length.eql?(1) && values.first.is_a?(Array)
      if accept_list
        allowed_values = [].concat(accept_list)
        allowed_values.concat(aliases.keys) unless aliases.nil?
        values = values.map{ |v| self.class.get_from_list(v, descr, allowed_values)}
      end
      multiple ? values : values.first
    elsif !default.nil? then default
      # no value provided, either get value interactively, or exception
    elsif mandatory then get_interactive(descr, multiple: multiple, accept_list: accept_list)
    end
  if result.is_a?(String) && validation.eql?(Integer)
    int_result = Integer(result, exception: false)
    raise Cli::BadArgument, "Invalid integer: #{result}" if int_result.nil?
    result = int_result
  end
  Log.log.debug{"#{descr}=#{result}"}
  result = aliases[result] if aliases&.key?(result)
  # if value comes from JSON/YAML, it may come as Integer
  result = result.to_s if result.is_a?(Integer) && validation.eql?(String)
  self.class.validate_type(:argument, descr, result, allowed_types, check_array: multiple) unless result.nil? && !mandatory
  return result
end

#get_next_command(command_list, aliases: nil) ⇒ Object 



237
 
# File 'lib/aspera/cli/manager.rb', line 237

def get_next_command(command_list, aliases: nil); return get_next_argument('command', accept_list: command_list, aliases: aliases); end

#get_option(option_symbol, mandatory: false, default: nil) ⇒ Object

Get an option value by name either return value or calls handler, can return nil ask interactively if requested/required

Parameters:

  • mandatory (Boolean) (defaults to: false) —

    if true, raise error if option not set



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/aspera/cli/manager.rb', line 243

def get_option(option_symbol, mandatory: false, default: nil)
  Aspera.assert_type(option_symbol, Symbol)
  attributes = @declared_options[option_symbol]
  Aspera.assert(attributes){"option not declared: #{option_symbol}"}
  result = nil
  case attributes[:read_write]
  when :accessor
    result = attributes[:accessor].value
  when :value
    result = attributes[:value]
  else Aspera.error_unexpected_value(attributes[:read_write]){'attribute read/write'}
  end
  Log.log.trace1{"(#{attributes[:read_write]}) get #{option_symbol}=#{result}"}
  result = default if result.nil?
  # do not fail for manual generation if option mandatory but not set
  result = :skip_missing_mandatory if result.nil? && mandatory && !@fail_on_missing_mandatory
  # Log.log.debug{"interactive=#{@ask_missing_mandatory}"}
  if result.nil?
    if !@ask_missing_mandatory
      raise Cli::BadArgument, "Missing mandatory option: #{option_symbol}" if mandatory
    elsif @ask_missing_optional || mandatory
      # ask_missing_mandatory
      accept_list = nil
      # print "please enter: #{option_symbol.to_s}"
      accept_list = attributes[:values] if @declared_options.key?(option_symbol) && attributes.key?(:values)
      result = get_interactive(option_symbol.to_s, option: true, accept_list: accept_list)
      set_option(option_symbol, result, where: 'interactive')
    end
  end
  self.class.validate_type(:option, option_symbol, result, attributes[:types]) unless result.nil? && !mandatory
  return result
end

#known_options(only_defined: false) ⇒ Hash

Returns options as taken from config file and command line just before command execution.

Parameters:

  • only_defined (Boolean) (defaults to: false) —

    if true, only return options that were defined

Returns:

  • (Hash) —

    options as taken from config file and command line just before command execution



435
436
437
438
439
440
441
442
443
444
 
# File 'lib/aspera/cli/manager.rb', line 435

def known_options(only_defined: false)
  result = {}
  @declared_options.each_key do |option_symbol|
    v = get_option(option_symbol)
    result[option_symbol] = v unless only_defined && v.nil?
  rescue => e
    result[option_symbol] = e.to_s
  end
  return result
end

#parse_options! ⇒ Object

removes already known options from the list



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/aspera/cli/manager.rb', line 447

def parse_options!
  Log.log.trace1('parse_options!'.red)
  # first conf file, then env var
  consume_option_pairs(@option_pairs_batch, 'set')
  consume_option_pairs(@option_pairs_env, 'env')
  # command line override
  unknown_options = []
  begin
    # remove known options one by one, exception if unknown
    Log.log.trace1('Before parse')
    @parser.parse!(@unprocessed_cmd_line_options)
    Log.log.trace1('After parse')
  rescue OptionParser::InvalidOption => e
    Log.log.trace1{"InvalidOption #{e}".red}
    if (m = e.args.first.match(/^--([a-z\-]+)\.([^=]+)=(.+)$/))
      option, path, raw_value = m.captures
      option_sym = self.class.option_line_to_name(option).to_sym
      if @declared_options.key?(option_sym)
        value = path.split(OPTION_HASH_SEPARATOR).reverse.inject(smart_convert(raw_value)){ |v, k| {k => v}}
        set_option(option_sym, value, where: 'dotted')
        retry
      end
    end
    # save for later processing
    unknown_options.push(e.args.first)
    retry
  end
  Log.log.trace1{"remains: #{unknown_options}"}
  # set unprocessed options for next time
  @unprocessed_cmd_line_options = unknown_options
end

#prompt_user_input(prompt, sensitive: false) ⇒ Object 



479
480
481
482
483
484
485
 
# File 'lib/aspera/cli/manager.rb', line 479

def prompt_user_input(prompt, sensitive: false)
  return $stdin.getpass("#{prompt}> ") if sensitive
  print("#{prompt}> ")
  line = $stdin.gets
  Aspera.assert_type(line, String){'Unexpected end of standard input'}
  return line.chomp
end

#prompt_user_input_in_list(prompt, sym_list) ⇒ Symbol

prompt user for input in a list of symbols

Parameters:

  • prompt (String) —

    prompt to display

  • sym_list (Array) —

    list of symbols to select from

Returns:

  • (Symbol) —

    selected symbol



491
492
493
494
495
496
497
498
499
500
 
# File 'lib/aspera/cli/manager.rb', line 491

def prompt_user_input_in_list(prompt, sym_list)
  loop do
    input = prompt_user_input(prompt).to_sym
    if sym_list.any?{ |a| a.eql?(input)}
      return input
    else
      $stderr.puts("No such #{prompt}: #{input}, select one of: #{sym_list.join(', ')}") # rubocop:disable Style/StderrPuts
    end
  end
end

#set_option(option_symbol, value, where: 'code override') ⇒ Object

set an option value by name, either store value or call handler

Parameters:

  • option_symbol (Symbol) —

    option name

  • value (String) —

    value to set

  • where (String) (defaults to: 'code override') —

    where the value comes from

  • expect (Class, Array) —

    expected value type(s)

Raises:



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/aspera/cli/manager.rb', line 281

def set_option(option_symbol, value, where: 'code override')
  Aspera.assert_type(option_symbol, Symbol)
  raise Cli::BadArgument, "Unknown option: #{option_symbol}" unless @declared_options.key?(option_symbol)
  attributes = @declared_options[option_symbol]
  Log.log.warn("#{option_symbol}: Option is deprecated: #{attributes[:deprecation]}") if attributes[:deprecation]
  value = evaluate_extended_value(value, attributes[:types])
  value = Manager.enum_to_bool(value) if attributes[:values].eql?(BOOLEAN_VALUES)
  Log.log.trace1{"(#{attributes[:read_write]}/#{where}) set #{option_symbol}=#{value}"}
  self.class.validate_type(:option, option_symbol, value, attributes[:types])
  case attributes[:read_write]
  when :accessor
    attributes[:accessor].value = value
  when :value
    attributes[:value] = value
  else Aspera.error_unexpected_value(attributes[:read_write]){'attribute read/write'}
  end
end

#unprocessed_options_with_value ⇒ Hash

get all original options on command line used to generate a config in config file

Returns:

  • (Hash) —

    options as taken from config file and command line just before command execution



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/aspera/cli/manager.rb', line 412

def unprocessed_options_with_value
  result = {}
  @initial_cli_options.each do |option_value|
    case option_value
    when /^#{OPTION_PREFIX}([^=]+)$/o
      # ignore
    when /^#{OPTION_PREFIX}([^=]+)=(.*)$/o
      name = Regexp.last_match(1)
      value = Regexp.last_match(2)
      name.gsub!(OPTION_SEP_LINE, OPTION_SEP_SYMBOL)
      value = ExtendedValue.instance.evaluate(value)
      Log.log.debug{"option #{name}=#{value}"}
      result[name] = value
      @unprocessed_cmd_line_options.delete(option_value)
    else
      raise Cli::BadArgument, "wrong option format: #{option_value}"
    end
  end
  return result
end

#unshift_next_argument(argument) ⇒ Object

allows a plugin to add an argument as next argument to process



393
394
395
 
# File 'lib/aspera/cli/manager.rb', line 393

def unshift_next_argument(argument)
  @unprocessed_cmd_line_arguments.unshift(argument)
end