#39 - Allow path params to use "normal" { } as well as : for Javalin

Author: rbygrave

http-generator-core/src/main/java/io/avaje/http/generator/core/PathSegments.java

@@ -10,39 +10,40 @@
 
 public class PathSegments {
 
-  static final PathSegments EMPTY = new PathSegments("", Collections.emptySet());
+  static final PathSegments EMPTY = new PathSegments(new Chunks(), Collections.emptySet());
 
   static PathSegments parse(String fullPath) {
 
     Set<Segment> segments = new LinkedHashSet<>();
 
-    StringBuilder path = new StringBuilder();
-
+    Chunks chunks = new Chunks();
     if ("/".equals(fullPath)) {
-      path.append("/");
+      chunks.literal("/");
 
     } else {
       for (String section : fullPath.split("/")) {
         if (!section.isEmpty()) {
-          path.append("/");
+          chunks.literal("/");
           if (section.startsWith(":")) {
-            Segment segment = createSegment(section.substring(1));
+            final String name = section.substring(1);
+            Segment segment = createSegment(name);
             segments.add(segment);
-            path.append(segment.path(section, ":", ""));
+            chunks.named(segment.path(name));
 
           } else if ((section.startsWith("{") && (section.endsWith("}")))) {
-            Segment segment = createSegment(section.substring(1, section.length() - 1));
+            String name = section.substring(1, section.length() - 1);
+            Segment segment = createSegment(name);
             segments.add(segment);
-            path.append(segment.path(section, "{", "}"));
+            chunks.named(segment.path(name));
 
           } else {
-            path.append(section);
+            chunks.literal(section);
           }
         }
       }
     }
 
-    return new PathSegments(path.toString(), segments);
+    return new PathSegments(chunks, segments);
   }
 
   private static Segment createSegment(String val) {
@@ -54,16 +55,16 @@ private static Segment createSegment(String val) {
     return new Segment(matrixSplit[0], matrixKeys);
   }
 
-  private final String fullPath;
+  private final Chunks chunks;
 
   private final Set<Segment> segments;
 
   private final List<Segment> withMatrixs = new ArrayList<>();
 
   private final Set<String> allNames = new HashSet<>();
 
-  private PathSegments(String fullPath, Set<Segment> segments) {
-    this.fullPath = fullPath;
+  private PathSegments(Chunks chunks, Set<Segment> segments) {
+    this.chunks = chunks;
     this.segments = segments;
     for (Segment segment : segments) {
       segment.addNames(allNames);
@@ -92,8 +93,22 @@ public Segment segment(String varName) {
     return null;
   }
 
+  /**
+   * Return full path with <code>{}</code for named path params.
+   */
   public String fullPath() {
-    return fullPath;
+    return fullPath("{", "}");
+  }
+
+  /**
+   * Return full path with colon for named path params (Javalin).
+   */
+  public String fullPathColon() {
+    return fullPath(":", "");
+  }
+
+  private String fullPath(String prefix, String suffix) {
+    return chunks.fullPath(prefix, suffix);
   }
 
   public static class Segment {
@@ -184,11 +199,54 @@ boolean isRequired(String varName) {
       return name.equals(varName);
     }
 
-    String path(String section, String prefix, String suffix) {
+    String path(String section) {
       if (!hasMatrixParams()) {
         return section;
       }
-      return prefix + name + "_segment" + suffix;
+      return name + "_segment";
     }
   }
+
+  private static class Chunks {
+    private final List<Chunk> chunks = new ArrayList<>();
+
+    void named(String name) {
+      chunks.add(new Chunk(name));
+    }
+
+    void literal(String val) {
+      chunks.add(new LiteralChunk(val));
+    }
+
+    String fullPath(String prefix, String suffix) {
+      StringBuilder sb = new StringBuilder();
+      for (Chunk chunk : chunks) {
+        chunk.append(sb, prefix, suffix);
+      }
+      return sb.toString();
+    }
+  }
+
+  private static class LiteralChunk extends Chunk {
+    private LiteralChunk(String value) {
+      super(value);
+    }
+
+    @Override
+    void append(StringBuilder fullPath, String prefix, String suffix) {
+      fullPath.append(value);
+    }
+  }
+
+  private static class Chunk {
+    final String value;
+    private Chunk(String value) {
+      this.value = value;
+    }
+
+    void append(StringBuilder fullPath, String prefix, String suffix) {
+      fullPath.append(prefix).append(value).append(suffix);
+    }
+  }
+
 }

http-generator-core/src/main/java/io/avaje/http/generator/core/openapi/MethodDocBuilder.java

@@ -44,7 +44,7 @@ public void build() {
       operation.setDeprecated(true);
     }
 
-    PathItem pathItem = ctx.pathItem(normalisePath(methodReader.getFullPath()));
+    PathItem pathItem = ctx.pathItem(methodReader.getFullPath());
     switch (methodReader.getWebMethod()) {
       case GET:
         pathItem.setGet(operation);
@@ -85,10 +85,6 @@ public void build() {
     responses.addApiResponse(methodReader.getStatusCode(), response);
   }
 
-  String normalisePath(String fullPath) {
-    return fullPath.replaceAll("(:)([^/]+)", "{$2}");
-  }
-
   DocContext getContext() {
     return ctx;
   }

http-generator-core/src/test/java/io/avaje/http/generator/core/PathSegmentsTest.java

@@ -53,8 +53,8 @@ public void parse_snake() {
     assertTrue(segments.contains("one-a"));
     assertTrue(segments.contains("two-b"));
 
-    assertEquals("/fo/:one-a/:two-b", segments.fullPath());
-
+    assertEquals("/fo/:one-a/:two-b", segments.fullPathColon());
+    assertEquals("/fo/{one-a}/{two-b}", segments.fullPath());
   }
 
   @Test
@@ -63,7 +63,6 @@ public void parse_empty() {
     PathSegments segments = PathSegments.parse("/hello");
     assertFalse(segments.contains("hello"));
     assertEquals("/hello", segments.fullPath());
-
   }
 
   @Test
@@ -80,7 +79,8 @@ public void pathMatrixParams_colonPrefix() {
     assertThat(matrixSegments.get(1).name()).isEqualTo("foo");
     assertThat(matrixSegments.get(1).matrixKeys()).containsOnly("baz");
 
-    assertEquals("/:id_segment/:foo_segment", segments.fullPath());
+    assertEquals("/:id_segment/:foo_segment", segments.fullPathColon());
+    assertEquals("/{id_segment}/{foo_segment}", segments.fullPath());
   }
 
   @Test
@@ -98,17 +98,20 @@ public void pathMatrixParams_normalised() {
     assertThat(matrixSegments.get(1).matrixKeys()).containsOnly("baz");
 
     assertEquals("/{id_segment}/{foo_segment}", segments.fullPath());
+    assertEquals("/:id_segment/:foo_segment", segments.fullPathColon());
   }
 
   @Test
   public void pathMatrixParams_fullPath() {
 
     PathSegments segments = PathSegments.parse("/start/:id;key;other/:foo;baz/end");
-    assertEquals("/start/:id_segment/:foo_segment/end", segments.fullPath());
+    assertEquals("/start/:id_segment/:foo_segment/end", segments.fullPathColon());
+    assertEquals("/start/{id_segment}/{foo_segment}/end", segments.fullPath());
 
     segments = PathSegments.parse("/start/:id;key;other/middle/:foo;baz/end");
 
-    assertEquals("/start/:id_segment/middle/:foo_segment/end", segments.fullPath());
+    assertEquals("/start/:id_segment/middle/:foo_segment/end", segments.fullPathColon());
+    assertEquals("/start/{id_segment}/middle/{foo_segment}/end", segments.fullPath());
   }
 
   @Test

http-generator-core/src/test/java/io/avaje/http/generator/core/openapi/MethodDocBuilderTest.java

@@ -31,7 +31,7 @@ class ControllerMethodWriter {
   void write(boolean requestScoped) {
 
     final PathSegments segments = method.getPathSegments();
-    final String fullPath = segments.fullPath();
+    final String fullPath = segments.fullPathColon();
 
     writer.append("    ApiBuilder.%s(\"%s\", ctx -> {", webMethod.name().toLowerCase(), fullPath).eol();
     writer.append("      ctx.status(%s);", method.getStatusCode()).eol();

http-generator-javalin/src/main/java/io/avaje/http/generator/javalin/ControllerMethodWriter.java

@@ -60,7 +60,7 @@ public Foo putIt(FooBody payload) {
     return foo;
   }
 
-  @Delete("{id}")
+  @Delete(":id")
   public Foo deleteIt(long id, FooBody body) {
     Foo foo = new Foo();
     foo.name = body.name + "=" + body.getMessage() + " - Delete " + id;

tests/test-helidon/src/main/java/org/example/FooController.java

@@ -22,7 +22,7 @@ class BazController extends BaseController<Baz, Long> {
    *
    * @return The list of baz
    */
-  @Get("findbyname/:name")
+  @Get("findbyname/{name}")
   List<Baz> searchByName(String name) {
 
     Baz b1 = new Baz();