ttytest2 0.8.6 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5813f48d629bc3029c7c486652b5badcedbbac19b4c24946f50f8aa9df579c8
-  data.tar.gz: 86adb037b39d0da7cdcc9920d71f1655e8864e0171ae3fabfcb7301774908102
+  metadata.gz: 9c871fc585971f615966d7797478185dd942e78b6cfcfc9324773edfd789664f
+  data.tar.gz: 4a7a6b509c222510918cdad040e958c09bdd653700b3a3871f087cdadf7a5c9b
 SHA512:
-  metadata.gz: e6fe94d8ef4c818a94b487f01efee8ab8d2c1ed828b30679eed643e4388c9e77178d00c25e761881098b47512a51f696c597a82fabfa68d9e6a569ea52b0e15e
-  data.tar.gz: 0ce32ed7e12445f1c9d4fee55ec2f9b5c27a3890c73a1a3a52b45c39c5c1931ebc08bcc6f04bf5e55d372a03b82e4b19a2ccfee4a487a427d52047d92f3fec84
+  metadata.gz: 84d1c8b052ce38fdad9d0780774a0aae6a378b60804a156a74099e69b62f741f49b00887296e03a49030fe62c25d8bceef2b28e3a3ad2ddbd979cabbf7643b28
+  data.tar.gz: 4fc3e3186fe6827bb987f18e2d04aa9cfbe49c6c31f3d8a5e8ab92c6ec6f81264df11298cddbdeb70c46630f20ba056d29608f2df90549d6e3cbd25dbe7f4d29

data/README.md

@@ -20,14 +20,15 @@ It works by running commands inside a tmux session, capturing the pane, and comp
 The main way to use TTYtest is through assertions. When called on a `TTYtest::Terminal`, each of these will be retried (for up to 2 seconds).
 
 Available assertions:
-* `assert_row(row_number, expected_text)`
-* `assert_row_like(row_number, expected_text)`
-* `assert_row_starts_with(row_number, expected_text)`
-* `assert_row_ends_with(row_number, expected_text)`
-* `assert_cursor_position(x: x, y: y)`
-* `assert_cursor_visible`
-* `assert_cursor_hidden`
-* `assert_contents(lines_of_terminal)`
+* specify row matches expected text exactly: `assert_row(row_number, expected_text) `
+* specify expected position of expected text: `assert_row_at(row_number, column_start_position, column_end_position, expected_text)`
+* specify row contains expected text: `assert_row_like(row_number, expected_text)`
+* specify row starts with expected text: `assert_row_starts_with(row_number, expected_text)`
+* specify row ends with expected text: `assert_row_ends_with(row_number, expected_text)`
+* specify the current cursor position matches expected: `assert_cursor_position(x: x, y: y)`
+* specify the cursor is currently visible: `assert_cursor_visible`
+* specify the cursor is currently hidden: `assert_cursor_hidden`
+* specify the contents of the entire terminal window: `assert_contents(lines_of_terminal)`
 
 ### Sending output
 
@@ -80,6 +81,10 @@ require 'ttytest'
 @tty.send_keys_one_at_a_time('ps')
 @tty.assert_row_ends_with(0, 'ps')
 @tty.send_keys(TTYtest:NEWLINE) # can use constants instead
+
+@tty.assert_row_starts_with(0, ENV['USER'])
+@tty.assert_row_ends_with(0, '$')
+@tty.send_newline # an alternative to the 2 above methods to send \n to the terminal
 ```
 
 ### Constants
@@ -88,7 +93,6 @@ There are some commonly used keys available as constants to make interacting wit
 
 ``` ruby
   TTYtest::BACKSPACE
-  TTYtest::DELETE
   TTYtest::TAB
   TTYtest::CTRLF
   TTYtest::CTRLC

data/lib/ttytest/constants.rb

@@ -3,7 +3,6 @@
 # some constants that can be used with send_keys, just to help out people creating tests
 module TTYtest
   BACKSPACE = 127.chr
-  DELETE = '^[[3~'
   TAB = 9.chr
   CTRLF = 6.chr
   CTRLC = 3.chr

data/lib/ttytest/matchers.rb

@@ -3,10 +3,10 @@
 module TTYtest
   # Assertions for ttytest2.
   module Matchers
-    # Asserts the contents of a single row
+    # 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
-    # @raise [MatchError] if the row doesn't match
+    # @raise [MatchError] if the row doesn't match exactly
     def assert_row(row_number, expected)
       expected = expected.rstrip
       actual = row(row_number)
@@ -16,7 +16,25 @@ module TTYtest
             "expected row #{row_number} to be #{expected.inspect} but got #{actual.inspect}\nEntire screen:\n#{self}"
     end
 
