terminal_rb 0.9.4 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9409becbf807905a0659436c9e0f5c3644208006e23c038dbf43a621410c7c7
-  data.tar.gz: 7a583438aa3b66faa19a9bbd035ad26d2c74f889b923e2f410d6468291006495
+  metadata.gz: 977c06e8d495f8c0e73cff49642e812234cc5861d7495fc44f4dcef4f3b253ee
+  data.tar.gz: 863d24475a32ef39f8f1298876f55d112f4443384ddab9f3fe6fda7228db828c
 SHA512:
-  metadata.gz: 3aa083acc102175661145c924b62d3cee717a9453bb73abc6415800d70193ef957abe998732592d1171244a2393767141254891db15a73b96ff2d76bca5c38d8
-  data.tar.gz: 3375ed736835332ed58078ca090922f483a81b3c7a4e6d10b87c9abb64fc6260a67649c5e4a06147e0fa89bea44d623f6613f803e24f02c171830647864a88f2
+  metadata.gz: 2ad9fa7a857903776fddde3b4c4b00963f977c26f8e74662175234fe798615105f4a71c47a5d5cd02c944ed5090cc9c6892d164e1d2c7de9d013b0643d816115
+  data.tar.gz: ef31547f441d1833ef53d79b0e04c70451573f97966410247d83d883f392da0917fab3f0008a8419925e6d7e261d02b43f011bdc7fc2ab2b2519c21648aff1e7

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 ?
@@ -33,11 +30,16 @@ module Terminal
       end
 
       def unicode(key)
-        with_modifier(key) { ORD[_1] || _1.chr(Encoding::UTF_8) }
+        with_modifier(key) do |ord|
+          ORD[ord] || UNICODE_ORD[ord] || ord.chr(Encoding::UTF_8)
+        end
       end
 
       def legacy(key)
-        with_modifier(key) { _1 == 13 ? 'F3' : ORD[_1] }
+        with_modifier(key) do |ord|
+          return 'F3' if ord == 13
+          ord == 57_427 ? 'KpBegin' : ORD[ord]
+        end
       end
 
       def with_modifier(key)
@@ -54,6 +56,7 @@ module Terminal
     ORD = {
       0x02 => 'Ins',
       0x03 => 'Del',
+      0x04 => 'Del',
       0x05 => 'PageUp',
       0x06 => 'PageDown',
       0x07 => 'Home',
@@ -75,6 +78,88 @@ module Terminal
       0x7f => 'Back'
     }.compare_by_identity.freeze
 
