ttytest2 0.9.13 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd614376f0369112c875543a1d8cc498b0de69dd436e6158fd6d8f06bd4ee87f
-  data.tar.gz: 59373cd7e5699a8e6c96a3c0071efc4164d09ddfb71365291cf4a5d086b69bd1
+  metadata.gz: 4e4921ed7f9ec57ffb18c82a6ad29df778485f1d6d3bad878c06cdab50ba303a
+  data.tar.gz: c05db30206186a54ec5a5fa6b23dd333a173bb210b18aaff2201647e01ac99d1
 SHA512:
-  metadata.gz: 77eb7d0d56818eaa11b3f0ac84230f5100a50bfc0ccf45c67c34a0389005b55317b5a85d23ed68f5b65c923fe8a51efe620304dcc345c7cd4cf902ff80b8e8d4
-  data.tar.gz: 2a3d270669408488cd1e636231b336cd62e3606d1cd20dfd267858ca3e0a544ded977ecc657df82f2833a2a2a77c9f8d422428b84715377314e6c7faf57b81e7
+  metadata.gz: 0032e2da8ae48c097f614acbf908d5860732c78c09a98fe6738490e2675a6af54e043f499eb9367a8cd362070d8988cd79400b4c546803a57282f23dce3f2dc4
+  data.tar.gz: 4250ea672cc1d031fe5403bd21980e2e80b06095e2dc0d67df65d94d6f35904905fc0098480afb884d5008425207537aa9c6a2b73724b3d6ff40a4fbeb53a877

data/README.md

@@ -6,7 +6,7 @@ ttytest2 is a fork and a drop-in replacement for [ttytest](https://github.com/jh
 
 It works by running commands inside a tmux session, capturing the pane, and comparing the content to your assertions.
 
-The assertions will wait a specified amount of time (default 2 seconds) for the expected content to appear.
+The assertions will wait a specified amount of time (configurable, default 2 seconds) for the expected content to appear.
 
 [![Gem Version](https://badge.fury.io/rb/ttytest2.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/ttytest2)
 
@@ -39,6 +39,7 @@ The assertions will wait a specified amount of time (default 2 seconds) for the
 
 ``` ruby
 require 'ttytest'
+
 @tty = TTYtest.new_terminal(%(PS1='$ ' /bin/sh), width: 80, height: 7)
 @tty.assert_row(0, '$')
 @tty.assert_cursor_position(2, 0)
@@ -68,6 +69,31 @@ TTY
 # $
 ```
 
+### Initializing
+
+Call one of these methods to initialize an instance of ttytest2.
+
+* `new_terminal(cmd, width, height)`: initialize new tmux terminal instance and run cmd.
+
+* `new_default_sh_terminal()`: intialize new tmux terminal instance using sh, width of 80, height of 24.
+
+* `new_sh_terminal(width, height)`: intialize new tmux terminal instance using sh and width and height parameters.
+
+``` ruby
+require 'ttytest'
+
+# these are all equivalent
+@tty = TTYtest.new_terminal(%(PS1='$ ' /bin/sh))
+@tty = TTYtest.new_terminal(%(PS1='$ ' /bin/sh), width: 80, height: 24)
+@tty = TTYtest.new_default_sh_terminal
+@tty = TTYtest.new_sh_terminal
+@tty = TTYtest.new_sh_terminal(width: 80, height: 24)
+
+# you can also use other shells, like bash
+@tty = TTYtest.new_terminal('/bin/bash')
+@tty = TTYtest.new_terminal('/bin/bash', width: 80, height: 24)
+```
+
 ### Assertions
 
 The main way to use TTYtest is through assertions.
@@ -77,15 +103,25 @@ Assertions will be retried for up to 2 seconds when called through TTYtest::Term
 Available assertions:
 
 * `assert_row(row_number, expected_text)`
+
 * `assert_row_at(row_number, column_start_position, column_end_position, expected_text)`
+
 * `assert_row_like(row_number, expected_text)`
+
 * `assert_row_starts_with(row_number, expected_text)`
+
 * `assert_row_ends_with(row_number, expected_text)`
+
 * `assert_row_regexp(row_number, regexp_str)`
+
 * `assert_cursor_position(x: x, y: y)`
+
 * `assert_cursor_visible`
+
 * `assert_cursor_hidden`
+
 * `assert_contents(lines_of_terminal)`
+
 * `assert_contents_at(row_start, row_end, expected_text)`
 
 ### Output
@@ -118,21 +154,30 @@ Helper functions to make sending output easier! They use the methods above under
 * `send_newlines(number_of_times)` # equivalent to calling send_newline number_of_times
 * `send_enter` # alias for send_newline
 * `send_enters(number_of_times)` # alias for send_newlines
+
 * `send_backspace` # simulate hitting backspace, equivalent to @tty.send_keys(TTYtest::BACKSPACE)
 * `send_backspaces(number_of_times)` # equivalent to calling send_backspace number_of_times
+
 * `send_delete` # simulate hitting delete, equivalent to calling send_keys_exact(%(DC))
 * `send_deletes` # equivalent to calling send_delete number_of_times
+
 * `send_right_arrow`
 * `send_right_arrows(number_of_times)`
+
 * `send_left_arrow`
 * `send_left_arrows(number_of_times)`
+
 * `send_up_arrow`
 * `send_up_arrows(number_of_times)`
+
 * `send_down_arrow`
 * `send_down_arrows(number_of_times)`
+
 * `send_home` # simulate pressing the Home key
 * `send_end` # simulate pressing the End key
+
 * `send_clear` # clear the screen by sending clear ascii code
+
 * `send_escape`
 * `send_escapes`
 
@@ -227,7 +272,7 @@ There are some commonly used keys available as constants to make interacting wit
   TTYtest::CLEAR # clear the screen
 ```
 
-### Tips
+## Tips
 
 If you are using ttyest2 to test your CLI, using sh is easier than bash because you don't have to worry about user, current working directory, etc. as shown in the examples.
 

data/examples/integration_tests.rb

@@ -755,7 +755,7 @@ def stdout_and_stderr_redirection_tests(row)
 end
 
 row = 0
-@tty = TTYtest.new_terminal(%(PS1='$ ' ./bin/ncsh), width: 120, height: 120)
+@tty = TTYtest.new_terminal(%(./bin/ncsh), width: 120, height: 120)
 
 row = startup_tests(row, true)
 row = basic_tests row
@@ -776,7 +776,7 @@ tab_autocompletion_tests row
 @tty.send_newline
 
 row = 0
-@tty = TTYtest.new_terminal(%(PS1='$ ' ./bin/ncsh), width: 180, height: 150)
+@tty = TTYtest.new_terminal(%(./bin/ncsh), width: 180, height: 150)
 row = startup_tests(row, false)
 row = syntax_error_tests row
 row = stderr_redirection_tests row

data/lib/ttytest/matchers.rb

@@ -10,6 +10,7 @@ module TTYtest
     def assert_row(row_number, expected)
       expected = expected.rstrip
       actual = row(row_number)
+
       return if actual == expected
 
       raise MatchError,
@@ -26,6 +27,7 @@ module TTYtest
       expected = expected.rstrip
       actual = row(row_number)
       column_end += 1
+
       return if actual[column_start, column_end].eql?(expected)
 
       raise MatchError,
@@ -41,6 +43,7 @@ module TTYtest
     def assert_row_like(row_number, expected)
       expected = expected.rstrip
       actual = row(row_number)
+
       return if actual.include?(expected)
 
       raise MatchError,
@@ -55,6 +58,7 @@ module TTYtest
     def assert_row_starts_with(row_number, expected)
       expected = expected.rstrip
       actual = row(row_number)
+
       return if actual.start_with?(expected)
 
       raise MatchError,
@@ -68,6 +72,7 @@ module TTYtest
     def assert_row_ends_with(row_number, expected)
       expected = expected.rstrip
       actual = row(row_number)
+
       return if actual.end_with?(expected)
 
       raise MatchError,
@@ -88,6 +93,23 @@ module TTYtest
             "expected row #{row_number} to match regexp #{regexp_str} but it did not. Row value #{actual.inspect}\nEntire screen:\n#{self}"
     end
 
+    # Asserts the contents of a multiple rows each match against the passed in regular expression
+    # @param [Integer] row_start the row (starting from 0) to test against
+    # @param [Integer] row_end the last row 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_rows_each_match_regexp(row_start, row_end, regexp_str)
+      regexp = Regexp.new(regexp_str)
+      row_end += 1 if row_end.zero?
+
+      rows.slice(row_start, row_end).each_with_index do |actual_row, index|
+        next if actual_row.match?(regexp)
+
+        raise MatchError,
+              "expected row #{index} to match regexp #{regexp_str} but it did not. Row value #{actual_row.inspect}\nEntire screen:\n#{self}"
+      end
+    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
@@ -95,6 +117,7 @@ module TTYtest
     def assert_cursor_position(x, y)
       expected = [x, y]
       actual = [cursor_x, cursor_y]
+
       return if actual == expected
 
       raise MatchError,
@@ -115,14 +138,11 @@ module TTYtest
       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)
+    def matched(expected, actual)
       expected_rows = expected.split("\n")
       diff = []
       matched = true
-      rows.each_with_index do |actual_row, index|
+      actual.each_with_index do |actual_row, index|
         expected_row = (expected_rows[index] || '').rstrip
         if actual_row != expected_row
           diff << "-#{expected_row}"
@@ -133,32 +153,30 @@ module TTYtest
         end
       end
 
+      [matched, diff]
+    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)
+      matched, diff = matched(expected, rows)
+
       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
+    alias assert_screen 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
+      matched, diff = matched(expected, rows.slice(row_start, row_end))
 
       return if matched
 
@@ -166,6 +184,7 @@ module TTYtest
             "screen did not match expected content:\n--- expected\n+++ actual\n#{diff.join("\n")}"
     end
     alias assert_matches_at assert_contents_at
+    alias assert_rows assert_contents_at
 
     METHODS = public_instance_methods
   end

data/lib/ttytest/tmux/driver.rb

@@ -39,6 +39,14 @@ module TTYtest
         Terminal.new(session)
       end
 
+      def new_default_sh_terminal
+        new_terminal(%(PS1='$ ' /bin/sh), width: 80, height: 24)
+      end
+
+      def new_sh_terminal(width: 80, height: 24)
+        new_terminal(%(PS1='$ ' /bin/sh), width: width, height: height)
+      end
+
       # @api private
       def tmux(*args)
         ensure_available

data/lib/ttytest/tmux/session.rb

@@ -80,9 +80,9 @@ module TTYtest
         sleep sleep_time
       end
 
-      def send_line_then_sleep_and_repeat(*lines)
+      def send_line_then_sleep_and_repeat(*lines, sleep_time)
         lines.each do |line|
-          send_line_then_sleep(line)
+          send_line_then_sleep(line, sleep_time)
         end
       end
 

data/lib/ttytest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TTYtest
-  VERSION = '0.9.13'
+  VERSION = '1.0.1'
 end

data/lib/ttytest.rb

@@ -17,7 +17,15 @@ module TTYtest
     #   @param [Integer] width width of the new terminal
     #   @param [Integer] height height of the new terminal
     #   @return [Terminal] a new terminal running the specified command
-    def_delegators :driver, :new_terminal
+
+    # @!method new_default_sh_terminal
+    #   Create a new terminal using '/bin/sh' with width: 80 and height: 24.
+    #   Useful for Unixes.
+
+    # @!method new_sh_terminal(width: 80, height: 24)
+    #   Create a new terminal using '/bin/sh' with ability to set width and height.
+    #   Useful for Unixes.
+    def_delegators :driver, :new_terminal, :new_default_sh_terminal, :new_sh_terminal
   end
 
   class MatchError < StandardError; end

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github
-git tag v0.9.13
+git tag v1.0.1
 git push origin --tags
 
 to push new version to rubygems.org
 gem build ttytest2.gemspec
-gem push ttytest2-0.9.13.gem
+gem push ttytest2-1.0.1.gem

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ttytest2
 version: !ruby/object:Gem::Version
-  version: 0.9.13
+  version: 1.0.1
 platform: ruby
 authors:
 - Alex Eski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-03 00:00:00.000000000 Z
+date: 2025-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler