Module: Morpheus::Cli::OptionTypes

Includes:
Term::ANSIColor
Defined in:
lib/morpheus/cli/option_types.rb

Class Method Summary collapse

Class Method Details

.checkbox_prompt(option_type) ⇒ Object 



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/morpheus/cli/option_types.rb', line 227

def self.checkbox_prompt(option_type)
value_found = false
value = nil
while !value_found do
    print "#{option_type['fieldLabel']} (yes/no) [#{option_type['defaultValue'] == 'on' ? 'yes' : 'no'}]: "
    input = $stdin.gets.chomp!
    if input.downcase == 'yes'
      value = 'on'
    elsif input.downcase == 'no'
      value = 'off'
    else
      value = option_type['defaultValue']
    end
    if input == '?'
      help_prompt(option_type)
    elsif !value.nil? || option_type['required'] != true
      value_found = true
    end
  end
  return value
end

.confirm(message, options = {}) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/morpheus/cli/option_types.rb', line 9

def self.confirm(message,options={})
if options[:yes] == true
  return true
end
default_value = options[:default]
value_found = false
while value_found == false do
    if default_value.nil?
      print "#{message} (yes/no): "
    else
      print "#{message} (yes/no) [#{!!default_value ? 'yes' : 'no'}]: "
    end
    input = $stdin.gets.chomp!
    if input.empty? && !default_value.nil?
      return !!default_value
    end
    if input.downcase == 'yes' || input.downcase == 'y'
      return true
    elsif input.downcase == 'no' || input.downcase == 'n'
      return false
    else
      puts "Invalid Option... Please try again."
    end
  end
end

.display_option_types_help(option_types) ⇒ Object 



364
365
366
 
# File 'lib/morpheus/cli/option_types.rb', line 364

def self.display_option_types_help(option_types)
  puts self.format_option_types_help(option_types)
end

.display_select_options(select_options = []) ⇒ Object 



347
348
349
350
351
352
353
354
 
# File 'lib/morpheus/cli/option_types.rb', line 347

def self.display_select_options(select_options = [])
  puts "\nOptions"
  puts "==============="
  select_options.each do |option|
    puts " * #{option['name']} [#{option['value']}]"
  end
  puts "\n\n"
end

.file_prompt(option_type) ⇒ Object 



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/morpheus/cli/option_types.rb', line 304

def self.file_prompt(option_type)
value_found = false
value = nil
while !value_found do
    print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }#{!option_type['required'] ? ' (optional)' : ''}#{option_type['defaultValue'] ? ' ['+option_type['defaultValue'].to_s+']' : ''}: "
    Readline.completion_append_character = ""
    Readline.basic_word_break_characters = ''
    Readline.completion_proc = proc {|s| Readline::FILENAME_COMPLETION_PROC.call(s) }
    input = Readline.readline("#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }#{!option_type['required'] ? ' (optional)' : ''}#{option_type['defaultValue'] ? ' ['+option_type['defaultValue'].to_s+']' : ''} ['?' for options]: ", false).to_s
    input = input.chomp.strip
    #input = $stdin.gets.chomp!
    value = input.empty? ? option_type['defaultValue'] : input.to_s
    if input == '?'
      help_prompt(option_type)
    elsif value.empty? && option_type['required'] != true
      value = nil
      value_found = true
    elsif value
      filename = File.expand_path(value)
      if !File.exists?(filename)
        # print_red_alert "File not found: #{filename}"
        # exit 1
        print Term::ANSIColor.red,"  File not found: #{filename}",Term::ANSIColor.reset, "\n"
      elsif !File.file?(filename)
        print Term::ANSIColor.red,"  Argument is not a file: #{filename}",Term::ANSIColor.reset, "\n"
      else
        value = filename
        value_found = true
      end
    end
  end
  return value
end

.format_option_types_help(option_types) ⇒ Object 



356
357
358
359
360
361
362
363
 
# File 'lib/morpheus/cli/option_types.rb', line 356

def self.format_option_types_help(option_types)
  if option_types.empty?
    "Available Options:\nNone\n\n"
  else
    option_lines = option_types.collect {|it| "    -O #{it['fieldName']}=\"value\"" }.join("\n")
    "Available Options:\n#{option_lines}\n\n"
  end
end

.generic_prompt(option_type) ⇒ Object 



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/morpheus/cli/option_types.rb', line 249

