remote_ruby 0.3.0 → 1.0.0

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: remote_ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Nikita Chernukhin
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-16 00:00:00.000000000 Z
+date: 2025-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -30,42 +29,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: method_source
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.3'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: unparser
   requirement: !ruby/object:Gem::Requirement
@@ -87,39 +128,43 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
-- ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- Gemfile
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - lib/remote_ruby.rb
+- lib/remote_ruby/adapter_builder.rb
+- lib/remote_ruby/cache_adapter.rb
+- lib/remote_ruby/caching_adapter.rb
 - lib/remote_ruby/code_templates/compiler/main.rb.erb
+- lib/remote_ruby/compat_io_reader.rb
+- lib/remote_ruby/compat_io_writer.rb
 - lib/remote_ruby/compiler.rb
 - lib/remote_ruby/connection_adapter.rb
-- lib/remote_ruby/connection_adapter/cache_adapter.rb
-- lib/remote_ruby/connection_adapter/caching_adapter.rb
-- lib/remote_ruby/connection_adapter/eval_adapter.rb
-- lib/remote_ruby/connection_adapter/local_stdin_adapter.rb
-- lib/remote_ruby/connection_adapter/ssh_stdin_adapter.rb
-- lib/remote_ruby/connection_adapter/stdin_process_adapter.rb
 - lib/remote_ruby/execution_context.rb
-- lib/remote_ruby/flavour.rb
-- lib/remote_ruby/flavour/rails_flavour.rb
+- lib/remote_ruby/extensions.rb
 - lib/remote_ruby/locals_extractor.rb
-- lib/remote_ruby/runner.rb
+- lib/remote_ruby/parser_factory.rb
+- lib/remote_ruby/plugin.rb
+- lib/remote_ruby/rails_plugin.rb
+- lib/remote_ruby/remote_context.rb
+- lib/remote_ruby/remote_error.rb
 - lib/remote_ruby/source_extractor.rb
-- lib/remote_ruby/stream_cacher.rb
-- lib/remote_ruby/unmarshaler.rb
+- lib/remote_ruby/ssh_adapter.rb
+- lib/remote_ruby/stream_prefixer.rb
+- lib/remote_ruby/tee_writer.rb
+- lib/remote_ruby/text_mode_adapter.rb
+- lib/remote_ruby/text_mode_builder.rb
+- lib/remote_ruby/tmp_file_adapter.rb
 - lib/remote_ruby/version.rb
-- remote_ruby.gemspec
 homepage: https://github.com/nu-hin/remote_ruby
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+  homepage_uri: https://github.com/nu-hin/remote_ruby
+  source_code_uri: https://github.com/nu-hin/remote_ruby
 rdoc_options: []
 require_paths:
 - lib
@@ -127,15 +172,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Execute Ruby code on the remote servers.
 test_files: []

data/.github/workflows/main.yml

@@ -1,26 +0,0 @@
-name: "Lint & Test"
-on: [push, pull_request]
-jobs:
-  rubocop:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.0.2
-          bundler-cache: true
-      - run: bundle exec rubocop
-  rspec:
-    strategy:
-      matrix:
-        os: [ubuntu-latest, macos-latest]
-        ruby: [2.6, 2.7, 3.2, head]
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - run: bundle exec rspec
-      - uses: coverallsapp/github-action@v2

data/.gitignore

@@ -1,17 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/cache/
-/tmp/
-/tags
-/spec/integration/config.yml
-
-# rspec failure tracking
-.rspec_status
-
-.gem

data/Gemfile

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-gemspec
-
-group :development do
-  gem 'rubocop', '~> 1.23'
-  gem 'yard', '~> 0.9'
-end
-
-group :development, :test do
-  gem 'byebug', '~> 11.1'
-  gem 'pry-byebug', '~> 3.9'
-  gem 'rspec', '~> 3.10'
-end
-
-group :test do
-  gem 'simplecov', '~> 0.22'
-  gem 'simplecov-lcov', '~> 0.8'
-end

data/lib/remote_ruby/connection_adapter/cache_adapter.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module RemoteRuby
-  # An adapter which takes stdout and stderr from files and ignores
-  # all stdin. Only used to read from cache.
-  class CacheAdapter < ConnectionAdapter
-    def initialize(connection_name:, cache_path:)
-      super
-      @cache_path = cache_path
-      @connection_name = connection_name
-    end
-
-    def connection_name
-      "[CACHE] #{@connection_name}"
-    end
-
-    def open(_code)
-      stdout = File.open(stdout_file_path, 'r')
-      stderr = File.open(stderr_file_path, 'r')
-
-      yield stdout, stderr
-    ensure
-      stderr.close unless stderr.closed?
-      stdout.close unless stdout.closed?
-    end
-
-    private
-
-    attr_reader :cache_path
-
-    def stdout_file_path
-      fp = "#{cache_path}.stdout"
-      File.exist?(fp) ? fp : File::NULL
-    end
-
-    def stderr_file_path
-      fp = "#{cache_path}.stderr"
-      File.exist?(fp) ? fp : File::NULL
-    end
-  end
-end

data/lib/remote_ruby/connection_adapter/eval_adapter.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-module RemoteRuby
-  # An adapter to expecute Ruby code in the current process in an isolated
-  # scope
-  class EvalAdapter < ConnectionAdapter
-    attr_reader :async, :working_dir
-
-    def initialize(working_dir: Dir.pwd, async: false)
-      super
-      @async = async
-      @working_dir = working_dir
-    end
-
-    def connection_name
-      ''
-    end
-
-    def open(code, &block)
-      if async
-        run_async(code, &block)
-      else
-        run_sync(code, &block)
-      end
-    end
-
-    private
-
-    def run_code(code)
-      binder = Object.new
-
-      Dir.chdir(working_dir) do
-        binder.instance_eval(code)
-      end
-    end
-
-    def run_sync(code)
-      with_stringio do |tmp_stdout, tmp_stderr|
-        with_tmp_streams(tmp_stdout, tmp_stderr) do
-          run_code(code)
-        end
-
-        tmp_stdout.close_write
-        tmp_stderr.close_write
-        tmp_stdout.rewind
-        tmp_stderr.rewind
-        yield tmp_stdout, tmp_stderr
-      end
-    end
-
-    def run_async(code)
-      with_pipes do |out_read, out_write, err_read, err_write|
-        Thread.new do
-          with_tmp_streams(out_write, err_write) do
-            run_code(code)
-          end
-
-          out_write.close
-          err_write.close
-        end
-
-        yield out_read, err_read
-      end
-    end
-
-    def with_pipes
-      out_read, out_write = IO.pipe
-      err_read, err_write = IO.pipe
-      yield out_read, out_write, err_read, err_write
-    ensure
-      out_read.close
-      err_read.close
-    end
-
-    def with_stringio
-      out = StringIO.new
-      err = StringIO.new
-
-      yield out, err
-    ensure
-      out.close
-      err.close
-    end
-
-    def with_tmp_streams(out, err)
-      old_stdout = $stdout
-      old_stderr = $stderr
-      $stdout = out
-      $stderr = err
-      yield
-    ensure
-      $stdout = old_stdout
-      $stderr = old_stderr
-    end
-  end
-end

data/lib/remote_ruby/connection_adapter/local_stdin_adapter.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module RemoteRuby
-  # An adapter to expecute Ruby code on the local macine
-  # inside a specified directory
-  class LocalStdinAdapter < ::RemoteRuby::StdinProcessAdapter
-    attr_reader :working_dir, :bundler
-
-    def initialize(working_dir: '.', bundler: false)
-      super
-      @working_dir = working_dir
-      @bundler = bundler
-    end
-
-    def connection_name
-      working_dir
-    end
-
-    private
-
-    def command
-      if bundler
-        "cd \"#{working_dir}\" && bundle exec ruby"
-      else
-        "cd \"#{working_dir}\" && ruby"
-      end
-    end
-  end
-end

data/lib/remote_ruby/connection_adapter/ssh_stdin_adapter.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module RemoteRuby
-  # An adapter to execute Ruby code on the remote server via SSH
-  class SSHStdinAdapter < StdinProcessAdapter
-    attr_reader :server, :working_dir, :user, :key_file, :bundler
-
-    def initialize(server:, working_dir: '~', user: nil, key_file: nil, bundler: false)
-      super
-      @working_dir = working_dir
-      @server = user.nil? ? server : "#{user}@#{server}"
-      @user = user
-      @key_file = key_file
-      @bundler = bundler
-    end
-
-    def connection_name
-      "#{server}:#{working_dir}"
-    end
-
-    private
-
-    def command
-      command = 'ssh'
-      command = "#{command} -i #{key_file}" if key_file
-
-      if bundler
-        "#{command} #{server} \"cd #{working_dir} && bundle exec ruby\""
-      else
-        "#{command} #{server} \"cd #{working_dir} && ruby\""
-      end
-    end
-  end
-end

data/lib/remote_ruby/connection_adapter/stdin_process_adapter.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require 'open3'
-
-module RemoteRuby
-  # Base class for adapters which launch an external process to execute
-  # Ruby code and send the code to its standard input.
-  class StdinProcessAdapter < ::RemoteRuby::ConnectionAdapter
-    include Open3
-
-    def open(code)
-      result = nil
-
-      popen3(command) do |stdin, stdout, stderr, wait_thr|
-        stdin.write(code)
-        stdin.close
-
-        yield stdout, stderr
-
-        result = wait_thr.value
-      end
-
-      return if result.success?
-
-      raise "Remote connection exited with code #{result}"
-    end
-
-    protected
-
-    # Command to run an external process. Override in a child class.
-    def command
-      raise NotImplementedError
-    end
-  end
-end

