ttytest2 0.9.8 → 0.9.10

data/lib/ttytest/matchers.rb

@@ -1,157 +1,171 @@
-# frozen_string_literal: true
-
-module TTYtest
-  # Assertions for ttytest2.
-  module Matchers
-    # Asserts the contents of a single row match the value expected
-    # @param [Integer] row_number the row (starting from 0) to test against
-    # @param [String] expected the expected value of the row. Any trailing whitespace is ignored
-    # @raise [MatchError] if the row doesn't match exactly
-    def assert_row(row_number, expected)
-      expected = expected.rstrip
-      actual = row(row_number)
-      return if actual == expected
-
-      raise MatchError,
-            "expected row #{row_number} to be #{expected.inspect} but got #{actual.inspect}\nEntire screen:\n#{self}"
-    end
-
-    # Asserts the contents of a single row contains the expected string at a specific position
-    # @param [Integer] row_number the row (starting from 0) to test against
-    # @param [Integer] column_start the column position to start comparing expected against
-    # @param [Integer] columns_end the column position to end comparing expected against
-    # @param [String] expected the expected value that the row starts with. Any trailing whitespace is ignored
-    # @raise [MatchError] if the row doesn't match
-    def assert_row_at(row_number, column_start, column_end, expected)
-      expected = expected.rstrip
-      actual = row(row_number)
-      column_end += 1
-      return if actual[column_start, column_end].eql?(expected)
-
-      raise MatchError,
-            "expected row #{row_number} to contain #{expected[column_start,
-                                                              column_end]} at #{column_start}-#{column_end} and got #{actual[column_start,
-                                                                                                                             column_end]}\nEntire screen:\n#{self}"
-    end
-
-    # Asserts the contents of a single row contains the value expected
-    # @param [Integer] row_number the row (starting from 0) to test against
-    # @param [String] expected the expected value contained in the row. Any trailing whitespace is ignored
-    # @raise [MatchError] if the row doesn't match
-    def assert_row_like(row_number, expected)
-      expected = expected.rstrip
-      actual = row(row_number)
-      return if actual.include?(expected)
-
-      raise MatchError,
-            "expected row #{row_number} to be like #{expected.inspect} but got #{actual.inspect}\nEntire screen:\n#{self}"
-    end
-
-    # Asserts the contents of a single row starts with expected string
-    # @param [Integer] row_number the row (starting from 0) to test against
-    # @param [String] expected the expected value that the row starts with. Any trailing whitespace is ignored
-    # @raise [MatchError] if the row doesn't match
-    def assert_row_starts_with(row_number, expected)
-      expected = expected.rstrip
-      actual = row(row_number)
-      return if actual.start_with?(expected)
-
-      raise MatchError,
-            "expected row #{row_number} to start with #{expected.inspect} and got #{actual.inspect}\nEntire screen:\n#{self}"
-    end
-
-    # Asserts the contents of a single row end with expected
-    # @param [Integer] row_number the row (starting from 0) to test against
-    # @param [String] expected the expected value that the row starts with. Any trailing whitespace is ignored
-    # @raise [MatchError] if the row doesn't match
-    def assert_row_ends_with(row_number, expected)
-      expected = expected.rstrip
-      actual = row(row_number)
-      return if actual.end_with?(expected)
-
-      raise MatchError,
-            "expected row #{row_number} to end with #{expected.inspect} and got #{actual.inspect}\nEntire screen:\n#{self}"
-    end
-
-    # Asserts that the cursor is in the expected position
-    # @param [Integer] x cursor x (row) position, starting from 0
-    # @param [Integer] y cursor y (column) position, starting from 0
-    # @raise [MatchError] if the cursor position doesn't match
-    def assert_cursor_position(x, y)
-      expected = [x, y]
-      actual = [cursor_x, cursor_y]
-      return if actual == expected
-
-      raise MatchError,
-            "expected cursor to be at #{expected.inspect} but was at #{actual.inspect}\nEntire screen:\n#{self}"
-    end
-
-    # @raise [MatchError] if the cursor is hidden
-    def assert_cursor_visible
-      return if cursor_visible?
-
-      raise MatchError, "expected cursor to be visible was hidden\nEntire screen:\n#{self}"
-    end
-
-    # @raise [MatchError] if the cursor is visible
-    def assert_cursor_hidden
-      return if cursor_hidden?
-
-      raise MatchError, "expected cursor to be hidden was visible\nEntire screen:\n#{self}"
-    end
-
-    # Asserts the full contents of the terminal
-    # @param [String] expected the full expected contents of the terminal. Trailing whitespace on each line is ignored
-    # @raise [MatchError] if the terminal doesn't match the expected content
-    def assert_contents(expected)
-      expected_rows = expected.split("\n")
-      diff = []
-      matched = true
-      rows.each_with_index do |actual_row, index|
-        expected_row = (expected_rows[index] || '').rstrip
-        if actual_row != expected_row
-          diff << "-#{expected_row}"
-          diff << "+#{actual_row}"
-          matched = false
-        else
-          diff << " #{actual_row}".rstrip
-        end
-      end
-
-      return if matched
-
-      raise MatchError,
-            "screen did not match expected content:\n--- expected\n+++ actual\n#{diff.join("\n")}"
-    end
-    alias assert_matches assert_contents
-
-    # Asserts the contents of the terminal at specified rows
-    # @param [String] expected the expected contents of the terminal at specified rows. Trailing whitespace on each line is ignored
-    # @raise [MatchError] if the terminal doesn't match the expected content
-    def assert_contents_at(row_start, row_end, expected)
-      expected_rows = expected.split("\n")
-      diff = []
-      matched = true
-      row_end += 1 if row_end.zero?
-
-      rows.slice(row_start, row_end).each_with_index do |actual_row, index|
-        expected_row = (expected_rows[index] || '').rstrip
-        if actual_row != expected_row
-          diff << "-#{expected_row}"
-          diff << "+#{actual_row}"
-          matched = false
-        else
-          diff << " #{actual_row}".rstrip
-        end
-      end
-
-      return if matched
-
-      raise MatchError,
-            "screen did not match expected content:\n--- expected\n+++ actual\n#{diff.join("\n")}"
-    end
-    alias assert_matches_at assert_contents_at
-
-    METHODS = public_instance_methods
-  end
-end
+# frozen_string_literal: true
+
+module TTYtest
+  # Assertions for ttytest2.
+  module Matchers
+    # Asserts the contents of a single row match the value expected
+    # @param [Integer] row_number the row (starting from 0) to test against
+    # @param [String] expected the expected value of the row. Any trailing whitespace is ignored
+    # @raise [MatchError] if the row doesn't match exactly
+    def assert_row(row_number, expected)
+      expected = expected.rstrip
+      actual = row(row_number)
+      return if actual == expected
+
+      raise MatchError,
+            "expected row #{row_number} to be #{expected.inspect} but got #{actual.inspect}\nEntire screen:\n#{self}"
+    end
+
+    # Asserts the contents of a single row contains the expected string at a specific position
+    # @param [Integer] row_number the row (starting from 0) to test against
+    # @param [Integer] column_start the column position to start comparing expected against
+    # @param [Integer] columns_end the column position to end comparing expected against
+    # @param [String] expected the expected value that the row starts with. Any trailing whitespace is ignored
+    # @raise [MatchError] if the row doesn't match
+    def assert_row_at(row_number, column_start, column_end, expected)
+      expected = expected.rstrip
+      actual = row(row_number)
+      column_end += 1
+      return if actual[column_start, column_end].eql?(expected)
+
+      raise MatchError,
+            "expected row #{row_number} to contain #{expected[column_start,
+                                                              column_end]} at #{column_start}-#{column_end} and got #{actual[column_start,
+                                                                                                                             column_end]}\nEntire screen:\n#{self}"
+    end
+
+    # Asserts the contents of a single row contains the value expected
+    # @param [Integer] row_number the row (starting from 0) to test against
+    # @param [String] expected the expected value contained in the row. Any trailing whitespace is ignored
+    # @raise [MatchError] if the row doesn't match
+    def assert_row_like(row_number, expected)
+      expected = expected.rstrip
+      actual = row(row_number)
+      return if actual.include?(expected)
+
+      raise MatchError,
+            "expected row #{row_number} to be like #{expected.inspect} but got #{actual.inspect}\nEntire screen:\n#{self}"
+    end
+
+    # Asserts the contents of a single row starts with expected string
+    # @param [Integer] row_number the row (starting from 0) to test against
+    # @param [String] expected the expected value that the row starts with. Any trailing whitespace is ignored
+    # @raise [MatchError] if the row doesn't match
+    def assert_row_starts_with(row_number, expected)
+      expected = expected.rstrip
+      actual = row(row_number)
+      return if actual.start_with?(expected)
+
+      raise MatchError,
+            "expected row #{row_number} to start with #{expected.inspect} and got #{actual.inspect}\nEntire screen:\n#{self}"
+    end
+
+    # Asserts the contents of a single row end with expected
+    # @param [Integer] row_number the row (starting from 0) to test against
+    # @param [String] expected the expected value that the row starts with. Any trailing whitespace is ignored
+    # @raise [MatchError] if the row doesn't match
+    def assert_row_ends_with(row_number, expected)
+      expected = expected.rstrip
+      actual = row(row_number)
+      return if actual.end_with?(expected)
+
+      raise MatchError,
+            "expected row #{row_number} to end with #{expected.inspect} and got #{actual.inspect}\nEntire screen:\n#{self}"
+    end
+
+    # Asserts the contents of a single row match against the passed in regular expression
+    # @param [Integer] row_number the row (starting from 0) to test against
+    # @param [String] regexp_str the regular expression as a string that will be used to match with.
+    # @raise [MatchError] if the row doesn't match against the regular expression
+    def assert_row_regexp(row_number, regexp_str)
+      regexp = Regexp.new(regexp_str)
+      actual = row(row_number)
+
+      return if actual.match?(regexp)
+
+      raise MatchError,
+            "expected row #{row_number} to match regexp #{regexp_str} but it did not. Row value #{actual.inspect}\nEntire screen:\n#{self}"
+    end
+
+    # Asserts that the cursor is in the expected position
+    # @param [Integer] x cursor x (row) position, starting from 0
+    # @param [Integer] y cursor y (column) position, starting from 0
+    # @raise [MatchError] if the cursor position doesn't match
+    def assert_cursor_position(x, y)
+      expected = [x, y]
+      actual = [cursor_x, cursor_y]
+      return if actual == expected
+
+      raise MatchError,
+            "expected cursor to be at #{expected.inspect} but was at #{actual.inspect}\nEntire screen:\n#{self}"
+    end
+
+    # @raise [MatchError] if the cursor is hidden
+    def assert_cursor_visible
+      return if cursor_visible?
+
+      raise MatchError, "expected cursor to be visible was hidden\nEntire screen:\n#{self}"
+    end
+
+    # @raise [MatchError] if the cursor is visible
+    def assert_cursor_hidden
+      return if cursor_hidden?
+
+      raise MatchError, "expected cursor to be hidden was visible\nEntire screen:\n#{self}"
+    end
+
+    # Asserts the full contents of the terminal
+    # @param [String] expected the full expected contents of the terminal. Trailing whitespace on each line is ignored
+    # @raise [MatchError] if the terminal doesn't match the expected content
+    def assert_contents(expected)
+      expected_rows = expected.split("\n")
+      diff = []
+      matched = true
+      rows.each_with_index do |actual_row, index|
+        expected_row = (expected_rows[index] || '').rstrip
+        if actual_row != expected_row
+          diff << "-#{expected_row}"
+          diff << "+#{actual_row}"
+          matched = false
+        else
+          diff << " #{actual_row}".rstrip
+        end
+      end
+
+      return if matched
+
+      raise MatchError,
+            "screen did not match expected content:\n--- expected\n+++ actual\n#{diff.join("\n")}"
+    end
+    alias assert_matches assert_contents
+
+    # Asserts the contents of the terminal at specified rows
+    # @param [String] expected the expected contents of the terminal at specified rows. Trailing whitespace on each line is ignored
+    # @raise [MatchError] if the terminal doesn't match the expected content
+    def assert_contents_at(row_start, row_end, expected)
+      expected_rows = expected.split("\n")
+      diff = []
+      matched = true
+      row_end += 1 if row_end.zero?
+
+      rows.slice(row_start, row_end).each_with_index do |actual_row, index|
+        expected_row = (expected_rows[index] || '').rstrip
+        if actual_row != expected_row
+          diff << "-#{expected_row}"
+          diff << "+#{actual_row}"
+          matched = false
+        else
+          diff << " #{actual_row}".rstrip
+        end
+      end
+
+      return if matched
+
+      raise MatchError,
+            "screen did not match expected content:\n--- expected\n+++ actual\n#{diff.join("\n")}"
+    end
+    alias assert_matches_at assert_contents_at
+
+    METHODS = public_instance_methods
+  end
+end

