Class: Dracula::Flag

Inherits:
Struct
  • Object
show all
Defined in:
lib/dracula/flag.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#name ⇒ Object

Returns the value of attribute name

Returns:

  • (Object) —

    the current value of name



2
3
4
 
# File 'lib/dracula/flag.rb', line 2

def name
  @name
end

#params ⇒ Object

Returns the value of attribute params

Returns:

  • (Object) —

    the current value of params



2
3
4
 
# File 'lib/dracula/flag.rb', line 2

def params
  @params
end

Instance Method Details

#alias_name ⇒ Object Also known as: short_name 



32
33
34
 
# File 'lib/dracula/flag.rb', line 32

def alias_name
  params[:alias]
end
 


38
39
40
 
# File 'lib/dracula/flag.rb', line 38

def banner
  [short_name_banner, long_name_banner].compact.join(", ")
end

#boolean? ⇒ Boolean

Returns:

  • (Boolean) 


16
17
18
 
# File 'lib/dracula/flag.rb', line 16

def boolean?
  type == :boolean
end

#default_value ⇒ Object 



24
25
26
27
28
29
30
 
# File 'lib/dracula/flag.rb', line 24

def default_value
  if boolean?
    params.key?(:default) ? params[:default] : false
  else
    params[:default]
  end
end

#description ⇒ Object 



4
5
6
 
# File 'lib/dracula/flag.rb', line 4

def description
  params[:desc]
end

#has_default_value? ⇒ Boolean

Returns:

  • (Boolean) 


20
21
22
 
# File 'lib/dracula/flag.rb', line 20

def has_default_value?
  params.has_key?(:default) || boolean?
end

#long_name_banner ⇒ Object 



52
53
54
55
56
57
58
 
# File 'lib/dracula/flag.rb', line 52

def long_name_banner
  if boolean?
    "--#{name}"
  else
    "--#{name} #{name.upcase}"
  end
end

#required? ⇒ Boolean

Returns:

  • (Boolean) 


12
13
14
 
# File 'lib/dracula/flag.rb', line 12

def required?
  params[:required] == true
end

#short_name_banner ⇒ Object 



42
43
44
45
46
47
48
49
50
 
# File 'lib/dracula/flag.rb', line 42

def short_name_banner
  return nil if short_name.nil?

  if boolean?
    "-#{short_name}"
  else
    "-#{short_name} #{name.upcase}"
  end
end

#type ⇒ Object 



8
9
10
 
# File 'lib/dracula/flag.rb', line 8

def type
  params[:type] || :string
end