ttytest2 0.9.6 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 196acc1f485c7ad416fbdbe07c94f0829bfb53a57c852a85bf79d72655f4debb
-  data.tar.gz: a2afc1f836dff32a2e2aa53a90137ce9bd768a20907855defae05da66af821e4
+  metadata.gz: ad00f4819b188050fb5882adeac6578525082d1740c3b17a4320ec56b3f68b51
+  data.tar.gz: bf5dcc48c03fa7ab3cbf0c4e5780e479482f68fc19c149accd4e46c39d655cb2
 SHA512:
-  metadata.gz: 762f9246cadb92d30ef2d8535b135cb9d72270d8e24bc100c8d18e18ecdd949e35560a7ff6fdc3b413a7dffbacbef56cf712c0b459b4cc3f8f7797dbfeca61d3
-  data.tar.gz: 2e099fda420602c981073d9cb39d9be307e261086ac8682ec4b213b6a061eded99a9ccff73df9e6c16a9157676fc4dea03a33d834d643fcfdf63631090807156
+  metadata.gz: 8357acea4da5433d9131d72ab29c21a73c38f7c53140a0eff2a0ece7393eb47b2fb749b2539dee905bd4c3baa9f7aa2e502921a33a777b060cfe32568752933d
+  data.tar.gz: c4ecdc9782d7c1e0633dc5b3ff4579bcbac288e6cc4628a9e496ea91fe0777ab2e028896db6f398e1f2e9b66d050b2e9a04260da636dc2a1a2c7693640555ed0

data/README.md

@@ -57,6 +57,13 @@ $
 TTY
 @tty.assert_cursor_position(x: 2, y: 2)
 
+@tty.assert_contents_at(0, 0, '$ echo "Hello, world"')
+
+@tty.assert_row_starts_with(0, '$ echo')
+@tty.assert_row_ends_with(0, '"Hello, world"')
+@tty.assert_row_starts_with(1, 'Hello')
+@tty.assert_row_ends_with(1, ', world')
+
 @tty.print_rows # => ["$ echo \"Hello, world\"", "Hello, world", "$", "", "", "", ...]
 
 @tty.print # prints out the contents of the terminal
@@ -79,16 +86,15 @@ require 'ttytest'
 
 @tty.send_keys_one_at_a_time('ls')
 @tty.assert_row_ends_with(0, 'ls')
-@tty.send_keys(%(\n)) # make sure to use send_keys for 'multi-character' characters like \n, \r, \t, etc.
+@tty.send_newline # builtins for common outputs line newline
 
 @tty.send_keys_one_at_a_time('ps')
 @tty.assert_row_ends_with(1, 'ps')
 @tty.send_keys(TTYtest:NEWLINE) # can use constants instead
 
-
 @tty.assert_row_starts_with(2, ENV['USER'])
 @tty.assert_row_ends_with(2, '$')
-@tty.send_newline # an alternative to the 2 above methods to send \n to the terminal
+@tty.send_newline
 
 puts "\n#{@tty.capture}" # prints out the contents of the terminal, equivalent to @tty.print
 ```
@@ -108,6 +114,7 @@ Available assertions:
 * `assert_cursor_visible`
 * `assert_cursor_hidden`
 * `assert_contents(lines_of_terminal)`
+* `assert_contents_at(row_start, row_end, expected_text)`
 
 ### Output
 

data/lib/ttytest/capture.rb

@@ -51,10 +51,7 @@ module TTYtest
     def print
       puts "\n#{self}"
     end
-
-    def print_rows
-      puts rows
-    end
+    alias print_rows print
 
     # @return [String] All rows of the captured terminal, separated by newlines
     def to_s

data/lib/ttytest/matchers.rb

@@ -25,7 +25,7 @@ module TTYtest
     def assert_row_at(row_number, column_start, column_end, expected)
       expected = expected.rstrip
       actual = row(row_number)
-      column_end += 1 if column_end.positive?
+      column_end += 1
       return if actual[column_start, column_end].eql?(expected)
 
       raise MatchError,
@@ -125,6 +125,33 @@ module TTYtest
     end
     alias assert_matches assert_contents
 
+    # Asserts the contents of the terminal at specified rows
+    # @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)
+      expected_rows = expected.split("\n")
+      diff = []
+      matched = true
+      row_end += 1 if row_end.zero?
+
+      rows.slice(row_start, row_end).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
+
+      return if matched
+
+      raise MatchError,
+            "screen did not match expected content:\n--- expected\n+++ actual\n#{diff.join("\n")}"
+    end
+    alias assert_matches_at assert_contents_at
+
     METHODS = public_instance_methods
   end
 end

data/lib/ttytest/terminal.rb

@@ -61,13 +61,15 @@ module TTYtest
     #   @param [Integer] number of times to send up arrow
     # @!method send_keys_exact
     #   Send tmux send-keys command to the terminal, such as DC or Enter, to simulate pressing that key in the terminal.
+    # @!method send_home
+    #   Simulates typing in the Home key in the terminal.
+    # @!method send_end
+    #   Simulates typing in the End key in the terminal.
+    # @!method send_clear
+    #   Clears the screen in the terminal using ascii clear command.
     # @!method capture
     #   Capture the current state of the terminal
     #   @return [Capture] instantaneous state of the terminal when called
-    # @!method print
-    #   Prints the current state of the terminal to stdout. See capture to get the raw string.
-    # @!method print_rows
-    #   Prints the current state of the terminal as an array to stdout. See rows to get the raw array.
     def_delegators :@driver_terminal,
                    :send_keys, :send_keys_one_at_a_time,
                    :send_newline, :send_newlines,
@@ -78,6 +80,10 @@ module TTYtest
                    :send_keys_exact, :send_home, :send_end, :send_clear,
                    :capture
 
+    # @!method print
+    #   Prints the current state of the terminal to stdout. See capture to get the raw string.
+    # @!method print_rows
+    #   Prints the current state of the terminal as an array to stdout. See rows to get the raw array.
     # @!method rows
     #   @return [Array<String>]
     #   @see Capture#rows

data/lib/ttytest/version.rb

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

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github
-git tag v0.9.6
+git tag v0.9.7
 git push origin --tags
 
 to push new version to rubygems.org
 gem build ttytest2.gemspec
-gem push ttytest2-0.9.6.gem
+gem push ttytest2-0.9.7.gem

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ttytest2
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 0.9.7
 platform: ruby
 authors:
 - Alex Eski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-04 00:00:00.000000000 Z
+date: 2024-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler