ttytest2 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 360be4f6d7358f00c2462a247939072ab8e93e1b64f9465112c62b6f9a22a484
-  data.tar.gz: 7ede22ea96c9ce32546111761d730c008da042b997914e59b6d63bf1e4b06d69
+  metadata.gz: c7bf4ac747757d3aeaf01d103d15708cf487834ed43b9e3dad90e0d94e5203bc
+  data.tar.gz: 901c844e8719e6652943aae004e5f3deada174c4ab312e2e1c5956f496aa64c0
 SHA512:
-  metadata.gz: 739fde4fb24d1a2a2a6179c5433be0191587f6e6f4aad92c495880991140569ad82821e8e3285bca1cd908f067adb3d404fd70c696b8cb1d973ee4d3fbb8349a
-  data.tar.gz: 7c4472bb3d2cebfbbcf29edb62cbee8f16c8ae84bcd59e8263c108f71e0db89da1ab7fdd1c9c8dfa06f2047b9bae8d7e9e0016718a9ddcfb2ac89d91407efe10
+  metadata.gz: '02128e6d6ada7be932b624b5dd48c4d7eef0ace8a3d727629f7c756f4e5b0027b00aa6fe96040a38ff84178e0b74256e644584376e8d6784c48728662e50af3d'
+  data.tar.gz: a2909a072f201511eed7e77b72a67143b0fb9caa2dac07aa583696aa040e88c34a2188644b1a0872d4309cfe8b2ef7e30d271a68b97f298b4334948dd879a3a6

data/LICENSE

