New API for setting+configuring formatter: use_format #294
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
This makes the error more explicit and helpful. Previously, setting `output.format = :bad_value` would not raise immediately, but would fail later with a confusing error once a logging operation is attempted.
This commit introduces `use_format`, which is like the existing `format=` but optionally accepts arguments/options that will be passed to the formatter's constructor. SSHKit's current formatters do not yet accept extra arguments, but this API lays the groundwork for future formatters or formatter gems like airbrussh that are configurable and would benefit from a standard API for doing so.
|
👍 This looks good to me |
leehambley
added a commit
that referenced
this pull request
Nov 1, 2015
New API for setting+configuring formatter: use_format
|
Thanks @mattbrictson nice work, sorry merged out of habit, and then reverted. I'm around for an hour more thing evening if you have time, looks good to me though. |
|
@leehambley It should be good to merge now. I updated the README to refer to I also put entries in the CHANGELOG. |
|
Hmm.. GitHub is not pulling the new commits into the PR. Do I need to create a new PR? |
|
@leehambley Please merge #296 instead. Thanks! |
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.
As discussed in mattbrictson/airbrussh#64 (comment), this PR adds a new API for setting the SSHKit output.
Before:
After:
The benefit is that the new
use_formataccepts arbitrary arguments that are then passed to the formatter's constructor. This allows a formatter to be configured.Hypothetical example:
This would construct
SSHKit::Formatter::Airbrusshand pass{ :color => true, :truncate => false }to its constructor.SSHKit's current formatters do not yet accept extra arguments, but this API lays the groundwork for future formatters or formatter gems like airbrussh that are configurable and would benefit from a standard API for doing so.
Eventually we could deprecate the
format=API, but that can be a separate PR.@leehambley, @robd Let me know if this looks good and I'll expand this PR to a CHANGELOG entry and update the docs.
Also: this PR fixes a bug where calling
format = :bad_valueproceeds with no error or warning, but blows up later once a logging operation is attempted. Now it will immediately raiseNameError.