terminal_rb 0.12.0 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 357e535e9317609160d54c93a2a106a2a39d86a4c6740e93bbbccc01a2fcd42f
-  data.tar.gz: 746ddada0e50edf61c7220d144d75de46530056138e8a9d1bc1793098fe8a824
+  metadata.gz: 76a55505ad930b5c59af396e566e1079e3aa0c339d4ef68d5adf559c243c549a
+  data.tar.gz: 87882ec5820678e2f657d739588cd8502167aa68c5fffad47296903b387ced94
 SHA512:
-  metadata.gz: 90b2db6aa0cd6d3351ae8b7ec0f8df30a37e7bdad87050def22c47cbf48c94246efe927b15a612adbc713ff8b34971adc973721172da4702a1c7a433446db5e9
-  data.tar.gz: f35bafc5ecc52b59360ecec503e32ed173486fa81b42eec99912ef545d64be888ff01f9d584c3a6f34dd45505d449ece87ae033e61f0bb0e9637d481ddb7f310
+  metadata.gz: e9fffe327952f951928e43e2b29aec523f87794c499b1b9c81a483a529653c4434f3422e0a32b0ed2c08a3886a50a3f74f10704a50c5397867c470cc97a974ac
+  data.tar.gz: fee9b96d3b899667b772fb68590ecea6476c904279b374132d30fca959f5c1cc4559709a600302cb71aeb78eb4a9b128cc7167a64efd835ddc96e93f10c5b85a

data/README.md

