Fix minor formatting and dependency issues

JordonPhillips · JordonPhillips · commit fd816d7067cd · 2023-10-17T16:59:12.000+02:00
diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml
@@ -22,7 +22,7 @@
     <!-- Files must contain a copyright header, with or without a year. -->
     <module name="RegexpHeader">
         <property name="header"
-                  value="/\*\n \* Copyright( 20(23)|) Amazon\.com, Inc\. or its affiliates\. All Rights Reserved\.\n"/>
+                  value="/\*\n \* Copyright Amazon\.com, Inc\. or its affiliates\. All Rights Reserved\.\n"/>
         <property name="fileExtensions" value="java"/>
     </module>
 
diff --git a/smithy-docgen-core/build.gradle b/smithy-docgen-core/build.gradle
@@ -22,8 +22,8 @@ ext {
 }
 
 dependencies {
-    api("software.amazon.smithy:smithy-build:$smithyVersion")
-    api("software.amazon.smithy:smithy-model:$smithyVersion")
-    api("software.amazon.smithy:smithy-utils:$smithyVersion")
-    api("software.amazon.smithy:smithy-codegen-core:$smithyVersion")
+    implementation("software.amazon.smithy:smithy-build:$smithyVersion")
+    implementation("software.amazon.smithy:smithy-model:$smithyVersion")
+    implementation("software.amazon.smithy:smithy-utils:$smithyVersion")
+    implementation("software.amazon.smithy:smithy-codegen-core:$smithyVersion")
 }
diff --git a/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/DirectedDocGen.java b/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/DirectedDocGen.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 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.
@@ -15,8 +15,6 @@
 
 package software.amazon.smithy.docgen.core;
 
-import java.util.ArrayList;
-import java.util.List;
 import software.amazon.smithy.codegen.core.SymbolProvider;
 import software.amazon.smithy.codegen.core.directed.CreateContextDirective;
 import software.amazon.smithy.codegen.core.directed.CreateSymbolProviderDirective;
@@ -29,10 +27,8 @@
 import software.amazon.smithy.codegen.core.directed.GenerateStructureDirective;
 import software.amazon.smithy.codegen.core.directed.GenerateUnionDirective;
 import software.amazon.smithy.docgen.core.generators.ServiceGenerator;
-import software.amazon.smithy.model.Model;
 
