Fix a suggestions for safer conversions for Lint/NonAtomicFileOperation
#10781
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
ydah
force-pushed
the
fix_non_atomic_file_operation
branch
2 times, most recently
from
fd4cb08
to
818944a
Compare
ydah
changed the title
Lint/NonAtomicFileOperationLint/NonAtomicFileOperation
ydah
force-pushed
the
fix_non_atomic_file_operation
branch
3 times, most recently
from
fca0be1
to
fd5e30d
Compare
bbatsov
reviewed
Jul 7, 2022
| REMOVE_METHODS = %i[remove remove_dir remove_entry remove_entry_secure delete unlink | ||
| remove_file rm rm_f rm_r rm_rf rmdir rmtree safe_unlink].freeze | ||
| RESTRICT_ON_SEND = (MAKE_METHODS + REMOVE_METHODS).freeze | ||
| MSG_REMOVE_FILE_EXIST_CHECK = 'Remove an unnecessary existence checks ' \ |
There was a problem hiding this comment.
"Remove unnecessary existence check"
There was a problem hiding this comment.
Thank you so much. I fixed it.
bbatsov
reviewed
Jul 7, 2022
| RESTRICT_ON_SEND = (MAKE_METHODS + REMOVE_METHODS).freeze | ||
| MSG_REMOVE_FILE_EXIST_CHECK = 'Remove an unnecessary existence checks ' \ | ||
| '`%<receiver>s.%<method_name>s`.' | ||
| MSG_CHANGE_FORCE_METHOD = 'Change to a forced file operation method ' \ |
There was a problem hiding this comment.
I'm not sure if most people would understand this. :D I get what you mean, but I had to think for a moment what's "forced file operation" in this context.
There was a problem hiding this comment.
That's for sure. I was wondering what to do with this sentence.
How about "Use atomic file operation methods" ?
There was a problem hiding this comment.
I think that would be better.
There was a problem hiding this comment.
Thank you so much. I changed to "Use atomic file operation methods".
ydah
force-pushed
the
fix_non_atomic_file_operation
branch
2 times, most recently
from
be6b0c6
to
2db1687
Compare
bbatsov
reviewed
Jul 7, 2022
| RESTRICT_ON_SEND = (MAKE_METHODS + REMOVE_METHODS).freeze | ||
| MSG_REMOVE_FILE_EXIST_CHECK = 'Remove unnecessary existence check ' \ | ||
| '`%<receiver>s.%<method_name>s`.' | ||
| MSG_CHANGE_FORCE_METHOD = 'Use atomic file operation methods `FileUtils.%<method_name>s`.' |
…ion` This PR is fix a suggestions for safer conversions for `Lint/NonAtomicFileOperation`. Change the uniform conversion to `rm_rf` or `mkdir_p` to a safe change proposal as follows. For non-recurrent file deletions ```ruby # bad if File.exist?(path) File.remove(path) end # good FileUtils.rm_f(path) ``` For cases that do not require replacement ```ruby # bad if File.exist?(path) FileUtils.makedirs(path) end # good FileUtils.makedirs(path) ``` In addition, when replacing a non-atomic file operation with a forced file creation or deletion, an offense message has been added as follows. ```ruby if FileTest.exist?(path) ^^^^^^^^^^^^^^^^^^^^^^^^ Remove an unnecessary existence checks `FileTest.exist?`. FileUtils.remove(path) ^^^^^^^^^^^^^^^^ Use atomic file operation method `FileUtils.rm_f`. end ```
ydah
force-pushed
the
fix_non_atomic_file_operation
branch
from
2db1687
to
c95db16
Compare
|
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.
This PR is fix a suggestions for safer conversions for
Lint/NonAtomicFileOperation.Change the uniform conversion to
rm_rformkdir_pto a safe change proposal as follows.For non-recurrent file deletions
For cases that do not require replacement
In addition, when replacing a non-atomic file operation with a forced file creation or deletion, an offense message has been added as follows.
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.