Add new shapeExamples trait that communicates and enforces allowed and disallowed values #2851
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "type": "feature", | ||
| "description": "Add new shapeExamples to express allowed and disallowed values on an individual shape level", | ||
| "pull_requests": [ | ||
| "[#2851](https://github.com/smithy-lang/smithy/pull/2851)" | ||
| ] | ||
| } |
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,124 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
| package software.amazon.smithy.model.traits; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Optional; | ||
| import software.amazon.smithy.model.SourceException; | ||
| import software.amazon.smithy.model.node.ArrayNode; | ||
| import software.amazon.smithy.model.node.Node; | ||
| import software.amazon.smithy.model.node.ObjectNode; | ||
| import software.amazon.smithy.model.shapes.ShapeId; | ||
| import software.amazon.smithy.utils.MapUtils; | ||
| import software.amazon.smithy.utils.ToSmithyBuilder; | ||
|
|
||
| /** | ||
| * Defines values which are specifically allowed and/or disallowed for a shape. | ||
| */ | ||
| public final class ShapeExamplesTrait extends AbstractTrait implements ToSmithyBuilder<ShapeExamplesTrait> { | ||
| public static final ShapeId ID = ShapeId.from("smithy.api#shapeExamples"); | ||
|
|
||
| private final List<Node> allowed; | ||
| private final List<Node> disallowed; | ||
|
|
||
| private ShapeExamplesTrait(ShapeExamplesTrait.Builder builder) { | ||
| super(ID, builder.sourceLocation); | ||
| this.allowed = builder.allowed; | ||
| this.disallowed = builder.disallowed; | ||
| if (allowed == null && disallowed == null) { | ||
| throw new SourceException("One of 'allowed' or 'disallowed' must be provided.", getSourceLocation()); | ||
| } | ||
| if (allowed != null && allowed.isEmpty()) { | ||
| throw new SourceException("'allowed' must be non-empty when provided.", getSourceLocation()); | ||
| } | ||
| if (disallowed != null && disallowed.isEmpty()) { | ||
| throw new SourceException("'disallowed' must be non-empty when provided.", getSourceLocation()); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Gets the allowed values. | ||
| * | ||
| * @return returns the optional allowed values. | ||
| */ | ||
| public Optional<List<Node>> getAllowed() { | ||
| return Optional.ofNullable(allowed); | ||
| } | ||
|
|
||
| /** | ||
| * Gets the disallowed values. | ||
| * | ||
| * @return returns the optional disallowed values. | ||
| */ | ||
| public Optional<List<Node>> getDisallowed() { | ||
| return Optional.ofNullable(disallowed); | ||
| } | ||
|
|
||
| @Override | ||
| protected Node createNode() { | ||
| return new ObjectNode(MapUtils.of(), getSourceLocation()) | ||
| .withOptionalMember("allowed", getAllowed().map(ArrayNode::fromNodes)) | ||
| .withOptionalMember("disallowed", getDisallowed().map(ArrayNode::fromNodes)); | ||
| } | ||
|
|
||
| @Override | ||
| public ShapeExamplesTrait.Builder toBuilder() { | ||
| return builder().allowed(allowed).disallowed(disallowed).sourceLocation(getSourceLocation()); | ||
| } | ||
|
|
||
| /** | ||
| * @return Returns a new ShapeExamplesTrait builder. | ||
| */ | ||
| public static ShapeExamplesTrait.Builder builder() { | ||
| return new ShapeExamplesTrait.Builder(); | ||
| } | ||
|
|
||
| /** | ||
| * Builder used to create a ShapeExamplesTrait. | ||
| */ | ||
| public static final class Builder extends AbstractTraitBuilder<ShapeExamplesTrait, ShapeExamplesTrait.Builder> { | ||
| private List<Node> allowed; | ||
| private List<Node> disallowed; | ||
|
|
||
| public ShapeExamplesTrait.Builder allowed(List<Node> allowed) { | ||
| this.allowed = allowed; | ||
| return this; | ||
| } | ||
|
|
||
| public ShapeExamplesTrait.Builder disallowed(List<Node> disallowed) { | ||
| this.disallowed = disallowed; | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| public ShapeExamplesTrait build() { | ||
| return new ShapeExamplesTrait(this); | ||
| } | ||
| } | ||
|
|
||
| public static final class Provider implements TraitService { | ||
| @Override | ||
| public ShapeId getShapeId() { | ||
| return ID; | ||
| } | ||
|
|
||
| @Override | ||
| public ShapeExamplesTrait createTrait(ShapeId target, Node value) { | ||
| ShapeExamplesTrait.Builder builder = builder().sourceLocation(value.getSourceLocation()); | ||
| value.expectObjectNode() | ||
| .getMember("allowed", ShapeExamplesTrait.Provider::convertToShapeExampleList, builder::allowed) | ||
| .getMember("disallowed", | ||
| ShapeExamplesTrait.Provider::convertToShapeExampleList, | ||
| builder::disallowed); | ||
| ShapeExamplesTrait result = builder.build(); | ||
| result.setNodeCache(value); | ||
| return result; | ||
| } | ||
|
|
||
| private static List<Node> convertToShapeExampleList(Node node) { | ||
| return node.expectArrayNode().getElements(); | ||
| } | ||
| } | ||
| } |
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
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
Originally traversing into the shape when the value was null pretty much guaranteed that an error would be reported -- generally of the form "<string, number, object> was expected but value was null" (not exact wording).
Since is the
memberShapemethod, this only affects aggregate types which have an explicitnullvalue as opposed to the member being omitted.