move writable and chainwritable up (#622)

Author: lucix-aws

codegen/smithy-go-codegen/src/main/java/software/amazon/smithy/go/codegen/ChainWritable.java

@@ -0,0 +1,69 @@
+package software.amazon.smithy.go.codegen;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.Optional;
+import java.util.function.Function;
+import software.amazon.smithy.utils.ListUtils;
+
+/**
+ * Chains together multiple Writables that can be composed into one Writable.
+ */
+public final class ChainWritable {
+    private final List<Writable> writables;
+
+    public ChainWritable() {
+        writables = new ArrayList<>();
+    }
+
+    public static ChainWritable of(Writable... writables) {
+        var chain = new ChainWritable();
+        chain.writables.addAll(ListUtils.of(writables));
+        return chain;
+    }
+
+    public static ChainWritable of(Collection<Writable> writables) {
+        var chain = new ChainWritable();
+        chain.writables.addAll(writables);
+        return chain;
+    }
+
+    public boolean isEmpty() {
+        return writables.isEmpty();
+    }
+
+    public ChainWritable add(Writable writable) {
+        writables.add(writable);
+        return this;
+    }
+
+    public <T> ChainWritable add(Optional<T> value, Function<T, Writable> fn) {
+        value.ifPresent(t -> writables.add(fn.apply(t)));
+        return this;
+    }
+
+    public ChainWritable add(boolean include, Writable writable) {
+        if (!include) {
+            writables.add(writable);
+        }
+        return this;
+    }
+
+    public Writable compose(boolean writeNewlines) {
+        return (GoWriter writer) -> {
+            var hasPrevious = false;
+            for (Writable writable : writables) {
+                if (hasPrevious && writeNewlines) {
+                    writer.write("");
+                }
+                hasPrevious = true;
+                writer.write("$W", writable);
+            }
+        };
+    }
+
+    public Writable compose() {
+        return compose(true);
+    }
+}

codegen/smithy-go-codegen/src/main/java/software/amazon/smithy/go/codegen/ClientOptions.java

@@ -36,7 +36,7 @@
 /**
  * Implements codegen for service client config.
  */
-public class ClientOptions implements GoWriter.Writable {
+public class ClientOptions implements Writable {
     public static final String NAME = "Options";
 
     private final ProtocolGenerator.GenerationContext context;
@@ -66,7 +66,7 @@ public void accept(GoWriter writer) {
         writer.write(generate());
     }
 
-    private GoWriter.Writable generate() {
+    private Writable generate() {
         var apiOptionsDocs = goDocTemplate(
                 "Set of options to modify how an operation is invoked. These apply to all operations "
                         + "invoked for this client. Use functional options on operation call to modify this "
@@ -95,15 +95,15 @@ private GoWriter.Writable generate() {
                         "apiOptionsDocs", apiOptionsDocs,
                         "options", NAME,
                         "stack", SmithyGoTypes.Middleware.Stack,
-                        "fields", GoWriter.ChainWritable.of(fields.stream().map(this::writeField).toList()).compose(),
+                        "fields", ChainWritable.of(fields.stream().map(this::writeField).toList()).compose(),
                         "protocolFields", generateProtocolFields(),
                         "copy", generateCopy(),
                         "getIdentityResolver", generateGetIdentityResolver(),
                         "helpers", generateHelpers()
                 ));
     }
 
-    private GoWriter.Writable generateProtocolTypes() {
+    private Writable generateProtocolTypes() {
         ensureSupportedProtocol();
         return goTemplate("""
                 type HTTPClient interface {
@@ -112,8 +112,8 @@ private GoWriter.Writable generateProtocolTypes() {
                 """, GoStdlibTypes.Net.Http.Request, GoStdlibTypes.Net.Http.Response);
     }
 
-    private GoWriter.Writable writeField(ConfigField field) {
-        GoWriter.Writable docs = writer -> {
+    private Writable writeField(ConfigField field) {
+        Writable docs = writer -> {
             field.getDocumentation().ifPresent(writer::writeDocs);
             field.getDeprecated().ifPresent(s -> {
                 if (field.getDocumentation().isPresent()) {
@@ -128,7 +128,7 @@ private GoWriter.Writable writeField(ConfigField field) {
                 """, docs, field.getName(), field.getType());
     }
 
-    private GoWriter.Writable generateProtocolFields() {
+    private Writable generateProtocolFields() {
         ensureSupportedProtocol();
         return goTemplate("""
                 $1W
@@ -157,7 +157,7 @@ private GoWriter.Writable generateProtocolFields() {
                 goDocTemplate("Priority list of preferred auth scheme names (e.g. sigv4a)."));
     }
 
-    private GoWriter.Writable generateCopy() {
+    private Writable generateCopy() {
         return goTemplate("""
                 // Copy creates a clone where the APIOptions list is deep copied.
                 func (o $1L) Copy() $1L {
@@ -171,7 +171,7 @@ private GoWriter.Writable generateCopy() {
                 """, NAME, SmithyGoTypes.Middleware.Stack);
     }
 
-    private GoWriter.Writable generateGetIdentityResolver() {
+    private Writable generateGetIdentityResolver() {
         return goTemplate("""
                 func (o $L) GetIdentityResolver(schemeID string) $T {
                     $W
@@ -181,7 +181,7 @@ private GoWriter.Writable generateGetIdentityResolver() {
                 """,
                 NAME,
                 SmithyGoTypes.Auth.IdentityResolver,
-                GoWriter.ChainWritable.of(
+                ChainWritable.of(
                         ServiceIndex.of(context.getModel())
                                 .getEffectiveAuthSchemes(context.getService()).keySet().stream()
                                 .filter(authSchemes::containsKey)
@@ -191,14 +191,14 @@ private GoWriter.Writable generateGetIdentityResolver() {
                 generateGetIdentityResolverMapping(NoAuthTrait.ID, new AnonymousDefinition()));
     }
 
-    private GoWriter.Writable generateGetIdentityResolverMapping(ShapeId schemeId, AuthSchemeDefinition scheme) {
+    private Writable generateGetIdentityResolverMapping(ShapeId schemeId, AuthSchemeDefinition scheme) {
         return goTemplate("""
                 if schemeID == $S {
                     return $W
                 }""", schemeId.toString(), scheme.generateOptionsIdentityResolver());
     }
 
-    private GoWriter.Writable generateHelpers() {
+    private Writable generateHelpers() {
         return writer -> {
             writer.write("""
                     $W

codegen/smithy-go-codegen/src/main/java/software/amazon/smithy/go/codegen/GoJmespathExpressionGenerator.java

@@ -411,8 +411,8 @@ private Shape expectMember(MapShape shape) {
     }
 
     // helper to generate comparisons from two results, automatically handling any dereferencing in the process
-    private GoWriter.Writable compareVariables(String ident, Variable left, Variable right, ComparatorType cmp,
-                                               String cast) {
+    private Writable compareVariables(String ident, Variable left, Variable right, ComparatorType cmp,
+                                      String cast) {
         var isLPtr = isPointable(left.type);
         var isRPtr = isPointable(right.type);
         if (!isLPtr && !isRPtr) {

codegen/smithy-go-codegen/src/main/java/software/amazon/smithy/go/codegen/GoStackStepMiddlewareGenerator.java

@@ -73,7 +73,7 @@ public static GoStackStepMiddlewareGenerator createInitializeStepMiddleware(Stri
      * @param body is the function body.
      * @return the generated middleware func.
      */
-    public static GoWriter.Writable generateInitializeMiddlewareFunc(GoWriter.Writable body) {
+    public static Writable generateInitializeMiddlewareFunc(Writable body) {
         return goTemplate("""
                 func(ctx $T, in $T, next $T) (
                     out $T, metadata $T, err error,
@@ -143,7 +143,7 @@ public static GoStackStepMiddlewareGenerator createFinalizeStepMiddleware(String
      * @param body is the function body.
      * @return the generated middleware func.
      */
-    public static GoWriter.Writable generateFinalizeMiddlewareFunc(GoWriter.Writable body) {
+    public static Writable generateFinalizeMiddlewareFunc(Writable body) {
         return goTemplate("""
                 func(ctx $T, in $T, next $T) (
                     out $T, metadata $T, err error,
@@ -284,7 +284,7 @@ public void writeMiddleware(
      * @param fields A Writable that renders the middleware struct's fields.
      * @return the writable.
      */
-    public GoWriter.Writable asWritable(GoWriter.Writable body, GoWriter.Writable fields) {
+    public Writable asWritable(Writable body, Writable fields) {
         return writer -> writeMiddleware(
                 writer,
                 (generator, bodyWriter) -> bodyWriter.write("$W", body),

codegen/smithy-go-codegen/src/main/java/software/amazon/smithy/go/codegen/GoWriter.java

@@ -16,14 +16,12 @@
 package software.amazon.smithy.go.codegen;
 
 import java.util.ArrayList;
-import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.function.BiFunction;
 import java.util.function.Consumer;
-import java.util.function.Function;
 import java.util.logging.Logger;
 import java.util.regex.Pattern;
 import software.amazon.smithy.codegen.core.CodegenException;
@@ -43,7 +41,6 @@
 import software.amazon.smithy.model.traits.RequiredTrait;
 import software.amazon.smithy.model.traits.StringTrait;
 import software.amazon.smithy.utils.AbstractCodeWriter;
-import software.amazon.smithy.utils.ListUtils;
 import software.amazon.smithy.utils.SmithyInternalApi;
 import software.amazon.smithy.utils.StringUtils;
 
@@ -168,14 +165,14 @@ public static Writable goDocTemplate(String contents) {
      */
     public static Writable autoDocTemplate(String contents) {
         var paragraphs = contents.split("\n\n");
-        var chain = new GoWriter.ChainWritable();
+        var chain = new ChainWritable();
         for (int i = 0; i < paragraphs.length; ++i) {
             chain.add(docParagraphWriter(paragraphs[i], i < paragraphs.length - 1));
         }
         return chain.compose(false);
     }
 
-    private static GoWriter.Writable docParagraphWriter(String paragraph, boolean writeNewline) {
+    private static Writable docParagraphWriter(String paragraph, boolean writeNewline) {
         return writer -> {
             writer.writeDocs(paragraph);
             if (writeNewline) {
@@ -1001,67 +998,4 @@ public String apply(Object type, String indent) {
         }
     }
 
-    public interface Writable extends Consumer<GoWriter> {
-    }
-
-    /**
-     * Chains together multiple Writables that can be composed into one Writable.
-     */
-    public static final class ChainWritable {
-        private final List<GoWriter.Writable> writables;
-
-        public ChainWritable() {
-            writables = new ArrayList<>();
-        }
-
-        public static ChainWritable of(GoWriter.Writable... writables) {
-            var chain = new ChainWritable();
-            chain.writables.addAll(ListUtils.of(writables));
-            return chain;
-        }
-
-        public static ChainWritable of(Collection<GoWriter.Writable> writables) {
-            var chain = new ChainWritable();
-            chain.writables.addAll(writables);
-            return chain;
-        }
-
-        public boolean isEmpty() {
-            return writables.isEmpty();
-        }
-
-        public ChainWritable add(GoWriter.Writable writable) {
-            writables.add(writable);
-            return this;
-        }
-
-        public <T> ChainWritable add(Optional<T> value, Function<T, Writable> fn) {
-            value.ifPresent(t -> writables.add(fn.apply(t)));
-            return this;
-        }
-
-        public ChainWritable add(boolean include, GoWriter.Writable writable) {
-            if (!include) {
-                writables.add(writable);
-            }
-            return this;
-        }
-
-        public GoWriter.Writable compose(boolean writeNewlines) {
-            return (GoWriter writer) -> {
-                var hasPrevious = false;
-                for (GoWriter.Writable writable : writables) {
-                    if (hasPrevious && writeNewlines) {
-                        writer.write("");
-                    }
-                    hasPrevious = true;
-                    writer.write("$W", writable);
-                }
-            };
-        }
-
-        public GoWriter.Writable compose() {
-            return compose(true);
-        }
-    }
 }