ttytest2 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba5f1abfa44480c3955c2c0ff48e724ea09f060aa90417caa72cdcf2b15a29bc
-  data.tar.gz: 904200415a856ad8e9b077ea30f5bc9dea085f966ec896e5e19d328b39039000
+  metadata.gz: 15e01162a84bf95dce1f5694dfc57daa77decd5c7136af567c469d4e2148daa6
+  data.tar.gz: e29d3aae969a70b6bb0ba1003a87b4da7e2b819c0e80595f6a9604b11c52f7a8
 SHA512:
-  metadata.gz: 8d117e8a03132b3a0dd0c93bc0c8a864ffce023d286c98e495a7b8ddafccbdff49d7f2db49c864ceae9f88fd4529322294ec7c7b2e925806e7af721d94ba12e0
-  data.tar.gz: 1809000f0fea428a053449c07b7b94ca93028dfe3c91d815f0d903bb052c48736f542edb2493cd4fde39bed3c0fa495adca1bd14afccbe186c4cdf9735f54cf5
+  metadata.gz: dd61cb3a8e293c928e1d3b5fcb3637273bd6a27a55ecae96ea737b1f0b6959df44c223aae366131175411320d0c185d3b3a339a128c519e43a4d75dbe8990147
+  data.tar.gz: 38a1a8dfa89b91b8209fb033fe2a7b3af161f4bfdc87dd07bc2f30154c1f925cf48b1c4697eef25a11773e1a65eb0422edd6811ffcef56559167709e85e63180

data/README.md

@@ -196,8 +196,10 @@ 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_return` # simulate hitting enter, equivalent to @tty.send_keys(%(\r))
+* `send_returns(number_of_times)` # equivalent to calling send_return number_of_times
+
 
 * `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
@@ -225,6 +227,9 @@ Helper functions to make sending output easier! They use the methods above under
 * `send_escape`
 * `send_escapes(number_of_times)`
 
+* `send_tab`
+* `send_tab(number_of_times)`
+
 ### F keys?
 
 Send F keys like F1, F2, etc. as shown below:
@@ -258,7 +263,7 @@ There are some commonly used keys available as constants to make interacting wit
   TTYtest::SHIFT_ENTER # \v
   TTYtest::FORM_FEED # \f or New Page NP
   TTYtest::CTRLL
-  TTYtest::CARRIAGE_RETURN # \r
+  TTYtest::RETURN # \r
   TTYtest::CTRLU
   TTYtest::CTRLW
   TTYtest::ESCAPE # 27 decimal or ^[ or /033
@@ -278,7 +283,9 @@ There are some commonly used keys available as constants to make interacting wit
 
 ## Configurables
 
-Currently the only configuration for ttytest2 is max wait time.
+There are 2 main configurations for ttytest2: max_wait_time, and use_return_for_newline.
+
+### Max wait time
 
 Max wait time represents the amount of time in seconds that ttytest2 will keep retrying an assertion before failing.
 
