Generator Constraints and Violation Messages #1559
Merged
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.
Description
This adds the
GeneratorConstraint
abstract class, which is a helper class that enables a more imperative programing style in constraints. When writing goal I've found it pretty natural to switch from a functional style when getting and transforming inputs, to an imperative style when creating outputs. So I made a similar system for constraints where you can repeatedly callviolate(Violation)
or one of its derivatives instead of aggregating everything in a singleViolations
timeline.This also adds the first step for support of violation messages, as in customizable strings that can explain the violation to the user in the UI, and can be different for each violation generated. This doesn't do anything with the messages, it just stores them in the
Violation
class.Verification
I made a unit test to make sure the generator aggregates the results correctly.
Documentation
I wrote the docs after I made these changes; they are actually already live.
Future work