Remove formatter duplication #248
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
SimpleText now only needs to override one method - format_message
robd
force-pushed
the
remove-formatter-duplication
branch
3 times, most recently
from
74ca4c8
to
0db565e
Compare
Also added links to PRs / Issues
robd
force-pushed
the
remove-formatter-duplication
branch
from
0db565e
to
2aeeacc
Compare
|
Looks good! I also did a quick test and didn't see any regressions. |
leehambley
added a commit
that referenced
this pull request
May 12, 2015
Remove formatter duplication
jsonn
pushed a commit
to jsonn/pkgsrc
that referenced
this pull request
Dec 14, 2015
## 1.8.1
* Change license to MIT, thanks to all the patient contributors who gave
their permissions.
## 1.8.0
* add SSHKit::Backend::ConnectionPool#close_connections
[PR #285](capistrano/sshkit#285)
@akm
* Clean up rubocop lint warnings
[PR #275](capistrano/sshkit#275)
@cshaffer
* Prepend unused parameter names with an underscore
* Prefer “safe assignment in condition”
* Disambiguate regexp literals with parens
* Prefer `sprintf` over `String#%`
* No longer shadow `caller_line` variable in `DeprecationLogger`
* Rescue `StandardError` instead of `Exception`
* Remove useless `private` access modifier in `TestAbstract`
* Disambiguate block operator with parens
* Disambiguate between grouped expression and method params
* Remove assertion in `TestHost#test_assert_hosts_compare_equal` that compares something with itself
* Export environment variables and execute command in a subshell.
[PR #273](capistrano/sshkit#273)
@kuon
* Introduce `log_command_start`, `log_command_data`, `log_command_exit` methods on `Formatter`
[PR #257](capistrano/sshkit#257)
@robd
* Deprecate `@stdout` and `@stderr` accessors on `Command`
* Add support for deprecation logging options.
[README](README.md#deprecation-warnings),
[PR #258](capistrano/sshkit#258)
@robd
* Quote environment variable values.
[PR #250](capistrano/sshkit#250)
@Sinjo - Chris Sinjakli
* Simplified formatter hierarchy.
[PR #248](capistrano/sshkit#248)
@robd
* `SimpleText` formatter now extends `Pretty`, rather than duplicating.
* Hide ANSI color escape sequences when outputting to a file.
[README](README.md#output-colors),
[Issue #245](capistrano/sshkit#245),
[PR #246](capistrano/sshkit#246)
@robd
* Now only color the output if it is associated with a tty,
or the `SSHKIT_COLOR` environment variable is set.
* Removed broken support for assigning an `IO` to the `output` config option.
[Issue #243](capistrano/sshkit#243),
[PR #244](capistrano/sshkit#244)
@robd
* Use `SSHKit.config.output = SSHKit::Formatter::SimpleText.new($stdin)` instead
* Added support for `:interaction_handler` option on commands.
[PR #234](capistrano/sshkit#234),
[PR #242](capistrano/sshkit#242)
@robd
* Removed partially supported `TRACE` log level.
[2aa7890](capistrano/sshkit@2aa7890)
@robd
* Add support for the `:strip` option to the `capture` method and strip by default on the `Local` backend.
[PR #239](capistrano/sshkit#239),
[PR #249](capistrano/sshkit#249)
@robd
* The `Local` backend now strips by default to be consistent with the `Netssh` one.
* This reverses change [7d15a9a](capistrano/sshkit@7d15a9a) to the `Local` capture API to remove stripping by default.
* If you require the raw, unstripped output, pass the `strip: false` option: `capture(:ls, strip: false)`
* Simplified backend hierarchy.
[PR #235](capistrano/sshkit#235),
[PR #237](capistrano/sshkit#237)
@robd
* Moved duplicate implementations of `make`, `rake`, `test`, `capture`, `background` on to `Abstract` backend.
* Backend implementations now only need to implement `execute_command`, `upload!` and `download!`
* Removed `Printer` from backend hierarchy for `Local` and `Netssh` backends (they now just extend `Abstract`)
* Removed unused `Net::SSH:LogLevelShim`
* Removed dependency on the `colorize` gem. SSHKit now implements its own ANSI color logic, with no external dependencies. Note that SSHKit now only supports the `:bold` or plain modes. Other modes will be gracefully ignored. [#263](capistrano/sshkit#263)
* New API for setting the formatter: `use_format`. This differs from `format=` in that it accepts options or arguments that will be passed to the formatter's constructor. The `format=` syntax will be deprecated in a future release. [#295](capistrano/sshkit#295)
* SSHKit now immediately raises a `NameError` if you try to set a formatter that does not exist. [#295](capistrano/sshkit#295)
jsonn
pushed a commit
to jsonn/pkgsrc
that referenced
this pull request
Dec 14, 2015
## 1.8.1
* Change license to MIT, thanks to all the patient contributors who gave
their permissions.
## 1.8.0
* add SSHKit::Backend::ConnectionPool#close_connections
[PR #285](capistrano/sshkit#285)
@akm
* Clean up rubocop lint warnings
[PR #275](capistrano/sshkit#275)
@cshaffer
* Prepend unused parameter names with an underscore
* Prefer “safe assignment in condition”
* Disambiguate regexp literals with parens
* Prefer `sprintf` over `String#%`
* No longer shadow `caller_line` variable in `DeprecationLogger`
* Rescue `StandardError` instead of `Exception`
* Remove useless `private` access modifier in `TestAbstract`
* Disambiguate block operator with parens
* Disambiguate between grouped expression and method params
* Remove assertion in `TestHost#test_assert_hosts_compare_equal` that compares something with itself
* Export environment variables and execute command in a subshell.
[PR #273](capistrano/sshkit#273)
@kuon
* Introduce `log_command_start`, `log_command_data`, `log_command_exit` methods on `Formatter`
[PR #257](capistrano/sshkit#257)
@robd
* Deprecate `@stdout` and `@stderr` accessors on `Command`
* Add support for deprecation logging options.
[README](README.md#deprecation-warnings),
[PR #258](capistrano/sshkit#258)
@robd
* Quote environment variable values.
[PR #250](capistrano/sshkit#250)
@Sinjo - Chris Sinjakli
* Simplified formatter hierarchy.
[PR #248](capistrano/sshkit#248)
@robd
* `SimpleText` formatter now extends `Pretty`, rather than duplicating.
* Hide ANSI color escape sequences when outputting to a file.
[README](README.md#output-colors),
[Issue #245](capistrano/sshkit#245),
[PR #246](capistrano/sshkit#246)
@robd
* Now only color the output if it is associated with a tty,
or the `SSHKIT_COLOR` environment variable is set.
* Removed broken support for assigning an `IO` to the `output` config option.
[Issue #243](capistrano/sshkit#243),
[PR #244](capistrano/sshkit#244)
@robd
* Use `SSHKit.config.output = SSHKit::Formatter::SimpleText.new($stdin)` instead
* Added support for `:interaction_handler` option on commands.
[PR #234](capistrano/sshkit#234),
[PR #242](capistrano/sshkit#242)
@robd
* Removed partially supported `TRACE` log level.
[2aa7890](capistrano/sshkit@2aa7890)
@robd
* Add support for the `:strip` option to the `capture` method and strip by default on the `Local` backend.
[PR #239](capistrano/sshkit#239),
[PR #249](capistrano/sshkit#249)
@robd
* The `Local` backend now strips by default to be consistent with the `Netssh` one.
* This reverses change [7d15a9a](capistrano/sshkit@7d15a9a) to the `Local` capture API to remove stripping by default.
* If you require the raw, unstripped output, pass the `strip: false` option: `capture(:ls, strip: false)`
* Simplified backend hierarchy.
[PR #235](capistrano/sshkit#235),
[PR #237](capistrano/sshkit#237)
@robd
* Moved duplicate implementations of `make`, `rake`, `test`, `capture`, `background` on to `Abstract` backend.
* Backend implementations now only need to implement `execute_command`, `upload!` and `download!`
* Removed `Printer` from backend hierarchy for `Local` and `Netssh` backends (they now just extend `Abstract`)
* Removed unused `Net::SSH:LogLevelShim`
* Removed dependency on the `colorize` gem. SSHKit now implements its own ANSI color logic, with no external dependencies. Note that SSHKit now only supports the `:bold` or plain modes. Other modes will be gracefully ignored. [#263](capistrano/sshkit#263)
* New API for setting the formatter: `use_format`. This differs from `format=` in that it accepts options or arguments that will be passed to the formatter's constructor. The `format=` syntax will be deprecated in a future release. [#295](capistrano/sshkit#295)
* SSHKit now immediately raises a `NameError` if you try to set a formatter that does not exist. [#295](capistrano/sshkit#295)
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.
This PR is a refactor of the
Pretty/SimpleTextformatters to remove the duplication between them. I think this is about as dry as it gets for these 2 classes - now SimpleText only has to override theformat_messageinPretty(to exclude the level, uuid and indentation formatting) and thecolorizemethod inAbstract(to disable coloring). I think this closes #245 which was about having a way of turning off colors in theSimpleTextformatter, which we have now achieved.Team @leehambley & @mattbrictson - if you have time to eyeball, would appreciate it.