Merge pull request jruby#8481 from headius/update_reline

Update reline to 0.5.12

Author: headius

lib/pom.rb

@@ -85,7 +85,7 @@ def log(message=nil)
     # ['readline', '0.0.3'],
     # Will be solved with readline
     # ['readline-ext', '0.1.4'],
-    ['reline', '0.4.2'],
+    ['reline', '0.5.12'],
     # https://github.com/ruby/resolv/issues/19
     # ['resolv', '0.2.1'],
     ['resolv-replace', '0.1.0'],

lib/pom.xml

@@ -658,7 +658,7 @@ DO NOT MODIFY - GENERATED CODE
     <dependency>
       <groupId>rubygems</groupId>
       <artifactId>reline</artifactId>
-      <version>0.4.2</version>
+      <version>0.5.12</version>
       <type>gem</type>
       <scope>provided</scope>
       <exclusions>
@@ -1140,7 +1140,7 @@ DO NOT MODIFY - GENERATED CODE
           <include>specifications/racc-1.6.0*</include>
           <include>specifications/rake-ant-1.0.6*</include>
           <include>specifications/rdoc-6.4.1.1*</include>
-          <include>specifications/reline-0.4.2*</include>
+          <include>specifications/reline-0.5.12*</include>
           <include>specifications/resolv-replace-0.1.0*</include>
           <include>specifications/rinda-0.1.1*</include>
           <include>specifications/ruby2_keywords-0.0.5*</include>
@@ -1220,7 +1220,7 @@ DO NOT MODIFY - GENERATED CODE
           <include>gems/racc-1.6.0*/**/*</include>
           <include>gems/rake-ant-1.0.6*/**/*</include>
           <include>gems/rdoc-6.4.1.1*/**/*</include>
-          <include>gems/reline-0.4.2*/**/*</include>
+          <include>gems/reline-0.5.12*/**/*</include>
           <include>gems/resolv-replace-0.1.0*/**/*</include>
           <include>gems/rinda-0.1.1*/**/*</include>
           <include>gems/ruby2_keywords-0.0.5*/**/*</include>
@@ -1300,7 +1300,7 @@ DO NOT MODIFY - GENERATED CODE
           <include>cache/racc-1.6.0*</include>
           <include>cache/rake-ant-1.0.6*</include>
           <include>cache/rdoc-6.4.1.1*</include>
-          <include>cache/reline-0.4.2*</include>
+          <include>cache/reline-0.5.12*</include>
           <include>cache/resolv-replace-0.1.0*</include>
           <include>cache/rinda-0.1.1*</include>
           <include>cache/ruby2_keywords-0.0.5*</include>

test/mri/excludes/Reline/Test.rb

@@ -0,0 +1 @@
+exclude :test_tty_amibuous_width, 'too strict string coercion in Subspawn'

test/mri/reline/helper.rb

@@ -5,33 +5,84 @@
 require 'reline'
 require 'test/unit'
 
+begin
+  require 'rbconfig'
+rescue LoadError
+end
+
+begin
+  # This should exist and available in load path when this file is mirrored to ruby/ruby and running at there
+  if File.exist?(File.expand_path('../../tool/lib/envutil.rb', __dir__))
+    require 'envutil'
+  end
+rescue LoadError
+end
+
 module Reline
   class <<self
-    def test_mode
-        remove_const('IOGate') if const_defined?('IOGate')
-        const_set('IOGate', Reline::GeneralIO)
-        if ENV['RELINE_TEST_ENCODING']
-          encoding = Encoding.find(ENV['RELINE_TEST_ENCODING'])
-        else
-          encoding = Encoding::UTF_8
+    def test_mode(ansi: false)
+      @original_iogate = IOGate
+
+      if ENV['RELINE_TEST_ENCODING']
+        encoding = Encoding.find(ENV['RELINE_TEST_ENCODING'])
+      else
+        encoding = Encoding::UTF_8
+      end
+
+      if ansi
+        new_io_gate = ANSI.new
+        # Setting ANSI gate's screen size through set_screen_size will also change the tester's stdin's screen size
+        # Let's avoid that side-effect by stubbing the get_screen_size method
+        new_io_gate.define_singleton_method(:get_screen_size) do
+          [24, 80]
         end
