terminal_rb 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 03611bf9c12091c1899cf96f9b4bc8b116e8e6a7a83722cbd8cbfc0fdec0aa50
+  data.tar.gz: 9645a8ee9fb60c745804ac370492d81e8d217bfce58209a5f8a7b1dba4fc9631
+SHA512:
+  metadata.gz: d665b9b9c43b7a6df18248ae8a1d12ef791de691bc2a4b6bbe44790ee361af781cedbe9dfab020700c4f989f2f3e7126d30560b8a8eadc1d92251a16c5774733
+  data.tar.gz: 1dff9e55da621dd5b86ee3e887b4d234f972198c2123c3be0f4a71ae256b60d15bd89ad19a731a572c757d5372ac0c98d00736481e73a558771f5ec8417ecf17

data/.yardopts

@@ -0,0 +1,11 @@
+--title 'Terminal.rb'
+--charset utf-8
+--markup markdown
+--readme README.md
+--no-private
+--embed-mixins
+--tag comment
+--hide-tag comment
+lib/**/*.rb
+-
+README.md

data/README.md

@@ -0,0 +1,55 @@
+# Terminal.rb ![version](https://img.shields.io/gem/v/terminal_rb?label=)
+
+Terminal access with support for ANSI control codes and [BBCode-like](https://en.wikipedia.org/wiki/BBCode) embedded text attribute syntax.
+
+- Gem: [rubygems.org](https://rubygems.org/gems/terminal_rb)
+- Source: [codeberg.org](https://codeberg.org/mblumtritt/Terminal.rb)
+- Help: [rubydoc.info](https://rubydoc.info/gems/terminal_rb/Terminal)
+
+## Features
+
+- terminal emulator application detection
+- ANSI support detection
+- color depth detection
+- [NO_COLOR convention](https://no-color.org) support
+- markup of text attributes and colors using a [BBCode](https://en.wikipedia.org/wiki/BBCode)-like syntax
+- calculation for correct display width of strings containing Unicdode chars inclusive emojis
+- word-wise text wrapper
+- easy to use key codes
+
+## Examples
+
+### Check if ANSI is supported
+
+```ruby
+Terminal.ansi?
+# => true when current terminal emulator supports ANSI control codes
+```
+
+### Print with embedded formatting
+
+```ruby
+Terminal.puts "[red on_bright_yellow bold]Hello World![/]"
+```
+
+Have a look at the [examples](./examples/) directory to learn from code.
+
+## Installation
+
+You can install the gem in your system with
+
+```shell
+gem install terminal_rb
+```
+
+or you can use [Bundler](http://gembundler.com/) to add Terminal to your own project:
+
+```shell
+bundle add terminal_rb
+```
+
+After that you only need one line of code to have everything together
+
+```ruby
+require 'terminal'
+```

data/bin/bbcode

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby --disable-all
+# frozen_string_literal: true
+
+def me = File.basename(Process.argv0)
+puts(<<~HELP) || exit if ARGV.delete('-h') || ARGV.delete('--help')
+  usage: #{me} [OPTION] [FILE, ...]
+
+  Interprete BBCode of given files or stdin and print to stdout.
+
+  Options:
+    -A, --no-ansi     remove ANSI control codes
+    -B, --no-bbcode   remove BBCodes
+HELP
+
+begin
+  case ARGV[0]
+  when '-v', '--version'
+    puts("#{me} v1.0") || exit if ARGV.size == 1
+  when '-A', '--no-ansi'
+    no_ansi = ARGV.shift
+  when '-B', '--no-bbcode'
+    no_bbcode = ARGV.shift
+  when '-AB', '-BA'
+    no_ansi = no_bbcode = ARGV.shift
+  when '--auto'
+    ARGV.shift
+    require_relative('../lib/terminal')
+    no_ansi = no_bbcode = true unless Terminal.ansi?
+  end
+  require_relative('../lib/terminal/ansi')
+  $stdout.write(
+    Terminal::Ansi.send(
+      if no_ansi
+        no_bbcode ? :plain : :undecorate
+      else
+        no_bbcode ? :unbbcode : :bbcode
+      end,
+      ARGF.read
+    )
+  )
+rescue IOError, SystemCallError => e
+  $stderr.puts "#{me}-error: #{e.message.gsub(/@ \w+ /, '')}"
+  exit 1
+rescue Interrupt
+  exit 138
+end

data/examples/24bit-colors.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../lib/terminal'
+
+colors =
+  Terminal::Ansi
+    .named_colors
+    .delete_if { /\d/.match?(_1) }
+    .map! { "[on_#{_1}] [/] [#{_1}]#{_1.to_s.ljust(22)}[/]" }
+    .each_slice(3)
+    .map(&:join)
+    .join("\n")
+
+Terminal.puts <<~TEXT
+
+  ✅ [b bright_green]Terminal.rb[/b] — 24bit-Colors:[/]
+
+  #{colors}
+
+TEXT

data/examples/3bit-colors.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../lib/terminal'
+
+Terminal.puts <<~TEXT
+
+  ✅ [b bright_green]Terminal.rb[/b] — 3/4bit-Colors:[/]
+
+  [on_black] [/] [black]black[/]      [on_bright_black] [/] [bright_black]bright_black[/]
+  [on_red] [/] [red]red[/]        [on_bright_red] [/] [bright_red]bright_red[/]
+  [on_green] [/] [green]green[/]      [on_bright_green] [/] [bright_green]bright_green[/]
+  [on_yellow] [/] [yellow]yellow[/]     [on_bright_yellow] [/] [bright_yellow]bright_yellow[/]
+  [on_blue] [/] [blue]blue[/]       [on_bright_blue] [/] [bright_blue]bright_blue[/]
+  [on_magenta] [/] [magenta]magenta[/]    [on_bright_magenta] [/] [bright_magenta]bright_magenta[/]
+  [on_cyan] [/] [cyan]cyan[/]       [on_bright_cyan] [/] [bright_cyan]bright_cyan[/]
+  [on_white] [/] [white]white[/]      [on_bright_white] [/] [bright_white]bright_white[/]
+
+TEXT

data/examples/8bit-colors.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../lib/terminal'
+
+Terminal.puts <<~TEXT
+
+  ✅ [b bright_green]Terminal.rb[/b] — 8bit-Colors:[/]
+
+  System Colors
+    [on_0] 00 [on_1] 01 [on_2] 02 [on_3] 03 [on_4] 04 [on_5] 05 [on_6] 06 [on_7] 07 [/]
+    [on_8] 08 [on_9] 09 [on_a] 0a [on_b] 0b [on_c] 0c [on_d] 0d [on_e] 0e [on_e] 0f [/]
+
+  Grayscale
+    [on_e8] e8 [on_e9] e9 [on_ea] ea [on_eb] eb [on_ec] ec [on_ed] ed [on_ee] ee [on_ef] ef [on_f0] f0 [on_f1] f1 [on_f2] f2 [on_f3] f3 [/]
+    [on_f4] f4 [on_f5] f5 [on_f6] f6 [on_f7] f7 [on_f8] f8 [on_f9] f9 [on_fa] fa [on_fb] fb [on_fc] fc [on_fd] fd [on_fe] fe [on_ff] ff [/]
+
+  6x6 Color Cubes
+    [on_10] 10 [on_11] 11 [on_12] 12 [on_13] 13 [on_14] 14 [on_15] 15 [/]    [on_16] 16 [on_17] 17 [on_18] 18 [on_19] 19 [on_1a] 1a [on_1b] 1b [/]    [on_1c] 1c [on_1d] 1d [on_1e] 1e [on_1f] 1f [on_20] 20 [on_21] 21 [/]
+    [on_34] 34 [on_35] 35 [on_36] 36 [on_37] 37 [on_38] 38 [on_39] 39 [/]    [on_3a] 3a [on_3b] 3b [on_3c] 3c [on_3d] 3d [on_3e] 3e [on_3f] 3f [/]    [on_40] 40 [on_41] 41 [on_42] 42 [on_43] 43 [on_44] 44 [on_45] 45 [/]
+    [on_58] 58 [on_59] 59 [on_5a] 5a [on_5b] 5b [on_5c] 5c [on_5d] 5d [/]    [on_5e] 5e [on_5f] 5f [on_60] 60 [on_61] 61 [on_62] 62 [on_63] 63 [/]    [on_64] 64 [on_65] 65 [on_66] 66 [on_67] 67 [on_68] 68 [on_69] 69 [/]
+    [on_7c] 7c [on_7d] 7d [on_7e] 7e [on_7f] 7f [on_80] 80 [on_81] 81 [/]    [on_82] 82 [on_83] 83 [on_84] 84 [on_85] 85 [on_86] 86 [on_87] 87 [/]    [on_88] 88 [on_89] 89 [on_8a] 8a [on_8b] 8b [on_8c] 8c [on_8d] 8d [/]
+    [on_a0] a0 [on_a1] a1 [on_a2] a2 [on_a3] a3 [on_a4] a4 [on_a5] a5 [/]    [on_a6] a6 [on_a7] a7 [on_a8] a8 [on_a9] a9 [on_aa] aa [on_ab] ab [/]    [on_ac] ac [on_ad] ad [on_ae] ae [on_af] af [on_b0] b0 [on_b1] b1 [/]
+    [on_c4] c4 [on_c5] c5 [on_c6] c6 [on_c7] c7 [on_c8] c8 [on_c9] c9 [/]    [on_ca] ca [on_cb] cb [on_cc] cc [on_cd] cd [on_ce] ce [on_cf] cf [/]    [on_d0] d0 [on_d1] d1 [on_d2] d2 [on_d3] d3 [on_d4] d4 [on_d5] d5 [/]
+
+    [on_22] 22 [on_23] 23 [on_24] 24 [on_25] 25 [on_26] 26 [on_27] 27 [/]    [on_28] 28 [on_29] 29 [on_2a] 2a [on_2b] 2b [on_2c] 2c [on_2d] 2d [/]    [on_2e] 2e [on_2f] 2f [on_30] 30 [on_31] 31 [on_32] 32 [on_33] 33 [/]
+    [on_46] 46 [on_47] 47 [on_48] 48 [on_49] 49 [on_4a] 4a [on_4b] 4b [/]    [on_4c] 4c [on_4d] 4d [on_4e] 4e [on_4f] 4f [on_50] 50 [on_51] 51 [/]    [on_52] 52 [on_53] 53 [on_54] 54 [on_55] 55 [on_56] 56 [on_57] 57 [/]
+    [on_6a] 6a [on_6b] 6b [on_6c] 6c [on_6d] 6d [on_6e] 6e [on_6f] 6f [/]    [on_70] 70 [on_71] 71 [on_72] 72 [on_73] 73 [on_74] 74 [on_75] 75 [/]    [on_76] 76 [on_77] 77 [on_78] 78 [on_79] 79 [on_7a] 7a [on_7b] 7b [/]
+    [on_8e] 8e [on_8f] 8f [on_90] 90 [on_91] 91 [on_92] 92 [on_93] 93 [/]    [on_94] 94 [on_95] 95 [on_96] 96 [on_97] 97 [on_98] 98 [on_99] 99 [/]    [on_9a] 9a [on_9b] 9b [on_9c] 9c [on_9d] 9d [on_9e] 9e [on_9f] 9f [/]
+    [on_b2] b2 [on_b3] b3 [on_b4] b4 [on_b5] b5 [on_b6] b6 [on_b7] b7 [/]    [on_b8] b8 [on_b9] b9 [on_ba] ba [on_bb] bb [on_bc] bc [on_bd] bd [/]    [on_be] be [on_bf] bf [on_c0] c0 [on_c1] c1 [on_c2] c2 [on_c3] c3 [/]
+    [on_d6] d6 [on_d7] d7 [on_d8] d8 [on_d9] d9 [on_da] da [on_db] db [/]    [on_dc] dc [on_dd] dd [on_de] de [on_df] df [on_e0] e0 [on_e1] e1 [/]    [on_e2] e2 [on_e3] e3 [on_e4] e4 [on_e5] e5 [on_e6] e6 [on_e7] e7 [/]
+
+TEXT

data/examples/attributes.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative '../lib/terminal'
+
+Terminal.puts <<~TEXT
+
+  ✅ [b bright_green]Terminal.rb[/b] — Attributes:[/]
+
+  Terminal.rb supports all well known attributes like [b]bold[/b], [i]italic[/i], [u]underline[/u],
+  [blink]blink[/blink], [inv]invert[/inv] and [strike]strike[/strike]. Other attributes like [faint]faint[/faint], [double_underline]double underline[/], [curly_underline]curly
+  underline[/], [dotted_underline]dotted underline[/], [dashed_underline]dashed underline[/], etc. and alternative fonts like
+  [fraktur]fraktur[/] are not widely used by terminal emulators but supported by Terminal.rb.
+
+TEXT

data/examples/bbcode.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../lib/terminal'
+
+Terminal.puts <<~TEXT
+
+  ✅ [b bright_green]Terminal.rb::Ansi[/b] — BBCode:[/]
+
+              [b]Bold[/b]   [\\b]...[\\/b] or [\\bold]...[\\/bold]
+             [faint]Faint[/faint]   [\\faint]...[\\/faint]
+            [i]Italic[/i]   [\\i]...[\\/i] or [\\|italic]...[\\/italic]
+            [inv]Invert[/inv]   [\\inv]...[\\/inv] or [\\invert]...[\\/invert]
+            [strike]Strike[/strike]   [\\strike]...[\\/strike]
+              [h]Hide[/h]   [\\h]...[\\/h] or [\\hide]...[\\/hide] or [\\conceal]...[\\/conceal]
+        [blink]Slow blink[/blink]   [\\blink]...[\\/blink] or [\\slow_blink]...[\\/slow_blink]
+         [u]Underline[/u]   [\\u]...[\\/u] or [\\underline]...[\\/underline]
+  [uu]Double underline[/uu]   [\\uu]...[\\/uu] or [\\double_underline]...[\\/double_underline]
+   [cu]Curly underline[/cu]   [\\cu]...[\\/cu] or [\\curly_underline]...[\\/curly_underline]
+  [dau]Dashed underline[/dau]   [\\dau]...[\\/dau] or [\\dashed_underline]...[\\/dashed_underline]
+  [dou]Dotted underline[/dou]   [\\dou]...[\\/dou] or [\\dotted_underline]...[\\/dotted_underline]
+           [fraktur]Fraktur[/fraktur]   [\\fraktur]...[\\/fraktur]
+            [framed]Framed[/framed]   [\\framed]...[\\/framed]
+         [encircled]Encircled[/encircled]   [\\encircled]...[\\/encircled]
+         [ovr]Overlined[/ovr]   [\\ovr]...[\\/ovr] or [\\overlined]...[\\/overlined]
+         [sub]Subscript[/sub]   [\\sub]...[\\/sub] or [\\subscript]...[\\/subscript]
+       [sup]Superscript[/sup]   [\\sup]...[\\/sup] or [\\superscript]...[\\/superscript]
+
+TEXT

data/examples/info.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../lib/terminal'
+
+Terminal.puts <<~TEXT
+
+  ✅ [b bright_green]Terminal.rb[/b] — Terminal Info:[/]
+
+         Ansi mode: #{Terminal.ansi? ? '✓' : '𐄂'}
+       Application: #{Terminal.application}
+  Supported Colors: #{Terminal.colors}#{' (truecolor)' if Terminal.true_color?}
+     Terminal Size: #{Terminal.size.join(' x ')}
+   Cursor Position: #{Terminal.pos.join(', ')}
+
+TEXT

data/examples/key-codes.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../lib/terminal'
+
+Terminal.puts <<~TEXT
+
+  ✅ [b bright_green]Terminal.rb[/b] — Key Codes:[/]
+     Press any key to display it's control code and name.
+     [bright_black](Exit with Ctrl+C)[/]
+
+TEXT
+
+Terminal.hide_cursor
+at_exit { Terminal.show_cursor } # required for some terminals :/
+
+while true
+  raw, name = Terminal.read_key(mode: :both)
+  Terminal.puts(
+    "   [blue]: [yellow]#{raw.inspect}  [bold bright_green]#{name}[/]"
+  )
+  break puts if name == 'Ctrl+C'
+end

data/lib/terminal/ansi/attributes.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+module Terminal
+  module Ansi
+    ATTRIBUTES = {
+      '/' => '',
+      '/b' => '22',
+      '/blink' => '25',
+      '/bold' => '22',
+      '/conceal' => '28',
+      '/cu' => '4:0',
+      '/curly_underline' => '4:0',
+      '/dashed_underline' => '4:0',
+      '/dau' => '4:0',
+      '/dim' => '22',
+      '/dotted_underline' => '4:0',
+      '/dou' => '4:0',
+      '/double_underline' => '24',
+      '/encircled' => '54',
+      '/faint' => '22',
+      '/fraktur' => '23',
+      '/framed' => '54',
+      '/h' => '28',
+      '/hide' => '28',
+      '/i' => '23',
+      '/inv' => '27',
+      '/invert' => '27',
+      '/italic' => '23',
+      '/overlined' => '55',
+      '/ovr' => '55',
+      '/proportional' => '50',
+      '/slow_blink' => '25',
+      '/spacing' => '50',
+      '/strike' => '29',
+      '/sub' => '75',
+      '/subscript' => '75',
+      '/sup' => '75',
+      '/superscript' => '75',
+      '/u' => '24',
+      '/underline' => '24',
+      '/uu' => '24',
+      'b' => '1',
+      'blink' => '5',
+      'blink_off' => '25',
+      'bold' => '1',
+      'bold_off' => '22',
+      'conceal' => '8',
+      'cu' => '4:3',
+      'curly_underline' => '4:3',
+      'curly_underline_off' => '4:0',
+      'dashed_underline' => '4:5',
+      'dashed_underline_off' => '4:0',
+      'dau' => '4:5',
+      'default_font' => '10',
+      'dim' => '2',
+      'dotted_underline' => '4:4',
+      'dotted_underline_off' => '4:0',
+      'dou' => '4:4',
+      'double_underline' => '21',
+      'double_underline_off' => '24',
+      'encircled' => '52',
+      'encircled_off' => '54',
+      'faint' => '2',
+      'faint_off' => '22',
+      'font1' => '11',
+      'font2' => '12',
+      'font3' => '13',
+      'font4' => '14',
+      'font5' => '15',
+      'font6' => '16',
+      'font7' => '17',
+      'font8' => '18',
+      'font9' => '19',
+      'fraktur' => '20',
+      'fraktur_off' => '23',
+      'framed' => '51',
+      'framed_off' => '54',
+      'h' => '8',
+      'hide' => '8',
+      'hide_off' => '28',
+      'i' => '3',
+      'inv' => '7',
+      'invert' => '7',
+      'invert_off' => '27',
+      'italic' => '3',
+      'italic_off' => '23',
+      'overlined' => '53',
+      'overlined_off' => '55',
+      'ovr' => '53',
+      'primary_font' => '10',
+      'proportional' => '26',
+      'proportional_off' => '50',
+      'rapid_blink' => '6',
+      'reset' => '',
+      'reveal' => '28',
+      'slow_blink' => '5',
+      'spacing' => '26',
+      'strike' => '9',
+      'strike_off' => '29',
+      'sub' => '74',
+      'subscript' => '74',
+      'subscript_off' => '75',
+      'sup' => '73',
+      'superscript' => '73',
+      'superscript_off' => '75',
+      'u' => '4',
+      'underline' => '4',
+      'underline_off' => '24',
+      'uu' => '21'
+    }.freeze
+
+    COLORS = {
+      '/bg' => '49',
+      '/fg' => '39',
+      '/ul' => '59',
+      'bg_black' => '40',
+      'bg_blue' => '44',
+      'bg_bright_black' => '100',
+      'bg_bright_blue' => '104',
+      'bg_bright_cyan' => '106',
+      'bg_bright_green' => '102',
+      'bg_bright_magenta' => '105',
+      'bg_bright_red' => '101',
+      'bg_bright_white' => '107',
+      'bg_bright_yellow' => '103',
+      'bg_cyan' => '46',
+      'bg_default' => '49',
+      'bg_green' => '42',
+      'bg_magenta' => '45',
+      'bg_red' => '41',
+      'bg_white' => '47',
+      'bg_yellow' => '43',
+      'black' => '30',
+      'blue' => '34',
+      'bright_black' => '90',
+      'bright_blue' => '94',
+      'bright_cyan' => '96',
+      'bright_green' => '92',
+      'bright_magenta' => '95',
+      'bright_red' => '91',
+      'bright_white' => '97',
+      'bright_yellow' => '93',
+      'cyan' => '36',
+      'default' => '39',
+      'fg_black' => '30',
+      'fg_blue' => '34',
+      'fg_bright_black' => '90',
+      'fg_bright_blue' => '94',
+      'fg_bright_cyan' => '96',
+      'fg_bright_green' => '92',
+      'fg_bright_magenta' => '95',
+      'fg_bright_red' => '91',
+      'fg_bright_white' => '97',
+      'fg_bright_yellow' => '93',
+      'fg_cyan' => '36',
+      'fg_default' => '39',
+      'fg_green' => '32',
+      'fg_magenta' => '35',
+      'fg_red' => '31',
+      'fg_white' => '37',
+      'fg_yellow' => '33',
+      'green' => '32',
+      'magenta' => '35',
+      'on_black' => '40',
+      'on_blue' => '44',
+      'on_bright_black' => '100',
+      'on_bright_blue' => '104',
+      'on_bright_cyan' => '106',
+      'on_bright_green' => '102',
+      'on_bright_magenta' => '105',
+      'on_bright_red' => '101',
+      'on_bright_white' => '107',
+      'on_bright_yellow' => '103',
+      'on_cyan' => '46',
+      'on_default' => '49',
+      'on_green' => '42',
+      'on_magenta' => '45',
+      'on_red' => '41',
+      'on_white' => '47',
+      'on_yellow' => '43',
+      'red' => '31',
+      'ul_black' => '58;2;0;0;0',
+      'ul_blue' => '58;2;0;0;128',
+      'ul_bright_black' => '58;2;64;64;64',
+      'ul_bright_blue' => '58;2;0;0;255',
+      'ul_bright_cyan' => '58;2;0;255;255',
+      'ul_bright_green' => '58;2;0;255;0',
+      'ul_bright_magenta' => '58;2;255;0;255',
+      'ul_bright_red' => '58;2;255;0;0',
+      'ul_bright_white' => '58;2;255;255;255',
+      'ul_bright_yellow' => '58;2;255;255;0',
+      'ul_cyan' => '58;2;0;128;128',
+      'ul_default' => '59',
+      'ul_green' => '58;2;0;128;0',
+      'ul_magenta' => '58;2;128;0;128',
+      'ul_red' => '58;2;128;0;0',
+      'ul_white' => '58;2;128;128;128',
+      'ul_yellow' => '58;2;128;128;0',
+      'white' => '37',
+      'yellow' => '33'
+    }.freeze
+
+    ATTRIBUTES_S =
+      ATTRIBUTES.transform_keys(&:to_sym).compare_by_identity.freeze
+    COLORS_S = COLORS.transform_keys(&:to_sym).compare_by_identity.freeze
+
+    private_constant :ATTRIBUTES, :COLORS, :ATTRIBUTES_S, :COLORS_S
+  end
+end