Class: OptParseValidator::OptBase

Inherits:
Object
  • Object
show all
Defined in:
lib/opt_parse_validator/opts/base.rb

Overview

Base Option This Option should not be called, children should be used.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(option, attrs = {}) ⇒ OptBase

Note:

The :default and :normalize ‘logics’ are done in OptParseValidator::OptParser#add_option

Returns a new instance of OptBase.

Parameters:

  • option (Array) —

    See OptionParser#on

  • attrs (Hash) (defaults to: {})

Options Hash (attrs):

  • :required (Boolean)
  • :default (Mixed) —

    The default value to use if the option is not supplied

  • :value_if_empty (Mixed) —

    The value to use if no argument has been supplied

  • :normalize (Array<Symbol>) —

    See #normalize



17
18
19
20
21
22
23
24
 
# File 'lib/opt_parse_validator/opts/base.rb', line 17

def initialize(option, attrs = {})
  @option = option
  @attrs  = attrs

  # TODO: incompatible attributes, ie required and require_unless at the same time

  append_help_messages
end

Instance Attribute Details

#attrs ⇒ Object (readonly)

Returns the value of attribute attrs.



6
7
8
 
# File 'lib/opt_parse_validator/opts/base.rb', line 6

def attrs
  @attrs
end

#option ⇒ Object (readonly)

Returns the value of attribute option.



6
7
8
 
# File 'lib/opt_parse_validator/opts/base.rb', line 6

def option
  @option
end

#required=(value) ⇒ Object (writeonly)

Sets the attribute required

Parameters:

  • value —

    the value to set the attribute required to.



5
6
7
 
# File 'lib/opt_parse_validator/opts/base.rb', line 5

def required=(value)
  @required = value
end

Instance Method Details

#advanced? ⇒ Boolean

Returns:

  • (Boolean) 


68
69
70
 
# File 'lib/opt_parse_validator/opts/base.rb', line 68

def advanced?
  attrs[:advanced] ? true : false
end

#alias? ⇒ Boolean

Returns:

  • (Boolean) 


63
64
65
 
# File 'lib/opt_parse_validator/opts/base.rb', line 63

def alias?
  false
end

#append_help_messages ⇒ Void

Returns:

  • (Void) 


27
28
29
30
31
32
 
# File 'lib/opt_parse_validator/opts/base.rb', line 27

def append_help_messages
  option << "Default: #{help_message_for_default}" if default
  option << "Value if no argument supplied: #{value_if_empty}" if value_if_empty
  option << 'This option is mandatory' if required?
  option << "This option is mandatory unless #{required_unless.join(' or ')} is/are supplied" unless required_unless.empty?
end

#choices ⇒ Array<Mixed>

Returns:

  • (Array<Mixed>) 


53
54
55
 
# File 'lib/opt_parse_validator/opts/base.rb', line 53

def choices
  attrs[:choices]
end

#default ⇒ Mixed

Returns:

  • (Mixed) 


48
49
50
 
# File 'lib/opt_parse_validator/opts/base.rb', line 48

def default
  attrs[:default]
end

#help_message_for_default ⇒ Object 



34
35
36
 
# File 'lib/opt_parse_validator/opts/base.rb', line 34

def help_message_for_default
  default.to_s
end

#help_messages ⇒ Array<String>

Returns:

  • (Array<String>) 


130
131
132
133
134
135
136
 
# File 'lib/opt_parse_validator/opts/base.rb', line 130

def help_messages
  first_message_index = option.index { |e| e[0] != '-' }

  return [] unless first_message_index

  option[first_message_index..-1]
end

#normalize(value) ⇒ Mixed

Apply each methods from attrs to the value if possible User input should not be used in this attrs

e.g: normalize: :to_sym will return the symbol of the value

normalize: [:to_sym, :upcase] Will return the upercased symbol

Parameters:

  • value (Mixed)

Returns:

  • (Mixed) 


91
92
93
94
95
96
97
98
99
 
# File 'lib/opt_parse_validator/opts/base.rb', line 91

def normalize(value)
  [*attrs[:normalize]].each do |method|
    next unless method.is_a?(Symbol)

    value = value.send(method) if value.respond_to?(method)
  end

  value
end

#required? ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
 
# File 'lib/opt_parse_validator/opts/base.rb', line 39

def required?
  @required ||= attrs[:required]
end

#required_unless ⇒ Object 



43
44
45
 
# File 'lib/opt_parse_validator/opts/base.rb', line 43

def required_unless
  @required_unless ||= [*attrs[:required_unless]]
end

#to_long ⇒ String

Returns The raw long option (e.g: –proxy).

Returns:

  • (String) —

    The raw long option (e.g: –proxy)



114
115
116
117
118
119
120
121
122
 
# File 'lib/opt_parse_validator/opts/base.rb', line 114

def to_long
  option.each do |option_attr|
    if option_attr =~ /^--/
      return option_attr.gsub(/ .*$/, '')
                        .gsub(/\[[^\]]+\]/, '')
    end
  end
  nil
end

#to_s ⇒ String

Returns:

  • (String) 


125
126
127
 
# File 'lib/opt_parse_validator/opts/base.rb', line 125

def to_s
  to_sym.to_s
end

#to_sym ⇒ Symbol

Returns:

  • (Symbol) 


102
103
104
105
106
107
108
109
110
111
 
# File 'lib/opt_parse_validator/opts/base.rb', line 102

def to_sym
  unless @symbol
    long_option = to_long

    raise Error, "Could not find option symbol for #{option}" unless long_option

    @symbol = long_option.gsub(/^--/, '').tr('-', '_').to_sym
  end
  @symbol
end

#validate(value) ⇒ Object

Parameters:

  • value (String) 


73
74
75
76
77
78
79
80
 
# File 'lib/opt_parse_validator/opts/base.rb', line 73

def validate(value)
  if value.nil? || value.to_s.empty?
    raise Error, 'Empty option value supplied' if value_if_empty.nil?

    return value_if_empty
  end
  value
end

#value_if_empty ⇒ Mixed

Returns:

  • (Mixed) 


58
59
60
 
# File 'lib/opt_parse_validator/opts/base.rb', line 58

def value_if_empty
  attrs[:value_if_empty]
end