This repository has been archived by the owner on Jan 31, 2020. It is now read-only.
fix: Make File\Extension usable for non-existing files #266
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
Currently the validator fails if the given filename is not readable. This prevents valid use cases like checking if a user configurable filename has an allowed file extension before creating said file. As the validator only operates on the given string there is no need for the current readable check. Also fixes File\ExcludeExtension which suffers from the same issue.
|
This is definitely a change in behavior; we have tests that verify that the validator returns That said, looking through the code, you are absolutely correct - the validators are not testing any of the file contents, just the file name. For BC purposes, this needs to be opt-in behavior, with the current behavior being the default. We can revisit that when we consider a new major version. I'll push a change shortly to enable this. |
…ion validators This builds on the original patch. However, to avoid a BC break, this patch adds a new option to each of the Extension and ExcludeExtension file validators, `allowNonExistentFile`. By default, this flag is `false`, preserving the existing behavior where a file must exist in order to be validated. When `true`, the validator does not automatically return `false` for non-existent files, and will continue to test its extension.
weierophinney
force-pushed
the
fix/file_extension
branch
from
a0bb02b
to
cc8805d
Compare
|
I've pushed a change to make this optional behavior, and added documentation on how to enable the option. |
weierophinney
approved these changes
Dec 28, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Currently the validator fails if the given filename is not readable. This prevents valid use cases like checking if a user configurable filename has an allowed file extension before creating said file.
As the validator only operates on the given string there is no need for the current readable check.
Also fixes File\ExcludeExtension which suffers from the same issue.
In theory it's a BC breaking change, personally I would consider any code that (ab)uses this validator as a file_is_readable validator to be smelly/buggy.