ttytest2 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 995f1309860d889b44e0634247e1ae64cda8fc975a8a02de97de55605bd2958e
-  data.tar.gz: a7a2c819970a4a6b432b7067ef3bf2feb8d349332b731df4c1639b4db659140d
+  metadata.gz: 8801fe1b91cd7d371a9b1dc5668ad64b395e80778a6846c21ea004dd635b3107
+  data.tar.gz: fe6847ef687fa1ece179ab5201173145f5ee1b243fa62f533ce5deddc290137a
 SHA512:
-  metadata.gz: 83f652b2a5c2815e798cff48d6cd6c83b1a2d325e49306b9f883c11d6a01392c1b0c5303a175b1065238ea01d3628f06cc8a8a96cfa31c42e83d37746cd8cb63
-  data.tar.gz: 3916165f772f1607ab7c03b497848213d30c7e7e93ce584fb911f081c5236d76722e3090b3c2a26889b3c52294e153d66be5df532d45f91a19ce9e0b362b3644
+  metadata.gz: 85b636e54bd9845b50b5d6cc5c9feaa3fac871ee4bf724409f191e38e86649fa695bb6a4917ea877b5d59d6d8dbb2fd0697aacff6122501fba14d6ae56f00654
+  data.tar.gz: 38485e1cae3446068272b40a00d44eb12ce854442c87a8a0dbbd638d9b52a80a82b4c93a10e7f2c83312fef32aa88e771c7fe564d09d8db5e509907e68015bee

data/README.md

@@ -6,10 +6,7 @@ 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://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,6 +15,21 @@ 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)`
+
+
 ### 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.
 
@@ -52,23 +64,9 @@ 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.
 ```
 
-### 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).
-
-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)`
-
 ## Docker
 
 Easy to use from Docker. Add this to your dockerfile to get started.
@@ -77,20 +75,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,20 @@
+# frozen_string_literal: true
+
+# some constants that can be used with send_keys, just to help out people creating tests
+# may not work with all terminal emulators
+module TTYtest
+  BACKSPACE = 127.chr
+  TAB = 9.chr
+  CTRLF = 6.chr
+  CTRLC = 3.chr
+  CTRLD = '\004'
+  ESCAPE = 27.chr
+  NEWLINE = '\n'
+
+  UP_ARROW = "#{ESCAPE}[A".freeze
+  DOWN_ARROW = "#{ESCAPE}[B".freeze
+  RIGHT_ARROW = "#{ESCAPE}[C".freeze
+  LEFT_ARROW = "#{ESCAPE}[D".freeze
+
+  CLEAR = 'clear'
+end

data/lib/ttytest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TTYtest
-  VERSION = '0.8.3'
+  VERSION = '0.8.4'
 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.4
 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.4.gem

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ttytest2
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - Alex Eski
@@ -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