Add a base path to the idl serializer

smithy-lang · JordonPhillips · Feb 27, 2020 · Feb 21, 2020 · Feb 21, 2020 · Feb 24, 2020
commit 92a4eaa1a1cb59e08b17059e32e5a659715ef95a
diff --git a/smithy-model/src/main/java/software/amazon/smithy/model/shapes/SmithyIdlModelSerializer.java b/smithy-model/src/main/java/software/amazon/smithy/model/shapes/SmithyIdlModelSerializer.java
@@ -59,12 +59,19 @@ public final class SmithyIdlModelSerializer {
     private final Predicate<Shape> shapeFilter;
     private final Predicate<Trait> traitFilter;
     private final Function<Shape, Path> shapePlacer;
+    private final Path basePath;
 
     private SmithyIdlModelSerializer(Builder builder) {
         metadataFilter = builder.metadataFilter;
         shapeFilter = builder.shapeFilter.and(FunctionalUtils.not(Prelude::isPreludeShape));
         traitFilter = builder.traitFilter;
-        shapePlacer = builder.shapePlacer;
+        basePath = builder.basePath;
+        if (basePath != null) {
+            Function<Shape, Path> shapePlacer = builder.shapePlacer;
+            this.shapePlacer = shape -> this.basePath.resolve(shapePlacer.apply(shape));
+        } else {
+            this.shapePlacer = builder.shapePlacer;
+        }
     }
 
     /**
@@ -89,7 +96,11 @@ public Map<Path, String> serialize(Model model) {
                 .collect(Collectors.groupingBy(shapePlacer)).entrySet().stream()
                 .collect(Collectors.toMap(Map.Entry::getKey, entry -> serialize(model, entry.getValue())));
         if (result.isEmpty()) {
-            return Collections.singletonMap(Paths.get("metadata.smithy"), serializeHeader(model, null));
+            Path path = Paths.get("metadata.smithy");
+            if (basePath != null) {
+                path = basePath.resolve(path);
+            }
+            return Collections.singletonMap(path, serializeHeader(model, null));
         }
         return result;
     }
@@ -219,6 +230,7 @@ public static final class Builder implements SmithyBuilder<SmithyIdlModelSeriali
         private Predicate<Shape> shapeFilter = shape -> true;
         private Predicate<Trait> traitFilter = trait -> true;
         private Function<Shape, Path> shapePlacer = SmithyIdlModelSerializer::placeShapesByNamespace;
+        private Path basePath = null;
 
         public Builder() {}
 
@@ -274,6 +286,17 @@ public Builder shapePlacer(Function<Shape, Path> shapePlacer) {
             return this;
         }
 
+        /**
+         * A base path to use for any created models.
+         *
+         * @param basePath The base directory to assign models to.
+         * @return Returns the builder.
+         */
+        public Builder basePath(Path basePath) {
+            this.basePath = basePath;
+            return this;
+        }
+
         @Override
         public SmithyIdlModelSerializer build() {
             return new SmithyIdlModelSerializer(this);

diff --git a/...model/src/test/java/software/amazon/smithy/model/shapes/SmithyIdlModelSerializerTest.java b/...model/src/test/java/software/amazon/smithy/model/shapes/SmithyIdlModelSerializerTest.java
@@ -1,6 +1,7 @@
 package software.amazon.smithy.model.shapes;
 
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.contains;
 import static org.hamcrest.Matchers.containsString;
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.aMapWithSize;
@@ -17,6 +18,7 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.TestFactory;
 import software.amazon.smithy.model.Model;
+import software.amazon.smithy.model.node.StringNode;
 import software.amazon.smithy.model.traits.DocumentationTrait;
 import software.amazon.smithy.model.traits.RequiredTrait;
 import software.amazon.smithy.utils.IoUtils;
@@ -48,14 +50,12 @@ public void multipleNamespacesGenerateMultipleFiles() {
                 .addImport(getClass().getResource("idl-serialization/multiple-namespaces/input.json"))
                 .assemble()
                 .unwrap();
-        SmithyIdlModelSerializer serializer = SmithyIdlModelSerializer.builder().build();
-        Map<Path, String> serialized = serializer.serialize(model);
-
         Path outputDir = Paths.get(getClass().getResource("idl-serialization/multiple-namespaces/output").getFile());
-        serialized.forEach((path, generated) -> {
-            Path expectedPath = outputDir.resolve(path);
-            assertThat(generated, equalTo(IoUtils.readUtf8File(expectedPath)));
-        });
+        SmithyIdlModelSerializer serializer = SmithyIdlModelSerializer.builder()
+                .basePath(outputDir)
+                .build();
+        Map<Path, String> serialized = serializer.serialize(model);
+        serialized.forEach((path, generated) -> assertThat(generated, equalTo(IoUtils.readUtf8File(path))));
     }
 
     @Test
@@ -119,4 +119,18 @@ public void filtersDocumentationTrait() {
             assertThat(output, not(containsString("/// ")));
         }
     }
+
+    @Test
+    public void basePathAppliesToMetadataOnlyModel() {
+        Path basePath = Paths.get("/tmp/smithytest");
+        Model model = Model.assembler()
+                .putMetadata("foo", StringNode.from("bar"))
+                .assemble()
+                .unwrap();
+        SmithyIdlModelSerializer serializer = SmithyIdlModelSerializer.builder()
+                .basePath(basePath)
+                .build();
+        Map<Path, String> serialized = serializer.serialize(model);
+        assertThat(serialized.keySet(), contains(basePath.resolve("metadata.smithy")));
+    }
 }