remote_ruby 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfe882ffd1a38cbff3ecfb83645d2596ac0dfec4668bc96a834217dbaacf1ea0
-  data.tar.gz: 1cc79ea7002fdf02434e26ab86227f69de8a3d9ca6daa8263940115f456190bb
+  metadata.gz: 3cedd66138541336a6fbb5518c94c1b8bae4baa005f8326bb08958c5e87f669e
+  data.tar.gz: d93ac29bf86d2cb44c94fb6c9dcea8cfb82fa5d7a24bcfa2d831077a8b26f6f9
 SHA512:
-  metadata.gz: 914c030cec1dde0ac7d3c4444ca5af976feb8928018f3533bf990451b8d6079c58c365f7ac2a46a9b35cc49059f15c87ce956c050f41d31ebba69ce960be3f2e
-  data.tar.gz: e8a95a8592d317c8ee9ed3248203c9be5e5b032bf4ca49fd60162d2a756080bfe43d0a9b68b8038540029eee4329d5691bc12fd611b67424ae2900f6050efa3a
+  metadata.gz: d7ad4224cfcb7e1659c72b4022be4f2b50b08be8e2e7339bef855a46c04d9b5a40fd9ff929a2576c4bea69026b51e375ede8155a8816fd96f30e0fa9bcf0cd5f
+  data.tar.gz: 99177a9d0e62197a65f986be84154f26bb7be6b32a9538af515614ffe3f1575770ad7b836cd0fdd0b19f9c3e6383e34fe4b53c10c4adc0c4ca073d405ec74db9

data/.github/workflows/main.yml

@@ -0,0 +1,28 @@
+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.0', 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
+
+
+

data/.rubocop.yml

@@ -1,3 +1,12 @@
+AllCops:
+  NewCops: enable
+
 Metrics/BlockLength:
-  ExcludedMethods: ['describe', 'context', 'shared_context']
+  IgnoredMethods: ['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,17 +7,16 @@ 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 'bundler', '~> 1.15'
-  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 'coveralls', '~> 0.8', require: false
 end

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Nikita Chernukhin
+Copyright (c) 2021 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,12 +1,13 @@
 # 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)
 [![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)
 
 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)
@@ -26,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.
@@ -95,12 +100,18 @@ puts a # => 100
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'remote_ruby', git: 'https://github.com/nu-hin/remote_ruby'
+gem 'remote_ruby'
 ```
 
 And then execute:
+```bash
+bundle
+```
 
-    $ bundle
+Alternatively, install RemoteRuby in your gemset with the following command:
+```bash
+gem install remote_ruby
+```
 
 ## Usage
 

data/lib/remote_ruby/compiler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'base64'
 require 'digest'
 require 'erb'
@@ -18,6 +20,7 @@ module RemoteRuby
 
     def compiled_code
       return @compiled_code if @compiled_code
+
       template_file =
         ::RemoteRuby.lib_path('remote_ruby/code_templates/compiler/main.rb.erb')
       template = ERB.new(File.read(template_file))
@@ -26,11 +29,13 @@ module RemoteRuby
 
     def client_locals_base64
       return @client_locals_base64 if @client_locals_base64
+
       @client_locals_base64 = {}
 
       client_locals.each do |name, data|
         base64_data = process_local(name, data)
         next if base64_data.nil?
+
         @client_locals_base64[name] = base64_data
       end
 

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)
@@ -46,6 +46,7 @@ module RemoteRuby
     def assign_locals(local_names, values, block)
       local_names.each do |local|
         next unless values.key?(local)
+
         block.binding.local_variable_set(local, values[local])
       end
     end
@@ -102,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,9 +13,10 @@ 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)
+
         locals[name] = value
       end
 
@@ -22,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'.freeze
+  VERSION = '0.2'
 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.'
@@ -18,12 +26,10 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test|spec|features)/})
   end
 
-  spec.bindir        = 'bin'
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   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'
+  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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remote_ruby
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Nikita Chernukhin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-08-31 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -30,60 +30,56 @@ 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'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.6'
 description: Execute Ruby code on the remote servers from local Ruby script.
 email:
 - nuinuhin@gmail.com
-executables:
-- console
-- setup
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
-- bin/console
-- bin/setup
 - lib/remote_ruby.rb
 - lib/remote_ruby/code_templates/compiler/main.rb.erb
 - lib/remote_ruby/compiler.rb
@@ -107,8 +103,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
@@ -116,16 +113,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.7.7
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Execute Ruby code on the remote servers.
 test_files: []

data/.travis.yml

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

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'remote_ruby'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here