-        Reline::GeneralIO.reset(encoding: encoding)
-        send(:core).config.instance_variable_set(:@test_mode, true)
-        send(:core).config.reset
+        new_io_gate.define_singleton_method(:encoding) do
+          encoding
+        end
+      else
+        new_io_gate = Dumb.new(encoding: encoding)
+      end
+
+      remove_const('IOGate')
+      const_set('IOGate', new_io_gate)
+      core.config.instance_variable_set(:@test_mode, true)
+      core.config.reset
     end
 
     def test_reset
+      remove_const('IOGate')
+      const_set('IOGate', @original_iogate)
       Reline.instance_variable_set(:@core, nil)
     end
-  end
-end
 
-def start_pasting
-  Reline::GeneralIO.start_pasting
-end
+    # Return a executable name to spawn Ruby process. In certain build configuration,
+    # "ruby" may not be available.
+    def test_rubybin
+      # When this test suite is running in ruby/ruby, prefer EnvUtil result over original implementation
+      if const_defined?(:EnvUtil)
+        return EnvUtil.rubybin
+      end
 
-def finish_pasting
-  Reline::GeneralIO.finish_pasting
+      # The following is a simplified port of EnvUtil.rubybin in ruby/ruby
+      if ruby = ENV["RUBY"]
+        return ruby
+      end
+      ruby = "ruby"
+      exeext = RbConfig::CONFIG["EXEEXT"]
+      rubyexe = (ruby + exeext if exeext and !exeext.empty?)
+      if File.exist? ruby and File.executable? ruby and !File.directory? ruby
+        return File.expand_path(ruby)
+      end
+      if rubyexe and File.exist? rubyexe and File.executable? rubyexe
+        return File.expand_path(rubyexe)
+      end
+      if defined?(RbConfig.ruby)
+        RbConfig.ruby
+      else
+        "ruby"
+      end
+    end
+  end
 end
 
 class Reline::TestCase < Test::Unit::TestCase
@@ -41,11 +92,11 @@ class Reline::TestCase < Test::Unit::TestCase
       if Reline::Unicode::EscapedChars.include?(c.ord)
         c
       else
-        c.encode(@line_editor.instance_variable_get(:@encoding), Encoding::UTF_8, **options)
+        c.encode(@line_editor.encoding, Encoding::UTF_8, **options)
       end
     }.join
   rescue Encoding::UndefinedConversionError, Encoding::InvalidByteSequenceError
-    input.unicode_normalize!(:nfc)
+    input = input.unicode_normalize(:nfc)
     if normalized
       options[:undef] = :replace
       options[:replace] = '?'
@@ -70,23 +121,33 @@ def input_keys(input, convert = true)
           @line_editor.input_key(Reline::Key.new(byte, byte, false))
         end
       else
-        c.bytes.each do |b|
-          @line_editor.input_key(Reline::Key.new(b, b, false))
-        end
+        @line_editor.input_key(Reline::Key.new(c.ord, c.ord, false))
       end
     end
   end
 
   def input_raw_keys(input, convert = true)
     input = convert_str(input) if convert
-    input.bytes.each do |b|
-      @line_editor.input_key(Reline::Key.new(b, b, false))
+    input.chars.each do |c|
+      @line_editor.input_key(Reline::Key.new(c.ord, c.ord, false))
     end
   end
 
-  def assert_line(expected)
-    expected = convert_str(expected)
-    assert_equal(expected, @line_editor.line)
+  def set_line_around_cursor(before, after)
+    input_keys("\C-a\C-k")
+    input_keys(after)
+    input_keys("\C-a")
+    input_keys(before)
+  end
+
+  def assert_line_around_cursor(before, after)
+    before = convert_str(before)
+    after = convert_str(after)
+    line = @line_editor.current_line
+    byte_pointer = @line_editor.instance_variable_get(:@byte_pointer)
+    actual_before = line.byteslice(0, byte_pointer)
+    actual_after = line.byteslice(byte_pointer..)
+    assert_equal([before, after], [actual_before, actual_after])
   end
 
   def assert_byte_pointer_size(expected)
@@ -97,29 +158,22 @@ def assert_byte_pointer_size(expected)
       expected.bytesize, byte_pointer,
       <<~EOM)
         <#{expected.inspect} (#{expected.encoding.inspect})> expected but was
