Add boolean contract combinators to the stdlib #1995
Merged
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
|
I think |
Yeah, it's hard to think of a good, natural use-case. I imagine they might exist. Let's implement it lazily: wait for someone to come with a need for it. Otherwise, it's ready to review now @jneem (sorry about the early ping, I requested your review too soon, before adding tests) |
jneem
approved these changes
Jul 17, 2024
yannham
force-pushed
the
task/immediate-parts-builtin-contracts
branch
from
01ca07a
to
375dccd
Compare
Base automatically changed from
task/immediate-parts-builtin-contracts
to
master
July 17, 2024 10:03
|
🎉 All dependencies have been resolved ! |
This commit adds the boolean combinators `one_of`, `not` and `all_of` to the contract module of the stdlib. They are implemented in the obvious way, by making immediate decisions based on the immediate part of their contract operands. The limitations and possible work arounds are detailed in the documentation and in the manual.
Co-authored-by: jneem <joeneeman@gmail.com>
Make a pass on the new documentation of boolean contract combinators to implement the reviewer's suggestions.
yannham
force-pushed
the
feat/one-of-final
branch
from
78b877c
to
b6e3b8e
Compare
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
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.
Depends on #1987
This commit adds the boolean combinators
one_of,notandall_ofto the contract module of the stdlib. They are implemented in the obvious way, by making immediate decisions based on the immediate part of their contract operands. The limitations and possible work around are detailed in the documentation and in the manual.I considered the addition of
one_of, to adhere to the JSON schema terminology, but it turns out that it seems pretty useless for the time being, because record contracts are mostly delayed and I couldn't come up with a simple compelling example that would work in the current setting, whereone_ofwould be needed overany_of. The standard example is two record contracts with an non-empty intersection, like{employee_id, name, ..}and{student_id, name, ..}, but this can't work as expected currently as the check for missing fields is delayed. I suspect we need to wait for proper full eager versions of builtin record contracts for a simple example (one can write the previous example with specialized custom contracts, but it starts to be involved - the fact that I can't come up with a short example to put in the documentation of the function leads me to think that it's too early to introduce this function)