ttytest2 0.9.12 → 0.9.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0509fd299994f0f61a308fe4f8fce559d9cd0f55d095ebac9e46a4889088d289'
-  data.tar.gz: 42db9936a321bce77fb11dbea796fd083291fac9c3bf3cc0611714815b3dca07
+  metadata.gz: fd614376f0369112c875543a1d8cc498b0de69dd436e6158fd6d8f06bd4ee87f
+  data.tar.gz: 59373cd7e5699a8e6c96a3c0071efc4164d09ddfb71365291cf4a5d086b69bd1
 SHA512:
-  metadata.gz: 9c118f0b7542d4bcef07ec07a4df564e345d6fdcc76357c342a42a3b0ee6e48c1d2b5a75c2299b2f6d3c46f2ccf4f06f1bfd1fd565b73966cf0ae942f48cd312
-  data.tar.gz: 3130e6923dbd0513e545fd19636828790488adaeaeab416fb42bdb6ab934c226bf028356b0beaf8054592e81e7eb19c602069dba4dbd993d21ee24ad2f5ba7d4
+  metadata.gz: 77eb7d0d56818eaa11b3f0ac84230f5100a50bfc0ccf45c67c34a0389005b55317b5a85d23ed68f5b65c923fe8a51efe620304dcc345c7cd4cf902ff80b8e8d4
+  data.tar.gz: 2a3d270669408488cd1e636231b336cd62e3606d1cd20dfd267858ca3e0a544ded977ecc657df82f2833a2a2a77c9f8d422428b84715377314e6c7faf57b81e7

data/README.md

@@ -95,9 +95,19 @@ You can send output to the terminal with the following calls.
 Note: Most of the time send_line has the best ergonomics.
 
 * `send_line(line)`: simulate typing in a command in the terminal and hitting enter!
+
 * `send_line_then_sleep(line, sleep_time)`: simulate typing in a command in the terminal and hitting enter, then wait for sleep_time seconds.
+
+* `send_lines(lines)`: for each line in lines, simulate sending the line and hitting enter.
+
+* `send_lines_then_sleep(lines, sleep_time)`: for each line in lines, simulate sending the line and hitting enter. After sending all the lines, sleep for sleep_time.
+
+* `send_line_then_sleep_and_repeat(lines, sleep_time)`: for each line in lines, simulate sending the line and hitting enter, then sleep before sending the next line.
+
 * `send_keys(output)`: for canonical shells/CLI's (or multi-character keys for noncanonical shells/CLI's).
+
 * `send_keys_one_at_a_time(output)`: for noncanonical shells/CLI's.
+
 * `send_keys_exact(output)`: for sending tmux specific keys (any supported send-keys arguments like: DC for delete, Escape for ESC, etc.)
 
 ### Output Helpers
@@ -106,6 +116,8 @@ Helper functions to make sending output easier! They use the methods above under
 
 * `send_newline` # simulate hitting enter, equivalent to @tty.send_keys(%(\n))
 * `send_newlines(number_of_times)` # equivalent to calling send_newline number_of_times
+* `send_enter` # alias for send_newline
+* `send_enters(number_of_times)` # alias for send_newlines
 * `send_backspace` # simulate hitting backspace, equivalent to @tty.send_keys(TTYtest::BACKSPACE)
 * `send_backspaces(number_of_times)` # equivalent to calling send_backspace number_of_times
 * `send_delete` # simulate hitting delete, equivalent to calling send_keys_exact(%(DC))
@@ -121,6 +133,8 @@ Helper functions to make sending output easier! They use the methods above under
 * `send_home` # simulate pressing the Home key
 * `send_end` # simulate pressing the End key
 * `send_clear` # clear the screen by sending clear ascii code
+* `send_escape`
+* `send_escapes`
 
 ### F keys?
 
@@ -166,8 +180,6 @@ You can use the method rows to get all rows of the terminal as an array, of use
 # if you want to programatically access the rows, you can do so using @tty.rows
 p @tty.rows # is equivalent to above statement @tty.print_rows
 
-
-
 # you can use @tty.capture to access the entire pane.
 @tty.print # prints out the contents of the terminal:
 # $ echo "Hello, world"
@@ -192,7 +204,9 @@ There are some commonly used keys available as constants to make interacting wit
   TTYtest::BACKSPACE
   TTYtest::TAB
   TTYtest::NEWLINE # \n
-  TTYtest::VERTICAL_TAB
+  TTYtest::ENTER # \n
+  TTYtest::VERTICAL_TAB # \v
+  TTYtest::SHIFT_ENTER # \v
   TTYtest::FORM_FEED # \f or New Page NP
   TTYtest::CTRLL
   TTYtest::CARRIAGE_RETURN # \r

data/lib/ttytest/constants.rb

@@ -11,7 +11,9 @@ module TTYtest
   BACKSPACE = 8.chr
   TAB = 9.chr # \t
   NEWLINE = 10.chr # \n
+  ENTER = 10.chr # \n
   VERTICAL_TAB = 11.chr # \v
+  SHIFT_ENTER = 11.chr # \v
   FORM_FEED = 12.chr # \f
   CTRLL = 12.chr
   CARRIAGE_RETURN = 13.chr # \r

data/lib/ttytest/matchers.rb

@@ -46,6 +46,7 @@ module TTYtest
       raise MatchError,
             "expected row #{row_number} to be like #{expected.inspect} but got #{actual.inspect}\nEntire screen:\n#{self}"
     end
+    alias assert_row_contains assert_row_like
 
     # Asserts the contents of a single row starts with expected string
     # @param [Integer] row_number the row (starting from 0) to test against

data/lib/ttytest/terminal.rb

@@ -21,70 +21,127 @@ 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)
     #   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_line(line)
     #   Simulate sending a line to the terminal and hitting enter.
+    #   Can send multiline input, but if you want to send several commands at once, see send_lines(lines)
+    #   @param [String] line the line to send to the terminal
+
     # @!method send_line_then_sleep(line, sleep_time)
-    #   Simulate sending a line to the terminal and hitting enter, then wait for the sleep_time.
+    #   Simulate sending a line to the terminal and hitting enter, then sleeping for sleep_time.
+    #   @param [String] line the line to send to the terminal
+    #   @param [Integer] sleep_time the amount of time to sleep after sending the line
+
+    # @!method send_lines(lines)
+    #   Simulate sending a multiple lines to the terminal and hitting enter after each line.
+    #   @param [String] lines array of lines to send to the terminal
+
+    # @!method send_lines_then_sleep(lines, sleep_time)
+    #   Simulate sending multiples lines to the terminal and hitting enter after each line.
+    #   After sending all lines, then wait for the sleep_time.
+    #   @param [String] line the line to send to the terminal
+    #   @param [Integer] sleep_time the amount of time to sleep after sending the line
+
+    # @!method send_line_then_sleep_and_repeat(lines, sleep_time)
+    #   Simulate sending a line to the terminal and hitting enter, then sleeping for sleep_time.
+    #   before sending the next line.
+    #   @param [String] line the line to send to the terminal
+    #   @param [Integer] sleep_time the amount of time to sleep after sending the line
+
     # @!method send_newline
     #   Simulate typing enter by sending newline character to the terminal.
-    # @!method send_newlines
+
+    # @!method send_newlines(number_of_times)
+    #   Simulates sending newline the specified number of times.
+    #   @param [Integer] number_of_times number of times to send newline
+
+    # @!method send_enter
+    #   Simulate typing enter by sending newline character to the terminal.
+
+    # @!method send_enters(number_of_times)
     #   Simulates sending newline the specified number of times.
     #   @param [Integer] number of times to send newline
+
     # @!method send_delete
     #   Simulate typing the delete key in the terminal.
-    # @!method send_deletes
+
+    # @!method send_deletes(number_of_times)
     #   Simulates typing delete the specified number of times.
     #   @param [Integer] number of times to send delete
+
     # @!method send_backspace
     #   Simulate typing the backspace key in the terminal.
