tty_string 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1b227f64f424b3dc76c088e9caa52639a5070e0543d022ffd920b01d830f78e
-  data.tar.gz: 6ddcd309f2b26d2a43251fcd0d7d673c72b5576e7e13c8d86df420a84b8d8c52
+  metadata.gz: 9abd5adac382e5520dc2699ff14dd2e213a9fed0d7aa3807e0b054a610ca9c46
+  data.tar.gz: 254d7adb36f29313bc441c237dc760399f9e3e9f4a4447c348a1387282d43b33
 SHA512:
-  metadata.gz: c1db0493d2d8c027517b531d6997ddc52c47d0f9de6f375efab05f781d30db0e2c63d98f5933d62f471cb882f3248d4798aa1a5b6018158453e13d6be7045ab8
-  data.tar.gz: 97bef4800b9e802e5aa5d12afc86483bf570dc3913b9cf7b7b6530f2c6d58adba935a772d6f1b16626c6ffe0096a59dcea715ab017a252dd36bcf93092dd3913
+  metadata.gz: b2883d488aa1ba89ddc5535ccf6c50d9b5722d3d9e906f5b856bca53a237f6901069f85e9d51a20d2c2fc9d10d9cab2ef14a37fa23665ddf7310c66fcdfde53e
+  data.tar.gz: c048606897448877ba108a78555697f7cbaad9578abd381313be692bb8dc16dd0bd1594c9b33e0fc32646b1529187ef873b60882d8e00d54765337d1507aa7d3

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v1.0.1
+- test push to rubygems, no functional changes
+
 # v1.0.0
 - added TTYString.parse as a shortcut for .new#to_s
 - added TTYString.to_proc for lols

data/README.md

@@ -1,8 +1,10 @@
 # TTYString
 
-[![Build Status](https://travis-ci.org/robotdana/tty_string.svg?branch=master)](https://travis-ci.org/robotdana/tty_string)
+[![Build Status](https://travis-ci.com/robotdana/tty_string.svg?branch=master)](https://travis-ci.com/robotdana/tty_string)
+[![Gem Version](https://badge.fury.io/rb/tty_string.svg)](https://rubygems.org/gems/tty_string)
 
 Render to a string like your terminal does by (narrowly) parsing ANSI TTY codes.
+Intended for use in tests of command line interfaces.
 
 ## Features
 
@@ -11,25 +13,26 @@ Render to a string like your terminal does by (narrowly) parsing ANSI TTY codes.
 
 ## Supported codes
 
- - `\a` # BEL, just removed.
- - `\b` # backspace
- - `\n` # newline
- - `\r` # return, jump to the start of the line
- - `\t` # tab, move to the next multiple-of-8 column
- - `\e[nA` # move up n lines, default: 1
- - `\e[nB` # move down n lines, default: 1
- - `\e[nC` # move right n columns, default: 1
- - `\e[nD` # move left n columns, default: 1
- - `\e[nE` # move down n lines, and to the start of the line, default: 1
- - `\e[nF` # move up n lines, and to the start of the line, default: 1
- - `\e[nG` # jump to column to n
- - `\e[n;mH` # jump to row n, column m, default: 1,1
- - `\e[nJ` # n=0: clear the screen forward, n=1: clear backward, n=2 or 3: clear the screen. default 0
- - `\e[nK` # n=0: clear the line forward, n=1: clear the line backward, n=2: clear the line. default 0
- - `\e[n;mf` # jump to row n, column m, default: 1,1
- - `\e[m` # styling codes, optionally suppressed with `clear_style: false`
- - `\e[nS` # scroll down n rows, default 1
- - `\e[nT` # scroll up n rows, default 1
+| Code | Description | Default |
+|------|-------------|---------|
+| `\a` | bell: suppressed | |
+| `\b` | backspace: clear the character to the left of the cursor and move the cursor back one column | |
+| `\n` | newline: move the cursor to the start of the next line | |
+| `\r` | return: move the cursor to the start of the current line | |
+| `\t` | tab: move the cursor to the next multiple-of-8 column | |
+| `\e[nA` | move the cursor up _n_ lines | _n_=`1` |
+| `\e[nB` | move the cursor down _n_ lines | _n_=`1` |
+| `\e[nC` | move the cursor right _n_ columns | _n_=`1` |
+| `\e[nD` | move the cursor left _n_ columns | _n_=`1` |
+| `\e[nE` | move the cursor down _n_ lines, and to the start of the line | _n_=`1` |
+| `\e[nF` | move the cursor up _n_ lines, and to the start of the line | _n_=`1` |
+| `\e[nG` | move the cursor to column _n_. `1` is left-most column | _n_=`1` |
+| `\e[n;mH` <br> `\e[n;mf` | move the cursor to row _n_, column _m_. `1;1` is top left corner | _n_=`1` _m_=`1` |
+| `\e[nJ` | _n_=`0`: clear the screen from the cursor forward <br>_n_=`1`: clear the screen from the cursor backward <br>_n_=`2` or _n_=`3`: clear the screen | _n_=`0` |
+| `\e[nK` | _n_=`0`: clear the line from the cursor forward <br>_n_=`1`: clear the line from the cursor backward <br>_n_=`2`: clear the line | _n_=`0` |
+| `\e[nS` | scroll up _n_ rows | _n_=`1` |
+| `\e[nT` | scroll down _n_ rows | _n_=`1` |
+| `\e[m` | styling codes: optionally suppressed with `clear_style: false` | |
 
 ## Installation
 
@@ -67,17 +70,17 @@ TTYString.parse("th\ta \e[31mstring\e[0m\e[3Gis is", clear_style: false)
 
 Just for fun TTYString.to_proc provides the `parse` method as a lambda, so:
 ```ruby
-"th\ta string\e[3Gis is".yield_self(&TTYString)
-=> "this is a string"
+["th\ta string\e[3Gis is"].each(&TTYString)
+=> ["this is a string"]
 ```
 
 ## Limitations
 
-Various terminals are wildly variously permissive with what they accept,
-so this doesn't even try to cover all possible cases,
-instead it covers the narrowest possible case, and leaves the codes in place when unrecognized
+- Various terminals are wildly variously permissive with what they accept,
+  so this doesn't even try to cover all possible cases,
+  instead it covers the narrowest possible case, and leaves the codes in place when unrecognized
 
-`clear_style: false` treats the style codes as regular text which may work differently when rendering codes that move the cursor.
+- `clear_style: false` treats the style codes as regular text which may work differently when rendering codes that move the cursor.
 
 ## Development
 

data/lib/tty_string/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class TTYString
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty_string
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Dana Sherson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-26 00:00:00.000000000 Z
+date: 2020-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler