Class: Clamp::Parameter

Inherits:
Object
  • Object
show all
Defined in:
lib/clamp/parameter.rb,
lib/clamp/parameter/parsing.rb,
lib/clamp/parameter/declaration.rb

Defined Under Namespace

Modules: Declaration, Parsing

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, description, options = {}) ⇒ Parameter

Returns a new instance of Parameter.



5
6
7
8
9
10
11
12
 
# File 'lib/clamp/parameter.rb', line 5

def initialize(name, description, options = {})
  @name = name
  @description = description
  infer_attribute_name_and_multiplicity
  if options.has_key?(:attribute_name)
    @attribute_name = options[:attribute_name].to_s 
  end
end

Instance Attribute Details

#attribute_name ⇒ Object (readonly)

Returns the value of attribute attribute_name.



14
15
16
 
# File 'lib/clamp/parameter.rb', line 14

def attribute_name
  @attribute_name
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



14
15
16
 
# File 'lib/clamp/parameter.rb', line 14

def description
  @description
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



14
15
16
 
# File 'lib/clamp/parameter.rb', line 14

def name
  @name
end

Instance Method Details

#consume(arguments) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/clamp/parameter.rb', line 20

def consume(arguments)
  if required? && arguments.empty?
    raise ArgumentError, "no value provided"
  end
  if multivalued?
    arguments.shift(arguments.length)
  else
    arguments.shift
  end
end

#help ⇒ Object 



16
17
18
 
# File 'lib/clamp/parameter.rb', line 16

def help
  [name, description]
end