-
-
Notifications
You must be signed in to change notification settings - Fork 7
Linter: create rule to remove other validation keywords when enum is present based on type #1899
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
Open
Karan-Palan
wants to merge
11
commits into
sourcemeta:main
Choose a base branch
from
Karan-Palan:linter/enum-validation-keywords
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
b1db205
create rule to remove other validation keywords when enum is present …
Karan-Palan acd7254
use type to remove keyword chekcs, use walker types instead of manual…
Karan-Palan 16d4a1d
Merge branch 'main' of github.com:Karan-Palan/core into linter/enum-v…
Karan-Palan 4e0891e
attempt to fix macos ci
Karan-Palan a016a15
Merge branch 'main' of github.com:Karan-Palan/core into linter/enum-v…
Karan-Palan c106652
add whitepsace for consistency
Karan-Palan 7210d07
Merge branch 'main' of github.com:Karan-Palan/core into linter/enum-v…
Karan-Palan c443b4c
add more tests
Karan-Palan 7b39def
chore: rename rule
Karan-Palan 98c44c1
chore: remove draft0 and update tests with relevant keywords
Karan-Palan 85b1205
fix: remove ref and add tests for that
Karan-Palan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
75 changes: 75 additions & 0 deletions
75
src/extension/alterschema/linter/non_applicable_enum_validation_keywords.h
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
class EnumValidationKeywordsDefault final : public SchemaTransformRule { | ||
public: | ||
EnumValidationKeywordsDefault() | ||
: SchemaTransformRule{ | ||
"enum_validation_keywords_default", | ||
"Setting validation keywords that do not apply to any item in " | ||
"`enum` is considered an " | ||
"anti-pattern, as the enumeration choices already imply their " | ||
"respective types"} {}; | ||
|
||
[[nodiscard]] auto | ||
condition(const sourcemeta::core::JSON &schema, | ||
const sourcemeta::core::JSON &, | ||
const sourcemeta::core::Vocabularies &vocabularies, | ||
const sourcemeta::core::SchemaFrame &, | ||
const sourcemeta::core::SchemaFrame::Location &, | ||
const sourcemeta::core::SchemaWalker &walker, | ||
const sourcemeta::core::SchemaResolver &) const | ||
-> sourcemeta::core::SchemaTransformRule::Result override { | ||
if (!contains_any(vocabularies, | ||
{"https://json-schema.org/draft/2020-12/vocab/validation", | ||
"https://json-schema.org/draft/2019-09/vocab/validation", | ||
"http://json-schema.org/draft-07/schema#", | ||
"http://json-schema.org/draft-06/schema#", | ||
"http://json-schema.org/draft-04/schema#", | ||
"http://json-schema.org/draft-03/schema#", | ||
"http://json-schema.org/draft-02/schema#", | ||
"http://json-schema.org/draft-02/hyper-schema#", | ||
"http://json-schema.org/draft-01/schema#", | ||
"http://json-schema.org/draft-01/hyper-schema#"}) || | ||
!schema.is_object() || !schema.defines("enum") || | ||
!schema.at("enum").is_array()) { | ||
return false; | ||
} | ||
|
||
std::set<sourcemeta::core::JSON::Type> enum_types; | ||
for (const auto &value : schema.at("enum").as_array()) { | ||
enum_types.emplace(value.type()); | ||
} | ||
|
||
if (enum_types.empty()) { | ||
return false; | ||
} | ||
|
||
this->blacklist.clear(); | ||
for (const auto &entry : schema.as_object()) { | ||
const auto metadata = walker(entry.first, vocabularies); | ||
if (metadata.type == sourcemeta::core::SchemaKeywordType::Other || | ||
metadata.type == sourcemeta::core::SchemaKeywordType::Reference) { | ||
continue; | ||
} | ||
|
||
if (metadata.instances.empty()) { | ||
continue; | ||
} | ||
|
||
if (std::ranges::none_of(metadata.instances.cbegin(), | ||
metadata.instances.cend(), | ||
[&enum_types](const auto keyword_type) { | ||
return enum_types.contains(keyword_type); | ||
})) { | ||
this->blacklist.emplace_back(entry.first); | ||
} | ||
} | ||
|
||
return !this->blacklist.empty(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. A bit of a minor thing, but can you print the offending keywords like we do for |
||
} | ||
|
||
auto transform(sourcemeta::core::JSON &schema) const -> void override { | ||
schema.erase_keys(this->blacklist.cbegin(), this->blacklist.cend()); | ||
} | ||
|
||
private: | ||
mutable std::vector<sourcemeta::core::JSON::String> blacklist; | ||
}; |
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The name of the class doesn't match the file name?