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

#nameObject

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

#paramsObject

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_nameObject Also known as: short_name



28
29
30
# File 'lib/dracula/flag.rb', line 28

def alias_name
  params[:alias]
end


34
35
36
37
38
39
40
# File 'lib/dracula/flag.rb', line 34

def banner
  if short_name_banner
    "#{short_name_banner}, #{long_name_banner}"
  else
    long_name_banner
  end
end

#boolean?Boolean

Returns:

  • (Boolean)


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

def boolean?
  type == :boolean
end

#default_valueObject



20
21
22
23
24
25
26
# File 'lib/dracula/flag.rb', line 20

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

#has_default_value?Boolean

Returns:

  • (Boolean)


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

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

#long_name_bannerObject



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)


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

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

#short_name_bannerObject



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

#typeObject



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

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