Skip to content
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.

Sign up for GitHub

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

Convert to internal trait from tag #1739

Merged
merged 3 commits into from
Apr 20, 2023
Merged

Convert to internal trait from tag #1739

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
385b4b6
Convert to internal trait from tag
srchase Apr 18, 2023
397dde9
Add javadocs
srchase Apr 19, 2023
f5b6df3
Fix typo in javadoc
srchase Apr 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions smithy-model/src/main/java/software/amazon/smithy/model/shapes/EnumShape.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import software.amazon.smithy.model.traits.EnumDefinition;
import software.amazon.smithy.model.traits.EnumTrait;
import software.amazon.smithy.model.traits.EnumValueTrait;
import software.amazon.smithy.model.traits.InternalTrait;
import software.amazon.smithy.model.traits.TagsTrait;
import software.amazon.smithy.model.traits.Trait;
import software.amazon.smithy.model.traits.UnitTypeTrait;
Expand Down Expand Up @@ -199,6 +200,12 @@ public static boolean canConvertToEnum(StringShape shape, boolean synthesizeEnum
/**
* Converts an enum definition to the equivalent enum member shape.
*
* <p>If an enum definition is marked as deprecated, the DeprecatedTrait
* is applied to the converted enum member shape.
*
* <p>If an enum definition has an "internal" tag, the InternalTrait is
* applied to the converted enum member shape.
*
* @param parentId The {@link ShapeId} of the enum shape.
* @param synthesizeName Whether to synthesize a name if possible.
* @return An optional member shape representing the enum definition,
Expand Down Expand Up @@ -233,6 +240,9 @@ static Optional<MemberShape> memberFromEnumDefinition(
if (definition.isDeprecated()) {
builder.addTrait(DeprecatedTrait.builder().build());
}
if (definition.hasTag("internal")) {
builder.addTrait(new InternalTrait());
}

return Optional.of(builder.build());
} catch (ShapeIdSyntaxException e) {
Expand Down
4 changes: 4 additions & 0 deletions smithy-model/src/main/java/software/amazon/smithy/model/transform/ModelTransformer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -515,6 +515,10 @@ public Model changeShapeType(
*
* <p>A member will be created on the shape for each entry in the {@link EnumTrait}.
*
* <p>When the enum definition from the enum trait has been marked as deprecated, or
* tagged as "internal", the corresponding enum shape member will be marked with the
* DeprecatedTrait or InternalTrait accordingly.
*
* @param model Model to transform.
* @param synthesizeEnumNames Whether enums without names should have names synthesized if possible.
* @return Returns the transformed model.
Expand Down
4 changes: 4 additions & 0 deletions smithy-model/src/test/java/software/amazon/smithy/model/shapes/EnumShapeTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import software.amazon.smithy.model.traits.EnumDefinition;
import software.amazon.smithy.model.traits.EnumTrait;
import software.amazon.smithy.model.traits.EnumValueTrait;
import software.amazon.smithy.model.traits.InternalTrait;
import software.amazon.smithy.model.traits.TagsTrait;
import software.amazon.smithy.model.traits.UnitTypeTrait;
import software.amazon.smithy.model.traits.synthetic.SyntheticEnumTrait;
Expand Down Expand Up @@ -125,6 +126,7 @@ public void addMemberFromEnumTrait() {
EnumDefinition enumDefinition = EnumDefinition.builder()
.name("foo")
.value("bar")
.tags(ListUtils.of("internal"))
.build();
EnumShape shape = builder.setMembersFromEnumTrait(EnumTrait.builder().addEnum(enumDefinition).build()).build();

Expand All @@ -133,6 +135,8 @@ public void addMemberFromEnumTrait() {
.id(shape.getId().withMember("foo"))
.target(UnitTypeTrait.UNIT)
.addTrait(EnumValueTrait.builder().stringValue("bar").build())
.addTrait(new InternalTrait())
.addTrait(TagsTrait.builder().addValue("internal").build())
.build());

assertTrue(shape.hasTrait(EnumTrait.class));
Expand Down
6 changes: 5 additions & 1 deletion smithy-model/src/test/java/software/amazon/smithy/model/transform/ChangeShapeTypeTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@
import software.amazon.smithy.model.traits.EnumDefinition;
import software.amazon.smithy.model.traits.EnumTrait;
import software.amazon.smithy.model.traits.EnumValueTrait;
import software.amazon.smithy.model.traits.InternalTrait;
import software.amazon.smithy.model.traits.TagsTrait;
import software.amazon.smithy.model.traits.UnitTypeTrait;
import software.amazon.smithy.model.traits.synthetic.SyntheticEnumTrait;
import software.amazon.smithy.utils.ListUtils;
Expand Down Expand Up @@ -269,6 +271,7 @@ public void canConvertStringToEnum() {
.addEnum(EnumDefinition.builder()
.name("foo")
.value("bar")
.addTag("internal")
.build())
.build();
SourceLocation source = new SourceLocation("/foo", 1, 1);
Expand All @@ -280,14 +283,15 @@ public void canConvertStringToEnum() {
.build();
Model model = Model.assembler().addShape(startShape).assemble().unwrap();
Model result = ModelTransformer.create().changeShapeType(model, MapUtils.of(id, ShapeType.ENUM));

assertThat(result.expectShape(id).getType(), Matchers.is(ShapeType.ENUM));
assertThat(result.expectShape(id).getSourceLocation(), Matchers.equalTo(source));
assertThat(result.expectShape(id).members(), Matchers.hasSize(1));
assertThat(result.expectShape(id).members().iterator().next(), Matchers.equalTo(MemberShape.builder()
.id(id.withMember("foo"))
.target(UnitTypeTrait.UNIT)
.addTrait(EnumValueTrait.builder().stringValue("bar").build())
.addTrait(new InternalTrait())
.addTrait(TagsTrait.builder().addValue("internal").build())
.build()));
}

Expand Down