Class: Benry::CmdOpt::SchemaItem

Inherits:
Object
  • Object
show all
Defined in:
lib/benry/cmdopt.rb

Overview

avoid Struct

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key, optdef, desc, short, long, param, required, type: nil, rexp: nil, pattern: nil, enum: nil, range: nil, value: nil, multiple: nil, detail: nil, hidden: nil, important: nil, tag: nil, &callback) ⇒ SchemaItem

Returns a new instance of SchemaItem.



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/benry/cmdopt.rb', line 326

def initialize(key, optdef, desc, short, long, param, required, type: nil, rexp: nil, pattern: nil, enum: nil, range: nil, value: nil, multiple: nil, detail: nil, hidden: nil, important: nil, tag: nil, &callback)
  rexp ||= pattern    # for backward compatibility
  _init_validation(param, required, type, rexp, enum, range, value)
  @key      = key       unless nil == key
  @optdef   = optdef    unless nil == optdef
  @desc     = desc      unless nil == desc
  @short    = short     unless nil == short
  @long     = long      unless nil == long
  @param    = param     unless nil == param
  @required = required  unless nil == required
  @type     = type      unless nil == type
  @rexp     = rexp      unless nil == rexp
  @enum     = enum      unless nil == enum
  @range    = range     unless nil == range
  @value    = value     unless nil == value
  @multiple = multiple  unless nil == multiple
  @detail   = detail    unless nil == detail
  @hidden   = hidden    unless nil == hidden
  @important = important unless nil == important
  @tag      = tag       unless nil == tag
  @callback = callback  unless nil == callback
  #; [!nn4cp] freezes enum object.
  @enum.freeze() if @enum
end

Instance Attribute Details

#callback ⇒ Object (readonly)

Returns the value of attribute callback.



351
352
353
 
# File 'lib/benry/cmdopt.rb', line 351

def callback
  @callback
end

#desc ⇒ Object Also known as: help

Returns the value of attribute desc.



351
352
353
 
# File 'lib/benry/cmdopt.rb', line 351

def desc
  @desc
end

#detail ⇒ Object

Returns the value of attribute detail.



351
352
353
 
# File 'lib/benry/cmdopt.rb', line 351

def detail
  @detail
end

#enum ⇒ Object (readonly)

Returns the value of attribute enum.



351
352
353
 
# File 'lib/benry/cmdopt.rb', line 351

def enum
  @enum
end

#hidden=(value) ⇒ Object (writeonly)

!!experimental!!



352
353
354
 
# File 'lib/benry/cmdopt.rb', line 352

def hidden=(value)
  @hidden = value
end

#important=(value) ⇒ Object (writeonly)

!!experimental!!



352
353
354
 
# File 'lib/benry/cmdopt.rb', line 352

def important=(value)
  @important = value
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



351
352
353
 
# File 'lib/benry/cmdopt.rb', line 351

def key
  @key
end

#long ⇒ Object (readonly)

Returns the value of attribute long.



351
352
353
 
# File 'lib/benry/cmdopt.rb', line 351

def long
  @long
end

#optdef ⇒ Object (readonly)

Returns the value of attribute optdef.



351
352
353
 
# File 'lib/benry/cmdopt.rb', line 351

def optdef
  @optdef
end

#param ⇒ Object (readonly)

Returns the value of attribute param.



351
352
353
 
# File 'lib/benry/cmdopt.rb', line 351

def param
  @param
end

#range ⇒ Object (readonly)

Returns the value of attribute range.



351
352
353
 
# File 'lib/benry/cmdopt.rb', line 351

def range
  @range
end

#rexp ⇒ Object (readonly) Also known as: pattern

Returns the value of attribute rexp.



351
352
353
 
# File 'lib/benry/cmdopt.rb', line 351

def rexp
  @rexp
end

#short ⇒ Object (readonly)

Returns the value of attribute short.



351
352
353
 
# File 'lib/benry/cmdopt.rb', line 351

def short
  @short
end

#tag ⇒ Object