@@ -292,6 +299,24 @@ You can configure max wait time as shown below.
 @tty.assert_row(0, 'echo Hello, world') # this assertion would fail after 3 seconds
 ```
 
+### Use return for newline
+
+Use return for newline tells ttytest2 to use return ('//r') instead of newline ('//n') for methods like send_line.
+
+Some line readers may interpreter return and newline differently, so this can be useful in those cases.
+
+You can still send newline via send_newline when this is enabled.
+
+You can also send return by itself with send_return.
+
+``` ruby
+@tty = TTYtest::new_terminal('', use_return_for_newline: true) # specified to use return in place of newline
+
+@tty.send_line('hello, world!') # will have return sent after 'hello, world!'
+@tty.use_return_for_newline = false
+@tty.assert_row(0, 'echo Hello, world') # will have newline sent after 'echo Hello, world'
+```
+
 ## 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.
@@ -325,6 +350,8 @@ If you are using ttyest2 to test your CLI, using sh is easier than bash because
 
 If you are using ttytest2 to test your shell, using assertions like `assert_row_like`, `assert_row_starts_with`, and `assert_row_ends_with` are going to be extremely helpful, especially if trying to test your shell in different environments or using a docker container.
 
+Most line readers use '\n' for newline, but some may interpret it differently and expect '\r'.
+
 ## Docker
 
 Easy to use from Docker. Add this to your dockerfile to get started.

data/lib/ttytest/capture.rb

@@ -9,7 +9,7 @@ module TTYtest
   class Capture
     include TTYtest::Assertions
 
-    attr_reader :cursor_x, :cursor_y, :width, :height
+    attr_reader :cursor_x, :cursor_y, :width, :height, :max_wait_time, :use_return_for_newline
 
     # Used internally by drivers when called by {Terminal#capture}
     # @api private

data/lib/ttytest/constants.rb

@@ -16,7 +16,8 @@ module TTYtest
   SHIFT_ENTER = 11.chr # \v
   FORM_FEED = 12.chr # \f
   CTRLL = 12.chr
-  CARRIAGE_RETURN = 13.chr # \r
+  CARRIAGE_RETURN = 13.chr # \r, left for backwards compat
+  RETURN = 13.chr # \r, same as CARRIAGE_RETURN
   CTRLU = 21.chr
   CTRLW = 23.chr
   ESCAPE = 27.chr # ^[ or /033 or /e

data/lib/ttytest/terminal.rb

@@ -9,14 +9,15 @@ module TTYtest
   class Terminal
     extend Forwardable
 
-    attr_accessor :max_wait_time
+    attr_accessor :max_wait_time, :use_return_for_newline
 
     # @api private
     # @see TTYtest.new_terminal, use this or other new_* methods instead.
     # Internal constructor.
-    def initialize(driver_terminal)
+    def initialize(driver_terminal, max_wait_time, use_return_for_newline)
+      @max_wait_time = max_wait_time
+      @use_return_for_newline = use_return_for_newline
       @driver_terminal = driver_terminal
-      @max_wait_time = TTYtest.default_max_wait_time
     end
 
     # @!method send_keys(*keys)
@@ -67,17 +68,21 @@ module TTYtest
     #   @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.
+    #   Simulate typing enter by sending newline (ALT + enter) character to the terminal.
+    #   Many line readers interpreter newline as return, but in some cases you may have to use send_return.
 
     # @!method send_newlines(number_of_times)
-    #   Simulates sending newline the specified number of times.
+    #   Simulates sending newline (ALT + enter) the specified number of times.
+    #   Many line readers interpreter newline as return, but in some cases you may have to use send_return.
     #   @param [Integer] number_of_times number of times to send newline
 
-    # @!method send_enter
+    # @!method send_return
     #   Simulate typing enter by sending newline character to the terminal.
+    #   Many line readers interpreter newline as return, but in some cases you may have to use send_return.
 
-    # @!method send_enters(number_of_times)
+    # @!method send_returns(number_of_times)
     #   Simulates sending newline the specified number of times.
+    #   Many line readers interpreter newline as return, but in some cases you may have to use send_return.
     #   @param [Integer] number of times to send newline
 
     # @!method send_delete
@@ -142,6 +147,13 @@ module TTYtest
     #   Simulates typing in the Escape (ESC) key in the terminal the specified number of times.
     #   @param [Integer] number of times to send escape
 
+    # @!method send_tab
+    #   Simulates typing in the Tab (\t) key in the terminal.
+
+    # @!method send_tabs(number_of_times)
+    #   Simulates typing in the Tab (\t) key in the terminal the specified number of times.
+    #   @param [Integer] number of times to send tab
+
     # @!method capture
     #   Capture represents the current state of the terminal.
     #   @return [Capture] The current state of the terminal when called
@@ -152,11 +164,13 @@ module TTYtest
                    :send_line_exact, :send_lines_exact,
                    :send_newline, :send_newlines,
                    :send_enter, :send_enters,
+                   :send_return, :send_returns,
                    :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_escapes,
+                   :send_tab, :send_tabs,
                    :capture
 
     # @!method print

data/lib/ttytest/tmux/driver.rb

@@ -31,21 +31,22 @@ module TTYtest
         @config_file_path = config_file_path
       end
 
-      def new_terminal(cmd, width: 80, height: 24)
+      def new_terminal(cmd, width: 80, height: 24, max_wait_time: 2, use_return_for_newline: false)
         cmd = "#{cmd}\n#{SLEEP_INFINITY}"
 
         session_name = "ttytest-#{SecureRandom.uuid}"
         tmux(*%W[-f #{@config_file_path} new-session -s #{session_name} -d -x #{width} -y #{height} #{cmd}])
-        session = Session.new(self, session_name)
-        Terminal.new(session)
+        session = Session.new(self, session_name, use_return_for_newline)
+        Terminal.new(session, max_wait_time, use_return_for_newline)
       end
 
       def new_default_sh_terminal
-        new_terminal(%(PS1='$ ' /bin/sh), width: 80, height: 24)
+        new_terminal(%(PS1='$ ' /bin/sh), width: 80, height: 24, max_wait_time: 2, use_return_for_newline: false)
       end
 
-      def new_sh_terminal(width: 80, height: 24)
-        new_terminal(%(PS1='$ ' /bin/sh), width: width, height: height)
+      def new_sh_terminal(width: 80, height: 24, max_wait_time: 2, use_return_for_newline: false)
+        new_terminal(%(PS1='$ ' /bin/sh), width: width, height: height, max_wait_time: max_wait_time,
+                                          use_return_for_newline: use_return_for_newline)
       end
 
       # @api private

data/lib/ttytest/tmux/session.rb

@@ -5,10 +5,11 @@ module TTYtest
     # represents a tmux session and how to send output to the current tmux session
     class Session
       # @api private
-      def initialize(driver, name)
+      def initialize(driver, name, use_return_for_newline)
         @id = SecureRandom.uuid
         @driver = driver
         @name = name
+        @use_return_for_newline = use_return_for_newline
 
         ObjectSpace.define_finalizer(@id, proc {
           begin
@@ -58,6 +59,10 @@ module TTYtest
       # Send line to tmux, no need to worry about newline character
       def send_line(line)
         send_keys_one_at_a_time(line)
+        if @use_return_for_newline
+          send_return unless ['\n', '\r'].include?(line[-1])
+          return
+        end
         send_newline unless line[-1] == '\n'
       end
 
@@ -75,6 +80,10 @@ module TTYtest
 
       def send_line_exact(line)
         send_keys_exact(line)
+        if @use_return_for_newline
+          send_return unless ['\n', '\r'].include?(line[-1])
+          return
+        end
         send_newline unless line[-1] == '\n'
       end
 
@@ -100,7 +109,6 @@ module TTYtest
       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?
@@ -108,7 +116,17 @@ module TTYtest
           number_of_times -= 1
         end
       end
-      alias send_enters send_newlines
+
+      def send_return
+        driver.tmux(*%W[send-keys -t #{name} -l], %(\r))
+      end
+
+      def send_returns(number_of_times)
+        while number_of_times.positive?
+          send_return
+          number_of_times -= 1
+        end
+      end
 
       def send_delete
         send_keys_exact(%(DC))
@@ -194,6 +212,10 @@ module TTYtest
 
       def send_clear
         send_keys_one_at_a_time(TTYtest::CLEAR)
+        if @use_return_for_newline
+          send_return
+          return
+        end
         send_newline
       end
 
@@ -208,6 +230,17 @@ module TTYtest
         end
       end
 
+      def send_tab
+        send_keys_exact(TTYtest::TAB)
+      end
+
+      def send_tabs(number_of_times)
+        while number_of_times.positive?
+          send_tab
+          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 = '1.2.0'
+  VERSION = '1.3.0'
 end

data/lib/ttytest.rb

@@ -16,30 +16,38 @@ module TTYtest
     #   @param [String] command a valid shell command to run
     #   @param [Integer] width width of the new terminal
     #   @param [Integer] height height of the new terminal
+    #   @param [Integer] max_wait_time max time to wait for screen to update before an assertion fails
+    #   @param [bool] use_return_for_newline use return instead of newline for functions like send_line
     #   @return [Terminal] a new terminal running the specified command
 
     # @!method new_default_sh_terminal
     #   Create a new terminal using '/bin/sh' with width: 80 and height: 24.
     #   Useful for Unixes.
+    #   @return [Terminal] a new sh terminal
 
     # @!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.
+    #   @param [Integer] max_wait_time max time to wait for screen to update before an assertion fails
+    #   @param [bool] use_return_for_newline use return instead of newline for functions like send_line
+    #   @return [Terminal] a new sh terminal with specified width and height
+
     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)
+    def new_terminal(cmd, width: 80, height: 24, max_wait_time: 2, use_return_for_newline: false)
+      # @max_wait_time = max_wait_time
+      # @use_return_for_newline = use_return_for_newline
+      driver.new_terminal(cmd, width: width, height: height, max_wait_time: max_wait_time,
+                               use_return_for_newline: use_return_for_newline)
     end
 
-    def new_default_sh_terminal(max_wait_time: 2)
-      @max_wait_time = max_wait_time
+    def new_default_sh_terminal
       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)
+    def new_sh_terminal(width: 80, height: 24, max_wait_time: 2, use_return_for_newline: false)
+      driver.new_sh_terminal(width: width, height: height, max_wait_time: max_wait_time,
+                             use_return_for_newline: use_return_for_newline)
     end
   end
 

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github
-git tag v1.2.0
+git tag v1.3.0
 git push origin --tags
 
 to push new version to rubygems.org
 gem build ttytest2.gemspec
-gem push ttytest2-1.2.0.gem
+gem push ttytest2-1.3.0.gem

metadata

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