Add new Style/FileTouch cop
#13484
Merged
Add new Style/FileTouch cop
#13484
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
lovro-bikic
commented
Nov 21, 2024
Earlopain
reviewed
Nov 21, 2024
lovro-bikic
commented
Nov 21, 2024
|
|
||
| module RuboCop | ||
| module Cop | ||
| module Style |
There was a problem hiding this comment.
I'm wondering if this should be a Lint cop instead. In the wild, I've seen File.open used to make sure a file exists or to try update its timestamps (much like touch utility), the latter of which actually doesn't happen:
path = 'foo.tmp'
FileUtils.touch(path) # create a file
atime_1, ctime_1, mtime_1 = File.atime(path), File.ctime(path), File.mtime(path)
File.open(path, 'a') {}
atime_2, ctime_2, mtime_2 = File.atime(path), File.ctime(path), File.mtime(path)
atime_1 == atime_2 && ctime_1 == ctime_2 && mtime_1 == mtime_2
# => trueso this could be considered erroneous code.
There was a problem hiding this comment.
I'm not on the fence about changing the department, but I think it'd be good to add this to the cop's rationale and examples.
There was a problem hiding this comment.
Okay, I've updated the docs, let me know if I made it clear enough.
lovro-bikic
force-pushed
the
feature/style-file-touch-cop
branch
from
65ea6a1 to
54a2603
Compare
lovro-bikic
force-pushed
the
feature/style-file-touch-cop
branch
from
54a2603 to
1effbaf
Compare
|
Looks good to me. 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.
Closes #13482.
Adds new
Style/FileTouchcop to detect usage ofFile.openin append mode with empty block and autocorrect it toFileUtils.touch.Before:
After:
Recognized access modes are
a,a+,ab,a+b,at,a+t.Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.