Remove whitespace in sdkId for rendering (#58)

disneystreaming · Jan 19, 2022 · d87e412 · d87e412
1 parent e3d718e
commit d87e412
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 14 deletions.
diff --git a/build.sbt b/build.sbt
@@ -299,6 +299,7 @@ lazy val codegen = projectMatrix
   .settings(
     buildInfoKeys := Seq[BuildInfoKey](version, scalaBinaryVersion),
     buildInfoPackage := "smithy4s.codegen",
+    isCE3 := true,
     libraryDependencies ++= Seq(
       Dependencies.Cats.core.value,
       Dependencies.Smithy.model,
@@ -308,8 +309,10 @@ lazy val codegen = projectMatrix
       "com.lihaoyi" %% "os-lib" % "0.8.0",
       "org.scala-lang.modules" %% "scala-collection-compat" % "2.2.0",
       "org.scala-lang" % "scala-reflect" % scalaVersion.value,
-      "io.get-coursier" %% "coursier" % "2.0.16"
+      "io.get-coursier" %% "coursier" % "2.0.16",
+      Dependencies.Weaver.cats.value % Test
     ),
+    testFrameworks += new TestFramework("weaver.framework.CatsEffect"),
     scalacOptions := scalacOptions.value
       .filterNot(Seq("-Ywarn-value-discard", "-Wvalue-discard").contains)
   )
@@ -328,8 +331,7 @@ lazy val `codegen-cli` = projectMatrix
     libraryDependencies ++= Seq(
       "com.monovore" %% "decline" % "2.2.0",
       Dependencies.Weaver.cats.value % Test
-    ),
-    testFrameworks += new TestFramework("weaver.framework.CatsEffect")
+    )
   )
 
 /**
@@ -386,7 +388,6 @@ lazy val protocol = projectMatrix
       Dependencies.Weaver.scalacheck.value % Test
     ),
     Test / fork := true,
-    testFrameworks += new TestFramework("weaver.framework.CatsEffect"),
     javacOptions ++= Seq(
       "-source",
       "1.8",
@@ -405,7 +406,6 @@ lazy val openapi = projectMatrix
   .jvmPlatform(buildtimejvmScala2Versions, jvmDimSettings)
   .dependsOn(protocol)
   .settings(
-    testFrameworks += new TestFramework("weaver.framework.CatsEffect"),
     isCE3 := true,
     libraryDependencies ++= Seq(
       Dependencies.Cats.core.value,
@@ -432,8 +432,7 @@ lazy val json = projectMatrix
       Dependencies.Weaver.cats.value % Test,
       Dependencies.Weaver.scalacheck.value % Test
     ),
-    Test / fork := virtualAxes.value.contains(VirtualAxis.jvm),
-    testFrameworks += new TestFramework("weaver.framework.CatsEffect")
+    Test / fork := virtualAxes.value.contains(VirtualAxis.jvm)
   )
   .jvmPlatform(allJvmScalaVersions, jvmDimSettings)
   .jsPlatform(allJsScalaVersions, jsDimSettings)
@@ -460,8 +459,7 @@ lazy val http4s = projectMatrix
       if (virtualAxes.value.contains(CatsEffect2Axis))
         moduleName.value + "-ce2"
       else moduleName.value
-    },
-    testFrameworks += new TestFramework("weaver.framework.CatsEffect")
+    }
   )
   .http4sPlatform(allJvmScalaVersions, jvmDimSettings)
 
@@ -484,8 +482,7 @@ lazy val `http4s-swagger` = projectMatrix
       if (virtualAxes.value.contains(CatsEffect2Axis))
         moduleName.value + "-ce2"
       else moduleName.value
-    },
-    testFrameworks += new TestFramework("weaver.framework.CatsEffect")
+    }
   )
   .http4sJvmPlatform(allJvmScalaVersions, jvmDimSettings)
 
@@ -509,7 +506,6 @@ lazy val tests = projectMatrix
         Dependencies.Weaver.cats.value
       )
     },
-    testFrameworks += new TestFramework("weaver.framework.CatsEffect"),
     Compile / smithySpecs := Seq(
       (ThisBuild / baseDirectory).value / "sampleSpecs" / "pizza.smithy",
       (ThisBuild / baseDirectory).value / "sampleSpecs" / "weather.smithy"

diff --git a/modules/codegen/src/smithy4s/codegen/SmithyToIR.scala b/modules/codegen/src/smithy4s/codegen/SmithyToIR.scala
@@ -34,6 +34,15 @@ object SmithyToIR {
     CompilationUnit(namespace, new SmithyToIR(model, namespace).allDecls)
   }
 
+  private[codegen] def prettifyName(
+      maybeSdkId: Option[String],
+      shapeName: String
+  ): String = {
+    maybeSdkId
+      .map(_.replaceAll("\\s+", ""))
+      .getOrElse(shapeName)
+  }
+
 }
 
 private[codegen] class SmithyToIR(model: Model, namespace: String) {
@@ -160,7 +169,7 @@ private[codegen] class SmithyToIR(model: Model, namespace: String) {
             .flatMap(st => Option(st.getSdkId()))
             .filterNot(_.isEmpty)
 
-        val prettyName = maybeSdkId.getOrElse(shape.name)
+        val prettyName = SmithyToIR.prettifyName(maybeSdkId, shape.name)
 
         Service(
           prettyName,

diff --git a/modules/codegen/test/src/smithy4s/codegen/SmithyToIRSpec.scala b/modules/codegen/test/src/smithy4s/codegen/SmithyToIRSpec.scala
@@ -0,0 +1,34 @@
+package smithy4s.codegen
+
+import weaver._
+
+object SmithyToIRSpec extends FunSuite {
+
+  test("prettifyName: sdkId takes precedence") {
+    expect.eql(
+      SmithyToIR.prettifyName(Some("Example"), "unused"),
+      "Example"
+    )
+  }
+  test("prettifyName: shapeName is used as a fallback") {
+    expect.eql(
+      SmithyToIR.prettifyName(None, "Example"),
+      "Example"
+    )
+  }
+
+  test("prettifyName removes whitespace in sdkId") {
+    expect.eql(
+      SmithyToIR.prettifyName(Some("QuickDB \t\nStreams"), "unused"),
+      "QuickDBStreams"
+    )
+  }
+
+  // Not a feature, just verifying the name is unaffected
+  test("prettifyName ignores whitespace in shape name") {
+    expect.eql(
+      SmithyToIR.prettifyName(None, "This Has Spaces"),
+      "This Has Spaces"
+    )
+  }
+}
diff --git a/project/Smithy4sPlugin.scala b/project/Smithy4sPlugin.scala
@@ -98,7 +98,8 @@ object Smithy4sPlugin extends AutoPlugin {
     incOptions := incOptions.value.withLogRecompileOnMacro(false),
     // https://scalacenter.github.io/scalafix/docs/users/installation.html
     semanticdbEnabled := true,
-    semanticdbVersion := scalafixSemanticdb.revision
+    semanticdbVersion := scalafixSemanticdb.revision,
+    testFrameworks += new TestFramework("weaver.framework.CatsEffect")
   ) ++ publishSettings ++ loggingSettings ++ compilerPlugins ++ headerSettings
 
   lazy val compilerPlugins = Seq(