ttytest2 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3f08a4827e337de7e9124c7c0daf929922f9c6dfb573a03e88ee5e23b243cf9
-  data.tar.gz: 1f4ae48c6dff1ce25ea0a22c6f29c188b98caee3efa2a512132e4c416a522185
+  metadata.gz: 000e855fe9017a84a4041ff693e8037d7ce134231699fb5e4440be428d7f068b
+  data.tar.gz: fac1531d712a1f276a3b861fc9f3cb1a21b6a3849433bf4bfff76ec852b39637
 SHA512:
-  metadata.gz: edc7cb24ffec16991743b8dd104050f594f78a68ed44b88df91e2ce3ba52045dd0d37548b978a1bc47e0bd424d3dd8b1b75b9cce231f323bb6f860e2fb6ef7e4
-  data.tar.gz: 8d7e3f220552cc6485fa848e046eb6711e18117f43d6fb99d1fdc1751391da3e0aa719cc5c50b34dd3a4256eb89e17fec5a3868d32084074909af68110570283
+  metadata.gz: 93ee5ba6fad1d8f44f000de98a2acd17fa7cb4d19e96dec87f2ea83a718d95db2eaf59b98d9430f8c4009d6f2808a066da31027d28b6005dd97e1906da16a783
+  data.tar.gz: 1d9de87f136ae70629a67e21570f325f1cd18e6ce243a0cd000b0f5217efc4222144e52ae1eaa2ba6658d2434c8a3293be83d407adda6e23e6e403432df1f94f

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/capture.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TTYtest
   # Represents the complete state of a {TTYtest::Terminal} at the time it was captured (contents, cursor position, etc).
   # @attr_reader [Integer] width the number of columns in the captured terminal

data/lib/ttytest/matchers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TTYtest
   # Assertions for ttytest2.
   module Matchers

data/lib/ttytest/terminal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'ttytest/matchers'
 require 'ttytest/capture'
@@ -17,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,19 +2,20 @@
 
 module TTYtest
   module Tmux
+    # represents a tmux session and how to send output to the current tmux session
     class Session
       # @api private
       def initialize(driver, name)
         @driver = driver
         @name = name
 
-        ObjectSpace.define_finalizer(self, self.class.finalize(driver, name))
+        # ObjectSpace.define_finalizer(self, self.class.finalize(driver, name))
       end
 
       # @api private
-      def self.finalize(driver, name)
-        proc { driver.tmux(*%W[kill-session -t #{name}]) }
-      end
+      # def self.finalize(driver, name)
+      #   proc { driver.tmux(*%W[kill-session -t #{name}]) }
+      # end
 
       def capture
         contents = driver.tmux(*%W[capture-pane -t #{name} -p])
@@ -41,6 +42,12 @@ module TTYtest
         driver.tmux(*%W[send-keys -t #{name} -l], *keys)
       end
 
+      def send_keys_one_at_a_time(*keys)
+        keys.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,3 +1,5 @@
+# frozen_string_literal: true
+
 module TTYtest
-  VERSION = '0.8.0'.freeze
+  VERSION = '0.8.2'
 end

data/lib/ttytest.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'ttytest/tmux/driver'
 require 'ttytest/tmux/session'
 
+# ttytest2 main module
 module TTYtest
   class << self
     attr_accessor :driver, :default_max_wait_time

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github,
-git tag v0.8.0
+git tag v0.8.2
 git push origin --tags
 
 to push new version to rubygems.org
 gem build ttytest2.gemspec
-gem push ttytest2-0.8.0.gem
+gem push ttytest2-0.8.2.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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ttytest2
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Alex Eski