tty_string 0.2.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a98f1f00566e4802bab20aa02326c6c53f9bbd164bbd5a499f64afc5a84f88cb
-  data.tar.gz: aa22c08116ffc776f98342bf7f8704cb5bfff7ec477fbe237d7405d1ae75752d
+  metadata.gz: ce94f319deb6062d8492d19e856f93d1e4b7fb1ef454e31e6824a1814b59a319
+  data.tar.gz: '05826ce61d59609df5db320f5e4bf83084b494a9f045f90b13cf8a3c18f07b40'
 SHA512:
-  metadata.gz: e2f47e040687ea392c87784ffbe45cefe76c0dc0c5c644e651ecdc349f7d57a140c869dfd685492e8f02b430b3b3e92a3121d3f67edc3e9bd7109cd2cf979fba
-  data.tar.gz: 59ddb4338dc11b483666497ea417a30f9857172a81e3c39271b1585d94d40f1738a3f426600e037f50d110f5abeeab36d6f0b62b9495bb4207802c5333ccb181
+  metadata.gz: 4299d0e7ffca36bf56f6899cb971a882e0646a71777cdbf0fd34a4569cfe3986d057fb0b10137815747b163d2e4da44b6243692d36ab8bee0141695df93416b1
+  data.tar.gz: 81e5f9aeee83e5b65df853dcfe94f41398eb5de0d690acafeded7aa896cfe80ba5c1cb09fad9ed4ff0a84edeb495cf6b4185a832261ce7ca9a248508015d0de9

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+# v1.1.1
+- i forgot how arity works
+
+# v1.1.0
+- suppress bracketed paste mode codes
+
+# 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
+- added jruby to travis matrix, fortunately it just works™
+
+# v0.2.1
+- fixed a bug with ignoring \a
+
 # v0.2.0
 - Stricter rendering because it turns out terminals are randomly permissive
 - removed support for ruby 2.3

data/README.md

@@ -1,42 +1,49 @@
 # TTYString
 