-    # @!method send_backspaces
+
+    # @!method send_backspaces(number_of_times)
     #   Simulates typing backspace the specified number of times.
     #   @param [Integer] number of times to send backspace
+
     # @!method send_left_arrow
     #   Simulate typing the left arrow key in the terminal.
-    # @!method send_left_arrows
+
+    # @!method send_left_arrows(number_of_times)
     #   Simulates typing left arrow the specified number of times.
     #   @param [Integer] number of times to send left arrow
+
     # @!method send_right_arrow
     #   Simulate typing the right arrow key in the terminal.
-    # @!method send_right_arrows
+
+    # @!method send_right_arrows(number_of_times)
     #   Simulates typing right arrow the specified number of times.
     #   @param [Integer] number of times to send right arrow
+
     # @!method send_down_arrow
     #   Simulate typing the down arrow key in the terminal.
-    # @!method send_down_arrows
+
+    # @!method send_down_arrows(number_of_times)
     #   Simulates typing the down arrow the specified number of times.
     #   @param [Integer] number of times to send down arrow
+
     # @!method send_up_arrow
     #   Simulate typing the up arrow key in the terminal.
-    # @!method send_up_arrows
+
+    # @!method send_up_arrows(number_of_times)
     #   Simulates typing the up arrow the specified number of times.
     #   @param [Integer] number of times to send up arrow
-    # @!method send_keys_exact
+
+    # @!method send_keys_exact(keys)
     #   Send tmux send-keys command to the terminal, such as DC or Enter, to simulate pressing that key in the terminal.
+    #   @param [String] keys the line to send to 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 send_escape
     #   Simulates typing in the Escape (ESC) key in the terminal.
+
+    # @!method send_escapes(number_of_times)
+    #   Simulates typing in the Escape (ESC) key in the terminal the specified number of times.
+    #   @param [Integer] number of times to send escape
+
     # @!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_line, :send_line_then_sleep,
+                   :send_lines, :send_lines_then_sleep, :send_line_then_sleep_and_repeat,
                    :send_newline, :send_newlines,
+                   :send_enter, :send_enters,
                    :send_delete, :send_deletes,
                    :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, :send_clear, :send_escape,
+                   :send_keys_exact, :send_home, :send_end, :send_clear, :send_escape, :send_escapes,
                    :capture
 
     # @!method print

data/lib/ttytest/tmux/session.rb

@@ -67,9 +67,29 @@ module TTYtest
         sleep sleep_time
       end
 
+      def send_lines(*lines)
+        lines.each do |line|
+          send_line(line)
+        end
+      end
+
+      def send_lines_then_sleep(*lines, sleep_time)
+        lines.each do |line|
+          send_line(line)
+        end
+        sleep sleep_time
+      end
+
+      def send_line_then_sleep_and_repeat(*lines)
+        lines.each do |line|
+          send_line_then_sleep(line)
+        end
+      end
+
       def send_newline
         driver.tmux(*%W[send-keys -t #{name} -l], %(\n))
       end
+      alias send_enter send_newline
 
       def send_newlines(number_of_times)
         while number_of_times.positive?
@@ -77,6 +97,7 @@ module TTYtest
           number_of_times -= 1
         end
       end
+      alias send_enters send_newlines
 
       def send_delete
         send_keys_exact(%(DC))
@@ -169,6 +190,13 @@ module TTYtest
         send_keys_exact(%(Escape))
       end
 
+      def send_escapes(number_of_times)
+        while number_of_times.positive?
+          send_escape
+          number_of_times -= 1
+        end
+      end
+
       private
 
       attr_reader :driver, :name

data/lib/ttytest/version.rb

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

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github
-git tag v0.9.12
+git tag v0.9.13
 git push origin --tags
 
 to push new version to rubygems.org
 gem build ttytest2.gemspec
-gem push ttytest2-0.9.12.gem
+gem push ttytest2-0.9.13.gem

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ttytest2
 version: !ruby/object:Gem::Version
-  version: 0.9.12
+  version: 0.9.13
 platform: ruby
 authors:
 - Alex Eski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-08 00:00:00.000000000 Z
+date: 2025-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler