Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

EXAMPLES.md corrections #527

Merged
merged 6 commits into from
Jan 5, 2024
Merged

EXAMPLES.md corrections #527

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8ee3341
Remove incorrect callouts about upload! not respecting within() and a…
JasonPoll Dec 30, 2023
3bde5d5
Update URL references to Net::SCP and Net::SFTP in EXAMPLES.md
JasonPoll Dec 30, 2023
7d5feb0
Update EXAMPLES.md to reference #use_format instead of format= (intro…
JasonPoll Dec 30, 2023
735b8c5
Update dirt-simple formatter example in EXAMPLES.md to be syntactical…
JasonPoll Dec 30, 2023
b12e74e
Update Net::SCP URL in EXAMPLES.md to reference github.com instead of…
JasonPoll Jan 4, 2024
99a5245
Merge branch 'master' into example-updates
mattbrictson Jan 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 8 additions & 13 deletions EXAMPLES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,6 @@ on hosts do |host|
end
```

**Note:** The `upload!()` method doesn't honor the values of `as()` etc, this
will be improved as the library matures, but we're not there yet.

## Upload a file from a stream

```ruby
Expand All @@ -148,9 +145,6 @@ end
This spares one from having to figure out the correct escaping sequences for
something like "echo(:cat, '...?...', '> /etc/sudoers.d/yolo')".

**Note:** The `upload!()` method doesn't honor the values of `within()`, `as()`
etc, this will be improved as the library matures, but we're not there yet.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This (and the above) appeared to be inaccurate based on my testing of #524.


## Upload a directory of files

```ruby
Expand All @@ -160,7 +154,8 @@ end
```

In this case the `recursive: true` option mirrors the same options which are
available to [`Net::{SCP,SFTP}`](http://net-ssh.github.io/net-scp/).
available to [`Net::SCP`](https://github.com/net-ssh/net-scp) and
[`Net::SFTP`](https://github.com/net-ssh/net-sftp).

## Set the upload/download method (SCP or SFTP).

Expand Down Expand Up @@ -252,16 +247,16 @@ end

```ruby
# The default format is pretty, which outputs colored text
SSHKit.config.format = :pretty
SSHKit.config.use_format :pretty
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These appeared to have never been updated in 2cb6326.


# Text with no coloring
SSHKit.config.format = :simpletext
SSHKit.config.use_format :simpletext

# Red / Green dots for each completed step
SSHKit.config.format = :dot
SSHKit.config.use_format :dot

# No output
SSHKit.config.format = :blackhole
SSHKit.config.use_format :blackhole
```

## Implement a dirt-simple formatter class
Expand All @@ -271,7 +266,7 @@ module SSHKit
module Formatter
class MyFormatter < SSHKit::Formatter::Abstract
def write(obj)
case obj.is_a? SSHKit::Command
if obj.is_a? SSHKit::Command
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least with Ruby 3.2.2, this case produced an error:

SyntaxError: unexpected `end', expecting `when'

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch!

# Do something here, see the SSHKit::Command documentation
end
end
Expand All @@ -280,7 +275,7 @@ module SSHKit
end

# If your formatter is defined in the SSHKit::Formatter module configure with the format option:
SSHKit.config.format = :myformatter
SSHKit.config.use_format :myformatter

# Or configure the output directly
SSHKit.config.output = MyFormatter.new($stdout)
Expand Down