terminal_rb 0.12.2 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76a55505ad930b5c59af396e566e1079e3aa0c339d4ef68d5adf559c243c549a
-  data.tar.gz: 87882ec5820678e2f657d739588cd8502167aa68c5fffad47296903b387ced94
+  metadata.gz: 756d1e0e016472a063f9d64650f4731ef6e8fe272d6a84c4e001119f050af3ea
+  data.tar.gz: 74c24ba64e08e6dc79605c17b0ded59ecb8784a45f95dbe5be7f231c889fdab7
 SHA512:
-  metadata.gz: e9fffe327952f951928e43e2b29aec523f87794c499b1b9c81a483a529653c4434f3422e0a32b0ed2c08a3886a50a3f74f10704a50c5397867c470cc97a974ac
-  data.tar.gz: fee9b96d3b899667b772fb68590ecea6476c904279b374132d30fca959f5c1cc4559709a600302cb71aeb78eb4a9b128cc7167a64efd835ddc96e93f10c5b85a
+  metadata.gz: 68bb81c425cb5df44650acc351a28cbbb3eccaea53b405167f1207ba3dc528093de6322bac087fad9301da7470711b4cd399f120233637e9b92f1727e9e2d4c9
+  data.tar.gz: 9e855ec0401d22c615fd6ff25e2adae7717ecbf3578ea40425e5ef580b9520ee23130c8d49814034f682590166d2319070c17c18407962fc8782b18c1fffe4fa

data/examples/bbcode.rb

@@ -7,12 +7,13 @@ 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]
+             [dim]Dim[/dim]     [\\d]...[\\/d] or [\\dim]...[\\/dim]
+            [i]Italic[/i]   [\\i]...[\\/i] or [\\italic]...[\\/italic]
+         [u]Underline[/u]   [\\u]...[\\/u] or [\\|undeline]...[\\/undeline]
             [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]
+            [strike]Strike[/strike]   [\\strike]...[\\/strike]
+             [blink]Blink[/blink]   [\\blink]...[\\/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]

data/lib/terminal/ansi.rb

@@ -12,7 +12,7 @@ module Terminal
       #
       # @attribute [r] attributes
       # @return [Array<Symbol>] all attribute names
-      def attributes = @attr_sym.keys
+      def attributes = @attributes.dup
 
       # Supported 3/4-bit color names.
       #
@@ -20,7 +20,7 @@ module Terminal
       #
       # @attribute [r] colors
       # @return [Array<Symbol>] all color names
-      def colors = @colors_sym.keys
+      def colors = @colors.dup
 
       # Supported basic 24-bit (Kitty compatible) color names.
       #
@@ -99,10 +99,9 @@ module Terminal
             .map do |arg|
               case arg
               when String
-                @attr[arg] || @colors[arg] || _color(arg) || _invalid(arg)
+                @attr_map[arg] || _invalid(arg)
               when Symbol
-                @attr_sym[arg] || @colors_sym[arg] || _color(arg) ||
-                  _invalid(arg)
+                @attrs_map[arg] || _invalid(arg)
               when (0..255)
                 "38;5;#{arg}"
               when (256..511)
@@ -179,11 +178,7 @@ module Terminal
       def try_convert(attributes, separator: ' ')
         return unless attributes
         return if (attributes = attributes.to_s.split(separator)).empty?
-        "\e[#{
-          attributes
-            .map! { @attr[_1] || @colors[_1] || _color(_1) || return }
-            .join(';')
-        }m"
+        "\e[#{attributes.map! { @attr_map[_1] || return }.join(';')}m"
       end
 
       # Test if all given attributes are valid.
@@ -196,9 +191,9 @@ module Terminal
         attributes.all? do |arg|
           case arg
           when String
-            @attr[arg] || @colors[arg] || _color(arg)
+            @attr_map[arg]
           when Symbol
-            @attr_sym[arg] || @colors_sym[arg] || _color(arg)
+            @attrs_map[arg]
           when (0..767)
             true
           end
@@ -249,7 +244,7 @@ module Terminal
           match = Regexp.last_match(1) or next match_str
           next "[#{match[1..]}]" if match[0] == '\\'
           next match_str if (match = match.split).empty?
-          next if match.all? { @attr[_1] || @colors[_1] || _color(_1) }
+          next if match.all? { @attr_map[_1] }
           match_str
         end
       end
@@ -277,7 +272,7 @@ module Terminal
             match = Regexp.last_match(1) or next match_str
             next "[#{match[1..]}]" if match[0] == '\\'
             next match_str if (match = match.split).empty?
-            next if match.all? { @attr[_1] || @colors[_1] || _color(_1) }
+            next if match.all? { @attr_map[_1] }
             match_str
           end
         str.index("\e") ? str.gsub!(@re_test, '') : str
@@ -586,9 +581,9 @@ module Terminal
       end
     end
 
-    @cbase =
-      { 'bg' => '48', 'on' => '48', 'ul' => '58' }.tap { _1.default = '38' }
-        .freeze
+    @cbase = { 'bg' => '48', 'on' => '48', 'ul' => '58' }
+    @cbase.default = '38'
+    @cbase.freeze
 
     @re_test =
       /
@@ -599,7 +594,195 @@ module Terminal
 
     @re_bbcode = /(?:\[((?~[\[\]]))\])/
 
-    require_relative 'ansi/attributes'
+    attr_map = {
+      '' => 'reset',
+      '1' => 'bold',
+      '2' => 'faint',
+      '3' => 'italic',
+      '4' => 'underline',
+      '5' => 'blink',
+      '6' => 'rapid_blink',
+      '7' => 'invert',
+      '8' => 'hide',
+      '9' => 'strike',
+      '10' => 'primary_font',
+      '11' => 'font1',
+      '12' => 'font2',
+      '13' => 'font3',
+      '14' => 'font4',
+      '15' => 'font5',
+      '16' => 'font6',
+      '17' => 'font7',
+      '18' => 'font8',
+      '19' => 'font9',
+      '20' => 'fraktur',
+      '21' => 'double_underline',
+      '22' => 'bold_off', # faint_off
+      '23' => 'italic_off', # fraktur_off
+      '24' => 'underline_off', # double_underline_off
+      '25' => 'blink_off', # rapid_blink_off
+      '26' => 'proportional',
+      '27' => 'invert_off',
+      '28' => 'hide_off',
+      '29' => 'strike_off',
+      # colors ...
+      '50' => 'proportional_off',
+      '51' => 'framed',
+      '52' => 'encircled',
+      '53' => 'overlined',
+      '54' => 'framed_off', # encircled_off
+      '55' => 'overlined_off',
+      # ...
+      '73' => 'superscript',
+      '74' => 'subscript',
+      '75' => 'superscript_off', # subscript_off
+      # special underline
+      '4:3' => 'curly_underline',
+      '4:4' => 'dotted_underline',
+      '4:5' => 'dashed_underline',
+      '4:0' => 'curly_underline_off' # dotted_underline_off, dashed_underline_off
+    }.invert
+    attr_alias = ->(t, s) { attr_map[t] = attr_map[s] }
+
+    clr_map = {
+      # foreground
+      '30' => 'black',
+      '31' => 'red',
+      '32' => 'green',
+      '33' => 'yellow',
+      '34' => 'blue',
+      '35' => 'magenta',
+      '36' => 'cyan',
+      '37' => 'white',
+      '39' => 'default', # reset
+      # background
+      '40' => 'on_black',
+      '41' => 'on_red',
+      '42' => 'on_green',
+      '43' => 'on_yellow',
+      '44' => 'on_blue',
+      '45' => 'on_magenta',
+      '46' => 'on_cyan',
+      '47' => 'on_white',
+      '49' => 'on_default', # reset
+      # underline
+      '58;2;0;0;0' => 'ul_black',
+      '58;2;0;0;128' => 'ul_blue',
+      '58;2;0;0;255' => 'ul_bright_blue',
+      '58;2;0;128;0' => 'ul_green',
+      '58;2;0;128;128' => 'ul_cyan',
+      '58;2;0;255;0' => 'ul_bright_green',
+      '58;2;0;255;255' => 'ul_bright_cyan',
+      '58;2;128;0;0' => 'ul_red',
+      '58;2;128;0;128' => 'ul_magenta',
+      '58;2;128;128;0' => 'ul_yellow',
+      '58;2;128;128;128' => 'ul_white',
+      '58;2;255;0;0' => 'ul_bright_red',
+      '58;2;255;0;255' => 'ul_bright_magenta',
+      '58;2;255;255;0' => 'ul_bright_yellow',
+      '58;2;255;255;255' => 'ul_bright_white',
+      '58;2;64;64;64' => 'ul_bright_black',
+      '59' => 'ul_default', # reset
+      # bright foreground
+      '90' => 'bright_black',
+      '91' => 'bright_red',
+      '92' => 'bright_green',
+      '93' => 'bright_yellow',
+      '94' => 'bright_blue',
+      '95' => 'bright_magenta',
+      '96' => 'bright_cyan',
+      '97' => 'bright_white',
+      # bright background
+      '100' => 'on_bright_black',
+      '101' => 'on_bright_red',
+      '102' => 'on_bright_green',
+      '103' => 'on_bright_yellow',
+      '104' => 'on_bright_blue',
+      '105' => 'on_bright_magenta',
+      '106' => 'on_bright_cyan',
+      '107' => 'on_bright_white'
+    }.invert
+    clr_alias = ->(t, s) { clr_map[t] = clr_map[s] }
+
+    %w[black red green yellow blue magenta cyan white].each do |name|
+      clr_alias["fg_#{name}", name]
+      clr_alias["bg_#{name}", "on_#{name}"]
+      clr_alias["fg_bright_#{name}", "bright_#{name}"]
+      clr_alias["bg_bright_#{name}", "on_bright_#{name}"]
+    end
+    clr_alias['fg_default', 'default']
+    clr_alias['bg_default', 'on_default']
+
+    attr_alias['faint_off', 'bold_off']
+    attr_alias['fraktur_off', 'italic_off']
+    attr_alias['double_underline_off', 'underline_off']
+    attr_alias['rapid_blink_off', 'blink_off']
+    attr_alias['encircled_off', 'framed_off']
+    attr_alias['subscript_off', 'superscript_off']
+    attr_alias['dotted_underline_off', 'curly_underline_off']
+    attr_alias['dashed_underline_off', 'curly_underline_off']
+
+    # extra aliases:
+    attr_alias['off', 'reset']
+    attr_alias['dim', 'faint']
+    attr_alias['dim_off', 'faint_off']
+    attr_alias['conceal', 'hide']
+    attr_alias['conceal_off', 'hide_off']
+    attr_alias['reveal', 'hide_off']
+    attr_alias['spacing', 'proportional']
+    attr_alias['spacing_off', 'proportional_off']
+
+    # shortcuts:
+    attr_alias['b', 'bold']
+    attr_alias['d', 'dim']
+    attr_alias['i', 'italic']
+    attr_alias['u', 'underline']
+    attr_alias['inv', 'invert']
+    attr_alias['h', 'hide']
+    attr_alias['s', 'strike']
+    attr_alias['uu', 'double_underline']
+    attr_alias['ovr', 'overlined']
+    attr_alias['sup', 'superscript']
+    attr_alias['sub', 'subscript']
+    attr_alias['cu', 'curly_underline']
+    attr_alias['dau', 'dashed_underline']
+    attr_alias['dou', 'dotted_underline']
+
+    @colors = clr_map.keys.map!(&:to_sym).sort!.freeze
+    @attributes = attr_map.keys.map!(&:to_sym).sort!.freeze
+
+    # shortcuts disable:
+    attr_map.keys.each do |n|
+      attr_alias["/#{n.delete_suffix('_off')}", n] if n.end_with?('_off')
+    end
+    attr_alias['/b', 'bold_off']
+    attr_alias['/d', 'dim_off']
+    attr_alias['/i', 'italic_off']
+    attr_alias['/u', 'underline_off']
+    attr_alias['/inv', 'invert_off']
+    attr_alias['/h', 'hide_off']
+    attr_alias['/s', 'strike_off']
+    attr_alias['/uu', 'double_underline_off']
+    attr_alias['/ovr', 'overlined_off']
+    attr_alias['/sup', 'superscript_off']
+    attr_alias['/sub', 'subscript_off']
+    attr_alias['/cu', 'curly_underline_off']
+    attr_alias['/dau', 'dashed_underline_off']
+    attr_alias['/dou', 'dotted_underline_off']
+
+    # additional shortcuts disable:
+    attr_alias['/', 'reset']
+    attr_map['/fg'] = clr_map['default']
+    attr_map['/bg'] = clr_map['on_default']
+    attr_map['/ul'] = clr_map['ul_default']
+
+    @attr_map = Hash.new { _color(_2) }
+    attr_map.merge!(clr_map).keys.sort!.each { @attr_map[_1] = attr_map[_1] }
+    @attr_map.freeze
+
+    @attrs_map = @attr_map.transform_keys(&:to_sym)
+    @attrs_map.default_proc = @attr_map.default_proc
+    @attrs_map.compare_by_identity.freeze
 
     autoload :NAMED_COLORS, "#{__dir__}/ansi/named_colors.rb"
     private_constant :NAMED_COLORS