@@ -14,7 +14,7 @@ Terminal access with super fast ANSI control codes support and [BBCode-like](htt
 - [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
-- generation of word-by-word wrapped text
+- word-wise line break generator
 - supports [CSIu protocol](https://sw.kovidgoyal.net/kitty/keyboard-protocol)
 
 ## Examples

data/lib/terminal/input/{as_key_event.rb → key_event.rb}

@@ -1,84 +1,73 @@
 # frozen_string_literal: true
 
 module Terminal
-  module AsKeyEvent
+  #
+  # Key event reported from {read_key_event}.
+  #
+  class KeyEvent
     class << self
+      # @attribute [w] caching
+      # @return [true, false] whether KeyCodes should be cached
+      def caching = !!@cache
+
+      # @attribute [w] caching
+      def caching=(value)
+        if value
+          @cache ||= {}
+        else
+          @cache = nil
+        end
+      end
+
+      # Translate a keyboard input string into a related KeyEvent
+      #
+      # @param [String] raw keyboard input
+      # @return [KeyEvent] related key event
       def [](raw)
-        return KeyEvent.new(raw, *@single_key[raw.ord]) if raw.size == 1
-        return KeyEvent.unknown(raw) if raw[0] != "\e"
+        return new(raw, *@single_key[raw.ord]) if raw.size == 1
+        return unknown(raw) if raw[0] != "\e"
         return esc1(raw, raw[1]) if raw.size == 2 # ESC ?
         case raw[1]
         when "\e" # ESC ESC ...
           return esc_esc(raw)
         when 'O'
-          if raw.size == 3
-            # ESC O ?
-            return KeyEvent.new(raw, *@ss3[raw[2].ord])
-          end
-        when '[' # ESC [ ...
-          if raw.size == 3
-            # ESC [ ?
-            return KeyEvent.new(raw, *@ss3[raw[2].ord])
-          end
-          if raw.size == 6 && raw[2] == 'M'
-            # ESC [ M b c r
+          return new(raw, *@ss3[raw[2].ord]) if raw.size == 3 # ESC O ?
+        when '['
+          return new(raw, *@ss3[raw[2].ord]) if raw.size == 3 # ESC [ ?
+          if raw.size == 6 && raw[2] == 'M' # ESC [ M b c r
             return mouse_vt200(raw)
           end
           return csi1(raw) if raw.start_with?("\e[1;") # ESC [ 1 ; ...
           case raw[-1]
-          when '~'
+          when '~' # ESC [ ... ~
             return legacy(raw)
-          when 'u'
+          when 'u' # ESC [ ... u
             return csi_u(raw)
-          when 'M'
+          when 'M' # ESC [ ... M
             return raw[2] == '<' ? mouse_sgr(raw) : mouse_urxvt(raw)
-          when 'm'
+          when 'm' # ESC [ ... m
             return mouse_sgr(raw) if raw[2] == '<'
           end
         end
-        KeyEvent.unknown(raw)
-      end
-
-      private
-
-      def mouse_vt200(raw)
-        # ESC [ M b c r
-        mouse_event(raw, *raw[3..].chars.map! { _1.ord - 32 })
+        unknown(raw)
       end
 
-      def mouse_sgr(raw)
-        # ESC [ < <code> ; <col> ; <row> M
-        # ESC [ < <code> ; <col> ; <row> m
-        return KeyEvent.unknown(raw) if raw.size < 8
-        bcr = raw[3..-2].split(';', 3).map!(&:to_i)
-        bcr.size == 3 ? mouse_event(raw, *bcr) : KeyEvent.unknown(raw)
+      # @!visibility private
+      def new(raw, key = raw, modifier = 0, extra = nil)
+        @cache ? (@cache[raw] ||= super.freeze) : super.freeze
       end
 
-      def mouse_urxvt(raw)
-        # ESC [ <code> ; <col> ; <row> M
-        return KeyEvent.unknown(raw) if raw.size < 8
-        bcr = raw[2..-2].split(';', 3).map!(&:to_i)
-        bcr.size == 3 ? mouse_event(raw, *bcr) : KeyEvent.unknown(raw)
-      end
+      private
 
-      def mouse_event(raw, btn, col, row)
-        return KeyEvent.unknown(raw) if btn < 0 || col < 1 || row < 1
-        kind = btn & 3
-        ka = btn >= 64 ? @mouse_wheel_kind : @mouse_kind
-        btn -= kind
-        modifier = btn.allbits?(4) ? 1 : 0
-        modifier += 2 if btn.allbits?(8)
-        modifier += 4 if btn.allbits?(16)
-        KeyEvent.new(raw, ka[kind], modifier, [col, row])
-      end
+      def unknown(raw) = new(raw, nil)
 
       def csi_u(raw)
         # ESC [ <code> u
         # ESC [ <code> ; <modifier> u
-        return KeyEvent.unknown(raw) if raw.size < 4
+        return unknown(raw) if raw.size < 4
         idx = raw.index(';')
         code = raw[2..(idx ? idx - 1 : -2)].to_i
-        KeyEvent.new(
+        new(
           raw,
           @csiu[code] || code.chr(Encoding::UTF_8),
           idx ? [raw[(idx + 1)..-2].to_i - 1, 0].max : 0
@@ -88,9 +77,9 @@ module Terminal
       def legacy(raw)
         # ESC [ <code> ~
         # ESC [ <code> ; <modifier> ~
-        return KeyEvent.unknown(raw) if raw.size < 4
+        return unknown(raw) if raw.size < 4
         idx = raw.index(';')
-        KeyEvent.new(
+        new(
           raw,
           @csi[raw[2..(idx ? idx - 1 : -2)].to_i],
           idx ? [raw[(idx + 1)..-2].to_i - 1, 0].max : 0
@@ -100,26 +89,135 @@ module Terminal
       def csi1(raw)
         # ESC [ 1 ; [~ABCDEFHPQRS]
         # ESC [ 1 ; <modifier> [~ABCDEFHPQRS]
-        return KeyEvent.unknown(raw) if raw.size < 5
+        return unknown(raw) if raw.size < 5
         key, modifier = @ss3[raw[-1].ord]
         modifier ||= 0
-        return KeyEvent.new(raw, nil, modifier) unless key
+        return new(raw, nil, modifier) unless key
         modifier |= [raw[4..-2].to_i - 1, 0].max if raw.size > 5
-        KeyEvent.new(raw, key, modifier)
+        new(raw, key, modifier)
       end
 
       def esc_esc(raw)
         return esc1(raw, raw[2]) if raw.size == 3 # ESC ESC ?
         ret = self[raw[1..]]
-        KeyEvent.new(raw, ret.key, ret.modifier | 2) # ESC ESC ...
+        new(raw, ret.key, ret.modifier | 2) # ESC ESC ...
       end
 
       def esc1(raw, char)
         key, modifier = @esc1[char.ord]
-        KeyEvent.new(raw, key || char, modifier || 2)
+        new(raw, key || char, modifier || 2)
+      end
+
+      def mouse_vt200(raw)
+        # ESC [ M b c r
+        mouse_event(raw, *raw[3..].chars.map! { _1.ord - 32 })
+      end
+
+      def mouse_sgr(raw)
+        # ESC [ < <code> ; <col> ; <row> M
+        # ESC [ < <code> ; <col> ; <row> m
+        return unknown(raw) if raw.size < 8
+        bcr = raw[3..-2].split(';', 3).map!(&:to_i)
+        bcr.size == 3 ? mouse_event(raw, *bcr) : unknown(raw)
+      end
+
+      def mouse_urxvt(raw)
+        # ESC [ <code> ; <col> ; <row> M
+        return unknown(raw) if raw.size < 8
+        bcr = raw[2..-2].split(';', 3).map!(&:to_i)
+        bcr.size == 3 ? mouse_event(raw, *bcr) : unknown(raw)
+      end
+
+      def mouse_event(raw, btn, col, row)
+        return unknown(raw) if btn < 0 || col < 1 || row < 1
+        key, btn = kind_of_mouse_event(btn)
+        modifier = btn.allbits?(4) ? 1 : 0
+        modifier += 2 if btn.allbits?(8)
+        modifier += 4 if btn.allbits?(16)
+        new(raw, key, modifier, [col, row])
+      end
+
+      def mouse_event_key(btn)
+        kind = btn & 3
+        key = (btn >= 64 ? @mouse_wheel_kind : @mouse_kind)[kind]
+        # TODO: what about btn >= 128 for more mouse wheel events?
+        [btn - kind, key]
       end
     end
 
+    # Event string received from standard input.
+    # This can be a simple value like `"a"`or more complex input like
+    # `"\e[24;6~"` (for Shift+Ctrl+F12).
+    #
+    # @return [String] received event string
+    attr_reader :raw
+
+    # Pressed key without any modifiers.
+    # This can be a string for simple keys like `"a"` or a Symbol like `:F12`.
+    # @return [String, Symbol] key without modifiers
+    attr_reader :key
+
+    # Modifier key code. This represents the encoded key modifier like `Shift`
+    # or `Alt`.
+    #
+    # @return [Integer] modifier key code
+    attr_reader :modifier
+
+    # @comment for mouse events
+    # @!visibility private
+    attr_reader :extra
+
+    # Name of the key event.
+    # This can be a simple name like `"a"` or `"Shift+Ctrl+F12"` for combined
+    # keys.
+    #
+    # @return [String] key name
+    attr_reader :name
+
+    # @attribute [r] modifier?
+    # @return [true, false] whether a key modifier was pressed
+    def modifier? = @modifier != 0
+
+    # @attribute [r] simple?
+    # @return [true, false] whether a simple key was pressed
+    def simple? = @raw == @name
+
+    # All pressed keys.
+    # This is composed by all {modifier} and the {key}.
+    #
+    # @return [Array<Symbol, String>] all pressed keys
+    def to_a = @ary.dup
+
+    # @!visibility private
+    def to_ary = simple? ? [@raw] : [@raw, @name]
+
+    # @!visibility private
+    def to_s = @name.dup
+
+    # @!visibility private
+    def inspect = "<#{self.class.name} #{to_ary.map(&:inspect).join(' ')}>"
+
+    # @!visibility private
+    def freeze
+      @raw.freeze
+      @key.freeze
+      @extra.freeze
+      @name.freeze
+      super
+    end
+
+    private
+
+    def initialize(raw, key, modifier, extra)
+      @raw = raw
+      @key = key
+      @modifier = modifier
+      @extra = extra
+      @ary = MODIFIERS.filter_map { |b, n| n if modifier.allbits?(b) }
+      @ary << key if key
+      @name = @ary.join('+') # .encode(Encoding::UTF_8)
+    end
+
     @mouse_kind = %i[
       MButton1
       MButton2
@@ -312,6 +410,19 @@ module Terminal
       0x20 => :Space,
       0x7f => :Back
     }.compare_by_identity.freeze
+
+    @cache = {}
+
+    MODIFIERS = {
+      1 => :Shift,
+      2 => :Alt,
+      4 => :Ctrl,
+      8 => :Super,
+      16 => :Hyper,
+      32 => :Meta,
+      64 => :Caps,
+      128 => :Num
+    }.freeze
+    private_constant :MODIFIERS
   end
-  private_constant :AsKeyEvent
 end

data/lib/terminal/input.rb

@@ -9,7 +9,8 @@ module Terminal
     # @attribute [r] input_mode
     #
     # @return [:csi_u]
-    #   when CSIu protocol support
+    #   when [CSIu protocol](https://sw.kovidgoyal.net/kitty/keyboard-protocol)
+    #   supported
     # @return [:legacy]
     #   for standard terminal
     # @return [:dumb]
@@ -25,13 +26,13 @@ module Terminal
     # The input will be returned as named key codes like "Ctrl+c" by default.
     # This can be changed by `mode`.
     #
-    # @deprecated Use arther {read_key_event} for better input handling.
+    # @deprecated Use rather {read_key_event} for better input handling.
     #
     # @param [:named, :raw, :both] mode modifies the result
     # @return [String] key code ("as is") in `:raw` mode
     # @return [String] key name in `:named` mode
     # @return [[String, String]] key code and key name in `:both` mode
-    # @return [nil] in any error case
+    # @return [nil] in error case
     def read_key(mode: :named)
       event = read_key_event or return
       return event.raw if mode == :raw
@@ -42,7 +43,7 @@ module Terminal
     # Read next {KeyEvent} from standard input.
     #
     # @return [KeyEvent] next event
-    # @return [nil] on any error
+    # @return [nil] in error case
     def read_key_event
       case input_mode
       when :dumb
@@ -51,25 +52,24 @@ module Terminal
         KeyEvent.new(raw, *opts)
       when :csi_u, :legacy
         # raw = with_mouse ? read_tty_with_mouse : read_tty
-        raw = read_tty
-        AsKeyEvent[raw] if raw
+        KeyEvent[raw] if (raw = read_tty)
       end
     end
 
     private
 
     def find_input_mode
+      # order is important!
       im = ENV['INPUT_MODE']
       return :dumb if im == 'dumb'
       return :legacy if im == 'legacy'
       return :dumb unless STDIN.tty?
       if ansi? && _write("\e[>1u\e[?u\e[c") && csi_u?
         at_exit { _write("\e[<u") }
-        :csi_u
-      else
-        :legacy
+        return :csi_u
       end
-    rescue SignalException
+      :legacy
+    rescue Interrupt
       :legacy
     rescue IOError, SystemCallError
       :error
@@ -90,7 +90,7 @@ module Terminal
       nil
     end
 
-    def read_tty_with_mouse(any_move: false)
+    def read_tty_with_mouse(each_move: false)
       # highlight: '1001'
       # drag: '1002'
       # move: '1003'
@@ -98,7 +98,7 @@ module Terminal
       # sgr: '1006'
       # urxvt: '1015'
       # pixel: '1016'
-      opts = any_move ? '1000;1003;1006;1015' : '1000;1006;1015'
+      opts = each_move ? '1000;1003;1006;1015' : '1000;1006;1015'
       opts = _write("\e[?#{opts}h") ? "\e[?#{opts}l" : nil
       read_tty
     ensure
@@ -106,13 +106,13 @@ module Terminal
     end
 
     def read_tty
-      key = STDIN.getch
-      return key if key != "\e"
-      while (nc = STDIN.read_nonblock(1, exception: false))
-        String === nc ? key << nc : break
+      if (key = STDIN.getch) == "\e"
+        while (nc = STDIN.read_nonblock(1, exception: false))
+          String === nc ? key << nc : break
+        end
       end
       key
-    rescue SignalException
+    rescue Interrupt
       nil
     rescue IOError, SystemCallError
       @input_mode = :error
@@ -130,116 +130,5 @@ module Terminal
     private_constant :DUMB_KEYS
   end
 
-  #
-  # Key event reported from {read_key_event}.
-  #
-  class KeyEvent
-    class << self
-      # @attribute [w] caching
-      # @return [true, false] whether KeyCodes should be cached
-      def caching = !!@cache
-
-      # @attribute [w] caching
-      def caching=(value)
-        if value
-          @cache ||= {}
-        else
-          @cache = nil
-        end
-      end
-
-      def new(raw, key = raw, modifier = 0, extra = nil)
-        @cache ? super.freeze : @cache[raw] || (@cache[raw] = super.freeze)
-      end
-
-      def unknown(raw) = new(raw, nil)
-    end
-
-    # Event string received from standard input.
-    # This can be a simple value like `"a"`or `"\e[24;6~"` (for Shift+Ctrl+F12).
-    #
-    # @return [String] received event string
-    attr_reader :raw
-
-    # Pressed key without any modifiers.
-    # This can be a string for simple keys like `"a"` or a Symbol like `:F12`.
-    # @return [String, Symbol] key without modifiers
-    attr_reader :key
-
-    # Modifier key code. This represents the encoded key modifier like `Shift`
-    # or `Alt`.
-    #
-    # @return [Integer] modifier key code
-    attr_reader :modifier
-
-    # @comment for mouse events? attr_reader :extra
-
-    # Name of the key event.
-    # This can be a simple name like `"a"` or `"Shift+Ctrl+F12"` for combined
-    # keys.
-    #
-    # @return [String] key name
-    attr_reader :name
-
-    # @attribute [r] modifier?
-    # @return [true, false] whether a key modifier was pressed
-    def modifier? = @modifier != 0
-
-    # @attribute [r] simple?
-    # @return [true, false] whether a simple char was pressed
-    def simple? = @raw == @name
-
-    # All pressed keys.
-    # This is composed by all {modifier} and the {key}.
-    #
-    # @return [Array<Symbol, String>] all pressed keys
-    def to_a = @ary.dup
-
-    # @!visibility private
-    def to_ary = simple? ? [@raw] : [@raw, @name]
-
-    # @!visibility private
-    def to_s = @name.dup
-
-    # @!visibility private
-    def inspect = "<#{self.class.name} #{to_ary.map(&:inspect).join(' ')}>"
-
-    # @!visibility private
-    def freeze
-      @raw.freeze
-      @key.freeze
-      @extra.freeze
-      @name.freeze
-      super
-    end
-
-    private
-
-    def initialize(raw, key, modifier, extra)
-      @raw = raw
-      @key = key
-      @modifier = modifier
-      @extra = extra
-      @ary = MODIFIERS.filter_map { |b, n| n if modifier.allbits?(b) }
-      @ary << key if key
-      @name = @ary.join('+').encode(Encoding::UTF_8)
-    end
-
-    @cache = {}
-
-    MODIFIERS = {
-      1 => :Shift,
-      2 => :Alt,
-      4 => :Ctrl,
-      8 => :Super,
-      16 => :Hyper,
-      32 => :Meta,
-      64 => :Caps,
-      128 => :Num
-    }.freeze
-    private_constant :MODIFIERS
-  end
-
-  autoload :AsKeyEvent, "#{__dir__}/input/as_key_event.rb"
-  private_constant :AsKeyEvent
+  autoload :KeyEvent, "#{__dir__}/input/key_event.rb"
 end

data/lib/terminal/rspec/helper.rb

@@ -2,6 +2,7 @@
 
 RSpec.shared_context 'with Terminal.rb' do |ansi: true, application: :kitty, colors: 256, size: [25, 80], pos: [1, 1]|
   let(:stdout) { [] }
+  let(:stdin) { [] }
   let(:stdoutstr) { stdout.join }
 
   before do
@@ -9,21 +10,22 @@ RSpec.shared_context 'with Terminal.rb' do |ansi: true, application: :kitty, col
     allow(Terminal).to receive(:application).with(no_args).and_return(
       application
     )
+    allow(Terminal).to receive(:input_mode).with(no_args).and_return(
+      ansi ? :csi_u : :dumb
+    )
     allow(Terminal).to receive(:colors).with(no_args).and_return(
       colors == :true_color ? 16_777_216 : colors
     )
     allow(Terminal).to receive(:size).with(no_args).and_return(size)
     allow(Terminal).to receive(:pos).with(no_args).and_return(pos)
-    allow(Terminal).to receive(:hide_cursor).with(no_args).and_return(Terminal)
-    allow(Terminal).to receive(:show_cursor).with(no_args).and_return(Terminal)
-
-    if ansi
-      bbc = ->(s) { Terminal::Ansi.bbcode(s) }
-      nobbc = lambda(&:to_s)
-    else
-      bbc = ->(s) { Terminal::Ansi.plain(s) }
-      nobbc = ->(s) { Terminal::Ansi.undecorate(s) }
-    end
+
+    bbcode_ = {
+      true =>
+        ansi ?
+          ->(s) { Terminal::Ansi.bbcode(s) } :
+          ->(s) { Terminal::Ansi.plain(s) },
+      false => ansi ? lambda(&:to_s) : ->(s) { Terminal::Ansi.undecorate(s) }
+    }.compare_by_identity
 
     allow(Terminal).to receive(:<<) do |object|
       stdout.push(bbcode[object]) unless object.nil?
@@ -31,7 +33,7 @@ RSpec.shared_context 'with Terminal.rb' do |ansi: true, application: :kitty, col
     end
 
     allow(Terminal).to receive(:print) do |*objects, bbcode: true|
-      bbcode = bbcode ? bbc : nobbc
+      bbcode = bbcode_[bbcode]
       objects.flatten.each { stdout.push(bbcode[_1]) unless _1.nil? }
       nil
     end
@@ -42,7 +44,7 @@ RSpec.shared_context 'with Terminal.rb' do |ansi: true, application: :kitty, col
         stdout.push("\n")
         next
       end
-      bbcode = bbcode ? bbc : nobbc
+      bbcode = bbcode_[bbcode]
       objects.each do |s|
         next stdout.push("\n") if s.nil?
         stdout.push(s = bbcode[s])
@@ -55,5 +57,9 @@ RSpec.shared_context 'with Terminal.rb' do |ansi: true, application: :kitty, col
       stdout.push(object = object.to_s)
       object.bytesize
     end
+
+    allow(Terminal).to receive(:read_key_event) do
+      Terminal::KeyEvent[stdin.shift || raise('stdin buffer is empty')]
+    end
   end
 end

data/lib/terminal/text.rb

@@ -30,7 +30,7 @@ module Terminal
       def width(str, bbcode: true)
         str = bbcode ? Ansi.unbbcode(str) : str.to_s
         return 0 if str.empty?
-        str = str.encode(ENC) if str.encoding != ENC
+        str = str.encode(@encoding) if str.encoding != @encoding
         width = 0
         str.scan(WIDTH_SCANNER) do |sp, gc|
           next width += char_width(gc) if gc
@@ -113,7 +113,7 @@ module Terminal
 
       def char_width(char)
         ord = char.ord
-        return CONTROL_CHAR_WIDTH[ord] || 2 if ord < 0x20
+        return @ctrlchar_width[ord] || 2 if ord < 0x20
         return 1 if char.size < 2 && ord < 0xa1
         width = CharWidth[ord]
         return @ambiguous_char_width if width == -1
@@ -124,7 +124,7 @@ module Terminal
       end
 
       def lim_pairs(snippeds, limit)
-        line = EMPTY.dup
+        line = @empty.dup
         size = 0
         csi = nil
         snippeds.each do |snipped|
@@ -144,7 +144,7 @@ module Terminal
 
           if snipped == :hard_nl
             line[-1] == ' ' ? yield(line.chop, size - 1) : yield(line, size)
-            line = EMPTY.dup
+            line = @empty.dup
             csi = nil
             next size = 0
           end
@@ -190,7 +190,7 @@ module Terminal
       end
 
       def pairs(snippeds)
-        line = EMPTY.dup
+        line = @empty.dup
         size = 0
         csi = nil
         snippeds.each do |snipped|
@@ -208,7 +208,7 @@ module Terminal
 
           if snipped == :hard_nl
             line[-1] == ' ' ? yield(line.chop, size - 1) : yield(line, size)
-            line = EMPTY.dup
+            line = @empty.dup
             csi = nil
             next size = 0
           end
@@ -229,7 +229,7 @@ module Terminal
       end
 
       def lim_lines(snippeds, limit)
-        line = EMPTY.dup
+        line = @empty.dup
         size = 0
         csi = nil
         snippeds.each do |snipped|
@@ -249,7 +249,7 @@ module Terminal
 
           if snipped == :hard_nl
             yield(line[-1] == ' ' ? line.chop : line)
-            line = EMPTY.dup
+            line = @empty.dup
             csi = nil
             next size = 0
           end
@@ -295,7 +295,7 @@ module Terminal
       end
 
       def lines(snippeds)
-        line = EMPTY.dup
+        line = @empty.dup
         size = 0
         csi = nil
         snippeds.each do |snipped|
@@ -313,7 +313,7 @@ module Terminal
 
           if snipped == :hard_nl
             yield(line[-1] == ' ' ? line.chop : line)
-            line = EMPTY.dup
+            line = @empty.dup
             csi = nil
             next size = 0
           end
@@ -342,7 +342,7 @@ module Terminal
             next ret << (last = :hard_nl)
           end
 
-          txt = txt.encode(ENC) if txt.encoding != ENC
+          txt = txt.encode(@encoding) if txt.encoding != @encoding
 
           txt.scan(SCAN_EXPR) do |nl, csi, osc, space, gc|
             if gc
@@ -445,10 +445,8 @@ module Terminal
     private_constant :Osc, :CsiEnd, :Csi, :Word, :WordEx
 
     @ambiguous_char_width = 1
-
-    ENC = Encoding::UTF_8
-    EMPTY = String.new(encoding: ENC).freeze
-    private_constant :ENC, :EMPTY
+    @encoding = Encoding::UTF_8
+    @empty = String.new(encoding: @encoding).freeze
 
     SCAN_EXPR =
       /\G(?:
@@ -468,7 +466,7 @@ module Terminal
       )/x
     private_constant :SCAN_EXPR, :WIDTH_SCANNER
 
-    CONTROL_CHAR_WIDTH = {
+    @ctrlchar_width = {
       0x00 => 0,
       0x01 => 1,
       0x02 => 1,
@@ -502,7 +500,6 @@ module Terminal
       0x1e => 1,
       0x1f => 1
     }.compare_by_identity.freeze
-    private_constant :CONTROL_CHAR_WIDTH
 
     autoload :CharWidth, "#{__dir__}/text/char_width.rb"
     private_constant :CharWidth

data/lib/terminal/version.rb

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

data/lib/terminal.rb

@@ -11,16 +11,16 @@ require_relative 'terminal/input'
 # It automagically detects whether your terminal supports ANSI features, like
 # coloring (see {colors}) or the
 # [CSIu protocol](https://sw.kovidgoyal.net/kitty/keyboard-protocol) support
-# (see {read_key} and {input_mode}). It calculates the display width for Unicode
-# chars (see {Text.width}) and help you to display text with line formatting
-# (see {Text.each_line}).
+# (see {read_key_event} and {input_mode}).
+# It calculates the display width for Unicode chars (see {Text.width}) and help
+# you to display text with line formatting (see {Text.each_line}).
 #
 module Terminal
   class << self
-    # Return true when the current terminal supports ANSI control codes.
-    # When the terminal does not support it, {colors} will return `2` as color
-    # count and all output methods ({<<}, {print}, {puts}) will not forward
-    # ANSI control codes to the terminal, {read_key} will not support CSIu.
+    # Return true if the current terminal supports ANSI control codes.
+    # When the terminal does not support it, {colors} will return `2` and all
+    # output methods ({<<}, {print}, {puts}) will not forward ANSI control
+    # codes to the terminal, {read_key_event} will not support CSIu.
     #
     # @attribute [r] ansi?
     # @return [Boolean] whether ANSI control codes are supported
@@ -123,8 +123,9 @@ module Terminal
 
     # Screen size as a tuple of {rows} and {columns}.
     #
-    # If the terminal does not support the report for it's dimension or ANSI
-    # is not supported in general then environment variables will be used.
+    # If the terminal does not support the report of it's dimension or ANSI
+    # is not supported in general then environment variables `COLUMNS` and
+    # `LINES` will be used.
     # If this failed `[25, 80]` will be returned as default.
     #
     # Setting the terminal size is not widely supported.
@@ -156,7 +157,8 @@ module Terminal
     # Hide the cursor.
     # Will not send the control code if the cursor is already hidden.
     #
-    # To show the cursor again call {show_cursor}.
+    # When you called {hide_cursor} n-times you need to call {show_cursor}
+    # n-times to show the cursor again.
     #
     # @return [Terminal] itself
     def hide_cursor

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terminal_rb
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.2
 platform: ruby
 authors:
 - Mike Blumtritt
@@ -9,9 +9,8 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: |
-  Terminal access with super fast ANSI control codes support and
-  BBCode-like embedded text attribute syntax.
+description: 'Terminal access with super fast ANSI control codes support, modern CSIu
+  input, word-wise line break, BBCode-like embedded text attribute syntax. '
 executables:
 - bbcode
 extensions: []
@@ -34,7 +33,7 @@ files:
 - lib/terminal/ansi/named_colors.rb
 - lib/terminal/detect.rb
 - lib/terminal/input.rb
-- lib/terminal/input/as_key_event.rb
+- lib/terminal/input/key_event.rb
 - lib/terminal/rspec/helper.rb
 - lib/terminal/text.rb
 - lib/terminal/text/char_width.rb
@@ -44,11 +43,11 @@ homepage: https://codeberg.org/mblumtritt/Terminal.rb
 licenses:
 - MIT
 metadata:
-  rubygems_mfa_required: 'true'
-  yard.run: yard
   source_code_uri: https://codeberg.org/mblumtritt/Terminal.rb
   bug_tracker_uri: https://codeberg.org/mblumtritt/Terminal.rb/issues
-  documentation_uri: https://rubydoc.info/gems/terminal_rb/Terminal
+  documentation_uri: https://rubydoc.info/gems/terminal_rb
+  rubygems_mfa_required: 'true'
+  yard.run: yard
 rdoc_options: []
 require_paths:
 - lib
@@ -65,5 +64,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.7.1
 specification_version: 4
-summary: Fast terminal access with ANSI and BBCode support.
+summary: Fast terminal access with ANSI, CSIu, BBCode, word-wise line break support.
 test_files: []