reline 0.3.4 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e5c7a3a92a99dc4e59ae8299c90086a1d5508a7aa7f23579ac9e69a516da22a
-  data.tar.gz: 4779c4eba572d69bda056dafdc974f898678a9a0d40636ffc54836bbcedce2e8
+  metadata.gz: 3075f4003cf263e4652fc0dec716c71b55b597e6cbdc8cdb5297181b72780b57
+  data.tar.gz: 78eb2e13f17bc0c7ae34b425effe29bf40a30b355af7d0efd271823c2cdde521
 SHA512:
-  metadata.gz: ec283bebd9d93cc46c0587da2d051f29a2f119c785eff4a0d554b019a6f4cc2c9503670e0f073c11ce3399b72ecd2b3cdd4d92315251022b4ef54378bb9eea35
-  data.tar.gz: ffab61dee9ca267ff0015280a0fb0cbd5c76b271867dd86fc1861379af4821929917a467017b1a9b6cd17c92e3bbc74905c7b43865406b5053890bdb42b00007
+  metadata.gz: 9fd55d135c7b1aaffaff575f930bdb6365c202a1d15b5943d3dd9f678f416ba312b21c836ef8b78d11ee9942c4e0f0ac50d395633196bd649bd23a2fa6096456
+  data.tar.gz: 43fe692b243560a81da41a48f4cb5cdf05514f85788bbc6b54bba72aef4d5e7258e73c2a84622c80e51adf36345cd9e7595455f8301e09c1f299f7b2ec147ff2

data/README.md