-public class DirectedDocGen
-        implements DirectedCodegen<DocGenerationContext, DocSettings, DocIntegration> {
+public class DirectedDocGen implements DirectedCodegen<DocGenerationContext, DocSettings, DocIntegration> {
 
     @Override
     public SymbolProvider createSymbolProvider(CreateSymbolProviderDirective<DocSettings> directive) {
@@ -41,16 +37,13 @@ public SymbolProvider createSymbolProvider(CreateSymbolProviderDirective<DocSett
 
     @Override
     public DocGenerationContext createContext(CreateContextDirective<DocSettings, DocIntegration> directive) {
-        Model model = directive.model();
-        DocSettings docSettings = directive.settings();
-        List<DocIntegration> docIntegrations = new ArrayList<>(directive.integrations());
-
         return new DocGenerationContext(
-                model,
-            docSettings,
-                directive.symbolProvider(),
-                directive.fileManifest(),
-            docIntegrations);
+            directive.model(),
+            directive.settings(),
+            directive.symbolProvider(),
+            directive.fileManifest(),
+            directive.integrations()
+        );
     }
 
     @Override
diff --git a/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/DocGenerationContext.java b/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/DocGenerationContext.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 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.
@@ -24,8 +24,7 @@
 import software.amazon.smithy.docgen.core.writers.MarkdownWriter;
 import software.amazon.smithy.model.Model;
 
-public final class DocGenerationContext
-        implements CodegenContext<DocSettings, DocWriter, DocIntegration> {
+public final class DocGenerationContext implements CodegenContext<DocSettings, DocWriter, DocIntegration> {
     private final Model model;
     private final DocSettings docSettings;
     private final SymbolProvider symbolProvider;
@@ -44,8 +43,8 @@ public DocGenerationContext(
         this.docSettings = docSettings;
         this.symbolProvider = symbolProvider;
         this.fileManifest = fileManifest;
-        this.writerDelegator = new WriterDelegator<>(fileManifest, symbolProvider,
-                new MarkdownWriter.Factory());
+        // TODO: pull the factory from the integrations
+        this.writerDelegator = new WriterDelegator<>(fileManifest, symbolProvider, new MarkdownWriter.Factory());
         this.docIntegrations = docIntegrations;
     }
 
diff --git a/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/DocIntegration.java b/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/DocIntegration.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 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.
@@ -18,6 +18,5 @@
 import software.amazon.smithy.codegen.core.SmithyIntegration;
 import software.amazon.smithy.docgen.core.writers.DocWriter;
 
-public interface DocIntegration
-        extends SmithyIntegration<DocSettings, DocWriter, DocGenerationContext> {
+public interface DocIntegration extends SmithyIntegration<DocSettings, DocWriter, DocGenerationContext> {
 }
diff --git a/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/DocSettings.java b/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/DocSettings.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 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.
@@ -15,12 +15,17 @@
 
 package software.amazon.smithy.docgen.core;
 
+import java.util.Objects;
 import software.amazon.smithy.model.node.ObjectNode;
 import software.amazon.smithy.model.shapes.ShapeId;
 
 public record DocSettings(ShapeId service) {
+
+    public DocSettings {
+        Objects.requireNonNull(service);
+    }
+
     public static DocSettings from(ObjectNode pluginSettings) {
-        return new DocSettings(
-                pluginSettings.expectStringMember("service").expectShapeId());
+        return new DocSettings(pluginSettings.expectStringMember("service").expectShapeId());
     }
 }
diff --git a/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/DocSymbolProvider.java b/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/DocSymbolProvider.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 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.
@@ -15,6 +15,9 @@
 
 package software.amazon.smithy.docgen.core;
 
+import static java.lang.String.format;
+
+import java.util.logging.Logger;
 import software.amazon.smithy.codegen.core.Symbol;
 import software.amazon.smithy.codegen.core.SymbolProvider;
 import software.amazon.smithy.model.Model;
@@ -23,6 +26,9 @@
 import software.amazon.smithy.model.shapes.ShapeVisitor;
 
 public class DocSymbolProvider extends ShapeVisitor.Default<Symbol> implements SymbolProvider {
+
+    private static final Logger LOGGER = Logger.getLogger(DocSymbolProvider.class.getName());
+
     private final Model model;
     private final DocSettings docSettings;
     private final ServiceShape serviceShape;
@@ -35,7 +41,9 @@ public DocSymbolProvider(Model model, DocSettings docSettings) {
 
     @Override
     public Symbol toSymbol(Shape shape) {
-        return shape.accept(this);
+        var symbol = shape.accept(this);
+        LOGGER.fine(() -> format("Creating symbol from %s: %s", shape, symbol));
+        return symbol;
     }
 
     @Override
@@ -48,8 +56,7 @@ public Symbol serviceShape(ServiceShape shape) {
     private Symbol.Builder getSymbolBuilder(Shape shape) {
         return Symbol.builder()
                 .name(getShapeName(serviceShape, shape))
-                .putProperty("shape", shape)
-                .putProperty("shapeType", shape.getType());
+                .putProperty("shape", shape);
     }
 
     private static String getDefinitionFile(ServiceShape serviceShape, Shape shape) {
@@ -61,11 +68,7 @@ public static String getDefinitionFile(String filename) {
     }
 
     private static String getShapeName(ServiceShape serviceShape, Shape shape) {
-        String name = shape.getId().getName(serviceShape);
-        if (shape.getId().getMember().isPresent()) {
-            name += "-" + shape.getId().getMember().get();
-        }
-        return name;
+        return shape.getId().getName(serviceShape);
     }
 
     // All other shapes don't get generation, so we'll do null checks where this might
diff --git a/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/SmithyDocPlugin.java b/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/SmithyDocPlugin.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 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.
@@ -15,6 +15,8 @@
 
 package software.amazon.smithy.docgen.core;
 
+
+import java.util.logging.Logger;
 import software.amazon.smithy.build.PluginContext;
 import software.amazon.smithy.build.SmithyBuildPlugin;
 import software.amazon.smithy.codegen.core.directed.CodegenDirector;
@@ -25,13 +27,16 @@
  */
 public final class SmithyDocPlugin implements SmithyBuildPlugin {
 
+    private static final Logger LOGGER = Logger.getLogger(SmithyDocPlugin.class.getName());
+
     @Override
     public String getName() {
         return "docgen";
     }
 
     @Override
     public void execute(PluginContext pluginContext) {
+        LOGGER.fine("Beginning documentation generation.");
         DocSettings docSettings = DocSettings.from(pluginContext.getSettings());
 
         CodegenDirector<DocWriter, DocIntegration, DocGenerationContext, DocSettings> runner
@@ -45,5 +50,6 @@ public void execute(PluginContext pluginContext) {
         runner.service(docSettings.service());
         runner.performDefaultCodegenTransforms();
         runner.run();
+        LOGGER.fine("Finished documentation generation.");
     }
 }
diff --git a/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/generators/ServiceGenerator.java b/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/generators/ServiceGenerator.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 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.
diff --git a/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/writers/DocImportContainer.java b/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/writers/DocImportContainer.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 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.
diff --git a/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/writers/DocWriter.java b/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/writers/DocWriter.java
@@ -1,3 +1,18 @@
+/*
+ * Copyright 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.docgen.core.writers;
 
 import software.amazon.smithy.codegen.core.SymbolWriter;
diff --git a/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/writers/MarkdownWriter.java b/smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/writers/MarkdownWriter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 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.

Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,8 @@ ext {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`dependencies {`
`25`		`- api("software.amazon.smithy:smithy-build:$smithyVersion")`
`26`		`- api("software.amazon.smithy:smithy-model:$smithyVersion")`
`27`		`- api("software.amazon.smithy:smithy-utils:$smithyVersion")`
`28`		`- api("software.amazon.smithy:smithy-codegen-core:$smithyVersion")`
	`25`	`+ implementation("software.amazon.smithy:smithy-build:$smithyVersion")`
	`26`	`+ implementation("software.amazon.smithy:smithy-model:$smithyVersion")`
	`27`	`+ implementation("software.amazon.smithy:smithy-utils:$smithyVersion")`
	`28`	`+ implementation("software.amazon.smithy:smithy-codegen-core:$smithyVersion")`
`29`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.`
	`2`	`+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License").`
`5`	`5`	`* You may not use this file except in compliance with the License.`
`@@ -18,6 +18,5 @@`
`18`	`18`	`import software.amazon.smithy.codegen.core.SmithyIntegration;`
`19`	`19`	`import software.amazon.smithy.docgen.core.writers.DocWriter;`
`20`	`20`
`21`		`-public interface DocIntegration`
`22`		`- extends SmithyIntegration<DocSettings, DocWriter, DocGenerationContext> {`
	`21`	`+public interface DocIntegration extends SmithyIntegration<DocSettings, DocWriter, DocGenerationContext> {`
`23`	`22`	`}`