terminal_rb 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9409becbf807905a0659436c9e0f5c3644208006e23c038dbf43a621410c7c7
-  data.tar.gz: 7a583438aa3b66faa19a9bbd035ad26d2c74f889b923e2f410d6468291006495
+  metadata.gz: d20a3a35e0ac4ef63e9275befee56d97d7fd611db9dcc3438de5a49bb0938eef
+  data.tar.gz: 86475f7f6d2f89e86353e25fe9bae8803d4a75a3df0a8aab2ae58b4fdd4a5a92
 SHA512:
-  metadata.gz: 3aa083acc102175661145c924b62d3cee717a9453bb73abc6415800d70193ef957abe998732592d1171244a2393767141254891db15a73b96ff2d76bca5c38d8
-  data.tar.gz: 3375ed736835332ed58078ca090922f483a81b3c7a4e6d10b87c9abb64fc6260a67649c5e4a06147e0fa89bea44d623f6613f803e24f02c171830647864a88f2
+  metadata.gz: b10bd0a2329433e8452b63b2291d4e888937ef8329d5557da7943605131b1a1ec8a42cbb77e6b8f2757f70525b8723d1c1a8242bd1f18593b1a47be6b7c7a655
+  data.tar.gz: d08a89d748cf95019615005bfa5370884e2f235f1721df29963a2acaf733ce2e6c06c912d9833cfa4660ca99972126b19477af380641673d63019ae6a9af5827

data/examples/key-codes.rb

@@ -18,5 +18,5 @@ while true
   Terminal.puts(
     "   [blue]: [yellow]#{raw.inspect}  [bold bright_green]#{name}[/]"
   )
-  break puts if name == 'Esc'
+  break puts if raw.nil? || name == 'Esc'
 end

data/lib/terminal/input/{csiu_mode.rb → csiu_keys.rb}

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
 module Terminal
-  module CSIUMode
+  module CSIuKeys
     class << self
-      def type = :csi_u
-
-      def key_name(key)
-        return unless key
+      def [](key)
         return ORD[key.ord] if key.size == 1
         return if key[0] != "\e"
         return C0_LEGACY[key[1].ord] if key.size == 2 # ESC ?
@@ -113,5 +110,5 @@ module Terminal
       128 => 'Num'
     }.freeze
   end
-  private_constant :CSIUMode
+  private_constant :CSIuKeys
 end

data/lib/terminal/input/dumb_keys.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Terminal
+  module DumbKeys
+    def self.[](key)
+      ORD[key.ord] if key.size == 1
+    end
+
+    ORD = {
+      0x05 => 'Ctrl+c',
+      0x08 => 'Back',
+      0x09 => 'Tab',
+      0x0a => 'Enter',
+      0x0d => 'Return',
+      0x1b => 'Esc'
+    }.compare_by_identity.freeze
+  end
+end

data/lib/terminal/input/{legacy_mode.rb → legacy_keys.rb}

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
 module Terminal
-  module LegacyMode
+  module LegacyKeys
     class << self
-      def type = :legacy
-
-      def key_name(key)
-        return unless key
+      def [](key)
         return ORD[key.ord] if key.size == 1
         return if key[0] != "\e"
         return csi(key) if key[1] == '['
@@ -118,5 +115,5 @@ module Terminal
       128 => 'Num'
     }.freeze
   end
-  private_constant :LegacyMode
+  private_constant :LegacyKeys
 end

data/lib/terminal/input.rb

@@ -7,14 +7,17 @@ module Terminal
     # Supported input mode.
     #
     # @attribute [r] input_mode
-    # @return [:csi_u] when CSIu protocol support
-    # @return [:legacy] for standard terminal
-    # @return [:dumb] for non-interactive input (pipes etc.)
-    # @return [:error] when input device is closed
+    #
+    # @return [:csi_u]
+    #   when CSIu protocol support
+    # @return [:legacy]
+    #   for standard terminal
+    # @return [:dumb]
+    #   for non-interactive input (pipes etc.)
+    # @return [:error]
+    #   when input device is closed
     def input_mode
-      return @inp_mode.type if (@inp ||= find_inp) == READ_TTY_INP
-      return :dumb if @inp == READ_DUMB_INP
-      :error
+      @input_mode ||= find_input_mode
     end
 
     # Read next keyboard input.
@@ -27,44 +30,48 @@ module Terminal
     # @return [String] key name in `:named` mode
     # @return [[String, String]] key code and key name in `:both` mode
     def read_key(mode: :named)
