Extract TextModeBuilder

Author: Nu-hin

lib/remote_ruby/adapter_builder.rb

@@ -6,11 +6,10 @@ module RemoteRuby
   class AdapterBuilder
     attr_reader :adapter_params, :use_cache, :save_cache, :text_mode
 
-    def initialize(adapter_klass: nil, use_cache: false, save_cache: false, text_mode: false, **params)
+    def initialize(adapter_klass: nil, use_cache: false, save_cache: false, **params)
       @adapter_klass = adapter_klass
       @use_cache = use_cache
       @save_cache = save_cache
-      @text_mode = text_mode
       @adapter_params = params
 
       RemoteRuby.ensure_cache_dir if save_cache
@@ -26,46 +25,18 @@ def adapter_klass
       end
     end
 
-    def build(code_hash, out_tty: true, err_tty: true)
+    def build(code_hash)
       res = adapter_klass.new(**adapter_params)
 
       cache_mode = use_cache && cache_exists?(code_hash)
 
-      res = if cache_mode
-              cache_adapter(code_hash, res.connection_name)
-            elsif save_cache
-              caching_adapter(res, code_hash)
-            else
-              res
-            end
-
-      wrap_text_mode(res, cache_mode, out_tty, err_tty)
-    end
-
-    def text_mode_params(adapter, cache_mode, out_tty, err_tty)
-      tm_params = ::RemoteRuby::TextModeAdapter::DEFAULT_SETTINGS.merge(
-        stdout_prefix: adapter.connection_name,
-        stderr_prefix: adapter.connection_name
-      )
-
-      tm_params = tm_params.merge(text_mode) if text_mode.is_a? Hash
-
-      disable_unless_tty = tm_params.delete(:disable_unless_tty) { |_| true }
-
-      tm_params[:stdout_prefix] = nil if disable_unless_tty && !out_tty
-      tm_params[:stderr_prefix] = nil if disable_unless_tty && !err_tty
-      tm_params[:cache_prefix] = nil unless cache_mode
-      tm_params
-    end
-
-    def wrap_text_mode(adapter, cache_mode, out_tty, err_tty)
-      return adapter unless text_mode
-
-      tm_params = text_mode_params(adapter, cache_mode, out_tty, err_tty)
-
-      return adapter unless tm_params[:stdout_prefix] || tm_params[:stderr_prefix]
-
-      ::RemoteRuby::TextModeAdapter.new(adapter, **tm_params)
+      if cache_mode
+        cache_adapter(code_hash, res.connection_name)
+      elsif save_cache
+        caching_adapter(res, code_hash)
+      else
+        res
+      end
     end
 
     def cache_adapter(code_hash, connection_name)

lib/remote_ruby/execution_context.rb

@@ -11,6 +11,7 @@
 require 'remote_ruby/remote_context'
 require 'remote_ruby/remote_error'
 require 'remote_ruby/adapter_builder'
+require 'remote_ruby/text_mode_builder'
 
 module RemoteRuby
   # This class is responsible for executing blocks on the remote host with the
@@ -20,6 +21,11 @@ def initialize(**params)
       add_plugins(params)
       configure_streams(params)
       @dump_code = params.delete(:dump_code) || false
+      @text_mode_builder = RemoteRuby::TextModeBuilder.new(
+        out_tty: out_stream.tty?,
+        err_tty: err_stream.tty?,
+        params: params
+      )
       @adapter_builder = RemoteRuby::AdapterBuilder.new(**params)
     end
 
@@ -45,7 +51,7 @@ def execute(locals = nil, &block)
 
     private
 
-    attr_reader :dump_code, :in_stream, :out_stream, :err_stream, :plugins, :adapter_builder
+    attr_reader :dump_code, :in_stream, :out_stream, :err_stream, :plugins, :adapter_builder, :text_mode_builder
 
     def add_plugins(params)
       @plugins = ::RemoteRuby::Plugin.build_plugins(params)
@@ -79,7 +85,8 @@ def build_compiler(ruby_code, client_locals)
     def execute_code(compiler)
       write_code(compiler.code_hash, compiler.compiled_code)
 
-      adapter = adapter_builder.build(compiler.code_hash, out_tty: out_stream.tty?, err_tty: err_stream.tty?)
+      adapter = adapter_builder.build(compiler.code_hash)
+      adapter = text_mode_builder.build(adapter)
 
       # rubocop:disable Security/MarshalLoad
       Marshal.load(adapter.open(compiler.compiled_code, in_stream, out_stream, err_stream))

lib/remote_ruby/text_mode_adapter.rb

@@ -17,26 +17,16 @@ class TextModeAdapter < ConnectionAdapter
     attr_reader :adapter, :stdout_prefix, :stderr_prefix, :cache_prefix, :stdout_mode, :stderr_mode,
                 :cache_mode
 
-    # rubocop:disable Metrics/ParameterLists
-    def initialize(
-      adapter,
-      stdout_prefix:,
-      stderr_prefix:,
-      cache_prefix:,
-      stdout_mode:,
-      stderr_mode:,
-      cache_mode:
-    )
+    def initialize(adapter, **params)
       super()
       @adapter = adapter
-      @stdout_prefix = stdout_prefix
-      @stderr_prefix = stderr_prefix
-      @cache_prefix = cache_prefix
-      @stdout_mode = stdout_mode
-      @stderr_mode = stderr_mode
-      @cache_mode = cache_mode
+      @stdout_prefix = params[:stdout_prefix]
+      @stderr_prefix = params[:stderr_prefix]
+      @cache_prefix = params[:cache_prefix]
+      @stdout_mode = params[:stdout_mode]
+      @stderr_mode = params[:stderr_mode]
+      @cache_mode = params[:cache_mode]
     end
-    # rubocop:enable Metrics/ParameterLists
 
     def open(code, stdin, stdout, stderr)
       stdout_pref = "#{cache_prefix_string}#{stdout_prefix_string}"

lib/remote_ruby/text_mode_builder.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RemoteRuby
+  # Wraps the connection adapter in a text mode adapter if text mode is enabled.
+  class TextModeBuilder
+    attr_reader :out_tty, :err_tty, :text_mode
+
+    def initialize(params:, out_tty: true, err_tty: true)
+      @out_tty = out_tty
+      @err_tty = err_tty
+      @text_mode = params.delete(:text_mode) || false
+    end
+
+    def build(adapter)
+      return adapter unless text_mode
+
+      cache_mode = adapter.is_a? CacheAdapter
+
+      tm_params = text_mode_params(adapter, cache_mode, out_tty, err_tty)
+
+      return adapter unless tm_params[:stdout_prefix] || tm_params[:stderr_prefix]
+
+      ::RemoteRuby::TextModeAdapter.new(adapter, **tm_params)
+    end
+
+    private
+
+    def text_mode_params(adapter, cache_mode, out_tty, err_tty)
+      tm_params = ::RemoteRuby::TextModeAdapter::DEFAULT_SETTINGS.merge(
+        stdout_prefix: adapter.connection_name,
+        stderr_prefix: adapter.connection_name
+      )
+
+      tm_params = tm_params.merge(text_mode) if text_mode.is_a? Hash
+
+      disable_unless_tty = tm_params.delete(:disable_unless_tty) { |_| true }
+
+      tm_params[:stdout_prefix] = nil if disable_unless_tty && !out_tty
+      tm_params[:stderr_prefix] = nil if disable_unless_tty && !err_tty
+      tm_params[:cache_prefix] = nil unless cache_mode
+      tm_params
+    end
+  end
+end