remote_ruby 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4ca4ae0f79adc6808a812e4e602e6f494ea18cf6
-  data.tar.gz: 5f2c4d145537c60a31d7993ba1460d90804edf76
+SHA256:
+  metadata.gz: 21850de6e7b04dfe1d79d324a84d1d75a667d8108f569af35a09a2eeb9bd0ccf
+  data.tar.gz: bc24eeaa65cfe32d2255ae57b2a0d25c0ec5e1f80405f699c338ccf05f61076a
 SHA512:
-  metadata.gz: 19fefa7fa66cfb83d57985c048ca73201c62c86149dcda365333349da2d452ba722ca662a78b9f3e7873f8e45219f0ae40a236585673f022fcdda6fd2a8e8f3f
-  data.tar.gz: aae7df487861b0cc0185e2df02c767ccd9e980a158aeeaf73c01edd909b5801bc213a414c1073b10e3fe58cd0a7d8e85d30d14b0089621f4c7849ef5e7eac7bb
+  metadata.gz: 2edae65955253f3bfaada58cc4fa813663d55ac85866ecff94495931802467d93197f66b449e8296d9a7b1b09b890acafb7c5e2ac8eedef4c82ab4bb3bfb89cf
+  data.tar.gz: b017792d4c4d400d680e77f6865c9fe3b0b8a6187f9a5c31134895cc1c2946724d687ebe72b41ae85a3372c80de78b4ba6fff64ef70d216788ef6640ed94fab5

data/.github/workflows/main.yml

@@ -0,0 +1,26 @@
+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/.rubocop.yml

@@ -1,3 +1,13 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
 Metrics/BlockLength:
-  ExcludedMethods: ['describe', 'context', 'shared_context']
+  AllowedMethods: ['describe', 'context', 'shared_context']
+
+Style/GlobalStdStream:
+  Exclude:
+    - spec/remote_ruby/connection_adapter/eval_adapter_spec.rb
 
+Style/DocumentDynamicEvalDefinition:
+  Enabled: false

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
@@ -5,16 +7,17 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 group :development do
-  gem 'rubocop'
-  gem 'yard'
+  gem 'rubocop', '~> 1.23'
+  gem 'yard', '~> 0.9'
 end
 
 group :development, :test do
-  gem 'byebug', '>= 8.0'
-  gem 'pry-byebug'
-  gem 'rspec', '~> 3.0'
+  gem 'byebug', '~> 11.1'
+  gem 'pry-byebug', '~> 3.9'
+  gem 'rspec', '~> 3.10'
 end
 
 group :test do
-  gem 'coveralls', require: false
+  gem 'simplecov', '~> 0.22'
+  gem 'simplecov-lcov', '~> 0.8'
 end

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Nikita Chernukhin
+Copyright (c) 2024 Nikita Chernukhin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,5 @@
 # remote_ruby
-
-[![Build Status](https://travis-ci.org/Nu-hin/remote_ruby.svg?branch=master)](https://travis-ci.org/Nu-hin/remote_ruby)
+[![Lint & Test](https://github.com/Nu-hin/remote_ruby/actions/workflows/main.yml/badge.svg)](https://github.com/Nu-hin/remote_ruby/actions/workflows/main.yml)
 [![Coverage Status](https://coveralls.io/repos/github/Nu-hin/remote_ruby/badge.svg?branch=master)](https://coveralls.io/github/Nu-hin/remote_ruby?branch=master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/e57430aa6f626aeca41d/maintainability)](https://codeclimate.com/github/Nu-hin/remote_ruby/maintainability)
 [![Gem Version](https://badge.fury.io/rb/remote_ruby.svg)](https://badge.fury.io/rb/remote_ruby)
@@ -8,6 +7,7 @@
 RemoteRuby allows you to execute Ruby code on remote servers via SSH right from the Ruby script running on your local machine, as if it was executed locally.
 
 ## Contents
+* [Requirements](#requirements)
 * [Overview](#overview)
 	* [How it works](#how-it-works)
 	* [Key features](#key-features)
@@ -27,6 +27,10 @@ RemoteRuby allows you to execute Ruby code on remote servers via SSH right from
 * [Contributing](#contributing)
 * [License](#license)
 
+## Requirements
+
+RemoteRuby requires at least Ruby 2.6 to run.
+
 ## Overview
 
 Here is a short example on how you can run your code remotely.

data/lib/remote_ruby/code_templates/compiler/main.rb.erb

@@ -1,3 +1,6 @@
+# Set up Bundler if Gemfile is present
+require 'bundler/setup' if File.exist?('Gemfile')
+
 require 'base64'
 
 __marshalled_locals_names__ = []

data/lib/remote_ruby/compiler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'base64'
 require 'digest'
 require 'erb'

data/lib/remote_ruby/connection_adapter/cache_adapter.rb

@@ -1,8 +1,11 @@
+# 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

data/lib/remote_ruby/connection_adapter/caching_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'remote_ruby/stream_cacher'
 
 module RemoteRuby
@@ -5,6 +7,7 @@ module RemoteRuby
   # initializer to cache stdout and stderr to local filesystem
   class CachingAdapter < ConnectionAdapter
     def initialize(cache_path:, adapter:)
+      super
       @cache_path = cache_path
       @adapter = adapter
     end

data/lib/remote_ruby/connection_adapter/eval_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RemoteRuby
   # An adapter to expecute Ruby code in the current process in an isolated
   # scope
@@ -5,6 +7,7 @@ module RemoteRuby
     attr_reader :async, :working_dir
 
     def initialize(working_dir: Dir.pwd, async: false)
+      super
       @async = async
       @working_dir = working_dir
     end
@@ -13,15 +16,11 @@ module RemoteRuby
       ''
     end
 
-    def open(code)
+    def open(code, &block)
       if async
-        run_async(code) do |out, err|
-          yield out, err
-        end
+        run_async(code, &block)
       else
-        run_sync(code) do |out, err|
-          yield out, err
-        end
+        run_sync(code, &block)
       end
     end
 

data/lib/remote_ruby/connection_adapter/local_stdin_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RemoteRuby
   # An adapter to expecute Ruby code on the local macine
   # inside a specified directory
@@ -5,6 +7,7 @@ module RemoteRuby
     attr_reader :working_dir
 
     def initialize(working_dir: '.')
+      super
       @working_dir = working_dir
     end
 

data/lib/remote_ruby/connection_adapter/ssh_stdin_adapter.rb

@@ -1,9 +1,12 @@
+# 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
 
     def initialize(server:, working_dir: '~', user: nil, key_file: nil)
+      super
       @working_dir = working_dir
       @server = user.nil? ? server : "#{user}@#{server}"
       @user = user

data/lib/remote_ruby/connection_adapter/stdin_process_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'open3'
 
 module RemoteRuby

data/lib/remote_ruby/connection_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RemoteRuby
   # Base class for other connection adapters.
   class ConnectionAdapter
@@ -20,7 +22,7 @@ module RemoteRuby
   end
 end
 
-require 'remote_ruby/connection_adapter/eval_adapter.rb'
+require 'remote_ruby/connection_adapter/eval_adapter'
 require 'remote_ruby/connection_adapter/stdin_process_adapter'
 require 'remote_ruby/connection_adapter/ssh_stdin_adapter'
 require 'remote_ruby/connection_adapter/local_stdin_adapter'

data/lib/remote_ruby/execution_context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'digest'
 require 'fileutils'
 
@@ -12,7 +14,6 @@ module RemoteRuby
   # This class is responsible for executing blocks on the remote host with the
   # specified adapters. This is the entrypoint to RemoteRuby logic.
   class ExecutionContext
-    # rubocop:disable Metrics/CyclomaticComplexity
     def initialize(**params)
       add_flavours(params)
       @use_cache = params.delete(:use_cache)   || false
@@ -25,7 +26,6 @@ module RemoteRuby
 
       FileUtils.mkdir_p(@cache_dir)
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
 
     def execute(locals = nil, &block)
       source = code_source(block)
@@ -103,7 +103,7 @@ module RemoteRuby
     end
 
     def adapter(code_hash)
-      actual_adapter = adapter_klass.new(params)
+      actual_adapter = adapter_klass.new(**params)
 
       if use_cache && cache_exists?(code_hash)
         cache_adapter(actual_adapter, code_hash)

data/lib/remote_ruby/flavour/rails_flavour.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module RemoteRuby
   # Flavour to load Rails environment
   class RailsFlavour < ::RemoteRuby::Flavour
     def initialize(environment: :development)
+      super
       @environment = environment
     end
 

data/lib/remote_ruby/flavour.rb

@@ -1,14 +1,16 @@
+# 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(params = {})
+    def self.build_flavours(args = {})
       res = []
 
       {
         rails: RemoteRuby::RailsFlavour
       }.each do |name, klass|
-        options = params.delete(name)
+        options = args.delete(name)
 
         res << klass.new(**options) if options
       end
@@ -16,7 +18,7 @@ module RemoteRuby
       res
     end
 
-    def initialize(params: {}); end
+    def initialize(**args); end
 
     def code_header; end
   end

data/lib/remote_ruby/locals_extractor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RemoteRuby
   # Extracts local variable from given context
   class LocalsExtractor
@@ -11,7 +13,7 @@ module RemoteRuby
     def locals
       locals = {}
 
-      local_variable_names.each do |name|
+      block.binding.local_variables.each do |name|
         value = block.binding.eval(name.to_s)
         next if ignored_type?(value)
 
@@ -23,18 +25,6 @@ module RemoteRuby
 
     private
 
-    def local_variable_names
-      if RUBY_VERSION >= '2.2'
-        block.binding.local_variables
-      else
-        # A hack to support Ruby 2.1 due to the absence
-        # of Binding#local_variables method. For some reason
-        # just calling `block.binding.send(:local_variables)`
-        # returns variables of the current context.
-        block.binding.eval('binding.send(:local_variables)')
-      end
-    end
-
     def ignored_type?(var)
       ignore_types.any? { |klass| var.is_a? klass }
     end

data/lib/remote_ruby/runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'colorize'
 
 require 'remote_ruby/unmarshaler'

data/lib/remote_ruby/source_extractor.rb

@@ -1,7 +1,19 @@
+# frozen_string_literal: true
+
 require 'method_source'
 require 'parser/current'
 require 'unparser'
 
+# Opt-in to most recent AST format
+Parser::Builders::Default.emit_lambda              = true
+Parser::Builders::Default.emit_procarg0            = true
+Parser::Builders::Default.emit_encoding            = true
+Parser::Builders::Default.emit_index               = true
+Parser::Builders::Default.emit_arg_inside_procarg0 = true
+Parser::Builders::Default.emit_forward_arg         = true
+Parser::Builders::Default.emit_kwargs              = true
+Parser::Builders::Default.emit_match_pattern       = true
+
 module RemoteRuby
   # Receives a block and extracts Ruby code (as a string) with this block's
   # source

data/lib/remote_ruby/stream_cacher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RemoteRuby
   # Decorates the source stream and writes to the cache stream as
   # the source is being read

data/lib/remote_ruby/unmarshaler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RemoteRuby
   # Unmarshals variables from given stream
   class Unmarshaler
@@ -41,9 +43,8 @@ module RemoteRuby
     def read_var_header(line)
       varname, length = line.split(':')
 
-      if varname.nil? || length.nil?
-        raise UnmarshalError, "Incorrect header '#{line}'"
-      end
+      raise UnmarshalError, "Incorrect header '#{line}'" \
+        if varname.nil? || length.nil?
 
       [varname, length]
     end

data/lib/remote_ruby/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RemoteRuby
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.2.1'
 end

data/lib/remote_ruby.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'remote_ruby/version'
 require 'remote_ruby/execution_context'
 

data/remote_ruby.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'remote_ruby/version'
@@ -8,6 +10,12 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Nikita Chernukhin']
   spec.email         = ['nuinuhin@gmail.com']
 
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
+
+  spec.required_ruby_version = '>= 2.6'
+
   spec.summary       = 'Execute Ruby code on the remote servers.'
   spec.description   =
     'Execute Ruby code on the remote servers from local Ruby script.'
@@ -20,8 +28,9 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'base64', '~> 0.2'
   spec.add_runtime_dependency 'colorize', '~> 0.8'
-  spec.add_runtime_dependency 'method_source', '~> 0.9'
-  spec.add_runtime_dependency 'parser', '~> 2.5'
-  spec.add_runtime_dependency 'unparser', '~> 0.2.6'
+  spec.add_runtime_dependency 'method_source', '~> 1.0'
+  spec.add_runtime_dependency 'parser', '~> 3.0'
+  spec.add_runtime_dependency 'unparser', '~> 0.6'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: remote_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - Nikita Chernukhin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-14 00:00:00.000000000 Z
+date: 2024-06-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -30,42 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: unparser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: '0.6'
 description: Execute Ruby code on the remote servers from local Ruby script.
 email:
 - nuinuhin@gmail.com
@@ -73,11 +87,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".gitlab-ci.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -104,8 +117,9 @@ files:
 homepage: https://github.com/nu-hin/remote_ruby
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,16 +127,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.5.9
+signing_key:
 specification_version: 4
 summary: Execute Ruby code on the remote servers.
 test_files: []

data/.gitlab-ci.yml

@@ -1,38 +0,0 @@
-variables:
-  BUNDLE_APP_CONFIG: '.bundle'
-
-stages:
-  - build
-  - lint
-  - test
-
-cache:
-  key: ${CI_COMMIT_REF_SLUG}
-  paths:
-  - vendor/bundle/
-  - .bundle/
-
-bundle:
-  stage: build
-  script:
-    - bundle config --local path vendor/bundle
-    - bundle config --local jobs $(nproc)
-    - bundle config --local with development test
-    - bundle install
-    - bundle env
-    - ls -la
-
-rubocop:
-  stage: lint
-  script:
-    - ls -la
-    - ls -la vendor/bundle/ruby/*/gems
-    - bundle exec rubocop
-  dependencies:
-    - bundle
-
-rspec:
-  stage: test
-  script: bundle exec rspec
-  dependencies:
-    - bundle

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-rvm:
-  - 2.1
-  - 2.2
-  - 2.2.3
-  - 2.3
-  - 2.4
-  - 2.5
-script:
-  - bundle exec rspec
-os:
-  - linux
-  - osx