add patch function

pwinckles · Aug 7, 2023 · 5e58459 · 5e58459
1 parent 8a7700c
commit 5e58459
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@
 - Add support for ordering by multiple fields
 - Add basic enum support
 - Add pagination support
+- Add `patch()` function on db classes as a convenience for creating patch objects
 
 ## [1.0.1] - 2023-07-26
 

diff --git a/README.md b/README.md
@@ -110,7 +110,7 @@ var id = exampleDb.insert(new Example()
         .setTimestamp(Instant.now()), conn);
 
 // update a single field on an existing entity
-exampleDb.update(id, new ExambleDb.Patch().setValue("updated"), conn);
+exampleDb.update(id, ExambleDb.patch().setValue("updated"), conn);
 
 // select all entities, ordered by a specific column
 var examples = exampleDb.select(select -> select.sort(orderBy -> orderBy.valueAsc()), conn);

diff --git a/processor/src/main/java/com/pwinckles/jdbcgen/processor/DbClassGenerator.java b/processor/src/main/java/com/pwinckles/jdbcgen/processor/DbClassGenerator.java
@@ -92,6 +92,7 @@ public JavaFile generate(EntitySpec entitySpec) {
         builder.addType(genPatchClass(entityType, patchType, idType, entitySpec))
                 .addType(genFilterBuilderClass(entityType, filterBuilderType, entitySpec))
                 .addType(genSortBuilderClass(entityType, sortBuilderType, entitySpec))
+                .addMethod(genPatchFunction(patchType))
                 .addMethod(genSelect(entityType, idType, entitySpec))
                 .addMethod(genSelect(entityType, filterBuilderType, sortBuilderType, entitySpec))
                 .addMethod(genSelectAll(entityType, entitySpec))
@@ -273,6 +274,17 @@ private TypeSpec genSortBuilderClass(TypeName entityType, TypeName sortBuilderTy
         return builder.build();
     }
 
+    private MethodSpec genPatchFunction(TypeName patchType) {
+        return MethodSpec.methodBuilder("patch")
+                .addJavadoc("Creates a new patch object to use for partially updating an entity.\n")
+                .addJavadoc("\n")
+                .addJavadoc("@return new patch")
+                .addModifiers(PUBLIC, STATIC)
+                .returns(patchType)
+                .addStatement("return new $T()", patchType)
+                .build();
+    }
+
     private MethodSpec genSelect(TypeName entityType, TypeName idType, EntitySpec entitySpec) {
         var query = "SELECT " + columnNames(entitySpec)
                 + " FROM " + entitySpec.getTableName()

diff --git a/test/src/main/java/com/pwinckles/jdbcgen/test/prototype/ExampleDb.java b/test/src/main/java/com/pwinckles/jdbcgen/test/prototype/ExampleDb.java
@@ -51,6 +51,15 @@ public Patch setExampleEnum(ExampleEnum exampleEnum) {
         }
     }
 
+    /**
+     * Creates a new patch object to use for partially updating an entity.
+     *
+     * @return new patch
+     */
+    public static Patch patch() {
+        return new Patch();
+    }
+
     /**
      * {@inheritDoc}
      */

diff --git a/test/src/test/java/com/pwinckles/jdbcgen/test/GetterSetterAllTypesEntityDbTest.java b/test/src/test/java/com/pwinckles/jdbcgen/test/GetterSetterAllTypesEntityDbTest.java
@@ -985,7 +985,7 @@ protected GetterSetterAllTypesEntity updateEntity(GetterSetterAllTypesEntity ent
 
     @Override
     protected GetterSetterAllTypesEntityDb.Patch patchAll(GetterSetterAllTypesEntity entity) {
-        return new GetterSetterAllTypesEntityDb.Patch()
+        return GetterSetterAllTypesEntityDb.patch()
                 .setLongPrim(entity.getLongPrim())
                 .setIntObj(entity.getIntObj())
                 .setIntPrim(entity.getIntPrim())
@@ -1028,7 +1028,7 @@ protected GetterSetterAllTypesEntity nullEntity(GetterSetterAllTypesEntity entit
 
     @Override
     protected GetterSetterAllTypesEntityDb.Patch nullPatchAll() {
-        return new GetterSetterAllTypesEntityDb.Patch()
+        return GetterSetterAllTypesEntityDb.patch()
                 .setIntObj(null)
                 .setShortObj(null)
                 .setDoubleObj(null)
@@ -1056,7 +1056,7 @@ protected Pair<GetterSetterAllTypesEntity, GetterSetterAllTypesEntityDb.Patch> p
 
         return ImmutablePair.of(
                 updated,
-                new GetterSetterAllTypesEntityDb.Patch()
+                GetterSetterAllTypesEntityDb.patch()
                         .setString(updated.getString())
                         .setUuid(updated.getUuid())
                         .setInstant(updated.getInstant())