ttytest2 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c871fc585971f615966d7797478185dd942e78b6cfcfc9324773edfd789664f
-  data.tar.gz: 4a7a6b509c222510918cdad040e958c09bdd653700b3a3871f087cdadf7a5c9b
+  metadata.gz: da8ddbaf4a49037e8dda3fb31986824c75819abbee94fb7954263c36a8e63414
+  data.tar.gz: 7091feb0fdac4857c1c0bf47a7c8158d8c90bd48d1ff321fec53aeab185443ec
 SHA512:
-  metadata.gz: 84d1c8b052ce38fdad9d0780774a0aae6a378b60804a156a74099e69b62f741f49b00887296e03a49030fe62c25d8bceef2b28e3a3ad2ddbd979cabbf7643b28
-  data.tar.gz: 4fc3e3186fe6827bb987f18e2d04aa9cfbe49c6c31f3d8a5e8ab92c6ec6f81264df11298cddbdeb70c46630f20ba056d29608f2df90549d6e3cbd25dbe7f4d29
+  metadata.gz: baab5b496e22d73a133084b2a4d58fc2fb83c95325c02227a50847adcbb876fe23f7a71e80efd69c12c2730aff64866222004db102b21613c4e4301455c15cd8
+  data.tar.gz: d66c05f581f565f33c9305ec9c484346790184d64ca5bdfb4b9718d95c22b842dbd2f689634548863f93cdcaced2dc94f4048dc66e6101dba8d2ef4f4856bae9

data/README.md

@@ -30,13 +30,24 @@ Available assertions:
 * specify the cursor is currently hidden: `assert_cursor_hidden`
 * specify the contents of the entire terminal window: `assert_contents(lines_of_terminal)`
 
-### Sending output
+### Sending Output
 
 You can send output to the terminal with the following calls.
 
-* `send_keys(output)`
+* `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_keys_one_at_a_time(output)`
+* `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`
 
 ### Example Canonical CLI/Shell
 

data/examples/canonical_integration_tests.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'ttytest'
+
+START_COL = 19
+
+def assert_check_new_row(row)
+  @tty.assert_row_starts_with(row, "#{ENV['USER']}:")
+  @tty.assert_row_like(row, 'ncsh')
+  @tty.assert_row_ends_with(row, '$')
+  @tty.assert_cursor_position(START_COL, row)
+end
+
+@tty = TTYtest.new_terminal(%(PS1='$ ' ./bin/ncsh), width: 80, height: 24)
+
+row = 0
+
+# # # # Basic Tests # # # #
+puts 'Starting basic tests'
+
+@tty.assert_row_starts_with(row, 'ncsh: startup time: ')
+row += 1
+
+assert_check_new_row(row)
+@tty.send_keys(%(ls))
+@tty.assert_cursor_position(START_COL + 2, 1)
+@tty.send_newline
+@tty.assert_row_ends_with(row, 'ls')
+row += 1
+@tty.assert_row_starts_with(row, 'LICENSE')
+row = 9
+
+assert_check_new_row(row)
+@tty.send_keys(%(echo hello))
+@tty.send_newline
+row += 1
+@tty.assert_row(row, 'hello')
+row += 1
+
+assert_check_new_row(row)
+@tty.send_keys(%(lss)) # send a bad command
+@tty.send_newline
+row += 1
+@tty.assert_row(row, 'ncsh: Could not find command or directory: No such file or directory')
+row += 1
+
+puts 'Starting backspace tests'
+
+# end of line backspace
+assert_check_new_row(row)
+@tty.send_keys(%(l))
+@tty.send_backspace
+assert_check_new_row(row)
+
+# multiple end of line backspaces
+@tty.send_keys(%(lsssss))
+@tty.send_backspace
+@tty.send_backspace
+@tty.send_backspace
+@tty.send_backspace
+@tty.assert_row_ends_with(row, '$ ls')
+@tty.send_backspace
+@tty.send_backspace
+@tty.send_keys(%(echo hello)) # make sure buffer is properly formed after backspaces
+@tty.send_newline
+row += 1
+@tty.assert_row(row, 'hello')
+row += 1
+
+# midline backspace
+assert_check_new_row(row)
+@tty.send_keys(%(lsssss))
+@tty.assert_cursor_position(START_COL + 6, row)
+@tty.send_keys(TTYtest::LEFT_ARROW)
+@tty.send_keys(TTYtest::LEFT_ARROW)
+@tty.assert_cursor_position(START_COL + 4, row)
+@tty.send_backspace
+@tty.send_backspace
+@tty.send_backspace
+@tty.send_backspace
+@tty.assert_cursor_position(START_COL, row)
+@tty.assert_row_ends_with(row, '$ ss')
+@tty.send_keys(TTYtest::RIGHT_ARROW)
+@tty.send_keys(TTYtest::RIGHT_ARROW)
+@tty.assert_cursor_position(START_COL + 2, row)
+@tty.send_backspace
+@tty.send_backspace
+@tty.assert_cursor_position(START_COL, row)
+@tty.send_keys(%(echo hello)) # make sure buffer is properly formed after backspaces
+@tty.send_newline
+row += 1
+@tty.assert_row(row, 'hello')

data/examples/noncanonical_integration_tests.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'ttytest'
+
+START_COL = 19
+
+def assert_check_new_row(row)
+  @tty.assert_row_starts_with(row, "#{ENV['USER']}:")
+  @tty.assert_row_like(row, 'ncsh')
+  @tty.assert_row_ends_with(row, '$')
+  @tty.assert_cursor_position(START_COL, row)
+end
+
+@tty = TTYtest.new_terminal(%(PS1='$ ' ./bin/ncsh), width: 80, height: 24)
+
+row = 0
+
+# # # # Basic Tests # # # #
+puts 'Starting basic tests'
+
+@tty.assert_row_starts_with(row, 'ncsh: startup time: ')
+row += 1
+
+assert_check_new_row(row)
+@tty.send_keys_one_at_a_time(%(ls))
+@tty.assert_cursor_position(START_COL + 2, 1)
+@tty.send_newline
+@tty.assert_row_ends_with(row, 'ls')
+row += 1
+@tty.assert_row_starts_with(row, 'LICENSE')
+row = 9
+
+assert_check_new_row(row)
+@tty.send_keys_one_at_a_time(%(echo hello))
+@tty.send_newline
+row += 1
+@tty.assert_row(row, 'hello')
+row += 1
+
+assert_check_new_row(row)
+@tty.send_keys_one_at_a_time(%(lss)) # send a bad command
+@tty.send_newline
+row += 1
+@tty.assert_row(row, 'ncsh: Could not find command or directory: No such file or directory')
+row += 1
+
+puts 'Starting backspace tests'
+
+# end of line backspace
+assert_check_new_row(row)
+@tty.send_keys_one_at_a_time(%(l))
+@tty.send_backspace
+assert_check_new_row(row)
+
+# multiple end of line backspaces
+@tty.send_keys_one_at_a_time(%(lsssss))
+@tty.send_backspace
+@tty.send_backspace
+@tty.send_backspace
+@tty.send_backspace
+@tty.assert_row_ends_with(row, '$ ls')
+@tty.send_backspace
+@tty.send_backspace
+@tty.send_keys_one_at_a_time(%(echo hello)) # make sure buffer is properly formed after backspaces
+@tty.send_newline
+row += 1
+@tty.assert_row(row, 'hello')
+row += 1
+
+# midline backspace
+assert_check_new_row(row)
+@tty.send_keys_one_at_a_time(%(lsssss))
+@tty.assert_cursor_position(START_COL + 6, row)
+@tty.send_keys(TTYtest::LEFT_ARROW)
+@tty.send_keys(TTYtest::LEFT_ARROW)
+@tty.assert_cursor_position(START_COL + 4, row)
+@tty.send_backspace
+@tty.send_backspace
+@tty.send_backspace
+@tty.send_backspace
+@tty.assert_cursor_position(START_COL, row)
+@tty.assert_row_ends_with(row, '$ ss')
+@tty.send_keys(TTYtest::RIGHT_ARROW)
+@tty.send_keys(TTYtest::RIGHT_ARROW)
+@tty.assert_cursor_position(START_COL + 2, row)
+@tty.send_backspace
+@tty.send_backspace
+@tty.assert_cursor_position(START_COL, row)
+@tty.send_keys_one_at_a_time(%(echo hello)) # make sure buffer is properly formed after backspaces
+@tty.send_newline
+row += 1
+@tty.assert_row(row, 'hello')

data/lib/ttytest/terminal.rb

@@ -36,7 +36,11 @@ module TTYtest
     #   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, :send_newline, :send_delete, :send_backspace, :send_keys_exact,
+                   :send_keys, :send_keys_one_at_a_time,
+                   :send_newline, :send_newlines,
+                   :send_delete, :send_deletes,
+                   :send_backspace, :send_backspaces,
+                   :send_keys_exact,
                    :capture
 
     # @!method rows

data/lib/ttytest/tmux/session.rb

@@ -57,14 +57,35 @@ module TTYtest
         driver.tmux(*%W[send-keys -t #{name} -l], %(\n))
       end
 
+      def send_newlines(number_of_times)
+        while number_of_times.positive?
+          send_newline
+          number_of_times -= 1
+        end
+      end
+
       def send_delete
         send_keys_exact(%(DC))
       end
 
+      def send_deletes(number_of_times)
+        while number_of_times.positive?
+          send_delete
+          number_of_times -= 1
+        end
+      end
+
       def send_backspace
         send_keys_exact(%(BSpace))
       end
 
+      def send_backspaces(number_of_times)
+        while number_of_times.positive?
+          send_backspace
+          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.0'
+  VERSION = '0.9.1'
 end

data/notes.txt

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

data/ttytest2.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   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 and/or cli applications inside of tmux and then making assertions on the output.'
+  spec.description   = 'ttytest2 allows running shell/cli applications inside of tmux and then making assertions on the output.'
   spec.homepage      = 'https://github.com/a-eski/ttytest2'
   spec.license       = 'MIT'
 
@@ -24,8 +24,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 3.2.3'
 
-  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'bundler', '~> 2.5'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ttytest2
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Alex Eski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-19 00:00:00.000000000 Z
+date: 2024-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -56,18 +56,18 @@ dependencies:
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: ttytest2 allows running shell and/or cli applications inside of tmux
-  and then making assertions on the output.
+        version: '0.9'
+description: ttytest2 allows running shell/cli applications inside of tmux and then
+  making assertions on the output.
 email:
 - alexeski@gmail.com
 executables: []
@@ -79,6 +79,8 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- examples/canonical_integration_tests.rb
+- examples/noncanonical_integration_tests.rb
 - lib/ttytest.rb
 - lib/ttytest/capture.rb
 - lib/ttytest/constants.rb