+    # ESC [ ? u
+    UNICODE_ORD = {
+      57_376 => 'F13',
+      57_377 => 'F14',
+      57_378 => 'F15',
+      57_379 => 'F16',
+      57_380 => 'F17',
+      57_381 => 'F18',
+      57_382 => 'F19',
+      57_383 => 'F20',
+      57_384 => 'F21',
+      57_385 => 'F22',
+      57_386 => 'F23',
+      57_387 => 'F24',
+      57_388 => 'F25',
+      57_389 => 'F26',
+      57_390 => 'F27',
+      57_391 => 'F28',
+      57_392 => 'F29',
+      57_393 => 'F30',
+      57_394 => 'F31',
+      57_395 => 'F32',
+      57_396 => 'F33',
+      57_397 => 'F34',
+      57_398 => 'F35',
+      57_399 => 'Kp0',
+      57_400 => 'Kp1',
+      57_401 => 'Kp2',
+      57_402 => 'Kp3',
+      57_403 => 'Kp4',
+      57_404 => 'Kp5',
+      57_405 => 'Kp6',
+      57_406 => 'Kp7',
+      57_407 => 'Kp8',
+      57_408 => 'Kp9',
+      57_409 => 'KpDecimal',
+      57_410 => 'KpDivide',
+      57_411 => 'KpMultiply',
+      57_412 => 'KpSubtract',
+      57_413 => 'KpAdd',
+      57_414 => 'KpEnter',
+      57_415 => 'KpEqual',
+      57_416 => 'KpSeparator',
+      57_417 => 'KpLeft',
+      57_418 => 'KpRight',
+      57_419 => 'KpUp',
+      57_420 => 'KpDown',
+      57_421 => 'KpPage_up',
+      57_422 => 'KpPage_down',
+      57_423 => 'KpHome',
+      57_424 => 'KpEnd',
+      57_425 => 'KpInsert',
+      57_426 => 'KpDelete',
+      57_428 => 'MediaPlay',
+      57_429 => 'MediaPause',
+      57_430 => 'MediaPlay Pause',
+      57_431 => 'MediaReverse',
+      57_432 => 'MediaStop',
+      57_433 => 'MediaFast Forward',
+      57_434 => 'MediaRewind',
+      57_435 => 'MediaTrack Next',
+      57_436 => 'MediaTrack Previous',
+      57_437 => 'MediaRecord',
+      57_438 => 'LowerVolume',
+      57_439 => 'RaiseVolume',
+      57_440 => 'MuteVolume',
+      57_441 => 'LeftShift',
+      57_442 => 'LeftControl',
+      57_443 => 'LeftAlt',
+      57_444 => 'LeftSuper',
+      57_445 => 'LeftHyper',
+      57_446 => 'LeftMeta',
+      57_447 => 'RightShift',
+      57_448 => 'RightControl',
+      57_449 => 'RightAlt',
+      57_450 => 'RightSuper',
+      57_451 => 'RightHyper',
+      57_452 => 'RightMeta',
+      57_453 => 'IsoLevel3Shift',
+      57_454 => 'IsoLevel5Shift'
+    }.compare_by_identity.freeze
+
     # ESC ?
     C0_LEGACY = {
       0x00 => 'Ctrl+Space',
@@ -113,5 +198,5 @@ module Terminal
       128 => 'Num'
     }.freeze
   end
-  private_constant :CSIUMode
+  private_constant :CSIuKeys
 end

data/lib/terminal/input/dumb_keys.rb

@@ -0,0 +1,19 @@
+# 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
+  private_constant :DumbKeys
+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,34 @@ 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?
+      STDIN.sync = true
+      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/rspec/helper.rb

@@ -1,34 +1,60 @@
 # frozen_string_literal: true
 
-RSpec.shared_context 'with Terminal' do |mod, ansi: true, winsize: [25, 80]|
-  let(:wrapper_module) { Module.new }
-  let(:stdout) { double(:STDOUT, winsize: winsize, tty?: ansi) }
-  let(:stdoutput) { [] }
-  let(:terminal) do
-    load('terminal/ansi/attributes.rb', wrapper_module)
-    load('terminal/ansi.rb', wrapper_module)
-    load('terminal/input/legacy_mode.rb', wrapper_module)
-    load('terminal/input.rb', wrapper_module)
-    load('terminal/detect.rb', wrapper_module)
-    load('terminal.rb', wrapper_module)
-    wrapper_module::Terminal
-  end
+RSpec.shared_context 'with Terminal.rb' do |ansi: true, application: :kitty, colors: 256, size: [25, 80], pos: [1, 1]|
+  let(:stdout) { [] }
+  let(:stdoutstr) { stdout.join }
 
   before do
-    allow(stdout).to receive(:write) do |*args|
-      stdoutput.concat(args)
-      nil
+    allow(Terminal).to receive(:ansi?).with(no_args).and_return(ansi)
+    allow(Terminal).to receive(:application).with(no_args).and_return(
+      application
+    )
+    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)
+
+    bbc =
+      if ansi
+        ->(s) { Terminal::Ansi.bbcode(s) }
+      else
+        ->(s) { Terminal::Ansi.plain(s) }
+      end
+
+    nobbc = ansi ? lambda(&:to_s) : ->(s) { Terminal::Ansi.undecorate(s) }
+
+    allow(Terminal).to receive(:<<) do |object|
+      stdout.push(bbcode[object]) unless object.nil?
+      Terminal
     end
 
