tty_string 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5cf9c99684d1bffc4b5238d85a0fbddc6c228a92
+  data.tar.gz: 29daa63edffa32d87215419a32c0f3eb06511648
+SHA512:
+  metadata.gz: c0184931cc63e842676e467f9cf1e3262f97a3e191f690bc100e075f389cdd54e3d94d09295da58a2e23a97b9f27836cd3eaf6772a67079184b1fc8030cd05ac
+  data.tar.gz: 5804b7bcf35cb28a18feeb330662cac534b307badd16f2ebd5e138a772fcd8cf4743702181d33a208bf6b20f8d03013ac0f77fae7e1faba4eb1745bbb2687296

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "rubocop_yml"]
+	path = rubocop_yml
+	url = https://github.com/robotdana/rubocop_yml.git

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1 @@
+rubocop_yml/rubocop.yml

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tty_string.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    tty_string (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.3)
+    method_source (0.9.2)
+    parallel (1.17.0)
+    parser (2.6.4.1)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.74.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.4.1)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.35.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.74.0)
+  rubocop-performance (~> 1.4.1)
+  rubocop-rspec (~> 1.35.0)
+  tty_string!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Dana Sherson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# TTYString
+
+Render a string like your terminal does by parsing ANSI TTY codes.
+This is useful for testing CLI's
+
+Supported codes
+
+ - \b
+ - \e[A
+ - \e[B
+ - \e[C
+ - \e[D
+ - \e[E
+ - \e[F
+ - \e[G
+ - \e[H
+ - \e[J
+ - \e[K
+ - \e[f
+ - \e[m
+ - \n
+ - \r
+ - \t
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tty_string'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tty_string
+
+## Usage
+
+```
+TTYString.new("th\ta string\e[3Gis is").to_s => "this is a string"
+```
+
+Styling information is suppressed by default:
+```
+TTYString.new("th\ta \e[31mstring\e[0m\e[3Gis is", clear_style: false).to_s => "this is a string"
+```
+But can be passed through:
+```
+TTYString.new("th\ta \e[31mstring\e[0m\e[3Gis is", clear_style: false).to_s => "this is a \e[31mstring\e[0m"
+```
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/robotdana/tty_string.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'tty_string'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tty_string/cursor.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+class TTYString
+  # point on a screen. you can move it
+  class Cursor
+    attr_reader :row, :col
+
+    def initialize(row = 0, col = 0)
+      @row = row
+      @col = col
+    end
+
+    def row=(value)
+      @row = value.to_i
+      @row = 0 if @row.negative?
+    end
+
+    def col=(value)
+      @col = value.to_i
+      @col = 0 if @col.negative?
+    end
+
+    def left(count = 1)
+      count = count.to_i
+      raise ArgumentError if count.negative?
+
+      self.col -= count
+    end
+
+    def up(count = 1)
+      count = count.to_i
+      raise ArgumentError if count.negative?
+
+      self.row -= count
+    end
+
+    def down(count = 1)
+      count = count.to_i
+      raise ArgumentError unless count >= 0
+
+      self.row += count
+    end
+
+    def right(count = 1)
+      count = count.to_i
+      raise ArgumentError unless count >= 0
+
+      self.col += count
+    end
+
+    def to_ary
+      [row, col]
+    end
+    alias to_a to_ary
+  end
+end

data/lib/tty_string/parser.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'strscan'
+require_relative 'renderer'
+
+class TTYString
+  # Reads the text string a
+  class Parser < StringScanner
+    def render(clear_style: true)
+      reset
+      @clear_style = clear_style
+      @renderer = Renderer.new
+      read until eos?
+      renderer.to_s
+    end
+
+    private
+
+    attr_reader :renderer
+    attr_reader :clear_style
+
+    def write(string)
+      renderer.write(string)
+    end
+
+    def read
+      text || slash_n || slash_r || slash_t || slash_b || slash_e
+    end
+
+    def text
+      write(matched) if scan(text_regexp)
+    end
+
+    def slash_n
+      renderer.slash_n if skip(/\n/)
+    end
+
+    def slash_r
+      renderer.slash_r if skip(/\r/)
+    end
+
+    def slash_t
+      renderer.slash_t if skip(/\t/)
+    end
+
+    def slash_b
+      # can't use `scan(/\b/)` because it matches everything
+      return unless peek(1) == "\b"
+
+      self.pos += 1
+      renderer.slash_b
+    end
+
+    def slash_e
+      return unless scan(csi_regexp)
+
+      args = matched.slice(2..-2).split(';')
+      command = matched.slice(-1)
+      render_csi(:"csi_#{command}", *args)
+    end
+
+    def csi_regexp
+      @csi_regexp ||= Regexp.new("\e#{csi_pattern}")
+    end
+
+    def csi_pattern
+      "\\[(\\d+;?|;)*[ABCDEFGHJKf#{'m' if clear_style}]"
+    end
+
+    def text_regexp
+      @text_regexp ||= Regexp.new("[^\b\t\r\n\e]|\e(?!#{csi_pattern})")
+    end
+
+    def render_csi(method, *args)
+      method = renderer.method(method)
+      params = method.parameters
+      args = args.take(params.length) unless params.assoc(:rest)
+      args = [] if args.all?(&:empty?)
+      method.call(*args)
+    end
+  end
+end

data/lib/tty_string/renderer.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative 'screen'
+class TTYString
+  # turns the text string into screen instructions
+  class Renderer
+    attr_reader :screen
+
+    def initialize
+      @screen = Screen.new
+    end
+
+    def to_s
+      screen.to_s
+    end
+
+    def write(string)
+      screen.write(string)
+    end
+
+    # rubocop:disable Naming/MethodName
+    def csi_A(rows = 1)
+      cursor.up(rows)
+    end
+
+    def csi_B(rows = 1)
+      cursor.down(rows)
+    end
+
+    def csi_C(cols = 1)
+      cursor.right(cols)
+    end
+
+    def csi_D(cols = 1)
+      cursor.left(cols)
+    end
+
+    def csi_E(rows = 1)
+      cursor.down(rows)
+      cursor.col = 0
+    end
+
+    def csi_F(rows = 1)
+      cursor.up(rows)
+      cursor.col = 0
+    end
+
+    def csi_G(col = 1)
+      cursor.col = col.to_i - 1 # cursor is zero indexed, arg is 1 indexed
+    end
+
+    def csi_H(row = 1, col = 1)
+      # cursor is zero indexed, arg is 1 indexed
+      cursor.row = row.to_i - 1
+      cursor.col = col.to_i - 1
+    end
+    alias csi_f csi_H
+
+    def csi_J(mode = 0)
+      case mode.to_i
+      when 0 then screen.clear_forward
+      when 1 then screen.clear_backward
+      when 2, 3 then screen.clear
+      end
+    end
+
+    def csi_K(mode = 0)
+      case mode.to_i
+      when 0 then screen.clear_line_forward
+      when 1 then screen.clear_line_backward
+      when 2 then screen.clear_line
+      end
+    end
+
+    def csi_m(*args)
+    end
+    # rubocop:enable Naming/MethodName
+
+    def slash_b
+      cursor.left
+      screen.clear_at_cursor
+    end
+
+    def slash_n
+      cursor.down
+      cursor.col = 0
+      screen.write('')
+    end
+
+    def slash_r
+      cursor.col = 0
+    end
+
+    def slash_t
+      cursor.right(8 - (cursor.col % 8))
+    end
+
+    private
+
+    def cursor
+      screen.cursor
+    end
+  end
+end

data/lib/tty_string/screen.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative 'cursor'
+
+class TTYString
+  # a grid to draw on
+  class Screen
+    attr_reader :cursor
+
+    def initialize
+      @cursor = Cursor.new
+      @screen = []
+    end
+
+    def to_s
+      screen.map { |c| Array(c).map { |x| x || ' ' }.join.rstrip }.join("\n")
+    end
+
+    def []=((row, col), *value)
+      screen[row] ||= []
+      screen[row][col] = value.flatten(1)
+    end
+
+    def []((row, col))
+      screen[row] ||= []
+      screen[row][col]
+    end
+
+    def clear_at_cursor
+      self[cursor] = nil
+    end
+
+    def clear_line_forward
+      screen[row].fill(nil, col..-1)
+    end
+
+    def clear_line_backward
+      screen[row].fill(nil, 0..col)
+    end
+
+    def clear_line
+      screen[row] = []
+    end
+
+    def clear
+      @screen = []
+    end
+
+    def clear_lines_before
+      screen.fill([], 0...row)
+    end
+
+    def clear_lines_after
+      screen.slice!((row + 1)..-1)
+    end
+
+    def clear_backward
+      clear_line_backward
+      clear_lines_before
+    end
+
+    def clear_forward
+      clear_lines_after
+      clear_line_forward
+    end
+
+    def write(string)
+      return self[cursor] if string.empty?
+
+      string.each_char do |char|
+        self[cursor] = char
+        cursor.right
+      end
+    end
+
+    private
+
+    attr_reader :screen
+
+    def row
+      cursor.row
+    end
+
+    def col
+      cursor.col
+    end
+  end
+end

data/lib/tty_string/version.rb

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

data/lib/tty_string.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+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"
+class TTYString
+  def initialize(input_string, clear_style: true)
+    @parser = Parser.new(input_string)
+    @clear_style = clear_style
+  end
+
+  def to_s
+    parser.render(clear_style: clear_style)
+  end
+
+  private
+
+  attr_reader :clear_style
+  attr_reader :parser
+end

data/tty_string.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tty_string/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'tty_string'
+  spec.version = TTYString::VERSION
+  spec.authors = ['Dana Sherson']
+  spec.email = ['robot@dana.sh']
+
+  spec.summary = 'Render a string using ANSI TTY codes'
+  spec.homepage = "https://github.com/robotdana/tty_string"
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|\.?rubocop|\.travis|\.git|\.rspec)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry', '~> 0.12.2'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.74.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.4.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.35.0'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: tty_string
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dana Sherson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.35.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.35.0
+description: 
+email:
+- robot@dana.sh
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitmodules"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tty_string.rb
+- lib/tty_string/cursor.rb
+- lib/tty_string/parser.rb
+- lib/tty_string/renderer.rb
+- lib/tty_string/screen.rb
+- lib/tty_string/version.rb
+- tty_string.gemspec
+homepage: https://github.com/robotdana/tty_string
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: Render a string using ANSI TTY codes
+test_files: []