Module: Brigadier::Parameters::Base

Included in:
Argument, Option, Toggle
Defined in:
lib/brigadier/parameters/base.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



4
5
6
 
# File 'lib/brigadier/parameters/base.rb', line 4

def description
  @description
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



4
5
6
 
# File 'lib/brigadier/parameters/base.rb', line 4

def name
  @name
end

#value ⇒ Object

Returns the value of attribute value.



4
5
6
 
# File 'lib/brigadier/parameters/base.rb', line 4

def value
  @value
end

Instance Method Details

#attribute_name ⇒ Object 



19
20
21
 
# File 'lib/brigadier/parameters/base.rb', line 19

def attribute_name
  @attribute_name ||= args.fetch(:attribute_name, name).to_s
end

#block_defined? ⇒ Boolean

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/brigadier/parameters/base.rb', line 41

def block_defined?
  !block.nil?
end

#forbidden_parameters ⇒ Object 



6
7
8
 
# File 'lib/brigadier/parameters/base.rb', line 6

def forbidden_parameters
  [ :name, :description, :value ]
end

#hidden? ⇒ Boolean

Returns:

  • (Boolean) 


23
24
25
 
# File 'lib/brigadier/parameters/base.rb', line 23

def hidden?
  args.fetch(:hidden, false)
end

#normalised_attribute_name ⇒ Object 



15
16
17
 
# File 'lib/brigadier/parameters/base.rb', line 15

def normalised_attribute_name
  attribute_name.gsub(/[ -]/, '_')
end

#required? ⇒ Boolean

Returns:

  • (Boolean) 


37
38
39
 
# File 'lib/brigadier/parameters/base.rb', line 37

def required?
  args.fetch(:required, false)
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
34
35
 
# File 'lib/brigadier/parameters/base.rb', line 31

def valid?
  validate! && true
rescue Exceptions::Base
  false
end

#value? ⇒ Boolean

Returns:

  • (Boolean) 


27
28
29
 
# File 'lib/brigadier/parameters/base.rb', line 27

def value?
  !value.nil?
end