Move logic related to custom sequence to a separated file

Author: 0x2c7

lib/ruby_jard.rb

@@ -17,6 +17,7 @@
 require 'ruby_jard/repl_manager'
 require 'ruby_jard/repl_interceptor'
 require 'ruby_jard/repl_state'
+require 'ruby_jard/repl_sequence'
 require 'ruby_jard/screen_manager'
 require 'ruby_jard/reflection'
 

lib/ruby_jard/pry_proxy.rb

@@ -57,12 +57,11 @@ def initialize(options = {})
     end
 
     def handle_line(line, *args)
-      index = line.to_s.rindex(RubyJard::ReplManager::COMMAND_ESCAPE_SEQUENCE)
-      if !index.nil?
-        command = line[(index + RubyJard::ReplManager::COMMAND_ESCAPE_SEQUENCE.length)..-1]
-        super(command, *args)
-      else
+      command = RubyJard::ReplSequence.detect(line)
+      if command.nil?
         super(line, *args)
+      else
+        super(command, *args)
       end
     ensure
       exec_hook :after_handle_line, *args, self

lib/ruby_jard/repl_interceptor.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+begin
+  require 'pty'
+rescue LoadError
+  # Ignore, fallback not to use interceptor
+end
+
 module RubyJard
   # Pry depends heavily on GNU Readline, or any Readline-like input libraries. Those libraries
   # serve limited use cases, and specific interface to support those. Unfortunately, to serve
@@ -44,8 +50,8 @@ class ReplInterceptor
       RubyJard::Keys::CTRL_C => (KEY_BINDING_INTERRUPT = :interrupt)
     }.freeze
 
-    KEY_READ_TIMEOUT = 0.2           # 200ms
-    PTY_OUTPUT_TIMEOUT = 1.to_f / 60 # 60hz
+    KEY_READ_TIMEOUT = 0.2    # 200ms
+    OUTPUT_TICK = 1.to_f / 60 # 60hz
 
     def initialize(state, console, key_bindings)
       @state = state
@@ -68,14 +74,16 @@ def start
     def stop
       @key_listen_thread&.exit if @key_listen_thread&.alive?
       if interceptable?
-        sleep PTY_OUTPUT_TIMEOUT until @state.exited?
+        sleep OUTPUT_TICK until @state.exited?
       else
         @state.exited!
       end
     end
 
     def dispatch_command(command)
-      @input_writer.write("#{RubyJard::ReplManager::COMMAND_ESCAPE_SEQUENCE}#{command}\n")
+      @input_writer.write(
+        "#{RubyJard::ReplSequence.encode(command)}\n"
+      )
     end
 
     def feed_output(content)
@@ -105,6 +113,7 @@ def redirected_output
     end
 
     def interceptable?
+      return false unless defined?(PTY)
       return false if defined?(Reline) && Readline == Reline
       return false if RubyJard::Reflection.instance.call_method(::Readline, :input=).source_location != nil
       return false if RubyJard::Reflection.instance.call_method(::Readline, :output=).source_location != nil
@@ -160,7 +169,7 @@ def output_bridge
             @state.exited!
           end
         elsif @state.exited?
-          sleep PTY_OUTPUT_TIMEOUT
+          sleep OUTPUT_TICK
         else
           content = @output_reader.read_nonblock(2048)
           unless content.nil?
@@ -169,7 +178,7 @@ def output_bridge
         end
       rescue IO::WaitReadable, IO::WaitWritable
         # Retry
-        sleep PTY_OUTPUT_TIMEOUT
+        sleep OUTPUT_TICK
       end
     rescue StandardError
       # This thread shoud never die, or the user may be freezed, and cannot type anything
@@ -184,7 +193,7 @@ def listen_key_press
 
         if @state.processing? && @state.pager?
           # Discard all keys unfortunately
-          sleep PTY_OUTPUT_TIMEOUT
+          sleep OUTPUT_TICK
         else
           key = @key_bindings.match { @console.getch(KEY_READ_TIMEOUT) }
           if key.is_a?(RubyJard::KeyBinding)
@@ -217,7 +226,7 @@ def handle_interrupt_command
       end
       loop do
         begin
-          sleep PTY_OUTPUT_TIMEOUT
+          sleep OUTPUT_TICK
         rescue Interrupt
           # Interrupt spam. Ignore.
         end
@@ -226,7 +235,7 @@ def handle_interrupt_command
     end
 
     def write_output(content)
