Class: Brigadier::Parameters::Toggle

Inherits:
Object
  • Object
show all
Includes:
Base
Defined in:
lib/brigadier/parameters/toggle.rb

Instance Attribute Summary

Attributes included from Base

#description, #name, #value

Instance Method Summary collapse

Methods included from Base

#attribute_name, #block_defined?, #forbidden_parameters, #hidden?, #normalised_attribute_name, #required?, #valid?, #value?

Constructor Details

#initialize(name, description, args, block) ⇒ Toggle

Returns a new instance of Toggle.



6
7
8
9
10
11
12
13
 
# File 'lib/brigadier/parameters/toggle.rb', line 6

def initialize(name, description, args, block)
  @name = name
  @description = description
  @args = args
  @block = block
  @value = default_value
  assign_value_from_env_variable
end

Instance Method Details

#disable! ⇒ Object 



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

def disable!
  assign_value(false)
end

#display_description ⇒ Object 



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

def display_description
  '%s (%s)' % [ description, description_detail ]
end

#display_name ⇒ Object 



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

def display_name
  "--#{name}"
end

#enable! ⇒ Object 



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

def enable!
  assign_value(true)
end