ttytest2 0.8.4 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8801fe1b91cd7d371a9b1dc5668ad64b395e80778a6846c21ea004dd635b3107
-  data.tar.gz: fe6847ef687fa1ece179ab5201173145f5ee1b243fa62f533ce5deddc290137a
+  metadata.gz: 3b98c6cd8789c970147b325d01c3af8e4b4eef8f32bac57aae4036b8ce3586d9
+  data.tar.gz: ddbfe244faedd701d96bc98ce103b49a8d825517e0664dbbea858954319290b4
 SHA512:
-  metadata.gz: 85b636e54bd9845b50b5d6cc5c9feaa3fac871ee4bf724409f191e38e86649fa695bb6a4917ea877b5d59d6d8dbb2fd0697aacff6122501fba14d6ae56f00654
-  data.tar.gz: 38485e1cae3446068272b40a00d44eb12ce854442c87a8a0dbbd638d9b52a80a82b4c93a10e7f2c83312fef32aa88e771c7fe564d09d8db5e509907e68015bee
+  metadata.gz: f4862a535e862eb7fa58bc3373306ee3f82b939f5652b9b334e55acb5437358159cef2dd02d551823ff47e62625ac3b69200c526365fee2277882a617156acbd
+  data.tar.gz: 7ceed490dc0fb92b77ace530650a92691fdc69fa1833344b8e0000d5b1f21fe654d995b63825b5512d289c75079a83abc117d0e24c85483fda7efc5bf634bda2

data/README.md

@@ -1,8 +1,8 @@
 # ttytest2
 
-TTYtest2 is an acceptance test framework for interactive console applications. It's like [capybara](https://github.com/teamcapybara/capybara) for the terminal.
+ttytest2 is an acceptance test framework for interactive console applications. It's like [capybara](https://github.com/teamcapybara/capybara) for the terminal.
 
-Forked from https://github.com/jhawthorn/ttytest, because I had some features I needed for my own project.
+A drop-in replacement for https://github.com/jhawthorn/ttytest, because I had some features I needed for my own project.
 
 It works by running commands inside a tmux session, capturing the pane, and comparing the content. The assertions will wait a specified amount of time (default 2 seconds) for the expected content to appear.
 
@@ -29,8 +29,16 @@ Available assertions:
 * `assert_cursor_hidden`
 * `assert_contents(lines_of_terminal)`
 
+### Sending output
+
+You can send output to the terminal with the following calls.
+
+* `send_keys(output)`
+* `send_newline # equivalent to @tty.send_keys(%(\n))`
+* `send_keys_one_at_a_time(output)`
 
 ### Example Canonical CLI/Shell
+
 Most people should use send_keys, if you are writing or working with a noncanonical shell/CLI, you will probably know it. Most are canonical.
 
 ``` ruby
@@ -53,7 +61,10 @@ p @tty.rows # => ["$ echo \"Hello, world\"", "Hello, world", "$", "", "", "", ..
 ```
 
 ### Example Noncanonical CLI/Shell
-If you are working with a noncanonical shell, you need to use send_keys_one_at_a_time to have your shell/CLI process the input correctly.
+
+If you are working with a noncanonical shell, you need to use send_keys_one_at_a_time to have your shell/CLI process the input correctly.<br /><br />
+Also useful if you need to send input one character at a time for whatever reason.<br /><br />
+'Multi-character' characters like '\n' need to be sent with send-keys, though.<br /><br />
 
 ``` ruby
 require 'ttytest'
@@ -65,6 +76,31 @@ require 'ttytest'
 @tty.send_keys_one_at_a_time('ls')
 @tty.assert_row_ends_with(0, 'ls')
 @tty.send_keys(%(\n)) # make sure to use send_keys for 'multi-character' characters like \n, \r, \t, etc.
+
+@tty.send_keys_one_at_a_time('ps')
+@tty.assert_row_ends_with(0, 'ps')
+@tty.send_keys(TTYtest:NEWLINE) # can use constants instead
+```
+
+### Constants
+
+There are some commonly used keys available as constants to make interacting with your shell/CLI easy. Most of them are self-evident, BACKSPACE is the same as hitting the backspace key on the keyboard.
+
+``` ruby
+  TTYtest::BACKSPACE
+  TTYtest::DELETE
+  TTYtest::TAB
+  TTYtest::CTRLF
+  TTYtest::CTRLC
+  TTYtest::CTRLD
+  TTYtest::ESCAPE
+
+  TTYtest::UP_ARROW
+  TTYtest::DOWN_ARROW
+  TTYtest::RIGHT_ARROW
+  TTYtest::LEFT_ARROW
+
+  TTYtest::CLEAR # clear the screen
 ```
 
 ## Docker

data/lib/ttytest/constants.rb

@@ -1,20 +1,19 @@
 # frozen_string_literal: true
 
 # some constants that can be used with send_keys, just to help out people creating tests
-# may not work with all terminal emulators
 module TTYtest
   BACKSPACE = 127.chr
+  DELETE = '^[[3~'
   TAB = 9.chr
   CTRLF = 6.chr
   CTRLC = 3.chr
   CTRLD = '\004'
   ESCAPE = 27.chr
-  NEWLINE = '\n'
 
-  UP_ARROW = "#{ESCAPE}[A".freeze
-  DOWN_ARROW = "#{ESCAPE}[B".freeze
-  RIGHT_ARROW = "#{ESCAPE}[C".freeze
-  LEFT_ARROW = "#{ESCAPE}[D".freeze
+  UP_ARROW = '^[[A'
+  DOWN_ARROW = '^[[B'
+  RIGHT_ARROW = '^[[C'
+  LEFT_ARROW = '^[[D'
 
   CLEAR = 'clear'
 end

data/lib/ttytest/terminal.rb

@@ -27,7 +27,7 @@ module TTYtest
     # @!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, :capture
+    def_delegators :@driver_terminal, :send_keys, :send_keys_one_at_a_time, :send_newline, :capture
 
     # @!method rows
     #   @return [Array<String>]

data/lib/ttytest/tmux/session.rb

@@ -48,6 +48,10 @@ module TTYtest
         end
       end
 
+      def send_newline
+        driver.tmux(*%W[send-keys -t #{name} -l], %(\n))
+      end
+
       private
 
       attr_reader :driver, :name

data/lib/ttytest/version.rb

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

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github,
-git tag v0.8.4
+git tag v0.8.5
 git push origin --tags
 
 to push new version to rubygems.org
 gem build ttytest2.gemspec
-gem push ttytest2-0.8.4.gem
+gem push ttytest2-0.8.5.gem

metadata

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