@@ -689,14 +872,6 @@ module Terminal
     #
     #   def set_scroll_region(top = nil, bottom = nil) = "\e[#{top};#{bottom}r"
 
-    # @comment TODO:
-    #   https://sw.kovidgoyal.net/kitty/desktop-notifications
-    #   https://sw.kovidgoyal.net/kitty/pointer-shapes
-    #   https://sw.kovidgoyal.net/kitty/unscroll
-    #   https://sw.kovidgoyal.net/kitty/color-stack
-    #   https://sw.kovidgoyal.net/kitty/deccara
-    #   https://sw.kovidgoyal.net/kitty/clipboard
-
     # @comment other:
     #   "\eE" same as "\r\n"
     #   "\eD" same as "\n" but preserves X coord
@@ -705,5 +880,13 @@ module Terminal
     #   "\e[21t report window’s title as ESC ] l title ESC \"
     #   "\e[?1004h" report focus lost "\e[O" and focus get "\e[I"
     #     (disable by "\e[?1004l")
+
+    # @comment TODO:
+    #   https://sw.kovidgoyal.net/kitty/desktop-notifications
+    #   https://sw.kovidgoyal.net/kitty/pointer-shapes
+    #   https://sw.kovidgoyal.net/kitty/unscroll
+    #   https://sw.kovidgoyal.net/kitty/color-stack
+    #   https://sw.kovidgoyal.net/kitty/deccara
+    #   https://sw.kovidgoyal.net/kitty/clipboard
   end
 end

data/lib/terminal/version.rb

@@ -2,5 +2,5 @@
 
 module Terminal
   # The version number of the gem.
-  VERSION = '0.12.2'
+  VERSION = '0.13.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terminal_rb
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.13.0
 platform: ruby
 authors:
 - Mike Blumtritt
@@ -29,7 +29,6 @@ files:
 - examples/key-codes.rb
 - lib/terminal.rb
 - lib/terminal/ansi.rb
-- lib/terminal/ansi/attributes.rb
 - lib/terminal/ansi/named_colors.rb
 - lib/terminal/detect.rb
 - lib/terminal/input.rb

data/lib/terminal/ansi/attributes.rb

@@ -1,206 +0,0 @@
-# frozen_string_literal: true
-
-module Terminal
-  module Ansi
-    @attr = {
-      '/' => '',
-      '/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
-
-    @attr_sym = @attr.transform_keys(&:to_sym).compare_by_identity.freeze
-    @colors_sym = @colors.transform_keys(&:to_sym).compare_by_identity.freeze
-  end
-end