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:



16
17
18
19
 
# File 'lib/ttytest/terminal.rb', line 16

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



9
10
11
 
# File 'lib/ttytest/terminal.rb', line 9

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



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#cursor_hidden? ⇒ true, false

Returns:

  • (true, false)

See Also:



111
112
113
114
115
 
# File 'lib/ttytest/terminal.rb', line 111

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

#cursor_visible? ⇒ true, false

Returns:

  • (true, false)

See Also:



111
112
113
114
115
 
# File 'lib/ttytest/terminal.rb', line 111

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

#cursor_x ⇒ Integer

Returns:

  • (Integer)

See Also:



111
112
113
114
115
 
# File 'lib/ttytest/terminal.rb', line 111

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

#cursor_y ⇒ Integer

Returns:

  • (Integer)

See Also:



111
112
113
114
115
 
# File 'lib/ttytest/terminal.rb', line 111

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

#height ⇒ Integer

Returns:

  • (Integer)

See Also:



111
112
113
114
115
 
# File 'lib/ttytest/terminal.rb', line 111

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

#print ⇒ Object

Prints the current state of the terminal to stdout. See capture to get the raw string.



111
112
113
114
115
 
# File 'lib/ttytest/terminal.rb', line 111

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

#print_rows ⇒ Object

Prints the current state of the terminal as an array to stdout. See rows to get the raw array.



111
112
113
114
115
 
# File 'lib/ttytest/terminal.rb', line 111

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

#row(row) ⇒ String

Returns:

  • (String)

See Also:



111
112
113
114
115
 
# File 'lib/ttytest/terminal.rb', line 111

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

#rows ⇒ Array<String>

Returns:

  • (Array<String>)

See Also:



111
112
113
114
115
 
# File 'lib/ttytest/terminal.rb', line 111

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

#send_backspace ⇒ Object

Simulate typing the backspace key in the terminal.



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_backspaces ⇒ Object

Simulates typing backspace the specified number of times.

Parameters:

  • number (Integer) —

    of times to send backspace



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_clear ⇒ Object

Clears the screen in the terminal using ascii clear command.



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_delete ⇒ Object

Simulate typing the delete key in the terminal.



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_deletes ⇒ Object

Simulates typing delete the specified number of times.

Parameters:

  • number (Integer) —

    of times to send delete



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_down_arrow ⇒ Object

Simulate typing the down arrow key in the terminal.



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_down_arrows ⇒ Object

Simulates typing the down arrow the specified number of times.

Parameters:

  • number (Integer) —

    of times to send down arrow



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_end ⇒ Object

Simulates typing in the End key in the terminal.



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_home ⇒ Object

Simulates typing in the Home key in the terminal.



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_keys(*keys) ⇒ Object

Simulate typing keys into the terminal. For canonical cli’s/shells which read line by line.

Parameters:

  • keys (String) —

    keys to send to the terminal



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_keys_exact ⇒ Object

Send tmux send-keys command to the terminal, such as DC or Enter, to simulate pressing that key in the terminal.



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_keys_one_at_a_time(keys) ⇒ Object

Simulate typing keys into the terminal. For noncanonical cli’s/shells which read character by character.

Parameters:

  • keys (String) —

    keys to send to the terminal



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_left_arrow ⇒ Object

Simulate typing the left arrow key in the terminal.



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_left_arrows ⇒ Object

Simulates typing left arrow the specified number of times.

Parameters:

  • number (Integer) —

    of times to send left arrow



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_newline ⇒ Object

Simulate typing enter by sending newline character to the terminal.



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_newlines ⇒ Object

Simulates sending newline the specified number of times.

Parameters:

  • number (Integer) —

    of times to send newline



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_right_arrow ⇒ Object

Simulate typing the right arrow key in the terminal.



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_right_arrows ⇒ Object

Simulates typing right arrow the specified number of times.

Parameters:

  • number (Integer) —

    of times to send right arrow



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_up_arrow ⇒ Object

Simulate typing the up arrow key in the terminal.



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#send_up_arrows ⇒ Object

Simulates typing the up arrow the specified number of times.

Parameters:

  • number (Integer) —

    of times to send up arrow



73
74
75
76
77
78
79
80
81
 
# File 'lib/ttytest/terminal.rb', line 73

def_delegators :@driver_terminal,
:send_keys, :send_keys_one_at_a_time,
:send_newline, :send_newlines,
:send_delete, :send_deletes,
:send_backspace, :send_backspaces,
:send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
:send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
:send_keys_exact, :send_home, :send_end, :send_clear,
:capture

#width ⇒ Integer

Returns:

  • (Integer)

See Also:



111
112
113
114
115
 
# File 'lib/ttytest/terminal.rb', line 111

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