-[![Build Status](https://travis-ci.org/robotdana/tty_string.svg?branch=master)](https://travis-ci.org/robotdana/tty_string)
-
-Render a string like your terminal does by (narrowly) parsing ANSI TTY codes.
-This is useful for testing CLI's
-
-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 unrecognised
-
-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
+[![Build Status](https://travis-ci.com/robotdana/tty_string.svg?branch=main)](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
+
+- supports ruby 2.4 - 3.0.0.preview1, and jruby
+- has no dependencies outside ruby stdlib
+
+## Supported codes
+
+| 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` | |
+| `\e[?2004h` | enabled bracketed paste: suppressed | |
+| `\e[?2004l` | disable bracketed paste: suppressed | |
+| `\e[200~` | bracketed paste start: suppressed | |
+| `\e[201~` | bracketed paste end: suppressed | |
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'tty_string'
+gem 'tty_string', '~> 1.0'
 ```
 
 And then execute:
@@ -50,26 +57,40 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-TTYString.new("th\ta string\e[3Gis is").to_s
+TTYString.parse("th\ta string\e[3Gis is")
 => "this is a string"
 ```
 
 Styling information is suppressed by default:
 ```ruby
-TTYString.new("th\ta \e[31mstring\e[0m\e[3Gis is").to_s
+TTYString.parse("th\ta \e[31mstring\e[0m\e[3Gis is")
 => "this is a string"
 ```
 But can be passed through:
 ```ruby
-TTYString.new("th\ta \e[31mstring\e[0m\e[3Gis is", clear_style: false).to_s
+TTYString.parse("th\ta \e[31mstring\e[0m\e[3Gis is", clear_style: false)
 => "this is a \e[31mstring\e[0m"
 ```
 
+Just for fun TTYString.to_proc provides the `parse` method as a lambda, so:
+```ruby
+["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
+
+- `clear_style: false` treats the style codes as regular text which may work differently when rendering codes that move the cursor.
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests and linters. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/lib/tty_string.rb

@@ -3,8 +3,18 @@
 require_relative 'tty_string/parser'
 
 # Renders a string taking into ANSI escape codes and \t\r\n etc
-# Usage: TTYString.new("this\r\e[Kthat").to_s => "that"
+# Usage: TTYString.parse("This\r\e[KThat") => "That"
 class TTYString
+  class << self
+    def parse(input_string, clear_style: true)
+      new(input_string, clear_style: clear_style).to_s
+    end
+
+    def to_proc
+      method(:parse).to_proc
+    end
+  end
+
   def initialize(input_string, clear_style: true)
     @parser = Parser.new(input_string)
     @parser.clear_style = clear_style
@@ -16,6 +26,5 @@ class TTYString
 
   private
 
-  attr_reader :clear_style
-  attr_reader :parser
+  attr_reader :clear_style, :parser
 end

data/lib/tty_string/code.rb

@@ -11,6 +11,8 @@ class TTYString
         @@descendants ||= [] # rubocop:disable Style/ClassVars I want it to be shared between subclasses.
         @@descendants << klass
         @@descendants.uniq!
+
+        super
       end
 
       def render(parser)
@@ -45,12 +47,12 @@ class TTYString
       @parser = parser
     end
 
+    def action; end
+
     private
 
     attr_reader :parser
 
-    def action; end
-
     def screen
       parser.screen
     end

data/lib/tty_string/code_definitions.rb

@@ -5,11 +5,11 @@ require_relative 'csi_code'
 
 class TTYString
   class Code
-    class SlashA < TTYString::Code
+    class SlashA < TTYString::Code # leftovers:allow
       char "\a"
     end
 
-    class SlashB < TTYString::Code
+    class SlashB < TTYString::Code # leftovers:allow
       char "\b"
 
       def self.match?(scanner)
@@ -26,7 +26,7 @@ class TTYString
       end
     end
 
-    class SlashN < TTYString::Code
+    class SlashN < TTYString::Code # leftovers:allow
       char "\n"
 
       def action
@@ -36,7 +36,7 @@ class TTYString
       end
     end
 
-    class SlashR < TTYString::Code
+    class SlashR < TTYString::Code # leftovers:allow
       char "\r"
 
       def action
@@ -44,7 +44,7 @@ class TTYString
       end
     end
 
-    class SlashT < TTYString::Code
+    class SlashT < TTYString::Code # leftovers:allow
       char "\t"
 
       def action

data/lib/tty_string/csi_code.rb

@@ -17,18 +17,21 @@ class TTYString
       end
 
       def args(parser)
-        parser.matched.slice(2..-2).split(';')
-          .map { |n| n.empty? ? default_arg : n.to_i }
+        a = parser.matched.slice(2..-2).split(';')
+        a = a.slice(0, max_args) unless max_args == -1
+        a.map! { |n| n.empty? ? default_arg : n.to_i }
+        a
       end
 
       def re
         @re ||= /\e\[#{args_re}#{char}/
       end
 
-      def args_re
+      def args_re # rubocop:disable Metrics/MethodLength
         case max_args
+        when 0 then nil
         when 1 then /#{arg_re}?/
-        when nil then /(#{arg_re}?(;#{arg_re})*)?/
+        when -1 then /(#{arg_re}?(;#{arg_re})*)?/
         else /(#{arg_re}?(;#{arg_re}){0,#{max_args - 1}})?/
         end
       end
@@ -40,7 +43,7 @@ class TTYString
       def max_args
         @max_args ||= begin
           params = instance_method(:action).parameters
-          return if params.assoc(:rest)
+          return -1 if params.assoc(:rest)
 
           params.length
         end

data/lib/tty_string/csi_code_definitions.rb

@@ -4,52 +4,52 @@ require_relative 'csi_code'
 
 class TTYString
   class CSICode
-    class A < TTYString::CSICode
+    class A < TTYString::CSICode # leftovers:allow
       def action(rows = 1)
         cursor.up(rows)
       end
     end
 
-    class B < TTYString::CSICode
+    class B < TTYString::CSICode # leftovers:allow
       def action(rows = 1)
         cursor.down(rows)
       end
     end
 
-    class C < TTYString::CSICode
+    class C < TTYString::CSICode # leftovers:allow
       def action(cols = 1)
         cursor.right(cols)
       end
     end
 
-    class D < TTYString::CSICode
+    class D < TTYString::CSICode # leftovers:allow
       def action(cols = 1)
         cursor.left(cols)
       end
     end
 
-    class E < TTYString::CSICode
+    class E < TTYString::CSICode # leftovers:allow
       def action(rows = 1)
         cursor.down(rows)
         cursor.col = 0
       end
     end
 
-    class F < TTYString::CSICode
+    class F < TTYString::CSICode # leftovers:allow
       def action(rows = 1)
         cursor.up(rows)
         cursor.col = 0
       end
     end
 
-    class G < TTYString::CSICode
+    class G < TTYString::CSICode # leftovers:allow
       def action(col = 1)
         # cursor is zero indexed, arg is 1 indexed
         cursor.col = col.to_i - 1
       end
     end
 
-    class H < TTYString::CSICode
+    class H < TTYString::CSICode # leftovers:allow
       def action(row = 1, col = 1)
         # cursor is zero indexed, arg is 1 indexed
         cursor.row = row.to_i - 1
@@ -57,14 +57,18 @@ class TTYString
       end
     end
 
-    class LowF < TTYString::CSICode::H
+    class LowH < TTYString::CSICode # leftovers:allow
+      char(/\?2004h/)
+    end
+
+    class LowF < TTYString::CSICode::H # leftovers:allow
       char 'f'
     end
 
-    class J < TTYString::CSICode
+    class J < TTYString::CSICode # leftovers:allow
       default_arg 0
 
-      def self.args_re
+      def self.arg_re
         /[0-3]?/
       end
 
@@ -79,7 +83,7 @@ class TTYString
       end
     end
 
-    class K < TTYString::CSICode
+    class K < TTYString::CSICode # leftovers:allow
       default_arg 0
 
       def self.arg_re
@@ -97,12 +101,16 @@ class TTYString
       end
     end
 
-    class LowM < TTYString::CSICode
+    class LowL < TTYString::CSICode # leftovers:allow
+      char(/\?2004l/)
+    end
+
+    class LowM < TTYString::CSICode # leftovers:allow
       char 'm'
 
       def self.arg_re
         # 0-255
-        /(\d|\d\d|1\d\d|2[0-4]\d|25[0-5])?/
+        /(?:\d|\d\d|1\d\d|2[0-4]\d|25[0-5])?/
       end
 
       def self.render(renderer)
@@ -112,16 +120,20 @@ class TTYString
       def action(*args); end
     end
 
-    class S < TTYString::CSICode
+    class S < TTYString::CSICode # leftovers:allow
       def action(rows = 1)
         rows.times { screen.scroll_up }
       end
     end
 
-    class T < TTYString::CSICode
+    class T < TTYString::CSICode # leftovers:allow
       def action(rows = 1)
         rows.times { screen.scroll_down }
       end
     end
+
+    class Tilde < TTYString::CSICode # leftovers:allow
+      char(/(?:200|201)~/)
+    end
   end
 end

data/lib/tty_string/cursor.rb

@@ -39,6 +39,5 @@ class TTYString
     def to_ary
       [row, col]
     end
-    alias to_a to_ary
   end
 end

data/lib/tty_string/version.rb

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

data/tty_string.gemspec

@@ -14,6 +14,12 @@ Gem::Specification.new do |spec|
   spec.homepage = 'https://github.com/robotdana/tty_string'
   spec.license = 'MIT'
 
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  end
+
   spec.files = Dir.glob('{lib}/**/*') + %w{
     CHANGELOG.md
     Gemfile
@@ -25,11 +31,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'fast_ignore', '>= 0.15.1'
+  spec.add_development_dependency 'leftovers', '>= 0.2.0'
   spec.add_development_dependency 'pry', '~> 0.12'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.74'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.4'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.35'
+  spec.add_development_dependency 'rubocop', '~> 0.93.1'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.8.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.44.1'
   spec.add_development_dependency 'simplecov', '~> 0.18.5'
+  spec.add_development_dependency 'simplecov-console'
+  spec.add_development_dependency 'spellr', '>= 0.8.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty_string
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Dana Sherson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-08 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: fast_ignore
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+- !ruby/object:Gem::Dependency
+  name: leftovers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +70,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,42 +100,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: 0.93.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: 0.93.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.35'
+        version: 1.44.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.35'
+        version: 1.44.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +150,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spellr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 description: 
 email:
 - robot@dana.sh
@@ -146,7 +202,10 @@ files:
 homepage: https://github.com/robotdana/tty_string
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/robotdana/tty_string
+  source_code_uri: https://github.com/robotdana/tty_string
+  changelog_uri: https://github.com/robotdana/tty_string/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -162,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Render a string using ANSI TTY codes