Class: Benry::CmdApp::AliasMetadata

Inherits:
BaseMetadata show all
Defined in:
lib/benry/cmdapp.rb

Instance Attribute Summary collapse

Attributes inherited from BaseMetadata

#desc, #hidden, #important, #name, #tag

Instance Method Summary collapse

Constructor Details

#initialize(alias_name, action_name, args, tag: nil, important: nil, hidden: nil) ⇒ AliasMetadata

Returns a new instance of AliasMetadata.



321
322
323
324
325
326
327
328
 
# File 'lib/benry/cmdapp.rb', line 321

def initialize(alias_name, action_name, args, tag: nil, important: nil, hidden: nil)
  #; [!qtb61] sets description string automatically.
  #; [!kgic6] includes args value into description if provided.
  desc = _build_desc(action_name, args)
  super(alias_name, desc, tag: tag, important: important, hidden: hidden)
  @action = action_name
  @args   = args
end

Instance Attribute Details

#action ⇒ Object (readonly)

Returns the value of attribute action.



330
331
332
 
# File 'lib/benry/cmdapp.rb', line 330

def action
  @action
end

#args ⇒ Object (readonly)

Returns the value of attribute args.



330
331
332
 
# File 'lib/benry/cmdapp.rb', line 330

def args
  @args
end

Instance Method Details

#alias? ⇒ Boolean

Returns:

  • (Boolean) 


338
339
340
341
 
# File 'lib/benry/cmdapp.rb', line 338

def alias?()
  #; [!c798o] returns true which means that this is an alias metadata.
  return true
end

#name_with_args ⇒ Object 



343
344
345
346
347
348
 
# File 'lib/benry/cmdapp.rb', line 343

def name_with_args()
  #; [!6kjuv] returns alias name if no args.
  return @name if ! @args || @args.empty?
  #; [!d4xrb] returns alias name and args as combined.
  return "#{@name} (with '#{@args.join(' ')}')"
end