-    # Asserts the contents of a single row contains expected
+    # Asserts the contents of a single row contains the expected string at a specific position
+    # @param [Integer] row_number the row (starting from 0) to test against
+    # @param [Integer] column_start the column position to start comparing expected against
+    # @param [Integer] columns_end the column position to end comparing expected against
+    # @param [String] expected the expected value that the row starts with. Any trailing whitespace is ignored
+    # @raise [MatchError] if the row doesn't match
+    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?
+      return if actual[column_start, column_end].eql?(expected)
+
+      raise MatchError,
+            "expected row #{row_number} to contain #{expected[column_start,
+                                                              column_end]} at #{column_start}-#{column_end} and got #{actual[column_start,
+                                                                                                                             column_end]}\nEntire screen:\n#{self}"
+    end
+
+    # Asserts the contents of a single row contains the value expected
     # @param [Integer] row_number the row (starting from 0) to test against
     # @param [String] expected the expected value contained in the row. Any trailing whitespace is ignored
     # @raise [MatchError] if the row doesn't match
@@ -29,7 +47,7 @@ module TTYtest
             "expected row #{row_number} to be like #{expected.inspect} but got #{actual.inspect}\nEntire screen:\n#{self}"
     end
 
-    # Asserts the contents of a single row start with expected
+    # Asserts the contents of a single row starts with expected string
     # @param [Integer] row_number the row (starting from 0) to test against
     # @param [String] expected the expected value that the row starts with. Any trailing whitespace is ignored
     # @raise [MatchError] if the row doesn't match

data/lib/ttytest/terminal.rb

@@ -21,13 +21,23 @@ module TTYtest
     # @!method send_keys(*keys)
     #   Simulate typing keys into the terminal. For canonical cli's/shells which read line by line.
     #   @param [String] keys keys to send to the terminal
-    # @!method send_keys_one_at_a_time(*keys)
+    # @!method send_keys_one_at_a_time(keys)
     #   Simulate typing keys into the terminal. For noncanonical cli's/shells which read character by character.
     #   @param [String] keys keys to send to the terminal
+    # @!method send_newline
+    #   Simulate typing enter by sending newline character to the terminal.
+    # @!method send_delete
+    #   Simulate typing the delete key in the terminal.
+    # @!method send_backspace
+    #   Simulate typing the backspace key in the terminal.
+    # @!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 capture
     #   Capture the current state of the terminal
     #   @return [Capture] instantaneous state of the terminal when called
-    def_delegators :@driver_terminal, :send_keys, :send_keys_one_at_a_time, :send_newline, :capture
+    def_delegators :@driver_terminal,
+                   :send_keys, :send_keys_one_at_a_time, :send_newline, :send_delete, :send_backspace, :send_keys_exact,
+                   :capture
 
     # @!method rows
     #   @return [Array<String>]

data/lib/ttytest/tmux/session.rb

@@ -38,10 +38,15 @@ module TTYtest
         )
       end
 
+      # Send the array of keys as a string literal to tmux.
+      # Will not be interpreted as send-keys values like Enter, Escape, DC for Delete, etc.
+      # @param [%w()] keys the keys to send to tmux
       def send_keys(*keys)
         driver.tmux(*%W[send-keys -t #{name} -l], *keys)
       end
 
+      # Send a string of keys one character at a time as literals to tmux.
+      # @param [String] keys the keys to send one at a time to tmux
       def send_keys_one_at_a_time(keys)
         keys.split('').each do |key|
           driver.tmux(*%W[send-keys -t #{name} -l], key)
@@ -52,6 +57,22 @@ module TTYtest
         driver.tmux(*%W[send-keys -t #{name} -l], %(\n))
       end
 
+      def send_delete
+        send_keys_exact(%(DC))
+      end
+
+      def send_backspace
+        send_keys_exact(%(BSpace))
+      end
+
+      # Useful to send send-keys commands to tmux without sending them as a string literal.
+      # So you can send Escape for escape key, DC for delete, etc.
+      # Uses the same key bindings as bind-key as well. C-c represents Ctrl + C keys, F1 is F1 key, etc.
+      # @param [String] keys the keys to send to tmux
+      def send_keys_exact(keys)
+        driver.tmux(*%W[send-keys -t #{name}], keys)
+      end
+
       private
 
       attr_reader :driver, :name

data/lib/ttytest/version.rb

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

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github,
-git tag v0.8.6
+git tag v0.9.0
 git push origin --tags
 
 to push new version to rubygems.org
 gem build ttytest2.gemspec
-gem push ttytest2-0.8.6.gem
+gem push ttytest2-0.9.0.gem

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ttytest2
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.9.0
 platform: ruby
 authors:
 - Alex Eski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-15 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler