ttytest2 0.8.1 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a35421907aa8999c90ba5e18959aa659bf6a9b14248ae46acddb7d18f1db0f5
-  data.tar.gz: bbf9762f20e681e29861f9f04090afa03c238fccee3ea6e3d2e8314fb6fa88c1
+  metadata.gz: 995f1309860d889b44e0634247e1ae64cda8fc975a8a02de97de55605bd2958e
+  data.tar.gz: a7a2c819970a4a6b432b7067ef3bf2feb8d349332b731df4c1639b4db659140d
 SHA512:
-  metadata.gz: 978ca3331442680de64cd74fdd9e7167526c4a521dc9ed41fdbd8e08d89d9caebb617d6427edb58b5bc79b1b0a522cbb4a54d0854a5f8a3953f22777adebc0d9
-  data.tar.gz: 4115b6301cba03d98b92a6b40f9264b3a0630f28421fae34d402bbfef941f6704895e6b73fee83ddde511b2523f602a16d351434366392a75a1e61457164432d
+  metadata.gz: 83f652b2a5c2815e798cff48d6cd6c83b1a2d325e49306b9f883c11d6a01392c1b0c5303a175b1065238ea01d3628f06cc8a8a96cfa31c42e83d37746cd8cb63
+  data.tar.gz: 3916165f772f1607ab7c03b497848213d30c7e7e93ce584fb911f081c5236d76722e3090b3c2a26889b3c52294e153d66be5df532d45f91a19ce9e0b362b3644

data/README.md

@@ -6,7 +6,10 @@ Forked from https://github.com/jhawthorn/ttytest, because I had some features I
 
 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://rubygems.org/gems/ttytest2)
+[![Gem Version](https://badge.fury.io/rb/ttytest2.svg)](https://badge.fury.io/rb/ttytest2)
+
+## Gem at RubyGems.org
+https://rubygems.org/gems/ttytest2
 
 ## Minimum Requirements
 
@@ -15,7 +18,8 @@ It works by running commands inside a tmux session, capturing the pane, and comp
 
 ## Usage
 
-### Example
+### 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
 require 'ttytest'
@@ -36,6 +40,21 @@ TTY
 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.
+
+``` ruby
+require 'ttytest'
+
+@tty = TTYtest.new_terminal(%{PS1='$ ' /bin/noncanonical-sh}, width: 80, height: 24)
+@tty.assert_row_starts_with(0, ENV['USER'])
+@tty.assert_row_ends_with(0, '$')
+
+@tty.send_keys_one_at_a_time('ls')
+@tty.assert_row_ends_with(0, 'ls')
+@tty.send_keys_one_at_a_time(%(\n))
+```
+
 ### 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 by default).

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'yard'

data/lib/ttytest/terminal.rb

@@ -19,12 +19,15 @@ module TTYtest
     end
 
     # @!method send_keys(*keys)
-    #   Simulate typing keys into the terminal
+    #   Simulate typing keys into the terminal. For canonical cli's/shells which read line by line.
+    #   @param [String] keys keys to send to the terminal
+    # @!method send_keys_one_at_a_time(*keys)
+    #   Simulate typing keys into the terminal. For noncanonical cli's/shells which read character by character.
     #   @param [String] keys keys to send to the terminal
     # @!method capture
     #   Capture the current state of the terminal
     #   @return [Capture] instantaneous state of the terminal when called
-    def_delegators :@driver_terminal, :send_keys, :capture
+    def_delegators :@driver_terminal, :send_keys, :send_keys_one_at_a_time, :capture
 
     # @!method rows
     #   @return [Array<String>]

data/lib/ttytest/tmux/driver.rb

@@ -8,6 +8,7 @@ require 'ttytest/tmux/session'
 
 module TTYtest
   module Tmux
+    # tmux driver
     class Driver
       COMMAND = 'tmux'
       SOCKET_NAME = 'ttytest'

data/lib/ttytest/tmux/session.rb

@@ -2,7 +2,7 @@
 
 module TTYtest
   module Tmux
-    # tmux session manager
+    # represents a tmux session and how to send output to the current tmux session
     class Session
       # @api private
       def initialize(driver, name)
@@ -42,6 +42,12 @@ module TTYtest
         driver.tmux(*%W[send-keys -t #{name} -l], *keys)
       end
 
+      def send_keys_one_at_a_time(keys)
+        keys.split('').each do |key|
+          driver.tmux(*%W[send-keys -t #{name} -l], key)
+        end
+      end
+
       private
 
       attr_reader :driver, :name

data/lib/ttytest/version.rb

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

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github,
-git tag v0.8.1
+git tag v0.8.3
 git push origin --tags
 
 to push new version to rubygems.org
 gem build ttytest2.gemspec
-gem push ttytest2-0.8.1.gem
+gem push ttytest2-0.8.3.gem

data/ttytest2.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ttytest/version'

metadata

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