Class: Gloo::Objs::Select

Inherits:
Core::Obj show all
Defined in:
lib/gloo/objs/cli/select.rb

Constant Summary collapse

KEYWORD = 
'select'.freeze
KEYWORD_SHORT = 
'sel'.freeze
PROMPT = 
'prompt'.freeze
OPTIONS = 
'options'.freeze
RESULT = 
'result'.freeze

Constants inherited from Core::Baseo

Core::Baseo::NOT_IMPLEMENTED_ERR

Instance Attribute Summary

Attributes inherited from Core::Obj

#children, #parent, #value

Attributes inherited from Core::Baseo

#name

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Core::Obj

#add_child, can_create?, #can_receive_message?, #child_count, #child_index, #contains_child?, #delete_children, #dispatch, #display_value, #find_add_child, #find_child, help, inherited, #initialize, #is_alias?, #is_function?, #msg_reload, #msg_unload, #multiline_value?, #pn, #remove_child, #render, #root?, #send_message, #set_parent, #set_value, #type_display, #value_display, #value_is_array?, #value_is_blank?, #value_string?

Methods inherited from Core::Baseo

#initialize, #type_display

Constructor Details

This class inherits a constructor from Gloo::Core::Obj

Class Method Details

.messages ⇒ Object

Get a list of message names that this object receives.



108
109
110
 
# File 'lib/gloo/objs/cli/select.rb', line 108

def self.messages
  return super + %w[run]
end

.short_typename ⇒ Object

The short name of the object type.



27
28
29
 
# File 'lib/gloo/objs/cli/select.rb', line 27

def self.short_typename
  return KEYWORD_SHORT
end

.typename ⇒ Object

The name of the object type.



20
21
22
 
# File 'lib/gloo/objs/cli/select.rb', line 20

def self.typename
  return KEYWORD
end

Instance Method Details

#add_children_on_create? ⇒ Boolean

Does this object have children to add when an object is created in interactive mode? This does not apply during obj load, etc.

Returns:



85
86
87
 
# File 'lib/gloo/objs/cli/select.rb', line 85

def add_children_on_create?
  return true
end

#add_default_children ⇒ Object

Add children to this object. This is used by containers to add children needed for default configurations.



94
95
96
97
98
99
 
# File 'lib/gloo/objs/cli/select.rb', line 94

def add_default_children
  fac = @engine.factory
  fac.create_string PROMPT, '>', self
  fac.create_can OPTIONS, self
  fac.create_string RESULT, nil, self
end

#key_for_option(selected) ⇒ Object

Get the value of the selected item.



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/gloo/objs/cli/select.rb', line 55

def key_for_option( selected )
  o = find_child OPTIONS
  return nil unless o

  o.children.each do |c|
    return c.value if c.name == selected
  end

  return nil
end

#msg_run ⇒ Object

Show the prompt and get the user’s selection.



115
116
117
118
119
120
121
122
123
 
# File 'lib/gloo/objs/cli/select.rb', line 115

def msg_run
  prompt = prompt_value
  return unless prompt

  # Page size was part of the tty-prompt but not used now.
  # per = Gloo::App::Settings.page_size( @engine )
  result = @engine.platform.prompt.select( prompt, options )
  set_result self.key_for_option( result )
end

#options ⇒ Object

Get the list of options for selection.



45
46
47
48
49
50
 
# File 'lib/gloo/objs/cli/select.rb', line 45

def options
  o = find_child OPTIONS
  return [] unless o

  return o.children.map( &:name )
end

#prompt_value ⇒ Object

Get the prompt from the child object. Returns nil if there is none.



35
36
37
38
39
40
 
# File 'lib/gloo/objs/cli/select.rb', line 35

def prompt_value
  o = find_child PROMPT
  return nil unless o

  return o.value
end

#set_result(data) ⇒ Object

Set the result of the system call.



69
70
71
72
73
74
 
# File 'lib/gloo/objs/cli/select.rb', line 69

def set_result( data )
  r = find_child RESULT
  return nil unless r

  r.set_value data
end