ttytest2 0.9.13 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd614376f0369112c875543a1d8cc498b0de69dd436e6158fd6d8f06bd4ee87f
-  data.tar.gz: 59373cd7e5699a8e6c96a3c0071efc4164d09ddfb71365291cf4a5d086b69bd1
+  metadata.gz: 4322aa40df769e1ed8a2095f5766199175afae71233c8308b3a6ef30322fedb2
+  data.tar.gz: 3d94b40f20cbea852a6462d23d3922a6a1e7ef95573815320047279f47e8c76d
 SHA512:
-  metadata.gz: 77eb7d0d56818eaa11b3f0ac84230f5100a50bfc0ccf45c67c34a0389005b55317b5a85d23ed68f5b65c923fe8a51efe620304dcc345c7cd4cf902ff80b8e8d4
-  data.tar.gz: 2a3d270669408488cd1e636231b336cd62e3606d1cd20dfd267858ca3e0a544ded977ecc657df82f2833a2a2a77c9f8d422428b84715377314e6c7faf57b81e7
+  metadata.gz: 90580621915fddc1ba3b6390fc58e7787fdfa86336cb576abd3224a68c8cb88fbf665425d960153bd0cf4d170aa02afb63f14f53acc2f1f37711d8bbb0c244a1
+  data.tar.gz: 44047668527313f4bcea17522d2c8ee77bf9e0695ebd89a6c68a01411305cd3389eb5e22e43c1c4861662414b7721b6772fd26d84b1364a8a447d9363af0ab04

data/README.md

@@ -6,7 +6,7 @@ ttytest2 is a fork and a drop-in replacement for [ttytest](https://github.com/jh
 
 It works by running commands inside a tmux session, capturing the pane, and comparing the content to your assertions.
 
-The assertions will wait a specified amount of time (default 2 seconds) for the expected content to appear.
+The assertions will wait a specified amount of time (configurable, default 2 seconds) for the expected content to appear.
 
 [![Gem Version](https://badge.fury.io/rb/ttytest2.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/ttytest2)
 
@@ -77,15 +77,25 @@ Assertions will be retried for up to 2 seconds when called through TTYtest::Term
 Available assertions:
 
 * `assert_row(row_number, expected_text)`
+
 * `assert_row_at(row_number, column_start_position, column_end_position, 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_row_regexp(row_number, regexp_str)`
+
 * `assert_cursor_position(x: x, y: y)`
+
 * `assert_cursor_visible`
+
 * `assert_cursor_hidden`
+
 * `assert_contents(lines_of_terminal)`
+
 * `assert_contents_at(row_start, row_end, expected_text)`
 
 ### Output
@@ -118,21 +128,30 @@ Helper functions to make sending output easier! They use the methods above under
 * `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))
 * `send_deletes` # equivalent to calling send_delete number_of_times
+
 * `send_right_arrow`
 * `send_right_arrows(number_of_times)`
+
 * `send_left_arrow`
 * `send_left_arrows(number_of_times)`
+
 * `send_up_arrow`
 * `send_up_arrows(number_of_times)`
+
 * `send_down_arrow`
 * `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
+
 * `send_escape`
 * `send_escapes`
 
@@ -227,7 +246,7 @@ There are some commonly used keys available as constants to make interacting wit
   TTYtest::CLEAR # clear the screen
 ```
 
-### Tips
+## Tips
 
 If you are using ttyest2 to test your CLI, using sh is easier than bash because you don't have to worry about user, current working directory, etc. as shown in the examples.
 

data/lib/ttytest/tmux/driver.rb

@@ -39,6 +39,14 @@ module TTYtest
         Terminal.new(session)
       end
 
+      def new_default_sh_terminal
+        new_terminal(%(PS1='$ ' /bin/sh), width: 80, height: 24)
+      end
+
+      def new_sh_terminal(width: 80, height: 24)
+        new_terminal(%(PS1='$ ' /bin/sh), width: width, height: height)
+      end
+
       # @api private
       def tmux(*args)
         ensure_available

data/lib/ttytest/tmux/session.rb

@@ -80,9 +80,9 @@ module TTYtest
         sleep sleep_time
       end
 
-      def send_line_then_sleep_and_repeat(*lines)
+      def send_line_then_sleep_and_repeat(*lines, sleep_time)
         lines.each do |line|
-          send_line_then_sleep(line)
+          send_line_then_sleep(line, sleep_time)
         end
       end
 

data/lib/ttytest/version.rb

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

data/lib/ttytest.rb

@@ -17,7 +17,15 @@ module TTYtest
     #   @param [Integer] width width of the new terminal
     #   @param [Integer] height height of the new terminal
     #   @return [Terminal] a new terminal running the specified command
-    def_delegators :driver, :new_terminal
+
+    # @!method new_default_sh_terminal
+    #   Create a new terminal using '/bin/sh' with width: 80 and height: 24.
+    #   Useful for Unixes.
+
+    # @!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.
+    def_delegators :driver, :new_terminal, :new_default_sh_terminal, :new_sh_terminal
   end
 
   class MatchError < StandardError; end

data/notes.txt

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

metadata

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