remote_ruby 0.3.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37bace854f64fcf07a95e1a8168cef708988610894764afdfadc08c8fb46674d
-  data.tar.gz: 0324ae7519ada602236715247b2dd55b228e33019f5d262024fc3acbbe2fa823
+  metadata.gz: acba2fd4c7364a6be5101be3505de18aeb6b566e061bb9eafdc1dbff82347209
+  data.tar.gz: 3ce29f9130c169b18b7c9b372e8249ea399229a4f78b28aaed615cdfb98b9c2f
 SHA512:
-  metadata.gz: 1ed7df90f0a19153b1cc868b21aded8630eb40eaa6c52925c7ffad99fcac69d58733bec402ea3d4eff9fe5eb511d39281539ed292b56f350ecb02f2c68f9662d
-  data.tar.gz: 9ed44ea3c1abee071e574f1a5fb69979464b47d8dd22ad1c7349f118bf5020e1ee6241ed5b8dbecb6a5e99d9906de051ccef11ff1b767c2d732e2a26702d6002
+  metadata.gz: e390a2c17b1738f9aef2776fe0eaec313a2d6aa3bbc83b1be07741fad2c0d2fdeb62471f3bcf38feb3a783dfd8230c24d176ce738d7b31f49e62486c11b567c4
+  data.tar.gz: 538d0d9b0b8713b93624e92664075eaffcc06202107e3860ba96d506b3590c645bcaf0b522eda8cfa9f48e212de5e0e25725b8cba658c0a8bd5e9b396276cdda

data/.rspec

@@ -1,4 +1,3 @@
 --require 'spec_helper'
---format documentation
 --color
---tag ~type:integration
+--tag ~type:ssh

data/.rubocop.yml

@@ -1,13 +1,44 @@
+plugins:
+  - rubocop-rspec
+
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
+
+Metrics/AbcSize:
+  Max: 22
+
+Metrics/ClassLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 24
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 30
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
 
-Metrics/BlockLength:
-  AllowedMethods: ['describe', 'context', 'shared_context']
+RSpec/NestedGroups:
+  Max: 4
 
-Style/GlobalStdStream:
+RSpec/DescribeClass:
   Exclude:
-    - spec/remote_ruby/connection_adapter/eval_adapter_spec.rb
+    - 'spec/integration/**/*_spec.rb'
+
+
+RSpec/ContextWording:
+  Prefixes:
+    - and
+    - with
+    - because
+    - when
+    - without
+    - shared
 
-Style/DocumentDynamicEvalDefinition:
+RSpec/RepeatedExampleGroupBody:
   Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,69 @@
+# Changelog
+
+## [1.1](https://github.com/Nu-hin/remote_ruby/releases/tag/v1.1)
+
+* Added a new option `ruby_executable` to the `ExecutionContext`
+* Fixed a bug when non-zero return code of SSH process was raising an incorrect excepion.
+
+## [1.0](https://github.com/Nu-hin/remote_ruby/releases/tag/v1.0)
+
+### Major changes
+
+* Full [support of SSH features](README.md#ssh-parameters), including password authentication, private key passphrases, made possible by switching to [net-ssh](https://github.com/net-ssh/net-ssh) gem.
+* Since RemoteRuby no longer uses system SSH client, use of MacOS Keychain (`UseKeychain` option in MacOS OpenSSH implementation, starting from MacOS Sierra) is no longer possible.
+* Added [support for STDIN](README.md#input) redirection. It is now possible to make remote scripts interactive, or stream data from local host.
+* The output and error streams are now automatically synchronized. There is no need to use `STDOUT.flush` in the remote script anymore to avoid delays.
+* Output and Error streams now work in binary mode, instead of being read line-by-line. It is possible to stream binary data from the remote script.
+* Added support for dumping compiled code for easier debugging (see [Parameters](README.md#parameters))
+* Added proper [error handling](README.md#error-handling). Printing remote stack trace and code context on error for easier debugging.
+* Added advanced, customizable [text mode](README.md#text-mode).
+* Flavours are renamed to plugins. It is now possible to [add custom plugins in configuration](README.md#plugins).
+* Added a possibility to ignore specified types globally. Variables of the ignored types won't be attempted for serialization.
+
+### Minor changes
+
+* Minimum supported Ruby version is now 2.7
+* `.remotely` is not included to the global scope by default, and needs to be included [explicitly](README.md#basic-usage).
+* Connection adapter is now automatically selected based on the presence of the `host` argument.
+* Only two adapters are now available: SSH adapter, and local temp file adapter. All other adapters are deprecated.
+* Cache directory is now a [global configuration option](README.md#configuration), rather than an argument to the ExecutionContext.
+* The default cache location is now in the .remote_ruby/cache, relative to the working directory.
+* Added a possibility to suppress [Parser warnings](https://github.com/whitequark/parser#compatibility-with-ruby-mri).
+* Added [changelog](#CHANGELOG.md)
+
+### Migration from v0.3
+
+1. To have `.remotely` method in global scope, include the `RemoteRuby::Extensions` module
+2. Rename `server` parameter to `host`.
+3. Remove `adapter` parameter.
+4. Remove `cache_dir` parameter and configure it globally instead.
+5. Remove `bundler` parameter.
+6. If you want stdout and stderr to be prefixed, enable Text Mode and configure it.
+7. Change `key_file` parameter to `keys` and make it an array with one filename instead of single string.
+8. Optionally remove `STDOUT.flush` from your scripts.
+
+Here's an example configuration which should resemble the default behaviour of v0.3:
+
+```ruby
+RemoteRuby.configure do |c|
+    c.cache_dir = File.join(Dir.pwd, 'cache')
+end
+
+include RemoteRuby::Extensions
+
+ec = RemoteRuby::ExecutionContext.new(
+    host: 'my_ssh_host',
+    text_mode: true
+)
+
+ec.execute do
+    # your code
+end
+
+# OR
+
+remotely(host: 'my_ssh_host', text_mode: true) do
+    # your code
+end
+
+```

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 Nikita Chernukhin
+Copyright (c) 2025 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