@@ -0,0 +1,8 @@
+Copyright (c) 2016-2025 John Hawthorn
+Copyright (c) 2024-2025 Alex Eski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -116,6 +116,8 @@ If you are reading this on github, the ruby docs accessible from [RubyDoc.Info](
 
 ### Available Assertions
 
+#### Row Assertions
+
 * `assert_row(row_number, expected_text)`
 
 * `assert_row_is_empty(row_number)`
@@ -132,18 +134,32 @@ If you are reading this on github, the ruby docs accessible from [RubyDoc.Info](
 
 * `assert_rows_each_match_regexp(row_start, row_end, regexp_str)`
 
+#### Column Assertions
+
 * `assert_column(col_number, expected_text)`
 
 * `assert_column_is_empty(col_number)`
 
 * `assert_column_at(col_number, row_start, row_end, expected_str)`
 
+* `assert_column_starts_with(col_number, expected_text)`
+
+* `assert_column_ends_with(col_number, expected_text)`
+
+* `assert_column_regexp(col_number, regexp_str)`
+
+* `assert_columns_each_match_regexp(col_start, col_end, regexp_str)`
+
+#### Cursor Assertions
+
 * `assert_cursor_position(x: x, y: y)`
 
 * `assert_cursor_visible`
 
 * `assert_cursor_hidden`
 
+#### Screen Contents Assertions
+
 * `assert_contents(lines_of_terminal)`
 
 * `assert_contents_at(row_start, row_end, expected_text)`
@@ -154,6 +170,8 @@ If you are reading this on github, the ruby docs accessible from [RubyDoc.Info](
 
 * `assert_contents_match_regexp(regexp_str)`
 
+#### File Assertions
+
 * `assert_file_exists(file_path)`
 
 * `assert_file_doesnt_exist(file_path)`

data/lib/ttytest/assertions/column_assertions.rb

@@ -42,7 +42,7 @@ module TTYtest
     # @param [Integer] col_number the column (starting from 0) to test against
     # @param [Integer] row_start the row position to start comparing expected against
     # @param [Integer] row_end the row position to end comparing expected against (inclusive)
-    # @param [String] expected the expected value that the row starts with. Any trailing whitespace is ignored
+    # @param [String] expected the expected value that the column starts with. Any trailing whitespace is ignored
     # @raise [MatchError] if the column doesn't match
     def assert_column_at(col_number, row_start, row_end, expected)
       validate(col_number)
@@ -51,7 +51,7 @@ module TTYtest
 
       rows.each_with_index do |row, i|
         next if i < row_start
-        break if i > row_end || row.nil? || row == ''
+        break if i > row_end || row.nil?
 
         actual[i - row_start] = row[col_number]
         next if row[col_number] == expected[i - row_start]
@@ -68,5 +68,101 @@ module TTYtest
       raise MatchError,
             "expected column #{col_number} to contain #{expected} at #{row_start}-#{row_end} and got #{inspection}\nEntire screen:\n#{self}"
     end
+
+    # Asserts the contents of a single column contains the value expected
+    # @param [Integer] col_number the column number (starting from 0) to test against
+    # @param [String] expected the expected value contained in the column. Any trailing whitespace is ignored
+    # @raise [MatchError] if the column doesn't match
+    def assert_column_like(col_number, expected)
+      validate(col_number)
+      expected = expected.rstrip
+      actual = get_column(col_number).join
+
+      return if !actual.nil? && actual.include?(expected)
+
+      raise MatchError,
+            "expected column #{col_number} to be like #{expected.inspect} but got #{get_inspection(actual)}\nEntire screen:\n#{self}"
+    end
+    alias assert_column_contains assert_column_like
+
+    # Asserts the contents of a single column starts with expected string
+    # @param [Integer] col_number the column (starting from 0) to test against
+    # @param [String] expected the expected value that the column starts with. Any trailing whitespace is ignored
+    # @raise [MatchError] if the column doesn't match
+    def assert_column_starts_with(col_number, expected)
+      validate(col_number)
+      expected = expected.rstrip
+      actual = get_column(col_number).join
+
+      return if !actual.nil? && actual.start_with?(expected)
+
+      raise MatchError,
+            "expected column #{col_number} to start with #{expected.inspect} and got #{get_inspection(actual)}\nEntire screen:\n#{self}"
+    end
+
+    # Asserts the contents of a column ends with expected
+    # @param [Integer] col_number the column (starting from 0) to test against
+    # @param [String] expected the expected value that the column starts with. Any trailing whitespace is ignored
+    # @raise [MatchError] if the column doesn't match
+    def assert_column_ends_with(col_number, expected)
+      validate(col_number)
+      expected = expected.rstrip
+      actual = get_column(col_number).join
+
+      return if !actual.nil? && actual.end_with?(expected)
+
+      raise MatchError,
+            "expected column #{col_number} to end with #{expected.inspect} and got #{get_inspection(actual)}\nEntire screen:\n#{self}"
+    end
+
+    # Asserts the contents of a single column match against the passed in regular expression
+    # @param [Integer] col_number the column (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 column doesn't match against the regular expression
+    def assert_column_regexp(col_number, regexp_str)
+      validate(col_number)
+      regexp = Regexp.new(regexp_str)
+      actual = get_column(col_number).join
+
+      return if !actual.nil? && actual.match?(regexp)
+
+      raise MatchError,
+            "expected column #{col_number} to match regexp #{regexp_str} but it did not. Column value #{get_inspection(actual)}\nEntire screen:\n#{self}"
+    end
+
+    # Asserts the contents of a multiple columns each match against the passed in regular expression
+    # @param [Integer] col_start the column (starting from 0) to test against
+    # @param [Integer] col_end the last column to test against
+    # @param [String] regexp_str the regular expression as a string that will be used to match with.
+    # @raise [MatchError] if the column doesn't match against the regular expression
+    def assert_columns_each_match_regexp(col_start, col_end, regexp_str)
+      validate(col_end)
+      regexp = Regexp.new(regexp_str)
+      col_cur = col_start
+      col_end += 1 if col_end.zero?
+
+      while col_cur < col_end
+        actual = get_column(col_cur).join
+        col_cur += 1
+        next if !actual.nil? && actual.match?(regexp)
+
+        raise MatchError,
+              "expected column #{col_cur - 1} to match regexp #{regexp_str} but it did not. Column value #{get_inspection(actual)}\nEntire screen:\n#{self}"
+      end
+    end
+
+    private
+
+    def get_column(col_number)
+      actual = []
+
+      rows.each_with_index do |row, i|
+        break if row.nil?
+
+        actual[i] = row[col_number]
+      end
+
+      actual
+    end
   end
 end

data/lib/ttytest/assertions/exit_code_assertions.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module TTYtest
+  # Exit Code Assertions for ttytest2. Not finished and added yet.
+  module ExitCodeAssertions
+    # Asserts that the exit code of the previous command matches the specified value
+    # Note: if you are tracking current row in your tests, this command will take up 2 lines.
+    # It echos the previous commands exit code to the screen and then reads it from there
+    # @param [Integer] code the expected exit code
+    # @raise [MatchError] if the exit code found does not match specified value
+    def assert_exit_code(code) end
+  end
+end

data/lib/ttytest/assertions/file_assertions.rb

@@ -61,7 +61,7 @@ module TTYtest
 
     # Asserts the specified file has line count specified
     # @param [String] file_path the path to the file
-    # @param [String] expected_count the expected line count of the file
+    # @param [Integer] expected_count the expected line count of the file
     # @raise [MatchError] if the file has a different line count than specified
     def assert_file_has_line_count(file_path, expected_count)
       raise file_not_found_error(file_path) unless File.exist?(file_path)

data/lib/ttytest/assertions/row_assertions.rb

@@ -89,7 +89,7 @@ module TTYtest
     end
     alias assert_line_starts_with assert_row_starts_with
 
-    # Asserts the contents of a single row end with expected
+    # Asserts the contents of a single row ends 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

data/lib/ttytest/version.rb

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

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github
-git tag v1.4.0
+git tag v1.5.0
 git push origin --tags
 
 to push new version to rubygems.org
 gem build ttytest2.gemspec
-gem push ttytest2-1.4.0.gem
+gem push ttytest2-1.5.0.gem

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ttytest2
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Alex Eski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-29 00:00:00.000000000 Z
+date: 2025-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,6 +92,7 @@ files:
 - ".github/workflows/test.yml"
 - ".gitignore"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - examples/integration_tests.rb
@@ -100,6 +101,7 @@ files:
 - lib/ttytest/assertions.rb
 - lib/ttytest/assertions/column_assertions.rb
 - lib/ttytest/assertions/cursor_assertions.rb
+- lib/ttytest/assertions/exit_code_assertions.rb
 - lib/ttytest/assertions/file_assertions.rb
 - lib/ttytest/assertions/row_assertions.rb
 - lib/ttytest/assertions/screen_assertions.rb