ttytest2 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da8ddbaf4a49037e8dda3fb31986824c75819abbee94fb7954263c36a8e63414
-  data.tar.gz: 7091feb0fdac4857c1c0bf47a7c8158d8c90bd48d1ff321fec53aeab185443ec
+  metadata.gz: d96194b301f836b47b4f9ea52632848be70165ac1a772456f64a31289de71064
+  data.tar.gz: fb936199069fbcfd35c6579f0cd63387b90634469b1b9789d305775b5995ad71
 SHA512:
-  metadata.gz: baab5b496e22d73a133084b2a4d58fc2fb83c95325c02227a50847adcbb876fe23f7a71e80efd69c12c2730aff64866222004db102b21613c4e4301455c15cd8
-  data.tar.gz: d66c05f581f565f33c9305ec9c484346790184d64ca5bdfb4b9718d95c22b842dbd2f689634548863f93cdcaced2dc94f4048dc66e6101dba8d2ef4f4856bae9
+  metadata.gz: c80882c328784d2ddbb94f49928138b8d0393b7e243ceab49defbbd0fe3acea4e7af9c3392ced11115a9ee6ef566bb5c3b71f30b6623c25aac8a5c3cc92881cd
+  data.tar.gz: 899589eba988a8e89c19ba47c0cd20285791a00654f44063c9d613f5517dcfedb4d9087230f6e76b058ee7fe7905c4ee30b2f859ba392809be9fbecc5626ba99

data/README.md

@@ -15,43 +15,63 @@ It works by running commands inside a tmux session, capturing the pane, and comp
 
 ## Usage
 
