Class: Clamp::Attribute::Definition
- Inherits:
-
Object
- Object
- Clamp::Attribute::Definition
show all
- Defined in:
- lib/clamp/attribute/definition.rb
Instance Attribute Summary collapse
Instance Method Summary
collapse
Constructor Details
#initialize(options) ⇒ Definition
Returns a new instance of Definition.
8
9
10
11
12
13
14
15
16
17
|
# File 'lib/clamp/attribute/definition.rb', line 8
def initialize(options)
if options.key?(:attribute_name)
@attribute_name = options[:attribute_name].to_s
end
@default_value = options[:default] if options.key?(:default)
if options.key?(:environment_variable)
@environment_variable = options[:environment_variable]
end
@hidden = options[:hidden] if options.key?(:hidden)
end
|
Instance Attribute Details
#description ⇒ Object
Returns the value of attribute description.
19
20
21
|
# File 'lib/clamp/attribute/definition.rb', line 19
def description
@description
end
|
#environment_variable ⇒ Object
Returns the value of attribute environment_variable.
19
20
21
|
# File 'lib/clamp/attribute/definition.rb', line 19
def environment_variable
@environment_variable
end
|
Instance Method Details
#append_method ⇒ Object
45
46
47
|
# File 'lib/clamp/attribute/definition.rb', line 45
def append_method
"append_to_#{attribute_name}" if multivalued?
end
|
#attribute_name ⇒ Object
61
62
63
|
# File 'lib/clamp/attribute/definition.rb', line 61
def attribute_name
@attribute_name ||= infer_attribute_name
end
|
#default_method ⇒ Object
37
38
39
|
# File 'lib/clamp/attribute/definition.rb', line 37
def default_method
"default_#{read_method}"
end
|
#default_value ⇒ Object
65
66
67
68
69
70
71
|
# File 'lib/clamp/attribute/definition.rb', line 65
def default_value
if defined?(@default_value)
@default_value
elsif multivalued?
[]
end
end
|
#help ⇒ Object
25
26
27
|
# File 'lib/clamp/attribute/definition.rb', line 25
def help
[help_lhs, help_rhs]
end
|
#help_rhs ⇒ Object
21
22
23
|
# File 'lib/clamp/attribute/definition.rb', line 21
def help_rhs
description + default_description
end
|
#hidden? ⇒ Boolean
57
58
59
|
# File 'lib/clamp/attribute/definition.rb', line 57
def hidden?
@hidden
end
|
#ivar_name ⇒ Object
29
30
31
|
# File 'lib/clamp/attribute/definition.rb', line 29
def ivar_name
"@#{attribute_name}"
end
|
#multivalued? ⇒ Boolean
49
50
51
|
# File 'lib/clamp/attribute/definition.rb', line 49
def multivalued?
@multivalued
end
|
#of(command) ⇒ Object
73
74
75
|
# File 'lib/clamp/attribute/definition.rb', line 73
def of(command)
Attribute::Instance.new(self, command)
end
|
#option_missing_message ⇒ Object
77
78
79
80
81
82
83
84
85
86
|
# File 'lib/clamp/attribute/definition.rb', line 77
def option_missing_message
if environment_variable
Clamp.message(:option_or_env_required,
:option => switches.first,
:env => environment_variable)
else
Clamp.message(:option_required,
:option => switches.first)
end
end
|
#read_method ⇒ Object
33
34
35
|
# File 'lib/clamp/attribute/definition.rb', line 33
def read_method
attribute_name
end
|
#required? ⇒ Boolean
53
54
55
|
# File 'lib/clamp/attribute/definition.rb', line 53
def required?
@required
end
|
#write_method ⇒ Object
41
42
43
|
# File 'lib/clamp/attribute/definition.rb', line 41
def write_method
"#{attribute_name}="
end
|