def self.generic_prompt(option_type)
value_found = false
value = nil
while !value_found do
    print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }#{!option_type['required'] ? ' (optional)' : ''}#{option_type['defaultValue'] ? ' ['+option_type['defaultValue'].to_s+']' : ''}: "
    input = $stdin.gets.chomp!
    value = input.empty? ? option_type['defaultValue'] : input
    if input == '?'
      help_prompt(option_type)
    elsif !value.nil? || option_type['required'] != true
      value_found = true
    end
  end
  return value
end

.help_prompt(option_type) ⇒ Object 



338
339
340
 
# File 'lib/morpheus/cli/option_types.rb', line 338

def self.help_prompt(option_type)
  print Term::ANSIColor.green,"  * #{option_type['fieldLabel']} [-O #{option_type['fieldContext'] ? (option_type['fieldContext']+'.') : ''}#{option_type['fieldName']}=] - ", Term::ANSIColor.reset , "#{option_type['description']}\n"
end

.load_source_options(source, api_client, params) ⇒ Object 



343
344
345
 
# File 'lib/morpheus/cli/option_types.rb', line 343

def self.load_source_options(source,api_client,params)
  api_client.options.options_for_source(source,params)['data']
end

.multiline_prompt(option_type) ⇒ Object 



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/morpheus/cli/option_types.rb', line 265

def self.multiline_prompt(option_type)
value_found = false
value = nil
while !value_found do
    if value.nil?
      print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }#{!option_type['required'] ? ' (optional)' : ''} [Type 'EOF' to stop input]: \n"
    end
    input = $stdin.gets.chomp!
    # value = input.empty? ? option_type['defaultValue'] : input
    if input == '?' && value.nil?
      help_prompt(option_type)
    elsif (!value.nil? || option_type['required'] != true) && input.chomp == 'EOF'
      value_found = true
    else
      if value.nil?
        value = ''
      end
      value << input + "\n"
    end
  end
  return value
end

.number_prompt(option_type) ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/morpheus/cli/option_types.rb', line 158

def self.number_prompt(option_type)
value_found = false
value = nil
while !value_found do
    print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }#{!option_type['required'] ? ' (optional)' : ''}#{option_type['defaultValue'] ? ' ['+option_type['defaultValue'].to_s+']' : ''}: "
    input = $stdin.gets.chomp!
    value = input.empty? ? option_type['defaultValue'] : input.to_i
    if input == '?'
      help_prompt(option_type)
    elsif !value.nil? || option_type['required'] != true
      value_found = true
    end
  end
  return value
end

.password_prompt(option_type) ⇒ Object 



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/morpheus/cli/option_types.rb', line 288

def self.password_prompt(option_type)
value_found = false
while !value_found do
    print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }#{!option_type['required'] ? ' (optional)' : ''}: "
    input = $stdin.noecho(&:gets).chomp!
    value = input
    print "\n"
    if input == '?'
      help_prompt(option_type)
    elsif !value.empty? || option_type['required'] != true
      value_found = true
    end
  end
  return value
end

.prompt(option_types, options = {}, api_client = nil, api_params = {}, no_prompt = false) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/morpheus/cli/option_types.rb', line 35

def self.prompt(option_types, options={}, api_client=nil,api_params={}, no_prompt=false)
  results = {}
  options = options || {}
  # puts "Options Prompt #{options}"
  option_types.sort { |x,y| x['displayOrder'].to_i <=> y['displayOrder'].to_i }.each do |option_type|
    context_map = results
    value = nil
    value_found=false
    if option_type['fieldContext']
      results[option_type['fieldContext']] ||= {}
      context_map = results[option_type['fieldContext']]
      if options[option_type['fieldContext']] and options[option_type['fieldContext']].key?(option_type['fieldName'])
        value = options[option_type['fieldContext']][option_type['fieldName']]
        if option_type['type'] == 'number'
          value = value.to_i
        end
        value_found = true
      end
    end

    if value_found == false && options.key?(option_type['fieldName'])
      value = options[option_type['fieldName']]
      if option_type['type'] == 'number'
        value = value.to_i
      end
      value_found = true
    end

    # no_prompt means skip prompting and instead
    # use default value or error if a required option is not present
    no_prompt = no_prompt || options[:no_prompt]
    if no_prompt
      if !value_found
        if option_type['defaultValue']
          value = option_type['defaultValue']
          value_found = true
        end
        if !value_found
          # select type is special because it supports skipSingleOption
          # and prints the available options on error
          if option_type['type'] == 'select'
            value = select_prompt(option_type, api_client, api_params, true)
            value_found = !!value
          end
          if !value_found
            if option_type['required']
              print Term::ANSIColor.red, "\nMissing Required Option\n\n"
              print Term::ANSIColor.red, "  * #{option_type['fieldLabel']} [-O #{option_type['fieldContext'] ? (option_type['fieldContext']+'.') : ''}#{option_type['fieldName']}=] - ", Term::ANSIColor.reset , "#{option_type['description']}\n"
              print "\n"
              exit 1
            else
              next
            end
          end
        end
      end
    end

    if !value_found
      if option_type['type'] == 'number'
        value = number_prompt(option_type)
      elsif option_type['type'] == 'password'
        value = password_prompt(option_type)
      elsif option_type['type'] == 'checkbox'
        value = checkbox_prompt(option_type)
      elsif option_type['type'] == 'radio'
        value = radio_prompt(option_type)
      elsif option_type['type'] == 'textarea'
        value = multiline_prompt(option_type)
      elsif option_type['type'] == 'code-editor'
        value = multiline_prompt(option_type)
      elsif option_type['type'] == 'select'
        value = select_prompt(option_type,api_client, api_params)
      elsif option_type['type'] == 'hidden'
        value = option_type['defaultValue']
        input = value
      elsif option_type['type'] == 'file'
        value = file_prompt(option_type)
      else
        value = generic_prompt(option_type)
      end
    end
    context_map[option_type['fieldName']] = value
  end

  return results
