ttytest2 1.0.7 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ec86d17bfe3b3a9c9485f0b53c14f4dcfebd5e875dd2ba1de7f26c7ef4b1a87
-  data.tar.gz: 2b53db154e9c680b89897bc46cffe087d415ce22049727ec1b3ff698ce80aba0
+  metadata.gz: 47258d8644be543f645de9e34a17eca3a0e38c5fb764e4e72f4d78a63a888388
+  data.tar.gz: 4aa9221ee6fc4f5e8fda754b2cd3b9c8218d7b8cf1e7e8b67dfe2a36dd9360b8
 SHA512:
-  metadata.gz: 5db41e82f2c81e5df9e8305f51431b58fafac9abe95b23eaf64f7e7f8e13c64ca5b1be21784b67438938579dd503cbd430128c6984e94b8fa69990c9d9e7b0cf
-  data.tar.gz: 22e3f4c4609432321cf5c7abe0f061e15f52816f89f1d8dd87283aef6d9d78dd661fe991edc074dbfd354024aaa59278799d332b29d3cd32460ef0d2bf665d4d
+  metadata.gz: f20f297c6b30fb549ade96a5a2644f11e9ad846f0e8950f5e119bcfc83a63228dcbe51b75e635fdcfeb0bd47b17122bf568e574305406582cf4a0e9978356137
+  data.tar.gz: 0ee8c938c0b66151ba208c1769bfd5ac65277d1c62dbc3ede3976926dfef964870a7119b6003601c4f2fb0c7a90cc2d6736e8cffc9df86de81d7f6efc5c2877a

data/README.md