-      key = (@inp ||= find_inp).call or return
-      return key if mode == :raw
-      return key, @inp_mode.key_name(key) if mode == :both
-      @inp_mode.key_name(key) || key
+      case input_mode
+      when :dumb
+        read_dumb(mode)
+      when :legacy
+        read_legacy(mode)
+      when :csi_u
+        read_csi_u(mode)
+      end
     end
 
     private
 
-    def find_inp
-      return READ_DUMB_INP unless STDIN.tty?
-      return READ_TTY_INP if !ansi? || _write("\e[>1u\e[?u\e[c").nil?
-      while true
-        result = READ_TTY_INP.call
-        if result.include?("\e[?1u")
-          @inp_mode = CSIUMode
-          at_exit { _write("\e[<u") } if ENV['ENV'] != 'test'
-        end
-        return READ_TTY_INP if result[-1] == 'c'
-      end
-    rescue IOError, SystemCallError
-      -> {}
-    ensure
-      @inp_mode ||= LegacyMode
-    end
-  end
-
-  READ_DUMB_INP =
-    lambda do
-      STDIN.getc
+    def read_dumb(mode)
+      translate_key(STDIN.getc, mode, DumbKeys)
     rescue Interrupt
-      nil
+      translate_key("\x05", mode, DumbKeys)
     rescue IOError, SystemCallError
-      @inp = -> {}
+      @input_mode = :error
       nil
     end
 
-  READ_TTY_INP =
-    lambda do
+    def read_legacy(mode) = translate_key(read_tty, mode, LegacyKeys)
+
+    def read_csi_u(mode)
+      if _write("\e[>1u")
+        key = read_tty
+        _write("\e[<u")
+        translate_key(key, mode, CSIuKeys)
+      else
+        @input_mode = :legacy
+        read_legacy(mode)
+      end
+    end
+
+    def translate_key(key, mode, translator)
+      return unless key
+      return key if mode == :raw
+      name = translator[key]
+      mode == :both ? [key, name] : name || key
+    end
+
+    def read_tty
       key = STDIN.getch
       while (nc = STDIN.read_nonblock(1, exception: false))
         String === nc ? key += nc : break
@@ -73,12 +80,33 @@ module Terminal
     rescue Interrupt
       key
     rescue IOError, SystemCallError
-      @inp = READ_DUMB_INP
+      @input_mode = :error
       nil
     end
 
+    def find_input_mode
+      return :dumb unless STDIN.tty?
+      return :legacy if !ansi? || _write("\e[>1u\e[?u\e[c").nil? || !csi_u?
+      _write("\e[<u")
+      :csi_u
+    rescue IOError, SystemCallError
+      :error
+    end
+
+    def csi_u?
+      ret = false
+      while true
+        result = read_tty or return false
+        ret = true if result.include?("\e[?1u")
+        break if result[-1] == 'c'
+      end
+      ret
+    end
+  end
+
   dir = __dir__
-  autoload :LegacyMode, "#{dir}/input/legacy_mode.rb"
-  autoload :CSIUMode, "#{dir}/input/csiu_mode.rb"
-  private_constant :READ_DUMB_INP, :READ_TTY_INP, :LegacyMode, :CSIUMode
+  autoload :CSIuKeys, "#{dir}/input/csiu_keys.rb"
+  autoload :DumbKeys, "#{dir}/input/dumb_keys.rb"
+  autoload :LegacyKeys, "#{dir}/input/legacy_keys.rb"
+  private_constant :CSIuKeys, :LegacyKeys
 end

data/lib/terminal/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terminal_rb
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - Mike Blumtritt
@@ -34,9 +34,9 @@ files:
 - lib/terminal/ansi/named_colors.rb
 - lib/terminal/detect.rb
 - lib/terminal/input.rb
-- lib/terminal/input/csiu_mode.rb
-- lib/terminal/input/legacy_mode.rb
-- lib/terminal/preload.rb
+- lib/terminal/input/csiu_keys.rb
+- lib/terminal/input/dumb_keys.rb
+- lib/terminal/input/legacy_keys.rb
 - lib/terminal/rspec/helper.rb
 - lib/terminal/text.rb
 - lib/terminal/text/char_width.rb
@@ -49,7 +49,7 @@ metadata:
   rubygems_mfa_required: 'true'
   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/0.9.4/Terminal
+  documentation_uri: https://rubydoc.info/gems/terminal_rb/0.9.5/Terminal
 rdoc_options: []
 require_paths:
 - lib

data/lib/terminal/preload.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../terminal'
-require_relative 'ansi/named_colors'
-require_relative 'text'
-require_relative 'text/char_width'
-require_relative 'detect'
-require_relative 'version'