ttytest2 0.9.7 → 0.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad00f4819b188050fb5882adeac6578525082d1740c3b17a4320ec56b3f68b51
-  data.tar.gz: bf5dcc48c03fa7ab3cbf0c4e5780e479482f68fc19c149accd4e46c39d655cb2
+  metadata.gz: 255274128343764bc7bfcd600e925ba0e84b3c36d79550205890e9583b34723f
+  data.tar.gz: bcfce7f61108dc09ea83baacc27a6dbc2f416fae5b90663859e665887e6d9ed6
 SHA512:
-  metadata.gz: 8357acea4da5433d9131d72ab29c21a73c38f7c53140a0eff2a0ece7393eb47b2fb749b2539dee905bd4c3baa9f7aa2e502921a33a777b060cfe32568752933d
-  data.tar.gz: c4ecdc9782d7c1e0633dc5b3ff4579bcbac288e6cc4628a9e496ea91fe0777ab2e028896db6f398e1f2e9b66d050b2e9a04260da636dc2a1a2c7693640555ed0
+  metadata.gz: d9e355e8958e8336e9b76cc976728faf511e1edd3b7cf6774613e3d62c12d93192bb8a1a6f9881d8a63343fdd213050fad6e86e7e37d6cfe20757e3c4f564763
+  data.tar.gz: ff23c17d5fe7b11dd4ca7b0405d647de1e5309c32f9e3f65b98ade66d2aeed5ba5925f959e91af88a2a8e3c0af95e8228592a41af7ead7dc3fe0a8ecc4979e6b

data/README.md

@@ -146,11 +146,42 @@ Helper functions to make sending output easier! They use the methods above under
 * `send_end` # simulate pressing the End key
 * `send_clear` # clear the screen by sending clear ascii code
 
+### F keys?
+
+Send F keys like F1, F2, etc. as shown below:
+
+``` ruby
+@tty = TTYtest.new_terminal(%{PS1='$ ' /bin/sh}, width: 80, height: 24)
+
+@tty.send_keys_exact(%(F1))
+@tty.send_keys_exact(%(F2))
+# ...
+@tty.send_keys_exact(%(F11))
+@tty.send_keys_exact(%(F12))
+```
+
+### Configurables
+
+Currently the only configuration for ttytest2 is max wait time.
+
+Max wait time represents the amount of time in seconds that ttytest2 will keep retrying an assertion before failing.
+
+You can configure max wait time as shown below.
+
+``` ruby
+@tty = TTYtest::new_terminal('')
+@tty.max_wait_time = 1 # sets the max wait time to 1 second
+
+@tty.assert_row(0, 'echo Hello, world') # this assertion would fail after 1 second
+```
+
 ### 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
+@tty = TTYtest::new_terminal('')
+
 # 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.
@@ -165,18 +196,27 @@ p "\n#{@tty.capture}" # prints out the contents of the terminal
 There are some commonly used keys available as constants to make interacting with your shell/CLI easy.
 
 ``` ruby
-  TTYtest::BACKSPACE
-  TTYtest::TAB
-  TTYtest::CTRLF
   TTYtest::CTRLC
   TTYtest::CTRLD
-  TTYtest::ESCAPE
+  TTYtest::CTRLF
+  TTYtest::BELL # ring the terminal bell
+  TTYtest::BACKSPACE
+  TTYtest::TAB
+  TTYtest::NEWLINE # \n
+  TTYtest::VERTICAL_TAB
+  TTYtest::FORM_FEED # \f or New Page NP
+  TTYtest::CARRIAGE_RETURN # \r
+  TTYtest::ESCAPE # 27 decimal or ^[ or /033
+  TTYtest::DELETE
 
   TTYtest::UP_ARROW
   TTYtest::DOWN_ARROW
   TTYtest::RIGHT_ARROW
   TTYtest::LEFT_ARROW
 
+  TTYtest::HOME_KEY
+  TTYtest::END_KEY
+
   TTYtest::CLEAR # clear the screen
 ```
 

data/lib/ttytest/capture.rb

@@ -51,7 +51,10 @@ module TTYtest
     def print
       puts "\n#{self}"
     end
-    alias print_rows print
+
+    def print_rows
+      p rows
+    end
 
     # @return [String] All rows of the captured terminal, separated by newlines
     def to_s

data/lib/ttytest/constants.rb

@@ -2,17 +2,26 @@
 
 # some constants that can be used with send_keys, just to help out people creating tests
 module TTYtest
-  BACKSPACE = 127.chr
-  TAB = 9.chr
-  CTRLF = 6.chr
   CTRLC = 3.chr
-  CTRLD = '\004'
-  ESCAPE = 27.chr
+  CTRLD = 4.chr
+  CTRLF = 6.chr
+  BELL = 7.chr
+  BACKSPACE = 8.chr
+  TAB = 9.chr
+  NEWLINE = 10.chr # \n
+  VERTICAL_TAB = 11.chr
+  FORM_FEED = 12.chr
+  CARRIAGE_RETURN = 13.chr # \r
+  ESCAPE = 27.chr # ^[ or /033
+  DELETE = 127.chr
 
   UP_ARROW = "#{ESCAPE}[A".freeze
   DOWN_ARROW = "#{ESCAPE}[B".freeze
   RIGHT_ARROW = "#{ESCAPE}[C".freeze
   LEFT_ARROW = "#{ESCAPE}[D".freeze
 
+  HOME_KEY = "#{ESCAPE}[H".freeze
+  END_KEY = "#{ESCAPE}[F".freeze
+
   CLEAR = "#{ESCAPE}[2J".freeze
 end

data/lib/ttytest/terminal.rb

@@ -67,6 +67,8 @@ module TTYtest
     #   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 capture
     #   Capture the current state of the terminal
     #   @return [Capture] instantaneous state of the terminal when called
@@ -77,7 +79,7 @@ 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, :send_clear,
+                   :send_keys_exact, :send_home, :send_end, :send_clear, :send_escape,
                    :capture
 
     # @!method print

data/lib/ttytest/tmux/session.rb

@@ -139,11 +139,11 @@ module TTYtest
       end
 
       def send_home
-        send_keys_exact(%(Home))
+        send_keys_exact(TTYtest::HOME_KEY)
       end
 
       def send_end
-        send_keys_exact(%(End))
+        send_keys_exact(TTYtest::END_KEY)
       end
 
       def send_clear
@@ -151,6 +151,10 @@ module TTYtest
         send_newline
       end
 
+      def send_escape
+        send_keys_exact(%(Escape))
+      end
+
       private
 
       attr_reader :driver, :name

data/lib/ttytest/version.rb

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

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github
-git tag v0.9.7
+git tag v0.9.9
 git push origin --tags
 
 to push new version to rubygems.org
 gem build ttytest2.gemspec
-gem push ttytest2-0.9.7.gem
+gem push ttytest2-0.9.9.gem

metadata

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