ttytest2 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e4921ed7f9ec57ffb18c82a6ad29df778485f1d6d3bad878c06cdab50ba303a
-  data.tar.gz: c05db30206186a54ec5a5fa6b23dd333a173bb210b18aaff2201647e01ac99d1
+  metadata.gz: 2a0efe35a9376c501403b55279be2f4d1945cd11fa6daf56df854f1883d432df
+  data.tar.gz: 8663d5d7aad9d17067733670cec372fe6d9ea0c1e384956a4e899da9b0322054
 SHA512:
-  metadata.gz: 0032e2da8ae48c097f614acbf908d5860732c78c09a98fe6738490e2675a6af54e043f499eb9367a8cd362070d8988cd79400b4c546803a57282f23dce3f2dc4
-  data.tar.gz: 4250ea672cc1d031fe5403bd21980e2e80b06095e2dc0d67df65d94d6f35904905fc0098480afb884d5008425207537aa9c6a2b73724b3d6ff40a4fbeb53a877
+  metadata.gz: 7962a743edd2522bfe4d5278f2ef014dde6f2b086d022ed9a9193101b30e4eea27dcbb986db43e24032e0beb51380b27724d3c50323b8f0df9c143e1f09d6110
+  data.tar.gz: 91d8b71eead9a642318f10ef2209cc3775d3fb82f14456e4976955fd868fe85e33a34e271f5e5d39fd80577be23a85fcc3279e9c8d831a3907513eabd8112b70

data/README.md

@@ -104,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/lib/ttytest/matchers.rb

@@ -3,19 +3,61 @@
 module TTYtest
   # Assertions for ttytest2.
   module Matchers
+    def get_inspection(actual)
+      if actual.nil?
+        'nil'
+      else
+        actual.inspect
+      end
+    end
+
+    def get_inspection_bounded(actual, column_start, column_end)
+      if actual.nil?
+        'nil'
+      else
+        actual[column_start, column_end]
+      end
+    end
+
+    def validate(row)
+      return if @height.nil?
+      return unless row >= @height
+
+      raise MatchError,
+            "row is at #{row}, which is greater than set height #{height}, so assertions will fail. If intentional, set height larger or break apart tests.\n
+            Entire screen:\n#{self}"
+    end
+
     # 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)
+      validate(row_number)
       expected = expected.rstrip
       actual = row(row_number)
 
-      return if actual == expected
+      return if !actual.nil? && actual == expected
 
       raise MatchError,
-            "expected row #{row_number} to be #{expected.inspect} but got #{actual.inspect}\nEntire screen:\n#{self}"
+            "expected row #{row_number} to be #{expected.inspect} but got #{get_inspection(actual)}\n
+            Entire screen:\n#{self}"
     end
+    alias assert_line assert_row
+
+    # 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)
+      validate(row_number)
+      actual = row(row_number)
+
+      return if actual == ''
+
+      raise MatchError,
+            "expected row #{row_number} to be empty but got #{get_inspection(actual)}\nEntire screen:\n#{self}"
+    end
+    alias assert_line_is_empty assert_row_is_empty
 
     # 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
@@ -24,45 +66,52 @@ module TTYtest
     # @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)
+      validate(row_number)
       expected = expected.rstrip
       actual = row(row_number)
       column_end += 1
 
-      return if actual[column_start, column_end].eql?(expected)
+      return if !actual.nil? && actual[column_start, column_end].eql?(expected)
+
+      inspection = get_inspection_bounded(actual, column_start, column_end)
 
       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}"
+                                                              column_end]} at #{column_start}-#{column_end} and got #{inspection}\nEntire screen:\n#{self}"
     end
+    alias assert_line_at assert_row_at
 
     # 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)
+      validate(row_number)
       expected = expected.rstrip
       actual = row(row_number)
 
-      return if actual.include?(expected)
+      return if !actual.nil? && actual.include?(expected)
 
       raise MatchError,
-            "expected row #{row_number} to be like #{expected.inspect} but got #{actual.inspect}\nEntire screen:\n#{self}"
+            "expected row #{row_number} to be like #{expected.inspect} but got #{get_inspection(actual)}\nEntire screen:\n#{self}"
     end
     alias assert_row_contains assert_row_like
+    alias assert_line_contains assert_row_like
+    alias assert_line_like assert_row_like
 
     # 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)
+      validate(row_number)
       expected = expected.rstrip
       actual = row(row_number)
 
-      return if actual.start_with?(expected)
+      return if !actual.nil? && actual.start_with?(expected)
 
       raise MatchError,
-            "expected row #{row_number} to start with #{expected.inspect} and got #{actual.inspect}\nEntire screen:\n#{self}"
+            "expected row #{row_number} to start with #{expected.inspect} and got #{get_inspection(actual)}\nEntire screen:\n#{self}"
     end
 
     # Asserts the contents of a single row end with expected
@@ -70,13 +119,14 @@ module TTYtest
     # @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)
+      validate(row_number)
       expected = expected.rstrip
       actual = row(row_number)
 
-      return if actual.end_with?(expected)
+      return if !actual.nil? && actual.end_with?(expected)
 
       raise MatchError,
-            "expected row #{row_number} to end with #{expected.inspect} and got #{actual.inspect}\nEntire screen:\n#{self}"
+            "expected row #{row_number} to end with #{expected.inspect} and got #{get_inspection(actual)}\nEntire screen:\n#{self}"
     end
 
     # Asserts the contents of a single row match against the passed in regular expression
@@ -84,13 +134,14 @@ module TTYtest
     # @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)
+      validate(row_number)
       regexp = Regexp.new(regexp_str)
       actual = row(row_number)
 
-      return if actual.match?(regexp)
+      return if !actual.nil? && 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}"
+            "expected row #{row_number} to match regexp #{regexp_str} but it did not. Row value #{get_inspection(actual)}\nEntire screen:\n#{self}"
     end
 
     # Asserts the contents of a multiple rows each match against the passed in regular expression
@@ -99,14 +150,15 @@ module TTYtest
     # @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)
+      validate(row_end)
       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)
+        next if !actual_row.nil? && 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}"
+              "expected row #{index} to match regexp #{regexp_str} but it did not. Row value #{get_inspection(actual_row)}\nEntire screen:\n#{self}"
       end
     end
 
@@ -121,7 +173,7 @@ module TTYtest
       return if actual == expected
 
       raise MatchError,
-            "expected cursor to be at #{expected.inspect} but was at #{actual.inspect}\nEntire screen:\n#{self}"
+            "expected cursor to be at #{expected.inspect} but was at #{get_inspection(actual)}\nEntire screen:\n#{self}"
     end
 
     # @raise [MatchError] if the cursor is hidden
@@ -174,6 +226,7 @@ module TTYtest
     # @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)
+      validate(row_end)
       row_end += 1 if row_end.zero?
 
       matched, diff = matched(expected, rows.slice(row_start, row_end))

data/lib/ttytest/version.rb

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

data/notes.txt

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

metadata

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