ttytest2 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4322aa40df769e1ed8a2095f5766199175afae71233c8308b3a6ef30322fedb2
-  data.tar.gz: 3d94b40f20cbea852a6462d23d3922a6a1e7ef95573815320047279f47e8c76d
+  metadata.gz: 9b9538d393117d0cc417fd097ce965cc0c84612e9c8c244a7462072568ae1f42
+  data.tar.gz: c88ea611163de40b6047faea181a573e767e6e68a3644143a0e4e00dc3401448
 SHA512:
-  metadata.gz: 90580621915fddc1ba3b6390fc58e7787fdfa86336cb576abd3224a68c8cb88fbf665425d960153bd0cf4d170aa02afb63f14f53acc2f1f37711d8bbb0c244a1
-  data.tar.gz: 44047668527313f4bcea17522d2c8ee77bf9e0695ebd89a6c68a01411305cd3389eb5e22e43c1c4861662414b7721b6772fd26d84b1364a8a447d9363af0ab04
+  metadata.gz: 86fa0a0862a158102d08c9d05df218927dee91bf49c73176d1f7979136c626b10496e02af55085f30e336492d1aad3884da8690d908868ed3bfb8b92f179172e
+  data.tar.gz: f2a16dcae9a58b970659e7a5181ba4dfad50b106bdf5efb057cc1ff3ccccc3712c7d7ded8edb49ed10102279244e7059ebd4c02b5d66940fa888fde4bc279fb6

data/README.md

@@ -39,6 +39,7 @@ The assertions will wait a specified amount of time (configurable, default 2 sec
 
 ``` 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.
@@ -78,6 +104,8 @@ Available assertions:
 
 * `assert_row(row_number, expected_text)`
 
+* `assert_row_is_empty(row_number)`
+
 * `assert_row_at(row_number, column_start_position, column_end_position, expected_text)`
 
 * `assert_row_like(row_number, expected_text)`

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,12 +10,27 @@ module TTYtest
     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
 
+    def assert_last_row(expected)
+    end
+
+    # Asserts the specified row is empty
+    # @param [Integer] row_number the row (starting from 0) to test against
+    # @raise [MatchError] if the row isn't empty
+    def assert_row_is_empty(row_number)
+      actual = row(row_number)
+
+      return if actual == ''
+
+      raise MatchError, "expected row #{row_number} to be empty 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
@@ -26,6 +41,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 +57,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 +72,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 +86,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 +107,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 +131,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 +152,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 +167,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 +198,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/version.rb

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

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github
-git tag v1.0.0
+git tag v1.0.2
 git push origin --tags
 
 to push new version to rubygems.org
 gem build ttytest2.gemspec
-gem push ttytest2-1.0.0.gem
+gem push ttytest2-1.0.2.gem

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ttytest2
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Alex Eski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-28 00:00:00.000000000 Z
+date: 2025-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler