-
-
Notifications
You must be signed in to change notification settings - Fork 7
Linter: create rule to to add syntactical sugar when then is set to false #1918
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
7
commits into
sourcemeta:main
Choose a base branch
from
Karan-Palan:linter/then-false-updated
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.
+568
−1
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
43b69a8
create rule to to add syntactical sugar when then is set to false
Karan-Palan 5af1cce
add newline
Karan-Palan 04ff1fd
check for then and add more tests
Karan-Palan 480ab0a
Merge branch 'main' of github.com:Karan-Palan/core into linter/then-f…
Karan-Palan 704b199
use std:all_of
Karan-Palan f4eb3e0
Merge branch 'main' of github.com:Karan-Palan/core into linter/then-f…
Karan-Palan 39c1dba
chore: remove default not from tests
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
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,39 @@ | ||
class ThenFalse final : public SchemaTransformRule { | ||
public: | ||
ThenFalse() | ||
: SchemaTransformRule{ | ||
"then_false", | ||
"`if: S, then: false` is logically equivalent to `not: S`"} {}; | ||
|
||
[[nodiscard]] auto | ||
condition(const JSON &schema, const JSON &, const Vocabularies &vocabularies, | ||
const SchemaFrame &, const SchemaFrame::Location &, | ||
const SchemaWalker &, const SchemaResolver &) const | ||
-> SchemaTransformRule::Result override { | ||
return contains_any( | ||
vocabularies, | ||
{"https://json-schema.org/draft/2020-12/vocab/applicator", | ||
"https://json-schema.org/draft/2019-09/vocab/applicator", | ||
"http://json-schema.org/draft-07/schema#"}) && | ||
schema.is_object() && schema.defines("if") && | ||
Karan-Palan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
schema.defines("then") && is_schema(schema.at("then")) && | ||
schema.at("then").is_boolean() && !schema.at("then").to_boolean() && | ||
is_schema(schema.at("if")) && | ||
(!schema.defines("else") || (schema.at("else").is_boolean() && | ||
schema.at("else").to_boolean())) && | ||
(!schema.at("if").is_object() || | ||
std::all_of(schema.at("if").as_object().begin(), | ||
schema.at("if").as_object().end(), | ||
[&schema](const auto &entry) { | ||
return !schema.defines(entry.first); | ||
})); | ||
} | ||
|
||
auto transform(JSON &schema) const -> void override { | ||
auto if_schema = schema.at("if"); | ||
schema.erase("if"); | ||
schema.erase("then"); | ||
schema.erase("else"); | ||
schema.assign("not", std::move(if_schema)); | ||
Karan-Palan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
}; |
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 |
---|---|---|
|
@@ -2725,3 +2725,178 @@ TEST(AlterSchema_lint_2019_09, not_false_5) { | |
|
||
EXPECT_EQ(document, expected); | ||
} | ||
|
||
TEST(AlterSchema_lint_2019_09, then_false_1) { | ||
sourcemeta::core::JSON document = sourcemeta::core::parse_json(R"JSON({ | ||
"$schema": "https://json-schema.org/draft/2019-09/schema", | ||
"if": { | ||
"properties": { | ||
"flag": { | ||
"const": true | ||
} | ||
} | ||
}, | ||
"then": false | ||
})JSON"); | ||
|
||
LINT_AND_FIX_FOR_READABILITY(document); | ||
|
||
const sourcemeta::core::JSON expected = sourcemeta::core::parse_json(R"JSON({ | ||
"$schema": "https://json-schema.org/draft/2019-09/schema", | ||
"not": { | ||
"properties": { | ||
"flag": { | ||
"const": true | ||
} | ||
} | ||
} | ||
})JSON"); | ||
|
||
EXPECT_EQ(document, expected); | ||
} | ||
|
||
TEST(AlterSchema_lint_2019_09, then_false_2) { | ||
sourcemeta::core::JSON document = sourcemeta::core::parse_json(R"JSON({ | ||
"$schema": "https://json-schema.org/draft/2019-09/schema", | ||
"if": { | ||
"properties": { | ||
"flag": { | ||
"const": true | ||
} | ||
} | ||
}, | ||
"then": false, | ||
"else": true | ||
})JSON"); | ||
|
||
LINT_AND_FIX_FOR_READABILITY(document); | ||
|
||
const sourcemeta::core::JSON expected = sourcemeta::core::parse_json(R"JSON({ | ||
"$schema": "https://json-schema.org/draft/2019-09/schema", | ||
"not": { | ||
"properties": { | ||
"flag": { | ||
"const": true | ||
} | ||
} | ||
} | ||
})JSON"); | ||
|
||
EXPECT_EQ(document, expected); | ||
} | ||
|
||
TEST(AlterSchema_lint_2019_09, then_false_3) { | ||
sourcemeta::core::JSON document = sourcemeta::core::parse_json(R"JSON({ | ||
"$schema": "https://json-schema.org/draft/2019-09/schema", | ||
"if": true, | ||
"then": false | ||
})JSON"); | ||
|
||
LINT_AND_FIX_FOR_READABILITY(document); | ||
|
||
const sourcemeta::core::JSON expected = sourcemeta::core::parse_json(R"JSON({ | ||
"$schema": "https://json-schema.org/draft/2019-09/schema", | ||
"not": true | ||
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. I know we have another rule, but I wonder if this case is simple enough to also side-fix it on the transform, so we don't have to run yet another rule to fix it. i.e. on the transform, if |
||
})JSON"); | ||
|
||
EXPECT_EQ(document, expected); | ||
} | ||
|
||
TEST(AlterSchema_lint_2019_09, then_false_4) { | ||
sourcemeta::core::JSON document = sourcemeta::core::parse_json(R"JSON({ | ||
"$schema": "https://json-schema.org/draft/2019-09/schema", | ||
"if": false, | ||
"then": false | ||
})JSON"); | ||
|
||
LINT_AND_FIX_FOR_READABILITY(document); | ||
|
||
const sourcemeta::core::JSON expected = sourcemeta::core::parse_json(R"JSON({ | ||
"$schema": "https://json-schema.org/draft/2019-09/schema" | ||
})JSON"); | ||
|
||
EXPECT_EQ(document, expected); | ||
} | ||
|
||
TEST(AlterSchema_lint_2019_09, then_false_5) { | ||
sourcemeta::core::JSON document = sourcemeta::core::parse_json(R"JSON({ | ||
"$schema": "https://json-schema.org/draft/2019-09/schema", | ||
"type": "object", | ||
"properties": { | ||
"name": { "type": "string" } | ||
}, | ||
"if": { | ||
"properties": { | ||
"name": { "type": "number" } | ||
} | ||
}, | ||
"then": false | ||
})JSON"); | ||
|
||
LINT_AND_FIX_FOR_READABILITY(document); | ||
|
||
const sourcemeta::core::JSON expected = sourcemeta::core::parse_json(R"JSON({ | ||
"$schema": "https://json-schema.org/draft/2019-09/schema", | ||
"type": "object", | ||
"properties": { | ||
"name": { "type": "string" } | ||
}, | ||
"if": { | ||
"properties": { | ||
"name": { "type": "number" } | ||
} | ||
}, | ||
"then": false | ||
})JSON"); | ||
|
||
EXPECT_EQ(document, expected); | ||
} | ||
|
||
TEST(AlterSchema_lint_2019_09, then_false_6) { | ||
sourcemeta::core::JSON document = sourcemeta::core::parse_json(R"JSON({ | ||
"$schema": "https://json-schema.org/draft/2019-09/schema", | ||
"if": { | ||
"properties": { | ||
"flag": { "const": true } | ||
} | ||
}, | ||
"then": false | ||
})JSON"); | ||
|
||
LINT_AND_FIX_FOR_READABILITY(document); | ||
|
||
const sourcemeta::core::JSON expected = sourcemeta::core::parse_json(R"JSON({ | ||
"$schema": "https://json-schema.org/draft/2019-09/schema", | ||
"not": { | ||
"properties": { | ||
"flag": { "const": true } | ||
} | ||
} | ||
})JSON"); | ||
|
||
EXPECT_EQ(document, expected); | ||
} | ||
|
||
TEST(AlterSchema_lint_2019_09, then_false_7) { | ||
sourcemeta::core::JSON document = sourcemeta::core::parse_json(R"JSON({ | ||
"$schema": "https://json-schema.org/draft/2019-09/schema", | ||
"if": { | ||
"type": "object" | ||
}, | ||
"then": false, | ||
"else": false | ||
})JSON"); | ||
|
||
LINT_AND_FIX_FOR_READABILITY(document); | ||
|
||
const sourcemeta::core::JSON expected = sourcemeta::core::parse_json(R"JSON({ | ||
"$schema": "https://json-schema.org/draft/2019-09/schema", | ||
"if": { | ||
"type": "object" | ||
}, | ||
"then": false, | ||
"else": false | ||
})JSON"); | ||
|
||
EXPECT_EQ(document, expected); | ||
} |
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.
Just to make it a lot more clear to users