Class: CLASP::Alias

Inherits:
Object
  • Object
show all
Defined in:
lib/clasp/aliases.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) ⇒ Alias

Returns a new instance of Alias.



203
204
205
206
207
208
209
 
# File 'lib/clasp/aliases.rb', line 203

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



214
215
216
 
# File 'lib/clasp/aliases.rb', line 214

def aliases
  @aliases
end

#extras ⇒ Object (readonly)

The flag’s extras



218
219
220
 
# File 'lib/clasp/aliases.rb', line 218

def extras
  @extras
end

#help ⇒ Object (readonly)

The flag’s help string



216
217
218
 
# File 'lib/clasp/aliases.rb', line 216

def help
  @help
end

#name ⇒ Object (readonly)

The alias’ name string



212
213
214
 
# File 'lib/clasp/aliases.rb', line 212

def name
  @name
end

Instance Method Details

#to_s ⇒ Object

String form of the option



221
222
223
224
 
# File 'lib/clasp/aliases.rb', line 221

def to_s

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