-
Notifications
You must be signed in to change notification settings - Fork 91
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add intEnum support, tests for enum generation (#605)
- Loading branch information
Showing
7 changed files
with
226 additions
and
3 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| smithyVersion=[1.25.0,1.26.0[ | ||
| smithyVersion=[1.26.0,1.27.0[ | ||
| smithyGradleVersion=0.6.0 |
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
89 changes: 89 additions & 0 deletions
89
...ipt-codegen/src/main/java/software/amazon/smithy/typescript/codegen/IntEnumGenerator.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| /* | ||
| * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://aws.amazon.com/apache2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file is distributed | ||
| * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
| * express or implied. See the License for the specific language governing | ||
| * permissions and limitations under the License. | ||
| */ | ||
|
|
||
| package software.amazon.smithy.typescript.codegen; | ||
|
|
||
| import java.util.Comparator; | ||
| import java.util.Map; | ||
| import software.amazon.smithy.codegen.core.Symbol; | ||
| import software.amazon.smithy.model.shapes.IntEnumShape; | ||
| import software.amazon.smithy.utils.SmithyInternalApi; | ||
|
|
||
| /** | ||
| * Generates an appropriate TypeScript type from a Smithy intEnum shape. | ||
| * | ||
| * <p>For example, given the following Smithy model:</p> | ||
| * | ||
| * <pre>{@code | ||
| * intEnum FaceCard { | ||
| * JACK = 1 | ||
| * QUEEN = 2 | ||
| * KING = 3 | ||
| * } | ||
| * }</pre> | ||
| * | ||
| * <p>We will generate the following: | ||
| * | ||
| * <pre>{@code | ||
| * export enum FaceCard { | ||
| * JACK = 1, | ||
| * QUEEN = 2, | ||
| * KING = 3, | ||
| * } | ||
| * }</pre> | ||
| * | ||
| * <p>Shapes that refer to this intEnum as a member will use the following | ||
| * generated code: | ||
| * | ||
| * <pre>{@code | ||
| * import { FaceCard } from "./FaceCard"; | ||
| * | ||
| * interface MyStructure { | ||
| * "facecard": FaceCard | number; | ||
| * } | ||
| * }</pre> | ||
| */ | ||
| @SmithyInternalApi | ||
| final class IntEnumGenerator implements Runnable { | ||
|
|
||
| private final Symbol symbol; | ||
| private final IntEnumShape shape; | ||
| private final TypeScriptWriter writer; | ||
|
|
||
| IntEnumGenerator(IntEnumShape shape, Symbol symbol, TypeScriptWriter writer) { | ||
| this.shape = shape; | ||
| this.symbol = symbol; | ||
| this.writer = writer; | ||
| } | ||
|
|
||
| @Override | ||
| public void run() { | ||
| generateIntEnum(); | ||
| } | ||
|
|
||
| private void generateIntEnum() { | ||
| writer.openBlock("export enum $L {", "}", symbol.getName(), () -> { | ||
| // Sort by the values to ensure a stable order and sane diffs. | ||
| shape.getEnumValues().entrySet() | ||
| .stream() | ||
| .sorted(Comparator.comparing(e -> e.getValue())) | ||
| .forEach(this::writeIntEnumEntry); | ||
| }); | ||
| } | ||
|
|
||
| private void writeIntEnumEntry(Map.Entry<String, Integer> entry) { | ||
| writer.write("$L = $L,", TypeScriptUtils.sanitizePropertyName(entry.getKey()), entry.getValue()); | ||
| } | ||
| } |
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
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
37 changes: 37 additions & 0 deletions
37
...codegen/src/test/java/software/amazon/smithy/typescript/codegen/IntEnumGeneratorTest.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| package software.amazon.smithy.typescript.codegen; | ||
|
|
||
| import static org.hamcrest.MatcherAssert.assertThat; | ||
| import static org.hamcrest.Matchers.containsString; | ||
| import static org.hamcrest.Matchers.stringContainsInOrder; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import software.amazon.smithy.codegen.core.Symbol; | ||
| import software.amazon.smithy.model.Model; | ||
| import software.amazon.smithy.model.node.Node; | ||
| import software.amazon.smithy.model.shapes.IntEnumShape; | ||
|
|
||
| public class IntEnumGeneratorTest { | ||
| @Test | ||
| public void generatesIntEnums() { | ||
| IntEnumShape shape = IntEnumShape.builder() | ||
| .id("com.foo#Foo") | ||
| .addMember("BAR", 5) | ||
| .addMember("BAZ", 2) | ||
| .build(); | ||
| TypeScriptWriter writer = new TypeScriptWriter("foo"); | ||
| Model model = Model.assembler() | ||
| .addShape(shape) | ||
| .addImport(getClass().getResource("simple-service.smithy")) | ||
| .assemble() | ||
| .unwrap(); | ||
| TypeScriptSettings settings = TypeScriptSettings.from(model, Node.objectNodeBuilder() | ||
| .withMember("package", Node.from("example")) | ||
| .withMember("packageVersion", Node.from("1.0.0")) | ||
| .build()); | ||
| Symbol symbol = new SymbolVisitor(model, settings).toSymbol(shape); | ||
| new IntEnumGenerator(shape, symbol, writer).run(); | ||
|
|
||
| assertThat(writer.toString(), containsString("export enum Foo {")); | ||
| assertThat(writer.toString(), stringContainsInOrder("BAZ = 2,", "BAR = 5,")); | ||
| } | ||
| } |
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