Always restore hidden cursor #30
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
Through some subtleties it is possible for the progress bar to not
restore the cursor:
b = TTY::ProgressBar.new "stuff |:bar|",
hide_cursor: true,
no_width: true,
total: 5,
width: 5
b.finish
Prior to this commit when #finish executes it will not restore the
cursor.
Tracing through #finish, while `hide_cursor` is true, we skip restoring
the cursor because the last render width is still 0 as we have not
rendered. We haven't completed the progress bar so we are not #done?.
We then #render.
In #render we are still not #done? so we hide the cursor because
`hide_cursor` is true, our last render width is still zero, and the
current value is not the total.
This leaves the cursor hidden when we exit the program.
This commit moves cursor restoration to the ensure block of finish so it
should always run, even if we are #done?
|
@drbrain Thanks! Your PRs are mega, I like the way you provide a full description of the issue, makes super easy to review and merge! ❤️ Released |
|
This library is nicely designed so I don't have to do too much to slip a change in |
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.
Through some subtleties it is possible for the progress bar to not
restore the cursor:
Prior to this commit when #finish executes it will not restore the
cursor.
Tracing through #finish, while
hide_cursoris true, we skip restoringthe cursor because the last render width is still 0 as we have not
rendered. We haven't completed the progress bar so we are not #done?.
We then #render.
In #render we are still not #done? so we hide the cursor because
hide_cursoris true, our last render width is still zero, and thecurrent value is not the total.
This leaves the cursor hidden when we exit the program.
This commit moves cursor restoration to the ensure block of finish so it
should always run, even if we are #done?