Use default value obj for terminal check #92
Merged
Conversation
This file contains hidden or 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
schneems
force-pushed
the
schneems/terminal-tty-too
branch
from
03f9aae to
903018d
Compare
In #91 the behavior of dead_end is now optimized to output values based on if the io object is a TTY (interactive terminal) or not. This behavior is awesome. The way we were checking default values though introduces a subtle bug, in Ruby `nil` and `false` are usually assumed to have the same/similar behavior (being falsey). This updates the logic to use a `Object.new` value to indicate a default value rather than rely on specific contents. It will reduce the chance the programmer accidentally passes in a value that triggers the default behavior. I also REALLY wanted to find a way to assert the inverse of the test added in "passing --terminal will force color codes" but it turns out it's really hard (if not impossible). I asked on twitter as well https://twitter.com/schneems/status/1452814816456945672. Instead I added some unit tests to at least assert that calling DisplayInvalidBlocks with default args defaulted to `io.isatty`. I also got rid of the describe block for now as there's only one thing in there. It makes diffs a bit more muddled if the contents of the tests get moved around. (Personal preference)
schneems
force-pushed
the
schneems/terminal-tty-too
branch
from
903018d to
8327c6b
Compare
stoivo
reviewed
Oct 26, 2021
| end | ||
| end | ||
|
|
||
| describe "terminal coloring" do |
Contributor
There was a problem hiding this comment.
I tried to write some specs here for testing tty, but came to the same conclusion as you did. It's hard.
| module DeadEnd | ||
| # Used to indicate a default value that cannot | ||
| # be confused with another input | ||
| DEFAULT_VALUE = Object.new.freeze |
Contributor
There was a problem hiding this comment.
Probably a good idea. I was thinking of merging the IO object and terminal into one argument, but didn't since I wasn't sure it is a good idea. Using nil/false/true might be a bit fragile.
Collaborator
Author
|
Thanks for the review and the initial PR! |
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.
In #91 the behavior of dead_end is now optimized to output values based on if the io object is a TTY (interactive terminal) or not.
This behavior is awesome. The way we were checking default values though introduces a subtle bug, in Ruby
nilandfalseare usually assumed to have the same/similar behavior (being falsey). This updates the logic to use aObject.newvalue to indicate a default value rather than rely on specific contents. It will reduce the chance the programmer accidentally passes in a value that triggers the default behavior.I also REALLY wanted to find a way to assert the inverse of the test added in "passing --terminal will force color codes" but it turns out it's really hard (if not impossible). I asked on twitter as well https://twitter.com/schneems/status/1452814816456945672.
Instead I added some unit tests to at least assert that calling DisplayInvalidBlocks with default args defaulted to
io.isatty.I also got rid of the describe block for now as there's only one thing in there. It makes diffs a bit more muddled if the contents of the tests get moved around. (Personal preference)