[DO NOT MERGE] PoC on Ruby DSL for configurable document types#11227
Draft
[DO NOT MERGE] PoC on Ruby DSL for configurable document types#11227
Conversation
This commit includes a basic DSL for configurable document types. It allows us to declare forms, block content schema, settings and metadata using Ruby rather than JSON, which opens up some interesting possibilities such as: - easily sharing field definitions across types (just declare a method in the DSL for commonly used fields such as the body field) - using the ActiveModel API directly from inside the DSL to declare attributes and validation - no more awkward JSON validation definitions - defining one-off Publishing API presentation logic easily from within the DSL, without having to provide a shared method for it as a payload builder - making the config self-validating - we can raise exceptions if it's invalid so the type won't even build. Much easier to see what the problem is than with JSON schema validation, and to perform more complex types of validation
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
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.
This commit includes a basic DSL for configurable document types. It allows us to declare forms, block content schema, settings and metadata using Ruby rather than JSON, which opens up some interesting possibilities such as: