Class: CLASP::AliasSpecification

Inherits:
Object
  • Object
show all
Defined in:
lib/clasp/specifications.rb

Overview

A class that represents an explicit alias for a flag or an option

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, aliases) ⇒ AliasSpecification

Returns a new instance of AliasSpecification.



354
355
356
357
358
359
360
 
# File 'lib/clasp/specifications.rb', line 354

def initialize(name, aliases)

  @name    = name
  @aliases = (aliases || []).select { |a| a and not a.empty? }
  @extras    = nil
  @help    = nil
end

Instance Attribute Details

#aliases ⇒ Object (readonly)

The alias’ aliases array



365
366
367
 
# File 'lib/clasp/specifications.rb', line 365

def aliases
  @aliases
end

#extras ⇒ Object (readonly)

The flag’s extras



369
370
371
 
# File 'lib/clasp/specifications.rb', line 369

def extras
  @extras
end

#help ⇒ Object (readonly)

The flag’s help string



367
368
369
 
# File 'lib/clasp/specifications.rb', line 367

def help
  @help
end

#name ⇒ Object (readonly)

The alias’ name string



363
364
365
 
# File 'lib/clasp/specifications.rb', line 363

def name
  @name
end

Instance Method Details

#to_s ⇒ Object

String form of the option



372
373
374
375
 
# File 'lib/clasp/specifications.rb', line 372

def to_s

  "{#{name}; aliases=#{aliases.join(', ')}}"
end