-      return if content.include?(RubyJard::ReplManager::COMMAND_ESCAPE_SEQUENCE)
+      return if RubyJard::ReplSequence.detect(content)
 
       @console.write content.force_encoding('UTF-8')
     end

lib/ruby_jard/repl_manager.rb

@@ -1,16 +1,13 @@
 # frozen_string_literal: true
 
-require 'pty'
 require 'ruby_jard/pager'
 require 'ruby_jard/pry_proxy'
 
 module RubyJard
   ##
   # Manage the dance between REPL components
   class ReplManager
-    # Escape sequence used to mark command from key binding
-    COMMAND_ESCAPE_SEQUENCE = '\e]711;Command~'
-    PTY_OUTPUT_TIMEOUT = 1.to_f / 60 # 60hz
+    OUTPUT_TICK = 1.to_f / 60 # 60hz
 
     def initialize(console:, key_bindings: nil)
       @console = console
@@ -53,7 +50,7 @@ def pry_proxy
             set_console_cooked!
             @state.processing!
             # Sleep 2 ticks, wait for pry to print out all existing output in the queue
-            sleep PTY_OUTPUT_TIMEOUT * 2
+            sleep OUTPUT_TICK * 2
           },
           after_handle_line: proc {
             set_console_raw!

lib/ruby_jard/repl_sequence.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RubyJard
+  ##
+  # Feed a custom escape sequence into Repl, then detect and parse
+  # to dispatch captured command.
+  class ReplSequence
+    COMMAND_ESCAPE_SEQUENCE_PREFIX = '\e]711;Command~'
+    COMMAND_ESCAPE_SEQUENCE_SUFFIX = ';'
+    COMMAND_ESCAPE_SEQUENCE_REGEXP = /\\e\]711;Command~([a-z\-\ ]*);/.freeze
+
+    def self.encode(command)
+      if command.nil? || command.empty?
+        ''
+      else
+        "#{COMMAND_ESCAPE_SEQUENCE_PREFIX}#{command}#{COMMAND_ESCAPE_SEQUENCE_SUFFIX}"
+      end
+    end
+
+    def self.detect(content)
+      matches = COMMAND_ESCAPE_SEQUENCE_REGEXP.match(content)
+      if matches.nil?
+        nil
+      else
+        matches[1]
+      end
+    end
+  end
+end

spec/ruby_jard/repl_sequence_spec.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+RSpec.describe RubyJard::ReplSequence do
+  describe '#encode' do
+    context 'when command is nil' do
+      it 'returns an empty string' do
+        expect(described_class.encode(nil)).to eql('')
+      end
+    end
+
+    context 'when command is empty' do
+      it 'returns an empty string' do
+        expect(described_class.encode('')).to eql('')
+      end
+    end
+
+    context 'when command is present' do
+      it 'returns escaped sequence' do
+        expect(described_class.encode('hello')).to eql('\e]711;Command~hello;')
+      end
+    end
+  end
+
+  describe '#detect' do
+    context 'when content is empty' do
+      it 'returns nil' do
+        expect(described_class.detect('')).to be(nil)
+      end
+    end
+
+    context 'when content is nil' do
+      it 'returns nil' do
+        expect(described_class.detect(nil)).to be(nil)
+      end
+    end
+
+    context 'when content does not contain an escaped sequence' do
+      it 'returns nil' do
+        expect(described_class.detect('hello 123')).to be(nil)
+      end
+    end
+
+    context 'when content contains an empty escaped sequence' do
+      it 'returns nil' do
+        expect(described_class.detect('\e]711;Command~')).to be(nil)
+      end
+    end
+
+    context 'when content contains a valid escaped sequence' do
+      it 'returns mentioned command' do
+        expect(described_class.detect('1251\e]711;Command~list;abcabc')).to eql('list')
+      end
+    end
+
+    context 'when content contains an escaped sequence with spaces' do
+      it 'returns mentioned command' do
+        expect(
+          described_class.detect('1251\e]711;Command~jard filter switch;abcabc')
+        ).to eql('jard filter switch')
+      end
+    end
+
+    context 'when content contains multiple escaped sequences' do
+      it 'returns first mentioned command' do
+        expect(
+          described_class.detect('1251\e]711;Command~list;abcabc\e]711;Command~patch;123')
+        ).to eql('list')
+      end
+    end
+  end
+end