ttytest2 1.0.5 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ec106999c321d47e8f687ffe4d168088a5b4e23da1f84ff3c0be23597b95480
-  data.tar.gz: e51ac6079575d1a5447510414ea345ca25afe2f421e02b5cea7dfbfc03a6d499
+  metadata.gz: 0ec86d17bfe3b3a9c9485f0b53c14f4dcfebd5e875dd2ba1de7f26c7ef4b1a87
+  data.tar.gz: 2b53db154e9c680b89897bc46cffe087d415ce22049727ec1b3ff698ce80aba0
 SHA512:
-  metadata.gz: 513f344a96b541be8d422144cec5b6f57dfff62b071c341c3c251601c86299b73767054e411fc7b5a4324da608bcd33f6ad5a478f240c0d12f00e4d513c8537e
-  data.tar.gz: c993ae268580440e8bdfb91c17a707638e6991a6842fa316cf72b6891d83af32ea8e8139a6a5bdc4f281c7fc1ec9d93c6159f2f49178bf8836978421caa276af
+  metadata.gz: 5db41e82f2c81e5df9e8305f51431b58fafac9abe95b23eaf64f7e7f8e13c64ca5b1be21784b67438938579dd503cbd430128c6984e94b8fa69990c9d9e7b0cf
+  data.tar.gz: 22e3f4c4609432321cf5c7abe0f061e15f52816f89f1d8dd87283aef6d9d78dd661fe991edc074dbfd354024aaa59278799d332b29d3cd32460ef0d2bf665d4d

data/README.md

@@ -262,10 +262,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,32 +2,7 @@
 
 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
-
+  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
@@ -113,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
@@ -128,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
@@ -143,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
@@ -161,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_line_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
@@ -190,29 +169,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
 
@@ -229,7 +190,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
 
@@ -239,6 +200,114 @@ module TTYtest
     alias assert_matches_at assert_contents_at
     alias assert_rows assert_contents_at
 
+    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
+
+    def assert_file_doesnt_exist(file_path)
+      return unless File.exist?(file_path) || File.file?(file_path)
+
+      raise MatchError,
+            "File with path #{file_path} was found or is a directory when it was asserted it did not exist.\nEntire screen:\n#{self}"
+    end
+
+    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)
+
+      file_contains = false
+      File.foreach(file_path) do |line|
+        if line.include?(needle)
+          file_contains = true
+          break
+        end
+      end
+      return if file_contains
+
+      raise MatchError,
+            "File with path #{file_path} did not contain #{needle}.\nEntire screen:\n#{self}"
+    end
+    alias assert_file_like assert_file_contains
+
+    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)
+
+      file_mode = File.stat(file_path).mode
+      perms_octal = format('%o', file_mode)[-3...]
+      return if perms_octal == permissions
+
+      raise MatchError,
+            "File had permissions #{perms_octal}, not #{permissions} as expected.\n Entire screen:\n#{self}"
+    end
+
+    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
+
+    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
+
+    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}"
+    end
+
+    def file_is_dir_error(file_path)
+      raise MatchError,
+            "File with path #{file_path} is a directory.\nEntire screen:\n#{self}"
+    end
   end
 end

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.5'
+  VERSION = '1.0.7'
 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.5
+git tag v1.0.7
 git push origin --tags
 
 to push new version to rubygems.org
 gem build ttytest2.gemspec
-gem push ttytest2-1.0.5.gem
+gem push ttytest2-1.0.7.gem

data/todo.txt

@@ -1,7 +1,2 @@
-assert_file_exists("./output.json")
-assert_file_not_exists("./tempfile")
-assert_file_contains("./log.txt", "Job completed")
-assert_file_permissions("./script.sh", "755")
-
 assert_exit_code(0)            # For success
 assert_exit_code(1)            # For expected failure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ttytest2
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.7
 platform: ruby
 authors:
 - Alex Eski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-18 00:00:00.000000000 Z
+date: 2025-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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