Class: TTYtest::Terminal

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/ttytest/terminal.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(driver_terminal, max_wait_time: nil) ⇒ Terminal

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Terminal.

See Also:



14
15
16
17
 
# File 'lib/ttytest/terminal.rb', line 14

def initialize(driver_terminal, max_wait_time: nil)
  @driver_terminal = driver_terminal
  @max_wait_time = max_wait_time || TTYtest.default_max_wait_time
end

Instance Attribute Details

#max_wait_time ⇒ Integer

the maximum amount of time (in seconds) to retry assertions before failing.

Returns:

  • (Integer) —

    the current value of max_wait_time



7
8
9
 
# File 'lib/ttytest/terminal.rb', line 7

def max_wait_time
  @max_wait_time
end

Instance Method Details

#capture ⇒ Capture

Capture the current state of the terminal

Returns:

  • (Capture) —

    instantaneous state of the terminal when called



25
 
# File 'lib/ttytest/terminal.rb', line 25

def_delegators :@driver_terminal, :send_keys, :capture

#cursor_hidden? ⇒ true, false

Returns:

  • (true, false)

See Also:



51
 
# File 'lib/ttytest/terminal.rb', line 51

def_delegators :capture, :rows, :row, :width, :height, :cursor_x, :cursor_y, :cursor_visible?, :cursor_hidden?

#cursor_visible? ⇒ true, false

Returns:

  • (true, false)

See Also:



51
 
# File 'lib/ttytest/terminal.rb', line 51

def_delegators :capture, :rows, :row, :width, :height, :cursor_x, :cursor_y, :cursor_visible?, :cursor_hidden?

#cursor_x ⇒ Integer

Returns:

  • (Integer)

See Also:



51
 
# File 'lib/ttytest/terminal.rb', line 51

def_delegators :capture, :rows, :row, :width, :height, :cursor_x, :cursor_y, :cursor_visible?, :cursor_hidden?

#cursor_y ⇒ Integer

Returns:

  • (Integer)

See Also:



51
 
# File 'lib/ttytest/terminal.rb', line 51

def_delegators :capture, :rows, :row, :width, :height, :cursor_x, :cursor_y, :cursor_visible?, :cursor_hidden?

#height ⇒ Integer

Returns:

  • (Integer)

See Also:



51
 
# File 'lib/ttytest/terminal.rb', line 51

def_delegators :capture, :rows, :row, :width, :height, :cursor_x, :cursor_y, :cursor_visible?, :cursor_hidden?

#row(row) ⇒ String

Returns:

  • (String)

See Also:



51
 
# File 'lib/ttytest/terminal.rb', line 51

def_delegators :capture, :rows, :row, :width, :height, :cursor_x, :cursor_y, :cursor_visible?, :cursor_hidden?

#rows ⇒ Array<String>

Returns:

  • (Array<String>)

See Also:



51
 
# File 'lib/ttytest/terminal.rb', line 51

def_delegators :capture, :rows, :row, :width, :height, :cursor_x, :cursor_y, :cursor_visible?, :cursor_hidden?

#send_keys(*keys) ⇒ Object

Simulate typing keys into the terminal

Parameters:

  • keys (String) —

    keys to send to the terminal



25
 
# File 'lib/ttytest/terminal.rb', line 25

def_delegators :@driver_terminal, :send_keys, :capture

#width ⇒ Integer

Returns:

  • (Integer)

See Also:



51
 
# File 'lib/ttytest/terminal.rb', line 51

def_delegators :capture, :rows, :row, :width, :height, :cursor_x, :cursor_y, :cursor_visible?, :cursor_hidden?