tty_string 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dabe05d450c5f5b8868252125bf944420aeccb8a86fcb1e59e50d3e906316dbe
-  data.tar.gz: f6e6faeabb0d814c8776d5d4ee82b5a0bcb3faf769fec87866503a1cf8b561e1
+  metadata.gz: b1b227f64f424b3dc76c088e9caa52639a5070e0543d022ffd920b01d830f78e
+  data.tar.gz: 6ddcd309f2b26d2a43251fcd0d7d673c72b5576e7e13c8d86df420a84b8d8c52
 SHA512:
-  metadata.gz: 3059865f39c20e61da6632623258dc6367e655258cd54f197e9528f1276994ca22df82a454cf03524368f270e4b0366742b8b966b005d2ee7fb742780427aa7f
-  data.tar.gz: 850f46bb356c39cbb198fc64708a8f1e90b95037fca303daf6c6167dd0a9d159fecfc9198f66f966baf996c61f6222ca15341df2923928277833fcbd182f8fa3
+  metadata.gz: c1db0493d2d8c027517b531d6997ddc52c47d0f9de6f375efab05f781d30db0e2c63d98f5933d62f471cb882f3248d4798aa1a5b6018158453e13d6be7045ab8
+  data.tar.gz: 97bef4800b9e802e5aa5d12afc86483bf570dc3913b9cf7b7b6530f2c6d58adba935a772d6f1b16626c6ffe0096a59dcea715ab017a252dd36bcf93092dd3913

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 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
 

data/README.md

@@ -2,14 +2,14 @@
 
 [![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
+Render to a string like your terminal does by (narrowly) parsing ANSI TTY codes.
 
-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
+## Features
+
+- supports ruby 2.4 - 2.7, and jruby
+- has no dependencies outside ruby stdlib
 
-Supported codes
+## Supported codes
 
  - `\a` # BEL, just removed.
  - `\b` # backspace
@@ -27,7 +27,7 @@ Supported codes
  - `\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[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
 
@@ -36,7 +36,7 @@ Supported codes
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'tty_string'
+gem 'tty_string', '~> 1.0'
 ```
 
 And then execute:
@@ -50,26 +50,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".yield_self(&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

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_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,11 +57,11 @@ class TTYString
       end
     end
 
-    class LowF < TTYString::CSICode::H
+    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
@@ -79,7 +79,7 @@ class TTYString
       end
     end
 
-    class K < TTYString::CSICode
+    class K < TTYString::CSICode # leftovers:allow
       default_arg 0
 
       def self.arg_re
@@ -97,7 +97,7 @@ class TTYString
       end
     end
 
-    class LowM < TTYString::CSICode
+    class LowM < TTYString::CSICode # leftovers:allow
       char 'm'
 
       def self.arg_re
@@ -112,13 +112,13 @@ 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

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.1'
+  VERSION = '1.0.0'
 end

data/tty_string.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'leftovers', '>= 0.2.0'
   spec.add_development_dependency 'pry', '~> 0.12'
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
@@ -32,4 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-performance', '~> 1.4'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.35'
   spec.add_development_dependency 'simplecov', '~> 0.18.5'
+  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.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Dana Sherson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-20 00:00:00.000000000 Z
+date: 2020-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !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
@@ -122,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.18.5
+- !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