data/lib/ttytest/terminal.rb

@@ -1,139 +1,141 @@
-# frozen_string_literal: true
-
-require 'forwardable'
-require 'ttytest/matchers'
-require 'ttytest/capture'
-
-module TTYtest
-  # @attr [Integer] max_wait_time the maximum amount of time (in seconds) to retry assertions before failing.
-  class Terminal
-    extend Forwardable
-
-    attr_accessor :max_wait_time
-
-    # @api private
-    # @see TTYtest.new_terminal
-    def initialize(driver_terminal, max_wait_time: nil)
-      @driver_terminal = driver_terminal
-      @max_wait_time = max_wait_time || TTYtest.default_max_wait_time
-    end
-
-    # @!method send_keys(*keys)
-    #   Simulate typing keys into the terminal. For canonical cli's/shells which read line by line.
-    #   @param [String] keys keys to send to the terminal
-    # @!method send_keys_one_at_a_time(keys)
-    #   Simulate typing keys into the terminal. For noncanonical cli's/shells which read character by character.
-    #   @param [String] keys keys to send to the terminal
-    # @!method send_newline
-    #   Simulate typing enter by sending newline character to the terminal.
-    # @!method send_newlines
-    #   Simulates sending newline the specified number of times.
-    #   @param [Integer] number of times to send newline
-    # @!method send_delete
-    #   Simulate typing the delete key in the terminal.
-    # @!method send_deletes
-    #   Simulates typing delete the specified number of times.
-    #   @param [Integer] number of times to send delete
-    # @!method send_backspace
-    #   Simulate typing the backspace key in the terminal.
-    # @!method send_backspaces
-    #   Simulates typing backspace the specified number of times.
-    #   @param [Integer] number of times to send backspace
-    # @!method send_left_arrow
-    #   Simulate typing the left arrow key in the terminal.
-    # @!method send_left_arrows
-    #   Simulates typing left arrow the specified number of times.
-    #   @param [Integer] number of times to send left arrow
-    # @!method send_right_arrow
-    #   Simulate typing the right arrow key in the terminal.
-    # @!method send_right_arrows
-    #   Simulates typing right arrow the specified number of times.
-    #   @param [Integer] number of times to send right arrow
-    # @!method send_down_arrow
-    #   Simulate typing the down arrow key in the terminal.
-    # @!method send_down_arrows
-    #   Simulates typing the down arrow the specified number of times.
-    #   @param [Integer] number of times to send down arrow
-    # @!method send_up_arrow
-    #   Simulate typing the up arrow key in the terminal.
-    # @!method send_up_arrows
-    #   Simulates typing the up arrow the specified number of times.
-    #   @param [Integer] number of times to send up arrow
-    # @!method send_keys_exact
-    #   Send tmux send-keys command to the terminal, such as DC or Enter, to simulate pressing that key in the terminal.
-    # @!method send_home
-    #   Simulates typing in the Home key in the terminal.
-    # @!method send_end
-    #   Simulates typing in the End key in the terminal.
-    # @!method send_clear
-    #   Clears the screen in the terminal using ascii clear command.
-    # @!method capture
-    #   Capture the current state of the terminal
-    #   @return [Capture] instantaneous state of the terminal when called
-    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
-
-    # @!method print
-    #   Prints the current state of the terminal to stdout. See capture to get the raw string.
-    # @!method print_rows
-    #   Prints the current state of the terminal as an array to stdout. See rows to get the raw array.
-    # @!method rows
-    #   @return [Array<String>]
-    #   @see Capture#rows
-    # @!method row(row)
-    #   @return [String]
-    #   @see Capture#row
-    # @!method width
-    #   @see Capture#width
-    #   @return [Integer]
-    # @!method height
-    #   @see Capture#height
-    #   @return [Integer]
-    # @!method cursor_x
-    #   @see Capture#cursor_x
-    #   @return [Integer]
-    # @!method cursor_y
-    #   @see Capture#cursor_y
-    #   @return [Integer]
-    # @!method cursor_visible?
-    #   @see Capture#cursor_visible?
-    #   @return [true,false]
-    # @!method cursor_hidden?
-    #   @see Capture#cursor_hidden?
-    #   @return [true,false]
-    def_delegators :capture, :print, :print_rows,
-                   :rows, :row,
-                   :width, :height,
-                   :cursor_x, :cursor_y,
-                   :cursor_visible?, :cursor_hidden?
-
-    TTYtest::Matchers::METHODS.each do |matcher_name|
-      define_method matcher_name do |*args|
-        synchronize do
-          capture.public_send(matcher_name, *args)
-        end
-      end
-    end
-
-    private
-
-    def synchronize(seconds = max_wait_time)
-      start_time = Time.now
-      begin
-        yield
-      rescue MatchError => e
-        raise e if (Time.now - start_time) >= seconds
-
-        sleep 0.05
-        retry
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'ttytest/matchers'
+require 'ttytest/capture'
+
+module TTYtest
+  # @attr [Integer] max_wait_time the maximum amount of time (in seconds) to retry assertions before failing.
+  class Terminal
+    extend Forwardable
+
+    attr_accessor :max_wait_time
+
+    # @api private
+    # @see TTYtest.new_terminal
+    def initialize(driver_terminal, max_wait_time: nil)
+      @driver_terminal = driver_terminal
+      @max_wait_time = max_wait_time || TTYtest.default_max_wait_time
+    end
+
+    # @!method send_keys(*keys)
+    #   Simulate typing keys into the terminal. For canonical cli's/shells which read line by line.
+    #   @param [String] keys keys to send to the terminal
+    # @!method send_keys_one_at_a_time(keys)
+    #   Simulate typing keys into the terminal. For noncanonical cli's/shells which read character by character.
+    #   @param [String] keys keys to send to the terminal
+    # @!method send_newline
+    #   Simulate typing enter by sending newline character to the terminal.
+    # @!method send_newlines
+    #   Simulates sending newline the specified number of times.
+    #   @param [Integer] number of times to send newline
+    # @!method send_delete
+    #   Simulate typing the delete key in the terminal.
+    # @!method send_deletes
+    #   Simulates typing delete the specified number of times.
+    #   @param [Integer] number of times to send delete
+    # @!method send_backspace
+    #   Simulate typing the backspace key in the terminal.
+    # @!method send_backspaces
+    #   Simulates typing backspace the specified number of times.
+    #   @param [Integer] number of times to send backspace
+    # @!method send_left_arrow
+    #   Simulate typing the left arrow key in the terminal.
+    # @!method send_left_arrows
+    #   Simulates typing left arrow the specified number of times.
+    #   @param [Integer] number of times to send left arrow
+    # @!method send_right_arrow
+    #   Simulate typing the right arrow key in the terminal.
+    # @!method send_right_arrows
+    #   Simulates typing right arrow the specified number of times.
+    #   @param [Integer] number of times to send right arrow
+    # @!method send_down_arrow
+    #   Simulate typing the down arrow key in the terminal.
+    # @!method send_down_arrows
+    #   Simulates typing the down arrow the specified number of times.
+    #   @param [Integer] number of times to send down arrow
+    # @!method send_up_arrow
+    #   Simulate typing the up arrow key in the terminal.
+    # @!method send_up_arrows
+    #   Simulates typing the up arrow the specified number of times.
+    #   @param [Integer] number of times to send up arrow
+    # @!method send_keys_exact
+    #   Send tmux send-keys command to the terminal, such as DC or Enter, to simulate pressing that key in the terminal.
+    # @!method send_home
+    #   Simulates typing in the Home key in the terminal.
+    # @!method send_end
+    #   Simulates typing in the End key in the terminal.
+    # @!method send_clear
+    #   Clears the screen in the terminal using ascii clear command.
+    # @!method send_escape
+    #   Simulates typing in the Escape (ESC) key in the terminal.
+    # @!method capture
+    #   Capture the current state of the terminal
+    #   @return [Capture] instantaneous state of the terminal when called
+    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, :send_escape,
+                   :capture
+
+    # @!method print
+    #   Prints the current state of the terminal to stdout. See capture to get the raw string.
+    # @!method print_rows
+    #   Prints the current state of the terminal as an array to stdout. See rows to get the raw array.
+    # @!method rows
+    #   @return [Array<String>]
+    #   @see Capture#rows
+    # @!method row(row)
+    #   @return [String]
+    #   @see Capture#row
+    # @!method width
+    #   @see Capture#width
+    #   @return [Integer]
+    # @!method height
+    #   @see Capture#height
+    #   @return [Integer]
+    # @!method cursor_x
+    #   @see Capture#cursor_x
+    #   @return [Integer]
+    # @!method cursor_y
+    #   @see Capture#cursor_y
+    #   @return [Integer]
+    # @!method cursor_visible?
+    #   @see Capture#cursor_visible?
+    #   @return [true,false]
+    # @!method cursor_hidden?
+    #   @see Capture#cursor_hidden?
+    #   @return [true,false]
+    def_delegators :capture, :print, :print_rows,
+                   :rows, :row,
+                   :width, :height,
+                   :cursor_x, :cursor_y,
+                   :cursor_visible?, :cursor_hidden?
+
+    Matchers::METHODS.each do |matcher_name|
+      define_method matcher_name do |*args|
+        synchronize do
+          capture.public_send(matcher_name, *args)
+        end
+      end
+    end
+
+    private
+
+    def synchronize(seconds = max_wait_time)
+      start_time = Time.now
+      begin
+        yield
+      rescue MatchError => e
+        raise e if (Time.now - start_time) >= seconds
+
+        sleep 0.05
+        retry
+      end
+    end
+  end
+end