ttytest2 0.9.5 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1d11e60e54ba7d4b267d4b51d0fedeeade66563ac9957dd652b4fb94e57ed4b
-  data.tar.gz: 568127f476a6fbed14d5288e4a07dddfa5512a9b050c9a31bd7071c92b7a90dc
+  metadata.gz: ad00f4819b188050fb5882adeac6578525082d1740c3b17a4320ec56b3f68b51
+  data.tar.gz: bf5dcc48c03fa7ab3cbf0c4e5780e479482f68fc19c149accd4e46c39d655cb2
 SHA512:
-  metadata.gz: 78b47ae1254de6020012e16e1825f2d43d5fe5ef36eb8c7deb141023e6a33616561f8794a02b79113963aa290e2c7b30df8fc0e73c0d4adf1c59de093ed70973
-  data.tar.gz: 2b9da01bb485487eb5e060a8a69ae9d7e989c5d5be1f873efe94a287773d0abc1106fd16002f88343c012d21a28642421ec0c8cbf222f886bcc32580abdd0154
+  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
 
@@ -137,17 +144,20 @@ Helper functions to make sending output easier! They use the methods above under
 * `send_down_arrows(number_of_times)`
 * `send_home` # simulate pressing the Home key
 * `send_end` # simulate pressing the End key
+* `send_clear` # clear the screen by sending clear ascii code
 
 ### Troubleshooting
 
 You can use the method rows to get all rows of the terminal as an array, of use the method capture to get the contents of the terminal window. This can be useful when troubleshooting.
 
 ``` ruby
-p @tty.rows # prints out the contents of the terminal as a array
-@tty.print_rows # equivalent to above
+# you can use @tty.rows to access the entire pane, split by line into an array.
+p @tty.rows # prints out the contents of the terminal as a array.
+@tty.print_rows # equivalent to above, just for ease of use.
 
-puts "\n#{@tty.capture}" # prints out the contents of the terminal
-@tty.print # equivalent to above
+# you can use @tty.capture to access the entire pane.
+p "\n#{@tty.capture}" # prints out the contents of the terminal
+@tty.print # equivalent to above, just for ease of use.
 ```
 
 ### Constants

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/constants.rb

@@ -14,5 +14,5 @@ module TTYtest
   RIGHT_ARROW = "#{ESCAPE}[C".freeze
   LEFT_ARROW = "#{ESCAPE}[D".freeze
 
-  CLEAR = 'clear'
+  CLEAR = "#{ESCAPE}[2J".freeze
 end

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,
@@ -75,9 +77,13 @@ module TTYtest
                    :send_backspace, :send_backspaces,
                    :send_left_arrow, :send_left_arrows, :send_right_arrow, :send_right_arrows,
                    :send_down_arrow, :send_down_arrows, :send_up_arrow, :send_up_arrows,
-                   :send_keys_exact, :send_home, :send_end,
-                   :capture, :print, :print_rows
+                   :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
@@ -102,7 +108,8 @@ module TTYtest
     # @!method cursor_hidden?
     #   @see Capture#cursor_hidden?
     #   @return [true,false]
-    def_delegators :capture, :rows, :row,
+    def_delegators :capture, :print, :print_rows,
+                   :rows, :row,
                    :width, :height,
                    :cursor_x, :cursor_y,
                    :cursor_visible?, :cursor_hidden?

data/lib/ttytest/tmux/session.rb

@@ -146,6 +146,11 @@ module TTYtest
         send_keys_exact(%(End))
       end
 
+      def send_clear
+        send_keys_one_at_a_time(TTYtest::CLEAR)
+        send_newline
+      end
+
       private
 
       attr_reader :driver, :name

data/lib/ttytest/version.rb

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

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github
-git tag v0.9.5
+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.5.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.5
+  version: 0.9.7
 platform: ruby
 authors:
 - Alex Eski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-29 00:00:00.000000000 Z
+date: 2024-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler