Update spring-base-commons to 2.0.0

.github/workflows/unit-test.yml

@@ -8,7 +8,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     env:
-      SPRING_BASE_COMMONS_VERSION: 1.1.0
+      SPRING_BASE_COMMONS_VERSION: 2.0.0
     steps:
     - uses: actions/checkout@v4
     - name: Set up JDK 25

Dockerfile

@@ -17,7 +17,7 @@ ENV APP_NAME=app.jar
 ENV DEPS_FILE=deps.info
 
 # Change this when there is an update
-ENV SPRING_BASE_COMMONS_VERSION=1.1.0
+ENV SPRING_BASE_COMMONS_VERSION=2.0.0
 
 # Clone the spring-base-commons repository
 RUN git clone --depth 1 --branch ${SPRING_BASE_COMMONS_VERSION} https://github.com/vulinh64/spring-base-commons.git

README.md

@@ -39,9 +39,9 @@
 
 The project uses the external dependency [spring-base-commons](https://github.com/vulinh64/spring-base-commons).
 
-* For Windows, run [this script](/create-data-classes.cmd)
+* For Windows, run [this script](./create-data-classes.cmd)
 
-* For Linux, run [this script](/create-data-classes.sh)
+* For Linux, run [this script](./create-data-classes.sh)
 
   * Run `chmod +x ./create-data-classes.sh` if you don't have permission to execute the shell file.
 
@@ -59,38 +59,40 @@ Check if your `pom.xml` contains these lines in the `<dependencies>` section:
 
 This project uses `spring-base-commons` as an external dependency (see above). If you want to change the version, check the following locations:
 
-* [`pom.xml` file](pom.xml) - find the property `spring-base-commons.version`.
+* [`pom.xml` file](./pom.xml) - find the property `spring-base-commons.version`.
 
 * Environment variable `SPRING_BASE_COMMONS_VERSION` in:
 
-  * [Dockerfile](/Dockerfile)
+  * [Dockerfile](./Dockerfile)
 
-  * [create-data-classes.cmd](/create-data-classes.cmd) (Windows)
+  * [create-data-classes.cmd](./create-data-classes.cmd) (Windows)
 
-  * [create-data-classes.sh](/create-data-classes.sh) (Linux)
+  * [create-data-classes.sh](./create-data-classes.sh) (Linux)
 
-  * [GitHub Actions workflows](/.github/workflows/unit-test.yml) (the variable is `${{ env.SPRING_BASE_COMMONS_VERSION }}`)
+  * [GitHub Actions workflows](./.github/workflows/unit-test.yml) (the variable is `${{ env.SPRING_BASE_COMMONS_VERSION }}`)
 
 ### Specifying Environment Variables
 
 The `SPRING_PROFILES_ACTIVE` variable is optional, but you can set it to `development` for local development.
 
 You can either specify these environment variables in a `.env` file or set them directly in Run Configurations.
 
-An example `.env` file can be copied from [this file](/.env-example).
+An example `.env` file can be copied from [this file](./.env-example).
 
 ### Running the Required Containers
 
-You can run [this script (Windows only)](/initialize-postgres-keycloak-rabbitmq.cmd) or [this script (Linux only)](/initialize-postgres-keycloak-rabbitmq.sh), and it will start the required containers for local development: PostgreSQL and Keycloak.
+You can run [this script (Windows only)](./initialize-postgres-keycloak-rabbitmq.cmd) or [this script (Linux only)](./initialize-postgres-keycloak-rabbitmq.sh), and it will start the required containers for local development: PostgreSQL and Keycloak.
 
 > Both scripts have already handled the external dependency for you. See the [Required External Dependency](#required-external-dependency) section for more information.
 
 ## Running the Compose Stack
 
-You can run [this script (Windows only)](/run-docker-compose-stack.cmd), and it will build the service image and start the containers for you.
+You can run [this script (Windows only)](./run-docker-compose-stack.cmd), or [this script (Linux only)](./run-docker-compose-stack.sh) and it will build the service image and start the containers for you.
 
 > Again, both scripts have already handled the external dependency for you.
 
+If you want to make use of host OS to build the images (to speed up the build process), run [this script (Windows only)](./run-docker-compose-stack-jar.cmd) or [this script (Linux only)](./run-docker-compose-stack-jar.sh) instead.
+
 # Additional Notes
 
 ## Virtual Threads

create-data-classes.cmd

@@ -1,6 +1,6 @@
 @echo off
 
-SET SPRING_BASE_COMMONS_VERSION=1.1.0
+SET SPRING_BASE_COMMONS_VERSION=2.0.0
 
 IF EXIST .\build\spring-base-commons rmdir /s /q .\build\spring-base-commons
 

create-data-classes.sh

@@ -2,7 +2,7 @@
 
 set -e
 
-SPRING_BASE_COMMONS_VERSION=1.1.0
+SPRING_BASE_COMMONS_VERSION=2.0.0
 
 if [ -d "./build/spring-base-commons" ]; then
   rm -rf ./build/spring-base-commons

pom.xml

@@ -68,7 +68,7 @@
         <!-- https://mvnrepository.com/artifact/org.keycloak/keycloak-admin-client -->
         <keycloak-admin-client.version>26.0.7</keycloak-admin-client.version>
 
-        <spring-base-commons.version>1.1.0</spring-base-commons.version>
+        <spring-base-commons.version>2.0.0</spring-base-commons.version>
     </properties>
 
     <dependencies>

src/main/java/com/vulinh/data/base/EntityDTOMapper.java

@@ -1,6 +1,6 @@
 package com.vulinh.data.base;
 
-public interface EntityDTOMapper<E extends AbstractIdentifiable<?>, D> {
+public interface EntityDTOMapper<E extends AbstractEntity<?>, D> {
 
   D toDto(E entity);
 }

src/main/java/com/vulinh/data/base/RecordIdentifiable.java

@@ -1,7 +1,9 @@
 package com.vulinh.data.base;
 
+import module java.base;
+
 @FunctionalInterface
-public interface RecordIdentifiable<I> extends Identifiable<I> {
+public interface RecordIdentifiable<I extends Serializable> extends Identifiable<I> {
 
   @Override
   default I getId() {

src/main/java/com/vulinh/data/base/RecordInstantDateTimeAuditable.java

@@ -0,0 +1,20 @@
+package com.vulinh.data.base;
+
+import module java.base;
+
+public interface RecordInstantDateTimeAuditable extends InstantDateTimeAuditable {
+
+  Instant createdDateTime();
+
+  Instant updatedDateTime();
+
+  @Override
+  default Instant getCreatedDateTime() {
+    return createdDateTime();
+  }
+
+  @Override
+  default Instant getUpdatedDateTime() {
+    return updatedDateTime();
+  }
+}

src/main/java/com/vulinh/data/dto/projection/CategoryProjection.java

@@ -1,8 +1,10 @@
 package com.vulinh.data.dto.projection;
 
-import com.vulinh.data.base.UuidIdentifiable;
+import module java.base;
 
-public interface CategoryProjection extends UuidIdentifiable {
+import com.vulinh.data.base.Identifiable;
+
+public interface CategoryProjection extends Identifiable<UUID> {
 
   String getDisplayName();
 }

src/main/java/com/vulinh/data/dto/projection/PostRevisionProjection.java

@@ -20,7 +20,7 @@ public record PostRevisionProjection(
     UUID authorId,
     UUID categoryId,
     String tags,
-    Instant revisionCreatedDate,
+    Instant revisionCreatedDateTime,
     UUID revisionCreatedBy)
     implements UUIDRevisionId, Serializable {
 

src/main/java/com/vulinh/data/dto/projection/PrefetchPostProjection.java

@@ -2,10 +2,10 @@
 
 import module java.base;
 
-import com.vulinh.data.base.DateTimeAuditable;
-import com.vulinh.data.base.UuidIdentifiable;
+import com.vulinh.data.base.Identifiable;
+import com.vulinh.data.base.InstantDateTimeAuditable;
 
-public interface PrefetchPostProjection extends UuidIdentifiable, DateTimeAuditable {
+public interface PrefetchPostProjection extends InstantDateTimeAuditable, Identifiable<UUID> {
 
   String getTitle();
 
@@ -18,8 +18,8 @@ public interface PrefetchPostProjection extends UuidIdentifiable, DateTimeAudita
   CategoryProjection getCategory();
 
   @Override
-  Instant getCreatedDate();
+  Instant getCreatedDateTime();
 
   @Override
-  Instant getUpdatedDate();
+  Instant getUpdatedDateTime();
 }

src/main/java/com/vulinh/data/dto/response/BasicPostResponse.java

@@ -4,7 +4,7 @@
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
-import com.vulinh.data.base.RecordDateTimeAuditable;
+import com.vulinh.data.base.RecordInstantDateTimeAuditable;
 import com.vulinh.data.base.RecordUuidIdentifiable;
 import com.vulinh.data.dto.response.data.TagData;
 import lombok.Builder;
@@ -15,12 +15,13 @@
 @Builder
 public record BasicPostResponse(
     UUID id,
+    Long revisionNumber,
     String title,
     String excerpt,
     String slug,
-    Instant createdDate,
-    Instant updatedDate,
+    Instant createdDateTime,
+    Instant updatedDateTime,
     UUID authorId,
     CategoryResponse category,
     Collection<TagData> tags)
-    implements RecordUuidIdentifiable, RecordDateTimeAuditable {}
+    implements RecordUuidIdentifiable, RecordInstantDateTimeAuditable {}

src/main/java/com/vulinh/data/dto/response/PostRevisionResponse.java

@@ -20,7 +20,7 @@ public record PostRevisionResponse(
     UUID authorId,
     UUID categoryId,
     String tags,
-    Instant revisionCreatedDate,
+    Instant revisionCreatedDateTime,
     UUID revisionCreatedBy)
     implements UUIDRevisionId, Serializable {
 

src/main/java/com/vulinh/data/dto/response/SingleCommentResponse.java

@@ -2,17 +2,13 @@
 
 import module java.base;
 
-import com.vulinh.data.base.RecordDateTimeAuditable;
+import com.vulinh.data.base.RecordInstantDateTimeAuditable;
 import com.vulinh.data.base.RecordUuidIdentifiable;
 import lombok.Builder;
 import lombok.With;
 
 @With
 @Builder
 public record SingleCommentResponse(
-    UUID id,
-    String content,
-    Instant createdDate,
-    Instant updatedDate,
-    Boolean isEdited)
-    implements RecordUuidIdentifiable, RecordDateTimeAuditable {}
+    UUID id, String content, Instant createdDateTime, Instant updatedDateTime, Boolean isEdited)
+    implements RecordUuidIdentifiable, RecordInstantDateTimeAuditable {}

src/main/java/com/vulinh/data/entity/Category.java

@@ -3,7 +3,7 @@
 import module java.base;
 
 import com.vulinh.annotation.UUIDAsIdIfNullGenerator;
-import com.vulinh.data.base.UuidJpaEntity;
+import com.vulinh.data.base.AbstractEntity;
 import jakarta.persistence.Entity;
 import jakarta.persistence.Id;
 import lombok.*;
@@ -15,7 +15,7 @@
 @Setter
 @ToString
 @Builder
-public class Category extends UuidJpaEntity {
+public class Category extends AbstractEntity<UUID> {
 
   @Serial private static final long serialVersionUID = 106688923162808538L;
 

src/main/java/com/vulinh/data/entity/Comment.java

@@ -2,15 +2,13 @@
 
 import module java.base;
 
-import com.vulinh.data.base.DateTimeAuditable;
-import com.vulinh.data.base.UuidJpaEntity;
+import com.vulinh.data.base.AbstractTimestampAuditableEntity;
 import jakarta.persistence.*;
 import lombok.*;
 import org.hibernate.annotations.UuidGenerator;
 import org.hibernate.annotations.UuidGenerator.Style;
 import org.springframework.data.annotation.CreatedBy;
-import org.springframework.data.annotation.CreatedDate;
-import org.springframework.data.annotation.LastModifiedDate;
+import org.springframework.data.annotation.LastModifiedBy;
 import org.springframework.data.jpa.domain.support.AuditingEntityListener;
 
 @Entity
@@ -22,7 +20,7 @@
 @ToString
 @Builder
 @With
-public class Comment extends UuidJpaEntity implements DateTimeAuditable {
+public class Comment extends AbstractTimestampAuditableEntity<UUID> {
 
   @Serial private static final long serialVersionUID = 8024056047258352378L;
 
@@ -32,14 +30,11 @@ public class Comment extends UuidJpaEntity implements DateTimeAuditable {
 
   String content;
 
-  @CreatedDate Instant createdDate;
-
-  @LastModifiedDate Instant updatedDate;
-
   // So that mapping on Post works
   @Column(name = "post_id")
   UUID postId;
 
-  @CreatedBy
-  UUID createdBy;
+  @CreatedBy UUID createdBy;
+
+  @LastModifiedBy UUID updatedBy;
 }