-    wrapper_module::STDOUT = stdout unless defined?(wrapper_module::STDOUT)
+    allow(Terminal).to receive(:print) do |*objects, bbcode: true|
+      bbcode = bbcode ? bbc : nobbc
+      objects.flatten.each { stdout.push(bbcode[_1]) unless _1.nil? }
+      nil
+    end
 
-    unless ansi
-      allow(ENV).to receive(:[]).and_call_original
-      allow(ENV).to receive(:[]).with('LINES').and_return winsize.first
-      allow(ENV).to receive(:[]).with('COLUMNS').and_return winsize.last
+    allow(Terminal).to receive(:puts) do |*objects, bbcode: true|
+      objects.flatten!
+      if objects.empty?
+        stdout.push("\n")
+        next
+      end
+      bbcode = bbcode ? bbc : nobbc
+      objects.each do |s|
+        next stdout.push("\n") if s.nil?
+        stdout.push(s = bbcode[s])
+        stdout.push("\n") if s[-1] != "\n"
+      end
+      nil
     end
 
-    mod.__send__(:remove_const, :Terminal) if defined?(mod::Terminal)
-    mod.__send__(:const_set, :Terminal, terminal)
+    allow(Terminal).to receive(:_write) do |object|
+      stdout.push(object = object.to_s)
+      object.bytesize
+    end
   end
 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.6'
 end

data/lib/terminal.rb

@@ -24,7 +24,7 @@ module Terminal
     #
     # @attribute [r] ansi?
     # @return [Boolean] whether ANSI control codes are supported
-    def ansi? = (@mode == :ansi)
+    def ansi? = @ansi
 
     # Terminal application identifier.
     #
@@ -182,7 +182,7 @@ module Terminal
     # @param [#to_s] object object to write
     # @return [Terminal] itself
     def <<(object)
-      @out.write(@bbcode[object]) unless object.nil? || @out.nil?
+      @out&.write(@bbcode[object]) unless object.nil?
       self
     rescue IOError
       @out = nil
@@ -197,8 +197,10 @@ module Terminal
     # @return [nil]
     def print(*objects, bbcode: true)
       return unless @out
-      bbcode = bbcode ? @bbcode : @nobbcode
-      objects.flatten.each { @out.write(bbcode[_1]) unless _1.nil? }
+      objects.flatten!
+      return if (line = objects.join).empty?
+      return if (line = (bbcode ? @bbcode : @nobbcode)[line]).empty?
+      @out.write(line)
       nil
     rescue IOError
       @out = nil
@@ -245,25 +247,31 @@ module Terminal
       [rows > 0 ? rows : 25, columns > 0 ? columns : 80]
     end
 
-    def _determine_mode
-      # order is important:
-      return :dumb unless STDOUT.tty?
-      ENV.key?('NO_COLOR') || ENV['TERM'] == 'dumb' ? :dumb : :ansi
+    def _determine_modes
+      # order is important!
+      tty = STDOUT.tty?
+      return tty, true if ENV['ANSI'] == 'force'
+      return false, false if ENV.key?('NO_COLOR') || ENV['TERM'] == 'dumb'
+      [tty, tty]
     rescue IOError
-      nil
+      [nil, false]
     end
   end
 
-  @mode = _determine_mode
-  @out = STDOUT if @mode
   @cc = 0
+  tty, @ansi = _determine_modes
 
-  if ansi?
-    @bbcode = ->(s) { Ansi.bbcode(s) }
-    @nobbcode = lambda(&:to_s)
+  (@out = STDOUT).sync = true unless tty.nil?
+
+  if tty
     @inf = STDOUT
     @con = IO.console
     Signal.trap('WINCH') { @size = nil } if Signal.list.key?('WINCH')
+  end
+
+  if @ansi
+    @bbcode = ->(s) { Ansi.bbcode(s) }
+    @nobbcode = lambda(&:to_s)
   else
     @bbcode = ->(s) { Ansi.plain(s) }
     @nobbcode = ->(s) { Ansi.undecorate(s) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terminal_rb
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.6
 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.6/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'