@@ -121,6 +121,8 @@ If you are reading this on github, the ruby docs accessible from [RubyDoc.Info](
 
 * `assert_row_regexp(row_number, regexp_str)`
 
+* `assert_rows_each_match_regexp(row_start, row_end, regexp_str)`
+
 * `assert_cursor_position(x: x, y: y)`
 
 * `assert_cursor_visible`
@@ -131,6 +133,22 @@ If you are reading this on github, the ruby docs accessible from [RubyDoc.Info](
 
 * `assert_contents_at(row_start, row_end, expected_text)`
 
+* `assert_contents_include(expected)`
+
+* `assert_contents_empty`
+
+* `assert_contents_match_regexp(regexp_str)`
+
+* `assert_file_exists(file_path)`
+
+* `assert_file_doesnt_exist(file_path)`
+
+* `assert_file_contains(file_path, needle)`
+
+* `assert_file_has_permissions(file_path, permissions)`
+
+* `assert_file_has_line_count(file_path, expected_count)`
+
 ## Output
 
 You can send output to the terminal with the following calls.

data/lib/ttytest/assertions.rb

@@ -139,7 +139,7 @@ module TTYtest
               "expected row #{index} to match regexp #{regexp_str} but it did not. Row value #{get_inspection(actual_row)}\nEntire screen:\n#{self}"
       end
     end
-    alias assert_line_each_match_regexp assert_rows_each_match_regexp
+    alias assert_lines_each_match_regexp assert_rows_each_match_regexp
 
     # Asserts that the cursor is in the expected position
     # @param [Integer] x cursor x (row) position, starting from 0
@@ -155,6 +155,7 @@ module TTYtest
             "expected cursor to be at #{expected.inspect} but was at #{get_inspection(actual)}\nEntire screen:\n#{self}"
     end
 
+    # Asserts the cursor is currently visible
     # @raise [MatchError] if the cursor is hidden
     def assert_cursor_visible
       return if cursor_visible?
@@ -162,6 +163,7 @@ module TTYtest
       raise MatchError, "expected cursor to be visible was hidden\nEntire screen:\n#{self}"
     end
 
+    # Asserts the cursor is currently hidden
     # @raise [MatchError] if the cursor is visible
     def assert_cursor_hidden
       return if cursor_hidden?
@@ -200,11 +202,56 @@ module TTYtest
     alias assert_matches_at assert_contents_at
     alias assert_rows assert_contents_at
 
+    # Asserts the contents of the screen include the passed in string
+    # @param [String] expected the string value expected to be found in the screen contents
+    # @raise [MatchError] if the screen does not contain the expected value
+    def assert_contents_include(expected)
+      found = false
+      rows.each do |row|
+        found = true if row.include?(expected)
+      end
+      return if found
+
+      raise MatchError,
+            "Expected screen contents to include #{expected}, but it was not found.\nEntire screen:\n#{self}"
+    end
+    alias assert_screen_includes assert_contents_include
+
+    # Asserts the contents of the screen are empty
+    # @raise [MatchError] if the screen is not empty
+    def assert_contents_empty
+      return if rows.all? { |s| s.to_s.empty? }
+
+      raise MatchError,
+            "Expected screen to be empty, but found content.\nEntire screen:\n#{self}"
+    end
+    alias assert_screen_empty assert_contents_empty
+
+    # Asserts the contents of the screen as a single string match the passed in regular expression
+    # @param [String] regexp_str the regular expression as a string that will be used to match with
+    # @raise [MatchError] if the screen as a string doesn't match against the regular expression
+    def assert_contents_match_regexp(regexp_str)
+      regexp = Regexp.new(regexp_str)
+      screen = capture.to_s
+
+      return if !screen.nil? && screen.match?(regexp)
+
+      raise MatchError,
+            "Expected screen contents to match regexp #{regexp_str} but they did not\nEntire screen:\n#{self}"
+    end
+    alias assert_screen_matches_regexp assert_contents_match_regexp
+
+    # Asserts the specified file exists
+    # @param [String] file_path the path to the file
+    # @raise [MatchError] if the file is not found or is a directory/symlink
     def assert_file_exists(file_path)
       raise file_not_found_error(file_path) unless File.exist?(file_path)
       raise file_is_dir_error(file_path) unless File.file?(file_path)
     end
 
+    # Asserts the specified file does not exists
+    # @param [String] file_path the path to the file
+    # @raise [MatchError] if the file is found or is a directory/symlink
     def assert_file_doesnt_exist(file_path)
       return unless File.exist?(file_path) || File.file?(file_path)
 
@@ -212,6 +259,10 @@ module TTYtest
             "File with path #{file_path} was found or is a directory when it was asserted it did not exist.\nEntire screen:\n#{self}"
     end
 
+    # Asserts the specified file contains the passed in string value
+    # @param [String] file_path the path to the file
+    # @param [String] needle the value to search for in the file
+    # @raise [MatchError] if the file does not contain value in variable needle
     def assert_file_contains(file_path, needle)
       raise file_not_found_error(file_path) unless File.exist?(file_path)
       raise file_is_dir_error(file_path) unless File.file?(file_path)
@@ -230,6 +281,10 @@ module TTYtest
     end
     alias assert_file_like assert_file_contains
 
+    # Asserts the specified file has the permissions specified
+    # @param [String] file_path the path to the file
+    # @param [String] permissions the expected permissions of the file (in form '644' or '775')
+    # @raise [MatchError] if the file has different permissions than specified
     def assert_file_has_permissions(file_path, permissions)
       raise file_not_found_error(file_path) unless File.exist?(file_path)
       raise file_is_dir_error(file_path) unless File.file?(file_path)
@@ -242,6 +297,10 @@ module TTYtest
             "File had permissions #{perms_octal}, not #{permissions} as expected.\n Entire screen:\n#{self}"
     end
 
+    # 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
+    # @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)
       raise file_is_dir_error(file_path) unless File.file?(file_path)

data/lib/ttytest/version.rb

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

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github
-git tag v1.0.7
+git tag v1.1.0
 git push origin --tags
 
 to push new version to rubygems.org
 gem build ttytest2.gemspec
-gem push ttytest2-1.0.7.gem
+gem push ttytest2-1.1.0.gem

data/todo.txt

@@ -1,2 +1,6 @@
 assert_exit_code(0)            # For success
 assert_exit_code(1)            # For expected failure
+assert_variable_equals
+assert_prompt
+assert_prompt_after("command failed")
+assert_style(row, col, style)

data/ttytest2.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Alex Eski']
   spec.email         = ['alexeski@gmail.com']
 
-  spec.summary       = 'ttytest2 is an integration test framework for interactive console (tty) applications'
-  spec.description   = 'ttytest2 runs shell/cli applications inside of tmux and allows you to make assertions on what the output should be'
+  spec.summary       = 'ttytest2 is for integration/acceptance testing your shells/CLIs/REPLs.'
+  spec.description   = 'ttytest2 is an integration test framework for interactive console (tty) applications'
   spec.homepage      = 'https://github.com/a-eski/ttytest2'
   spec.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ttytest2
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.0
 platform: ruby
 authors:
 - Alex Eski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-01 00:00:00.000000000 Z
+date: 2025-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,8 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: ttytest2 runs shell/cli applications inside of tmux and allows you to
-  make assertions on what the output should be
+description: ttytest2 is an integration test framework for interactive console (tty)
+  applications
 email:
 - alexeski@gmail.com
 executables: []
@@ -129,5 +129,5 @@ requirements: []
 rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
-summary: ttytest2 is an integration test framework for interactive console (tty) applications
+summary: ttytest2 is for integration/acceptance testing your shells/CLIs/REPLs.
 test_files: []