end

.radio_prompt(option_type) ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/morpheus/cli/option_types.rb', line 124

def self.radio_prompt(option_type)
value_found = false
value = nil
options = []
if option_type['config'] and option_type['config']['radioOptions']
  option_type['config']['radioOptions'].each do |radio_option|
    options << {key: radio_option['key'], checked: radio_option['checked']}
  end
end
optionString = options.collect{ |b| b[:checked] ? "(#{b[:key]})" : b[:key]}.join(', ')
while !value_found do
    print "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }[#{optionString}]: "
    input = $stdin.gets.chomp!
    if input == '?'
      help_prompt(option_type)
    else
      if input.nil? || input.empty?
        selectedOption = options.find{|o| o[:checked] == true}
      else
        selectedOption = options.find{|o| o[:key].downcase == input.downcase}
      end
      if selectedOption
        value = selectedOption[:key]
      else
        puts "Invalid Option. Please select from #{optionString}."
      end
      if !value.nil? || option_type['required'] != true
        value_found = true
      end
    end
  end
  return value
end

.select_prompt(option_type, api_client, api_params = {}, no_prompt = false) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/morpheus/cli/option_types.rb', line 174

def self.select_prompt(option_type,api_client, api_params={}, no_prompt=false)
value_found = false
value = nil
if option_type['selectOptions']
  select_options = option_type['selectOptions']
elsif option_type['optionSource']
  select_options = load_source_options(option_type['optionSource'],api_client,api_params)
else
  raise "select_prompt() requires selectOptions or optionSource!"
end
if !select_options.nil? && select_options.count == 1 && option_type['skipSingleOption'] == true
  value_found = true
  value = select_options[0]['value']
end
if no_prompt
  if !value_found
    if option_type['required']
      print Term::ANSIColor.red, "\nMissing Required Option\n\n"
      print Term::ANSIColor.red, "  * #{option_type['fieldLabel']} [-O #{option_type['fieldContext'] ? (option_type['fieldContext']+'.') : ''}#{option_type['fieldName']}=] - ", Term::ANSIColor.reset , "#{option_type['description']}\n"
      display_select_options(select_options)
      print "\n"
      exit 1
    else
      return nil
    end
  end
end
while !value_found do
    Readline.completion_append_character = ""
    Readline.basic_word_break_characters = ''
    Readline.completion_proc = proc {|s| select_options.clone.collect{|opt| opt['name']}.grep(/^#{Regexp.escape(s)}/)}
    input = Readline.readline("#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }#{!option_type['required'] ? ' (optional)' : ''}#{option_type['defaultValue'] ? ' ['+option_type['defaultValue'].to_s+']' : ''} ['?' for options]: ", false).to_s
    input = input.chomp.strip
    if input.empty?
      value = option_type['defaultValue']
    else
      select_option = select_options.find{|b| b['name'] == input || (!b['value'].nil? && b['value'].to_s == input) || (b['value'].nil? && input.empty?)}
      if select_option
        value = select_option['value']
      elsif !input.nil?  && !input.empty?
        input = '?'
      end
    end
    if input == '?'
      help_prompt(option_type)
      display_select_options(select_options)
    elsif !value.nil? || option_type['required'] != true
      value_found = true
    end
  end
  return value
end