-        <#{chunk.inspect} (#{chunk.encoding.inspect})> in <Terminal #{Reline::GeneralIO.encoding.inspect}>
+        <#{chunk.inspect} (#{chunk.encoding.inspect})> in <Terminal #{Reline::Dumb.new.encoding.inspect}>
       EOM
   end
 
-  def assert_cursor(expected)
-    assert_equal(expected, @line_editor.instance_variable_get(:@cursor))
-  end
-
-  def assert_cursor_max(expected)
-    assert_equal(expected, @line_editor.instance_variable_get(:@cursor_max))
-  end
-
   def assert_line_index(expected)
     assert_equal(expected, @line_editor.instance_variable_get(:@line_index))
   end
 
   def assert_whole_lines(expected)
-    previous_line_index = @line_editor.instance_variable_get(:@previous_line_index)
-    if previous_line_index
-      lines = @line_editor.whole_lines(index: previous_line_index)
-    else
-      lines = @line_editor.whole_lines
+    assert_equal(expected, @line_editor.whole_lines)
+  end
+
+  def assert_key_binding(input, method_symbol, editing_modes = [:emacs, :vi_insert, :vi_command])
+    editing_modes.each do |editing_mode|
+      @config.editing_mode = editing_mode
+      assert_equal(method_symbol, @config.editing_mode.get(input.bytes))
     end
-    assert_equal(expected, lines)
   end
 end

test/mri/reline/test_ansi.rb

@@ -0,0 +1,72 @@
+require_relative 'helper'
+require 'reline'
+
+class Reline::ANSITest < Reline::TestCase
+  def setup
+    Reline.send(:test_mode, ansi: true)
+    @config = Reline::Config.new
+    Reline.core.io_gate.set_default_key_bindings(@config)
+  end
+
+  def teardown
+    Reline.test_reset
+  end
+
+  def test_home
+    assert_key_binding("\e[1~", :ed_move_to_beg) # Console (80x25)
+    assert_key_binding("\e[H", :ed_move_to_beg) # KDE
+    assert_key_binding("\e[7~", :ed_move_to_beg) # urxvt / exoterm
+    assert_key_binding("\eOH", :ed_move_to_beg) # GNOME
+  end
+
+  def test_end
+    assert_key_binding("\e[4~", :ed_move_to_end) # Console (80x25)
+    assert_key_binding("\e[F", :ed_move_to_end) # KDE
+    assert_key_binding("\e[8~", :ed_move_to_end) # urxvt / exoterm
+    assert_key_binding("\eOF", :ed_move_to_end) # GNOME
+  end
+
+  def test_delete
+    assert_key_binding("\e[3~", :key_delete)
+  end
+
+  def test_up_arrow
+    assert_key_binding("\e[A", :ed_prev_history) # Console (80x25)
+    assert_key_binding("\eOA", :ed_prev_history)
+  end
+
+  def test_down_arrow
+    assert_key_binding("\e[B", :ed_next_history) # Console (80x25)
+    assert_key_binding("\eOB", :ed_next_history)
+  end
+
+  def test_right_arrow
+    assert_key_binding("\e[C", :ed_next_char) # Console (80x25)
+    assert_key_binding("\eOC", :ed_next_char)
+  end
+
+  def test_left_arrow
+    assert_key_binding("\e[D", :ed_prev_char) # Console (80x25)
+    assert_key_binding("\eOD", :ed_prev_char)
+  end
+
+  # Ctrl+arrow and Meta+arrow
+  def test_extended
+    assert_key_binding("\e[1;5C", :em_next_word) # Ctrl+→
+    assert_key_binding("\e[1;5D", :ed_prev_word) # Ctrl+←
+    assert_key_binding("\e[1;3C", :em_next_word) # Meta+→
+    assert_key_binding("\e[1;3D", :ed_prev_word) # Meta+←
+    assert_key_binding("\e\e[C", :em_next_word) # Meta+→
+    assert_key_binding("\e\e[D", :ed_prev_word) # Meta+←
+  end
+
+  def test_shift_tab
+    assert_key_binding("\e[Z", :completion_journey_up, [:emacs, :vi_insert])
+  end
+
+  # A few emacs bindings that are always mapped
+  def test_more_emacs
+    assert_key_binding("\e ", :em_set_mark, [:emacs])
+    assert_key_binding("\C-x\C-x", :em_exchange_mark, [:emacs])
+  end
+end