@@ -55,6 +55,29 @@ end
 
 See also: [test/reline/yamatanooroti/multiline_repl](https://github.com/ruby/reline/blob/master/test/reline/yamatanooroti/multiline_repl)
 
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/reline.
+
+### Run tests
+
+> **Note**
+> Please make sure you have `libvterm` installed for `yamatanooroti` tests (integration tests).
+
+If you use Homebrew, you can install it by running `brew install libvterm`.
+
+```bash
+WITH_VTERM=1 bundle install
+WITH_VTERM=1 bundle exec rake test test_yamatanooroti
+```
+
+## Releasing
+
+```bash
+rake release
+gh release create vX.Y.Z --generate-notes
+```
+
 ## License
 
 The gem is available as open source under the terms of the [Ruby License](https://www.ruby-lang.org/en/about/license.txt).

data/lib/reline/ansi.rb

@@ -206,7 +206,7 @@ class Reline::ANSI
   end
 
   def self.in_pasting?
-    @@in_bracketed_paste_mode or (not Reline::IOGate.empty_buffer?)
+    @@in_bracketed_paste_mode or (not empty_buffer?)
   end
 
   def self.empty_buffer?

data/lib/reline/key_stroke.rb

@@ -1,4 +1,8 @@
 class Reline::KeyStroke
+  ESC_BYTE = 27
+  CSI_PARAMETER_BYTES_RANGE = 0x30..0x3f
+  CSI_INTERMEDIATE_BYTES_RANGE = (0x20..0x2f)
+
   def initialize(config)
     @config = config
   end
@@ -73,17 +77,26 @@ class Reline::KeyStroke
       return :matched  if it.max_by(&:size)&.size&.< input.size
       return :matching if it.size > 1
     }
-    key_mapping.keys.select { |lhs|
-      start_with?(input, lhs)
-    }.tap { |it|
-      return it.size > 0 ? :matched : :unmatched
-    }
+    if key_mapping.keys.any? { |lhs| start_with?(input, lhs) }
+      :matched
+    else
+      match_unknown_escape_sequence(input).first
+    end
   end
 
   def expand(input)
-    input = compress_meta_key(input)
     lhs = key_mapping.keys.select { |item| start_with?(input, item) }.sort_by(&:size).last
-    return input unless lhs
+    unless lhs
+      status, size = match_unknown_escape_sequence(input)
+      case status
+      when :matched
+        return [:ed_unassigned] + expand(input.drop(size))
+      when :matching
+        return [:ed_unassigned]
+      else
+        return input
+      end
+    end
     rhs = key_mapping[lhs]
 
     case rhs
@@ -99,6 +112,36 @@ class Reline::KeyStroke
 
   private
 
+  # returns match status of CSI/SS3 sequence and matched length
+  def match_unknown_escape_sequence(input)
+    idx = 0
+    return [:unmatched, nil] unless input[idx] == ESC_BYTE
+    idx += 1
+    idx += 1 if input[idx] == ESC_BYTE
+
+    case input[idx]
+    when nil
+      return [:matching, nil]
+    when 91 # == '['.ord
+      # CSI sequence
+      idx += 1
+      idx += 1 while idx < input.size && CSI_PARAMETER_BYTES_RANGE.cover?(input[idx])
+      idx += 1 while idx < input.size && CSI_INTERMEDIATE_BYTES_RANGE.cover?(input[idx])
+      input[idx] ? [:matched, idx + 1] : [:matching, nil]
+    when 79 # == 'O'.ord
+      # SS3 sequence
+      input[idx + 1] ? [:matched, idx + 2] : [:matching, nil]
+    else
+      if idx == 1
+        # `ESC char`, make it :unmatched so that it will be handled correctly in `read_2nd_character_of_key_sequence`
+        [:unmatched, nil]
+      else
+        # `ESC ESC char`
+        [:matched, idx + 1]
+      end
+    end
+  end
+
   def key_mapping
     @config.key_bindings
   end

data/lib/reline/line_editor.rb

@@ -48,8 +48,8 @@ class Reline::LineEditor
     PERFECT_MATCH = :perfect_match
   end
 
-  CompletionJourneyData = Struct.new('CompletionJourneyData', :preposing, :postposing, :list, :pointer)
-  MenuInfo = Struct.new('MenuInfo', :target, :list)
+  CompletionJourneyData = Struct.new(:preposing, :postposing, :list, :pointer)
+  MenuInfo = Struct.new(:target, :list)
 
   PROMPT_LIST_CACHE_TIMEOUT = 0.5
   MINIMUM_SCROLLBAR_HEIGHT = 1
@@ -60,6 +60,10 @@ class Reline::LineEditor
     reset_variables(encoding: encoding)
   end
 
+  def io_gate
+    Reline::IOGate
+  end
+
   def set_pasting_state(in_pasting)
     @in_pasting = in_pasting
   end
@@ -562,6 +566,16 @@ class Reline::LineEditor
       @line_editor.instance_variable_get(:@screen_size).last
     end
 
+    def screen_height
+      @line_editor.instance_variable_get(:@screen_size).first
+    end
+
+    def preferred_dialog_height
+      rest_height = @line_editor.instance_variable_get(:@rest_height)
+      scroll_partial_screen = @line_editor.instance_variable_get(:@scroll_partial_screen) || 0
+      [cursor_pos.y - scroll_partial_screen, rest_height, (screen_height + 6) / 5].max
+    end
+
     def completion_journey_data
       @line_editor.instance_variable_get(:@completion_journey_data)
     end
@@ -714,7 +728,7 @@ class Reline::LineEditor
     ymax = ymax.clamp(screen_y_range.begin, screen_y_range.end)
     dialog_y = @first_line_started_from + @started_from
     cursor_y = dialog_y
-    if @highest_in_all < ymax
+    if @highest_in_all <= ymax
       scroll_down(ymax - cursor_y)
       move_cursor_up(ymax - cursor_y)
     end
@@ -1500,11 +1514,13 @@ class Reline::LineEditor
       return if key.char >= 128 # maybe, first byte of multi byte
       method_symbol = @config.editing_mode.get_method(key.combined_char)
       if key.with_meta and method_symbol == :ed_unassigned
-        # split ESC + key
-        method_symbol = @config.editing_mode.get_method("\e".ord)
-        process_key("\e".ord, method_symbol)
-        method_symbol = @config.editing_mode.get_method(key.char)
-        process_key(key.char, method_symbol)
+        if @config.editing_mode_is?(:vi_command, :vi_insert)
+          # split ESC + key in vi mode
+          method_symbol = @config.editing_mode.get_method("\e".ord)
+          process_key("\e".ord, method_symbol)
+          method_symbol = @config.editing_mode.get_method(key.char)
+          process_key(key.char, method_symbol)
+        end
       else
         process_key(key.combined_char, method_symbol)
       end
@@ -1635,7 +1651,7 @@ class Reline::LineEditor
       @line = ' ' * new_indent + @line.lstrip
 
       new_indent = nil
-      result = @auto_indent_proc.(new_lines[0..-2], @line_index - 1, (new_lines[-2].size + 1), false)
+      result = @auto_indent_proc.(new_lines[0..-2], @line_index - 1, (new_lines[@line_index - 1].bytesize + 1), false)
       if result
         new_indent = result
       end
@@ -3276,4 +3292,7 @@ class Reline::LineEditor
     @mark_pointer = new_pointer
   end
   alias_method :exchange_point_and_mark, :em_exchange_mark
+
+  private def em_meta_next(key)
+  end
 end

data/lib/reline/terminfo.rb

@@ -31,21 +31,7 @@ module Reline::Terminfo
   @curses_dl = false
   def self.curses_dl
     return @curses_dl unless @curses_dl == false
-    if RUBY_VERSION >= '3.0.0'
-      # Gem module isn't defined in test-all of the Ruby repository, and
-      # Fiddle in Ruby 3.0.0 or later supports Fiddle::TYPE_VARIADIC.
-      fiddle_supports_variadic = true
-    elsif Fiddle.const_defined?(:VERSION,false) and Gem::Version.create(Fiddle::VERSION) >= Gem::Version.create('1.0.1')
-      # Fiddle::TYPE_VARIADIC is supported from Fiddle 1.0.1.
-      fiddle_supports_variadic = true
-    else
-      fiddle_supports_variadic = false
-    end
-    if fiddle_supports_variadic and not Fiddle.const_defined?(:TYPE_VARIADIC)
-      # If the libffi version is not 3.0.5 or higher, there isn't TYPE_VARIADIC.
-      fiddle_supports_variadic = false
-    end
-    if fiddle_supports_variadic
+    if Fiddle.const_defined?(:TYPE_VARIADIC)
       curses_dl_files.each do |curses_name|
         result = Fiddle::Handle.new(curses_name)
       rescue Fiddle::DLError

data/lib/reline/unicode.rb

@@ -41,26 +41,6 @@ class Reline::Unicode
   OSC_REGEXP = /\e\]\d+(?:;[^;\a\e]+)*(?:\a|\e\\)/
   WIDTH_SCANNER = /\G(?:(#{NON_PRINTING_START})|(#{NON_PRINTING_END})|(#{CSI_REGEXP})|(#{OSC_REGEXP})|(\X))/o
 
-  def self.get_mbchar_byte_size_by_first_char(c)
-    # Checks UTF-8 character byte size
-    case c.ord
-    # 0b0xxxxxxx
-    when ->(code) { (code ^ 0b10000000).allbits?(0b10000000) } then 1
-    # 0b110xxxxx
-    when ->(code) { (code ^ 0b00100000).allbits?(0b11100000) } then 2
-    # 0b1110xxxx
-    when ->(code) { (code ^ 0b00010000).allbits?(0b11110000) } then 3
-    # 0b11110xxx
-    when ->(code) { (code ^ 0b00001000).allbits?(0b11111000) } then 4
-    # 0b111110xx
-    when ->(code) { (code ^ 0b00000100).allbits?(0b11111100) } then 5
-    # 0b1111110x
-    when ->(code) { (code ^ 0b00000010).allbits?(0b11111110) } then 6
-    # successor of mbchar
-    else 0
-    end
-  end
-
   def self.escape_for_print(str)
     str.chars.map! { |gr|
       escaped = EscapedPairs[gr.ord]

data/lib/reline/version.rb

@@ -1,3 +1,3 @@
 module Reline
-  VERSION = '0.3.4'
+  VERSION = '0.3.6'
 end

data/lib/reline.rb

@@ -17,7 +17,7 @@ module Reline
 
   class ConfigEncodingConversionError < StandardError; end
 
-  Key = Struct.new('Key', :char, :combined_char, :with_meta) do
+  Key = Struct.new(:char, :combined_char, :with_meta) do
     def match?(other)
       case other
       when Reline::Key
@@ -83,44 +83,48 @@ module Reline
       @bracketed_paste_finished = false
     end
 
+    def io_gate
+      Reline::IOGate
+    end
+
     def encoding
-      Reline::IOGate.encoding
+      io_gate.encoding
     end
 
     def completion_append_character=(val)
       if val.nil?
         @completion_append_character = nil
       elsif val.size == 1
-        @completion_append_character = val.encode(Reline::IOGate.encoding)
+        @completion_append_character = val.encode(encoding)
       elsif val.size > 1
-        @completion_append_character = val[0].encode(Reline::IOGate.encoding)
+        @completion_append_character = val[0].encode(encoding)
       else
         @completion_append_character = nil
       end
     end
 
     def basic_word_break_characters=(v)
-      @basic_word_break_characters = v.encode(Reline::IOGate.encoding)
+      @basic_word_break_characters = v.encode(encoding)
     end
 
     def completer_word_break_characters=(v)
-      @completer_word_break_characters = v.encode(Reline::IOGate.encoding)
+      @completer_word_break_characters = v.encode(encoding)
     end
 
     def basic_quote_characters=(v)
-      @basic_quote_characters = v.encode(Reline::IOGate.encoding)
+      @basic_quote_characters = v.encode(encoding)
     end
 
     def completer_quote_characters=(v)
-      @completer_quote_characters = v.encode(Reline::IOGate.encoding)
+      @completer_quote_characters = v.encode(encoding)
     end
 
     def filename_quote_characters=(v)
-      @filename_quote_characters = v.encode(Reline::IOGate.encoding)
+      @filename_quote_characters = v.encode(encoding)
     end
 
     def special_prefixes=(v)
-      @special_prefixes = v.encode(Reline::IOGate.encoding)
+      @special_prefixes = v.encode(encoding)
     end
 
     def completion_case_fold=(v)
@@ -181,20 +185,16 @@ module Reline
 
     def input=(val)
       raise TypeError unless val.respond_to?(:getc) or val.nil?
-      if val.respond_to?(:getc)
-        if defined?(Reline::ANSI) and Reline::IOGate == Reline::ANSI
-          Reline::ANSI.input = val
-        elsif Reline::IOGate == Reline::GeneralIO
-          Reline::GeneralIO.input = val
-        end
+      if val.respond_to?(:getc) && io_gate.respond_to?(:input=)
+        io_gate.input = val
       end
     end
 
     def output=(val)
       raise TypeError unless val.respond_to?(:write) or val.nil?
       @output = val
-      if defined?(Reline::ANSI) and Reline::IOGate == Reline::ANSI
-        Reline::ANSI.output = val
+      if io_gate.respond_to?(:output=)
+        io_gate.output = val
       end
     end
 
@@ -217,7 +217,7 @@ module Reline
     end
 
     def get_screen_size
-      Reline::IOGate.get_screen_size
+      io_gate.get_screen_size
     end
 
     Reline::DEFAULT_DIALOG_PROC_AUTOCOMPLETE = ->() {
@@ -260,7 +260,7 @@ module Reline
         pos: cursor_pos_to_render,
         contents: result,
         scrollbar: true,
-        height: 15,
+        height: [15, preferred_dialog_height].min,
         bg_color: 46,
         pointer_bg_color: 45,
         fg_color: 37,
@@ -270,7 +270,8 @@ module Reline
     Reline::DEFAULT_DIALOG_CONTEXT = Array.new
 
     def readmultiline(prompt = '', add_hist = false, &confirm_multiline_termination)
-      Reline::IOGate.with_raw_input do
+      Reline.update_iogate
+      io_gate.with_raw_input do
         unless confirm_multiline_termination
           raise ArgumentError.new('#readmultiline needs block to confirm multiline termination')
         end
@@ -288,6 +289,7 @@ module Reline
     end
 
     def readline(prompt = '', add_hist = false)
+      Reline.update_iogate
       inner_readline(prompt, add_hist, false)
 
       line = line_editor.line.dup
@@ -302,7 +304,7 @@ module Reline
 
     private def inner_readline(prompt, add_hist, multiline, &confirm_multiline_termination)
       if ENV['RELINE_STDERR_TTY']
-        if Reline::IOGate.win?
+        if io_gate.win?
           $stderr = File.open(ENV['RELINE_STDERR_TTY'], 'a')
         else
           $stderr.reopen(ENV['RELINE_STDERR_TTY'], 'w')
@@ -310,10 +312,10 @@ module Reline
         $stderr.sync = true
         $stderr.puts "Reline is used by #{Process.pid}"
       end
-      otio = Reline::IOGate.prep
+      otio = io_gate.prep
 
       may_req_ambiguous_char_width
-      line_editor.reset(prompt, encoding: Reline::IOGate.encoding)
+      line_editor.reset(prompt, encoding: encoding)
       if multiline
         line_editor.multiline_on
         if block_given?
@@ -337,7 +339,7 @@ module Reline
       unless config.test_mode
         config.read
         config.reset_default_key_bindings
-        Reline::IOGate.set_default_key_bindings(config)
+        io_gate.set_default_key_bindings(config)
       end
 
       line_editor.rerender
@@ -346,9 +348,9 @@ module Reline
         line_editor.set_signal_handlers
         prev_pasting_state = false
         loop do
-          prev_pasting_state = Reline::IOGate.in_pasting?
+          prev_pasting_state = io_gate.in_pasting?
           read_io(config.keyseq_timeout) { |inputs|
-            line_editor.set_pasting_state(Reline::IOGate.in_pasting?)
+            line_editor.set_pasting_state(io_gate.in_pasting?)
             inputs.each { |c|
               line_editor.input_key(c)
               line_editor.rerender
@@ -358,29 +360,29 @@ module Reline
               @bracketed_paste_finished = false
             end
           }
-          if prev_pasting_state == true and not Reline::IOGate.in_pasting? and not line_editor.finished?
+          if prev_pasting_state == true and not io_gate.in_pasting? and not line_editor.finished?
             line_editor.set_pasting_state(false)
             prev_pasting_state = false
             line_editor.rerender_all
           end
           break if line_editor.finished?
         end
-        Reline::IOGate.move_cursor_column(0)
+        io_gate.move_cursor_column(0)
       rescue Errno::EIO
         # Maybe the I/O has been closed.
       rescue StandardError => e
         line_editor.finalize
-        Reline::IOGate.deprep(otio)
+        io_gate.deprep(otio)
         raise e
       rescue Exception
         # Including Interrupt
         line_editor.finalize
-        Reline::IOGate.deprep(otio)
+        io_gate.deprep(otio)
         raise
       end
 
       line_editor.finalize
-      Reline::IOGate.deprep(otio)
+      io_gate.deprep(otio)
     end
 
     # GNU Readline waits for "keyseq-timeout" milliseconds to see if the ESC
@@ -395,7 +397,7 @@ module Reline
     private def read_io(keyseq_timeout, &block)
       buffer = []
       loop do
-        c = Reline::IOGate.getc
+        c = io_gate.getc
         if c == -1
           result = :unmatched
           @bracketed_paste_finished = true
@@ -435,7 +437,7 @@ module Reline
       begin
         succ_c = nil
         Timeout.timeout(keyseq_timeout / 1000.0) {
-          succ_c = Reline::IOGate.getc
+          succ_c = io_gate.getc
         }
       rescue Timeout::Error # cancel matching only when first byte
         block.([Reline::Key.new(c, c, false)])
@@ -450,7 +452,7 @@ module Reline
           end
           return :break
         when :matching
-          Reline::IOGate.ungetc(succ_c)
+          io_gate.ungetc(succ_c)
           return :next
         when :matched
           buffer << succ_c
@@ -467,7 +469,7 @@ module Reline
       begin
         escaped_c = nil
         Timeout.timeout(keyseq_timeout / 1000.0) {
-          escaped_c = Reline::IOGate.getc
+          escaped_c = io_gate.getc
         }
       rescue Timeout::Error # independent ESC
         block.([Reline::Key.new(c, c, false)])
@@ -490,19 +492,19 @@ module Reline
     end
 
     private def may_req_ambiguous_char_width
-      @ambiguous_width = 2 if Reline::IOGate == Reline::GeneralIO or !STDOUT.tty?
+      @ambiguous_width = 2 if io_gate == Reline::GeneralIO or !STDOUT.tty?
       return if defined? @ambiguous_width
-      Reline::IOGate.move_cursor_column(0)
+      io_gate.move_cursor_column(0)
       begin
         output.write "\u{25bd}"
       rescue Encoding::UndefinedConversionError
         # LANG=C
         @ambiguous_width = 1
       else
-        @ambiguous_width = Reline::IOGate.cursor_pos.x
+        @ambiguous_width = io_gate.cursor_pos.x
       end
-      Reline::IOGate.move_cursor_column(0)
-      Reline::IOGate.erase_after_cursor
+      io_gate.move_cursor_column(0)
+      io_gate.erase_after_cursor
     end
   end
 
@@ -565,7 +567,7 @@ module Reline
     @core ||= Core.new { |core|
       core.config = Reline::Config.new
       core.key_stroke = Reline::KeyStroke.new(core.config)
-      core.line_editor = Reline::LineEditor.new(core.config, Reline::IOGate.encoding)
+      core.line_editor = Reline::LineEditor.new(core.config, core.encoding)
 
       core.basic_word_break_characters = " \t\n`><=;|&{("
       core.completer_word_break_characters = " \t\n`><=;|&{("
@@ -578,12 +580,24 @@ module Reline
   end
 
   def self.ungetc(c)
-    Reline::IOGate.ungetc(c)
+    core.io_gate.ungetc(c)
   end
 
   def self.line_editor
     core.line_editor
   end
+
+  def self.update_iogate
+    return if core.config.test_mode
+
+    # Need to change IOGate when `$stdout.tty?` change from false to true by `$stdout.reopen`
+    # Example: rails/spring boot the application in non-tty, then run console in tty.
+    if ENV['TERM'] != 'dumb' && core.io_gate == Reline::GeneralIO && $stdout.tty?
+      require 'reline/ansi'
+      remove_const(:IOGate)
+      const_set(:IOGate, Reline::ANSI)
+    end
+  end
 end
 
 require 'reline/general_io'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reline
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.6
 platform: ruby
 authors:
 - aycabta
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-20 00:00:00.000000000 Z
+date: 2023-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: io-console