Returns the value of attribute tag.



351
352
353
 
# File 'lib/benry/cmdopt.rb', line 351

def tag
  @tag
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



351
352
353
 
# File 'lib/benry/cmdopt.rb', line 351

def type
  @type
end

#value ⇒ Object (readonly)

Returns the value of attribute value.



351
352
353
 
# File 'lib/benry/cmdopt.rb', line 351

def value
  @value
end

Instance Method Details

#arg_requireness ⇒ Object 



363
364
365
366
367
368
369
370
 
# File 'lib/benry/cmdopt.rb', line 363

def arg_requireness()
  #; [!kmo28] returns :none if option takes no arguments.
  #; [!owpba] returns :optional if argument is optional.
  #; [!s8gxl] returns :required if argument is required.
  return :none     if ! @param
  return :required if @required
  return :optional
end

#hidden? ⇒ Boolean

Returns:

  • (Boolean) 


378
379
380
381
382
383
384
385
 
# File 'lib/benry/cmdopt.rb', line 378

def hidden?()
  #; [!no6ov] returns true if @hidden is true.
  #; [!ej8ot] returns false if @hidden is false.
  return @hidden if @hidden != nil
  #; [!h0uxs] returns true if desc is nil.
  #; [!28vzx] returns false if else.
  return @desc == nil
end

#important? ⇒ Boolean

Returns:

  • (Boolean) 


387
388
389
390
391
 
# File 'lib/benry/cmdopt.rb', line 387

def important?()
  #; [!ua8kt] returns true/false if `important:` kwarg passed to constructor.
  #; [!hz9sx] returns nil if `important:` kwarg not passed to constructor.
  return @important
end

#multiple? ⇒ Boolean

Returns:

  • (Boolean) 


372
373
374
375
376
 
# File 'lib/benry/cmdopt.rb', line 372

def multiple?()
  #; [!1lj8v] returns true if @multiple is truthy.
  #; [!cun23] returns false if @multiple is falthy.
  return !! @multiple
end

#required? ⇒ Boolean

Returns:

  • (Boolean) 


356
357
358
359
360
361
 
# File 'lib/benry/cmdopt.rb', line 356

def required?()
  #; [!svxny] returns nil if option takes no arguments.
  #; [!uwbgc] returns false if argument is optional.
  #; [!togcx] returns true if argument is required.
  return ! @param ? nil : !! @required
end

#validate_and_convert(val, optdict) ⇒ Object 



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/benry/cmdopt.rb', line 393

def validate_and_convert(val, optdict)
  #; [!h0s0o] raises RuntimeError when value not matched to pattern.
  if @rexp && val != true
    val =~ @rexp  or
      raise "Pattern unmatched."
  end
  #; [!j4fuz] calls type-specific callback when type specified.
  if @type && val != true
    proc_ = PARAM_TYPES[@type]
    val = proc_.call(val)
  end
  #; [!5jrdf] raises RuntimeError when value not in enum.
  if @enum && val != true
    @enum.include?(val)  or
      raise "Expected one of #{@enum.join('/')}."
  end
  #; [!5falp] raise RuntimeError when value not in range.
  #; [!a0rej] supports endless range.
  if @range && val != true
    r = @range
    r.begin == nil || r.begin <= val  or (
      raise "Positive value (>= 0) expected." if r.begin == 0
      raise "Positive value (>= 1) expected." if r.begin == 1
      raise "Too small (min: #{r.begin.inspect})"
    )
    r.end == nil || val <= r.end  or
      raise "Too large (max: #{r.end.inspect})"
  end
  #; [!jn9z3] calls callback when callback specified.
  #; [!iqalh] calls callback with different number of args according to arity.
  if @callback
    n_args = @callback.arity
    val = n_args == 1 ? @callback.call(val) \
                      : @callback.call(optdict, @key, val)
  end
  #; [!eafem] returns default value (if specified) instead of true value.
  return @value if val == true && @value != nil
  #; [!x066l] returns new value.
  return val
end