+More documentation available at [(https://www.rubydoc.info/gems/ttytest2)].
+
 ### 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:
-* specify row matches expected text exactly: `assert_row(row_number, expected_text) `
-* specify expected position of expected text: `assert_row_at(row_number, column_start_position, column_end_position, expected_text)`
-* specify row contains expected text: `assert_row_like(row_number, expected_text)`
-* specify row starts with expected text: `assert_row_starts_with(row_number, expected_text)`
-* specify row ends with expected text: `assert_row_ends_with(row_number, expected_text)`
-* specify the current cursor position matches expected: `assert_cursor_position(x: x, y: y)`
-* specify the cursor is currently visible: `assert_cursor_visible`
-* specify the cursor is currently hidden: `assert_cursor_hidden`
-* specify the contents of the entire terminal window: `assert_contents(lines_of_terminal)`
+* `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_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) # for canonical shells/cli's (or multi-character keys for noncanonical shells/cli's)`
-* `send_keys_one_at_a_time(output) # for noncanonical shells/cli's`
+* `send_keys(output) # for canonical shells/CLI's (or multi-character keys for noncanonical shells/CLI's)`
+* `send_keys_one_at_a_time(output) # for noncanonical shells/CLI's`
 * `send_keys_exact(output) # for sending tmux specific keys (DC for delete, Escape for ESC, etc.)`
 
 ### Output Helpers
 
 Helper functions to make sending output easier! They use the methods above under 'Sending Output' section under the hood.
 
-* `send_newline # equivalent to @tty.send_keys(%(\n))`
-* `send_newlines(number_of_times) # equivalent to calling send_newline number_of_times`
-* `send_backspace # equivalent to @tty.send_keys(TTYtest::BACKSPACE)`
-* `send_backspaces(number_of_times) # equivalent to calling send_backspace number_of_times`
-* `send_delete # equivalent to calling send_keys_exact(%(DC))`
-* `send_deletes # equivalent to calling send_delete number_of_times`
+* `send_newline` # equivalent to @tty.send_keys(%(\n))
+* `send_newlines(number_of_times)` # equivalent to calling send_newline number_of_times
+* `send_backspace` # equivalent to @tty.send_keys(TTYtest::BACKSPACE)
+* `send_backspaces(number_of_times)` # equivalent to calling send_backspace number_of_times
+* `send_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)`
+
+### 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
+p @tty.rows # prints out the contents of the terminal as a array => ["$ echo \"Hello, world\"", "Hello, world", "$", "", "", "", ...]
+puts "\n#{@tty.capture}" # prints out the contents of the terminal
+```
 
 ### 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.
+Most people should use send_keys, if you are writing or working with a noncanonical shell/CLI, you will probably know it! Most shell/CLI applications are canonical.<br /><br />
+There are more examples in the examples folder.
 
 ``` ruby
 require 'ttytest'
@@ -70,6 +90,8 @@ TTY
 @tty.assert_cursor_position(x: 2, y: 2)
 
 p @tty.rows # => ["$ echo \"Hello, world\"", "Hello, world", "$", "", "", "", ...]
+
+puts "\n#{@tty.capture}" # prints out the contents of the terminal
 ```
 
 ### Example Noncanonical CLI/Shell
@@ -77,6 +99,7 @@ p @tty.rows # => ["$ echo \"Hello, world\"", "Hello, world", "$", "", "", "", ..
 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 />
+There are more examples in the examples folder.
 
 ``` ruby
 require 'ttytest'
@@ -96,6 +119,8 @@ require 'ttytest'
 @tty.assert_row_starts_with(0, ENV['USER'])
 @tty.assert_row_ends_with(0, '$')
 @tty.send_newline # an alternative to the 2 above methods to send \n to the terminal
+
+puts "\n#{@tty.capture}" # prints out the contents of the terminal
 ```
 
 ### Constants

data/lib/ttytest/matchers.rb

@@ -120,7 +120,8 @@ module TTYtest
 
       return if matched
 
-      raise MatchError, "screen did not match expected content:\n--- expected\n+++ actual\n#{diff.join("\n")}"
+      raise MatchError,
+            "screen did not match expected content:\n--- expected\n+++ actual\n#{diff.join("\n")}"
     end
     alias assert_matches assert_contents
 

data/lib/ttytest/tmux/session.rb

@@ -86,6 +86,50 @@ module TTYtest
         end
       end
 
+      def send_right_arrow
+        @tty.send_keys(TTYtest::RIGHT_ARROW)
+      end
+
+      def send_right_arrows(number_of_times)
+        while number_of_times.positive?
+          send_right_arrow
+          number_of_times -= 1
+        end
+      end
+
+      def send_left_arrow
+        @tty.send_keys(TTYtest::LEFT_ARROW)
+      end
+
+      def send_left_arrows(number_of_times)
+        while number_of_times.positive?
+          send_left_arrow
+          number_of_times -= 1
+        end
+      end
+
+      def send_up_arrow
+        @tty.send_keys(TTYtest::UP_ARROW)
+      end
+
+      def send_up_arrows(number_of_times)
+        while number_of_times.positive?
+          send_up_arrow
+          number_of_times -= 1
+        end
+      end
+
+      def send_down_arrow
+        @tty.send_keys(TTYtest::DOWN_ARROW)
+      end
+
+      def send_down_arrows(number_of_times)
+        while number_of_times.positive?
+          send_down_arrow
+          number_of_times -= 1
+        end
+      end
+
       # Useful to send send-keys commands to tmux without sending them as a string literal.
       # So you can send Escape for escape key, DC for delete, etc.
       # Uses the same key bindings as bind-key as well. C-c represents Ctrl + C keys, F1 is F1 key, etc.

data/lib/ttytest/version.rb

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

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github
-git tag v0.9.1
+git tag v0.9.2
 git push origin --tags
 
 to push new version to rubygems.org
 gem build ttytest2.gemspec
-gem push ttytest2-0.9.1.gem
+gem push ttytest2-0.9.2.gem

data/ttytest2.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Alex Eski']
   spec.email         = ['alexeski@gmail.com']
 
-  spec.summary       = 'ttytest2 is an integration test framework for interactive tty applications. Based on TTYtest!'
-  spec.description   = 'ttytest2 allows running shell/cli applications inside of tmux and then making assertions on the output.'
+  spec.summary       = 'ttytest2 is an integration test framework for interactive console (tty) applications'
+  spec.description   = 'ttytest2 runs shell/cli applications inside of tmux and allows you to make assertions on what the output should be'
   spec.homepage      = 'https://github.com/a-eski/ttytest2'
   spec.license       = 'MIT'
 
@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 3.2.3'
 
-  spec.add_development_dependency 'bundler', '~> 2.5'
+  spec.add_development_dependency 'bundler', '~> 2.4'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'yard', '~> 0.9'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ttytest2
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Alex Eski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -66,8 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: ttytest2 allows running shell/cli applications inside of tmux and then
-  making assertions on the output.
+description: ttytest2 runs shell/cli applications inside of tmux and allows you to
+  make assertions on what the output should be
 email:
 - alexeski@gmail.com
 executables: []
@@ -114,6 +114,5 @@ requirements: []
 rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
-summary: ttytest2 is an integration test framework for interactive tty applications.
-  Based on TTYtest!
+summary: ttytest2 is an integration test framework for interactive console (tty) applications
 test_files: []