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.

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

chore: refactor how temporary files are created (in tests) #590

Merged
merged 1 commit into from
Oct 31, 2024

Conversation

pvdb
Copy link
Contributor

@pvdb pvdb commented Oct 1, 2024

... by consistently using File::write instead of Kernel#open.

At the moment, most temporary files (in tests) are written using Kernel#open even though sometimes File::write is already being used; this PR refactors all tests to consistently use File::write.

It's possibly a matter of style/preference/opinion, but this also makes things slightly more readable and slightly less convoluted; either way, I think File.write is a tad more "intention revealing" than Kernel#open as well: we are "writing a (Rake-)file" as opposed to "opening a file for writing" ... small but subtle difference. 😅

In addition, the content of temporary files is refactored to consistently use heredocs, instead of a (quite random) mix of heredocs and IO#<< ... double win! 😃

PS - so as to not introduce any different behaviour, and to keep things functionally identical, I introduced a couple of newline characters ("\n") even though these appear to be immaterial (the tests run green with and without them) so I'm happy to take them out again.

@hemalvarambhia
Copy link

👍

@hsbt
Copy link
Member

hsbt commented Oct 31, 2024

👍 Thank you.

@hsbt hsbt merged commit 2e8dafa into ruby:master Oct 31, 2024
28 checks passed
@pvdb pvdb deleted the refactor_file_writing branch October 31, 2024 07:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants