ttytest2 1.0.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 986b298bb959d217e338bd7ce6c6ad5640ee656b99c44a85358bd02d408524b2
-  data.tar.gz: '08f35657997cbad512a7251c895853249fa80342a7a338a7fd83c6dca7fc73f1'
+  metadata.gz: 47258d8644be543f645de9e34a17eca3a0e38c5fb764e4e72f4d78a63a888388
+  data.tar.gz: 4aa9221ee6fc4f5e8fda754b2cd3b9c8218d7b8cf1e7e8b67dfe2a36dd9360b8
 SHA512:
-  metadata.gz: 1df9f3105198994fddb7105892bb0a1a659832bd5de3ac0dca99c87f584ccd11eaa9a9f008be97071f318445b77cde6007c161260616f1f9cd6f55a7193fa239
-  data.tar.gz: 75ddbafbb51117a557e943bd63f7c6b3d908d0e5b3f58ac10f60dff5b9d11a17c29490974cd8a6f5d75c17b89a0320c004c4a2034120170346b089a661d19ee3
+  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.
@@ -262,10 +280,11 @@ Max wait time represents the amount of time in seconds that ttytest2 will keep r
 You can configure max wait time as shown below.
 
 ``` ruby
-@tty = TTYtest::new_terminal('')
-@tty.max_wait_time = 1 # sets the max wait time to 1 second
+@tty = TTYtest::new_terminal('', max_wait_time: 1) # sets the max wait time to 1 second
 
 @tty.assert_row(0, 'echo Hello, world') # this assertion would fail after 1 second
+@tty.max_wait_time = 3
+@tty.assert_row(0, 'echo Hello, world') # this assertion would fail after 3 seconds
 ```
 
 ## Troubleshooting

data/lib/ttytest/{matchers.rb → assertions.rb}

@@ -2,7 +2,7 @@
 
 module TTYtest
   # Assertions for ttytest2.
-  module Matchers
+  module Assertions
     # 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
@@ -88,6 +88,7 @@ module TTYtest
       raise MatchError,
             "expected row #{row_number} to start with #{expected.inspect} and got #{get_inspection(actual)}\nEntire screen:\n#{self}"
     end
+    alias assert_line_starts_with assert_row_starts_with
 
     # Asserts the contents of a single row end with expected
     # @param [Integer] row_number the row (starting from 0) to test against
@@ -103,6 +104,7 @@ module TTYtest
       raise MatchError,
             "expected row #{row_number} to end with #{expected.inspect} and got #{get_inspection(actual)}\nEntire screen:\n#{self}"
     end
+    alias assert_line_ends_with assert_row_ends_with
 
     # Asserts the contents of a single row match against the passed in regular expression
     # @param [Integer] row_number the row (starting from 0) to test against
@@ -118,6 +120,7 @@ module TTYtest
       raise MatchError,
             "expected row #{row_number} to match regexp #{regexp_str} but it did not. Row value #{get_inspection(actual)}\nEntire screen:\n#{self}"
     end
+    alias assert_line_regexp assert_row_regexp
 
     # 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
@@ -136,6 +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_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
@@ -151,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?
@@ -158,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?
@@ -165,29 +171,11 @@ module TTYtest
       raise MatchError, "expected cursor to be hidden was visible\nEntire screen:\n#{self}"
     end
 
-    def matched(expected, actual)
-      expected_rows = expected.split("\n")
-      diff = []
-      matched = true
-      actual.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]
-    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)
+      matched, diff = get_diff(expected, rows)
 
       return if matched
 
@@ -204,7 +192,7 @@ module TTYtest
       validate(row_end)
       row_end += 1 if row_end.zero?
 
-      matched, diff = matched(expected, rows.slice(row_start, row_end))
+      matched, diff = get_diff(expected, rows.slice(row_start, row_end))
 
       return if matched
 
@@ -214,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)
 
@@ -226,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)
@@ -242,7 +279,12 @@ module TTYtest
       raise MatchError,
             "File with path #{file_path} did not contain #{needle}.\nEntire screen:\n#{self}"
     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)
@@ -255,6 +297,21 @@ 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)
+
+      actual_count = File.foreach(file_path).count
+      return if actual_count == expected_count
+
+      raise MatchError,
+            "File had #{actual_count} lines, not #{expected_count} lines as expected.\nEntire screen:\n#{self}"
+    end
+
     METHODS = public_instance_methods
 
     private
@@ -284,6 +341,24 @@ module TTYtest
             Entire screen:\n#{self}"
     end
 
+    def get_diff(expected, actual)
+      expected_rows = expected.split("\n")
+      diff = []
+      matched = true
+      actual.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]
+    end
+
     def file_not_found_error(file_path)
       raise MatchError,
             "File with path #{file_path} was not found when asserted it did exist.\nEntire screen:\n#{self}"

data/lib/ttytest/capture.rb

@@ -7,7 +7,7 @@ module TTYtest
   # @attr_reader [Integer] cursor_x The cursor's column (starting at 0) in the captured terminal.
   # @attr_reader [Integer] cursor_y The cursor's row (starting at 0) in the captured terminal.
   class Capture
-    include TTYtest::Matchers
+    include TTYtest::Assertions
 
     attr_reader :cursor_x, :cursor_y, :width, :height
 

data/lib/ttytest/terminal.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'forwardable'
-require 'ttytest/matchers'
+require 'ttytest/assertions'
 require 'ttytest/capture'
 
 module TTYtest
@@ -193,7 +193,7 @@ module TTYtest
                    :cursor_x, :cursor_y,
                    :cursor_visible?, :cursor_hidden?
 
-    Matchers::METHODS.each do |matcher_name|
+    Assertions::METHODS.each do |matcher_name|
       define_method matcher_name do |*args, **kwargs|
         synchronize do
           capture.public_send(matcher_name, *args, **kwargs)

data/lib/ttytest/version.rb

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

data/lib/ttytest.rb

@@ -25,7 +25,22 @@ module TTYtest
     # @!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
+    def_delegators :driver
+
+    def new_terminal(cmd, width: 80, height: 24, max_wait_time: 2)
+      @max_wait_time = max_wait_time
+      driver.new_terminal(cmd, width: width, height: height)
+    end
+
+    def new_default_sh_terminal(max_wait_time: 2)
+      @max_wait_time = max_wait_time
+      driver.new_default_sh_terminal
+    end
+
+    def new_sh_terminal(width: 80, height: 24, max_wait_time: 2)
+      @max_wait_time = max_wait_time
+      driver.new_sh_terminal(width: width, height: height)
+    end
   end
 
   # The error type raised when an assertion fails.

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github
-git tag v1.0.6
+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.6.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.6
+  version: 1.1.0
 platform: ruby
 authors:
 - Alex Eski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-28 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: []
@@ -96,9 +96,9 @@ files:
 - Rakefile
 - examples/integration_tests.rb
 - lib/ttytest.rb
+- lib/ttytest/assertions.rb
 - lib/ttytest/capture.rb
 - lib/ttytest/constants.rb
-- lib/ttytest/matchers.rb
 - lib/ttytest/terminal.rb
 - lib/ttytest/tmux/driver.rb
 - lib/ttytest/tmux/session.rb
@@ -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: []