Class: Gloo::Objs::Confirm

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

Constant Summary collapse

KEYWORD =
'confirm'.freeze
KEYWORD_SHORT =
'confirm'.freeze
PROMPT =
'prompt'.freeze
DEFAULT_PROMPT =
'> '.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

.messagesObject

Get a list of message names that this object receives.



79
80
81
# File 'lib/gloo/objs/cli/confirm.rb', line 79

def self.messages
  return super + [ 'run' ]
end

.short_typenameObject

The short name of the object type.



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

def self.short_typename
  return KEYWORD_SHORT
end

.typenameObject

The name of the object type.



20
21
22
# File 'lib/gloo/objs/cli/confirm.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:



59
60
61
# File 'lib/gloo/objs/cli/confirm.rb', line 59

def add_children_on_create?
  return true
end

#add_default_childrenObject

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



66
67
68
69
70
# File 'lib/gloo/objs/cli/confirm.rb', line 66

def add_default_children
  fac = @engine.factory
  fac.create_string PROMPT, DEFAULT_PROMPT, self
  fac.create_bool RESULT, nil, self
end

#msg_runObject

Run the confirmation command.



86
87
88
89
90
91
92
# File 'lib/gloo/objs/cli/confirm.rb', line 86

def msg_run
  prompt = prompt_value
  return unless prompt

  result = @engine.platform.prompt.yes?( prompt )
  set_result result
end

#prompt_valueObject

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



35
36
37
38
39
40
# File 'lib/gloo/objs/cli/confirm.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.



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

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

  r.set_value data
end