ttytest2 0.8.3 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 995f1309860d889b44e0634247e1ae64cda8fc975a8a02de97de55605bd2958e
-  data.tar.gz: a7a2c819970a4a6b432b7067ef3bf2feb8d349332b731df4c1639b4db659140d
+  metadata.gz: 3b98c6cd8789c970147b325d01c3af8e4b4eef8f32bac57aae4036b8ce3586d9
+  data.tar.gz: ddbfe244faedd701d96bc98ce103b49a8d825517e0664dbbea858954319290b4
 SHA512:
-  metadata.gz: 83f652b2a5c2815e798cff48d6cd6c83b1a2d325e49306b9f883c11d6a01392c1b0c5303a175b1065238ea01d3628f06cc8a8a96cfa31c42e83d37746cd8cb63
-  data.tar.gz: 3916165f772f1607ab7c03b497848213d30c7e7e93ce584fb911f081c5236d76722e3090b3c2a26889b3c52294e153d66be5df532d45f91a19ce9e0b362b3644
+  metadata.gz: f4862a535e862eb7fa58bc3373306ee3f82b939f5652b9b334e55acb5437358159cef2dd02d551823ff47e62625ac3b69200c526365fee2277882a617156acbd
+  data.tar.gz: 7ceed490dc0fb92b77ace530650a92691fdc69fa1833344b8e0000d5b1f21fe654d995b63825b5512d289c75079a83abc117d0e24c85483fda7efc5bf634bda2

data/README.md

@@ -1,15 +1,12 @@
 # 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.
 
-[![Gem Version](https://badge.fury.io/rb/ttytest2.svg)](https://badge.fury.io/rb/ttytest2)
-
-## Gem at RubyGems.org
-https://rubygems.org/gems/ttytest2
+[![Gem Version](https://badge.fury.io/rb/ttytest2.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/ttytest2)
 
 ## Minimum Requirements
 
@@ -18,7 +15,30 @@ https://rubygems.org/gems/ttytest2
 
 ## Usage
 
+### Assertions
+
+The main way to use TTYtest is through assertions. When called on a `TTYtest::Terminal`, each of these will be retried (for up to 2 seconds).
+
+Available assertions:
+* `assert_row(row_number, 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_cursor_position(x: x, y: y)`
+* `assert_cursor_visible`
+* `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
@@ -41,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'
@@ -52,22 +75,33 @@ require 'ttytest'
 
 @tty.send_keys_one_at_a_time('ls')
 @tty.assert_row_ends_with(0, 'ls')
-@tty.send_keys_one_at_a_time(%(\n))
+@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
 ```
 
-### Assertions
+### Constants
 
-The main way to use TTYtest is through assertions. When called on a `TTYtest::Terminal`, each of these will be retried (for up to 2 seconds by default).
+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.
 
-Available assertions:
-* `assert_row(row_number, 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_cursor_position(x: x, y: y)`
-* `assert_cursor_visible`
-* `assert_cursor_hidden`
-* `assert_contents(lines_of_terminal)`
+``` 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
 
@@ -77,20 +111,9 @@ Easy to use from Docker. Add this to your dockerfile to get started.
 RUN apt update && \
   apt install gcc make ruby tmux -y && \
   gem install ttytest2
-```
-
-## TravisCI
-
-TTYtest can run on [TravisCI](https://travis-ci.org/), but the version of tmux made available with their default ubuntu 12.04 environment is too old. However the TravisCI ubuntu 14.04 "trusty" image provides tmux 1.8, which works great.
-
-Ensure the following is in your `.travis.yml` (see [this project's .travis.yml](./.travis.yml) for an example)
 
-``` yaml
-dist: trusty
-addons:
-  apt:
-    packages:
-    - tmux
+# add this if you have issues
+# ENV RUBYOPT="-KU -E utf-8:utf-8"
 ```
 
 ## Contributing

data/lib/ttytest/constants.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# some constants that can be used with send_keys, just to help out people creating tests
+module TTYtest
+  BACKSPACE = 127.chr
+  DELETE = '^[[3~'
+  TAB = 9.chr
+  CTRLF = 6.chr
+  CTRLC = 3.chr
+  CTRLD = '\004'
+  ESCAPE = 27.chr
+
+  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.3'
+  VERSION = '0.8.5'
 end

data/lib/ttytest.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'forwardable'
+require 'ttytest/constants'
 require 'ttytest/tmux/driver'
 require 'ttytest/tmux/session'
 

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github,
-git tag v0.8.3
+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.3.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.3
+  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
@@ -81,6 +81,7 @@ files:
 - Rakefile
 - lib/ttytest.rb
 - lib/ttytest/capture.rb
+- lib/ttytest/constants.rb
 - lib/ttytest/matchers.rb
 - lib/ttytest/terminal.rb
 - lib/ttytest/tmux/driver.rb