Make call to shell_out compatible with Ruby 3 #257
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In previous versions of Ruby, calling `shell_out("cmd", { blah : "blah" })` would be interpreted correctly [here](https://github.com/chef/mixlib-shellout/blob/e2ec87f6f5933e5e5bc75a9fe08a8c8c73e55b72/lib/mixlib/shellout/helper.rb#L38) as `args = "cmd"` and `options = { blah : "blah" }`.
However because this can be ambiguous to interpret, Ruby would give the warning:
```
warning: Using the last argument as keyword parameters is deprecated; maybe ** should be added to the call
```
As of Ruby 3, `shell_out("cmd", { blah : "blah" })` will be interpreted as `args = ["cmd", { blah : "blah" }]` and `options = {}`.
This can be fixed by passing in the `options` parameter with a double splat (**) in front of it to explicitly convert the hash into a keyword argument.
Signed-off-by: William Starling <william@bugsnag.com>
foygl
force-pushed
the
fix-shell-out-call
branch
from
55c0726
to
16f19eb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
In previous versions of Ruby, calling
shell_out("cmd", { blah : "blah" })would be interpreted correctly here asargs = "cmd"andoptions = { blah : "blah" }.However because this can be ambiguous to interpret, Ruby would give the warning:
As of Ruby 3,
shell_out("cmd", { blah : "blah" })will be interpreted asargs = ["cmd", { blah : "blah" }]andoptions = {}.This can be fixed by passing in the
optionsparameter with a double splat (**) in front of it to explicitly convert the hash into a keyword argument.Issues Resolved
No open issues.
Check List