data/lib/remote_ruby/flavour.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module RemoteRuby
-  # Base class for Flavours: addons to execution context to insert additonal
-  # code to the generated remote code.
-  class Flavour
-    def self.build_flavours(args = {})
-      res = []
-
-      {
-        rails: RemoteRuby::RailsFlavour
-      }.each do |name, klass|
-        options = args.delete(name)
-
-        res << klass.new(**options) if options
-      end
-
-      res
-    end
-
-    def initialize(**args); end
-
-    def code_header; end
-  end
-end
-
-require 'remote_ruby/flavour/rails_flavour'

data/lib/remote_ruby/runner.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-require 'colorize'
-
-require 'remote_ruby/unmarshaler'
-
-module RemoteRuby
-  # Runner class is responsible for running a prepared Ruby code with given
-  # connection adapter, reading output and unmarshalling result and local
-  # variables values.
-  class Runner
-    def initialize(code:, adapter:, out_stream: $stdout, err_stream: $stderr)
-      @code = code
-      @adapter = adapter
-      @out_stream = out_stream
-      @err_stream = err_stream
-    end
-
-    def run
-      locals = nil
-
-      adapter.open(code) do |stdout, stderr|
-        out_thread = read_stream(stdout, out_stream, :green)
-        err_thread = read_stream(stderr, err_stream, :red)
-        [out_thread, err_thread].each(&:join)
-        locals = out_thread[:locals]
-      end
-
-      { result: locals[:__return_val__], locals: locals }
-    end
-
-    private
-
-    attr_reader :code, :adapter, :out_stream, :err_stream
-
-    def read_stream(read_from, write_to, color)
-      Thread.new do
-        until read_from.eof?
-          line = read_from.readline
-
-          if line.start_with?('%%%MARSHAL')
-            Thread.current[:locals] ||= unmarshal(read_from)
-          else
-            write_to.puts "#{adapter.connection_name.send(color)}>\t#{line}"
-          end
-        end
-      end
-    end
-
-    def unmarshal(stdout)
-      unmarshaler = RemoteRuby::Unmarshaler.new(stdout)
-      unmarshaler.unmarshal
-    end
-  end
-end

data/lib/remote_ruby/stream_cacher.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module RemoteRuby
-  # Decorates the source stream and writes to the cache stream as
-  # the source is being read
-  class StreamCacher
-    def initialize(source_stream, cache_stream)
-      @source_stream = source_stream
-      @cache_stream = cache_stream
-    end
-
-    def read(*args)
-      res = source_stream.read(*args)
-      cache_stream.write(res)
-      res
-    end
-
-    def readline
-      res = source_stream.readline
-      cache_stream.write(res)
-      res
-    end
-
-    def eof?
-      source_stream.eof?
-    end
-
-    def close
-      source_stream.close
-    end
-
-    private
-
-    attr_reader :source_stream, :cache_stream
-  end
-end

data/lib/remote_ruby/unmarshaler.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module RemoteRuby
-  # Unmarshals variables from given stream
-  class Unmarshaler
-    UnmarshalError = Class.new(StandardError)
-
-    def initialize(stream, terminator = nil)
-      @stream = stream
-      @terminator = terminator
-    end
-
-    def unmarshal
-      res = {}
-
-      until stream.eof?
-        line = stream.readline
-
-        break if terminator && line == terminator
-
-        var = read_var(line)
-        res[var.first] = var[1]
-      end
-
-      res
-    end
-
-    private
-
-    attr_reader :stream, :terminator
-
-    def read_var(line)
-      varname, length = read_var_header(line)
-      data = read_var_data(length)
-      [varname.to_sym, data]
-    rescue ArgumentError => e
-      raise UnmarshalError,
-            "Could not resolve type for #{varname} variable: #{e.message}"
-    rescue TypeError
-      raise UnmarshalError, 'Incorrect data format'
-    end
-
-    def read_var_header(line)
-      varname, length = line.split(':')
-
-      raise UnmarshalError, "Incorrect header '#{line}'" \
-        if varname.nil? || length.nil?
-
-      [varname, length]
-    end
-
-    # rubocop:disable Security/MarshalLoad
-    def read_var_data(length)
-      data = stream.read(length.to_i)
-      Marshal.load(data)
-    end
-    # rubocop:enable Security/MarshalLoad
-  end
-end