Merge pull request #356 from domaframework/feat/doma-codegen-plugin

Add example-codegen-plugin project

Author: nakamura-to

README.md

@@ -10,112 +10,7 @@ This repository includes the following examples:
 * [example-criteria](example-criteria) - Uses the Criteria API.
 * [example-jpms](example-jpms) - Uses the Java Platform Module System (JPMS).
 * [example-geometric-type](example-geometric-type) - Uses Geometric types of PostgreSQL.
-
-ER diagram
----------------------
-
-The ER diagram for the database used in the example projects is shown below.
-
-```mermaid
-erDiagram
-    DEPARTMENT {
-      INTEGER id PK "not null"
-      VARCHAR name "not null"
-      INTEGER version "not null"
-    }
-    EMPLOYEE {
-      INTEGER id PK "not null"
-      VARCHAR name "not null"
-      INTEGER age "not null"
-      INTEGER salary
-      VARCHAR job_type
-      TIMESTAMP hiredate
-      INTEGER department_id
-      INTEGER version "not null"
-      TIMESTAMP inserttimestamp
-      TIMESTAMP updatetimestamp
-    }
-    USER {
-      INT id PK "auto_increment"
-      VARCHAR name "not null"
-      VARCHAR email "unique not null"
-      TIMESTAMP created_at "default current_timestamp"
-      INT version "default 0 not null"
-    }
-    ROLE {
-      INT id PK "auto_increment"
-      VARCHAR name "unique not null"
-      INT version "default 0 not null"
-    }
-    USER_ROLE {
-      INT id PK "auto_increment"
-      INT user_id "not null"
-      INT role_id "not null"
-      INT version "default 0 not null"
-    }
-    PRODUCT {
-      INT id PK "auto_increment"
-      VARCHAR name "not null"
-      DECIMAL price "not null"
-      INT stock_quantity "not null"
-      TIMESTAMP created_at "default current_timestamp"
-      INT version "default 0 not null"
-    }
-    CATEGORY {
-      INT id PK "auto_increment"
-      VARCHAR name "unique not null"
-      INT version "default 0 not null"
-    }
-    PRODUCT_CATEGORY {
-      INT id PK "auto_increment"
-      INT product_id "not null"
-      INT category_id "not null"
-      INT version "default 0 not null"
-    }
-    ORDER {
-      INT id PK "auto_increment"
-      INT user_id "not null"
-      TIMESTAMP order_date "default current_timestamp"
-      VARCHAR status "not null"
-      INT version "default 0 not null"
-    }
-    ORDER_ITEM {
-      INT id PK "auto_increment"
-      INT order_id "not null"
-      INT product_id "not null"
-      INT quantity "not null"
-      DECIMAL price "not null"
-      INT version "default 0 not null"
-    }
-    PAYMENT {
-      INT id PK "auto_increment"
-      INT order_id "unique not null"
-      DECIMAL amount "not null"
-      TIMESTAMP payment_date "default current_timestamp"
-      INT version "default 0 not null"
-    }
-    REVIEW {
-      INT id PK "auto_increment"
-      INT user_id "not null"
-      INT product_id "not null"
-      INT rating "check: 1-5"
-      TEXT comment
-      TIMESTAMP created_at "default current_timestamp"
-      INT version "default 0 not null"
-    }
-
-    EMPLOYEE }|..|| DEPARTMENT : belongs_to
-    USER_ROLE }|..|| USER : "user_id"
-    USER_ROLE }|..|| ROLE : "role_id"
-    PRODUCT_CATEGORY }|..|| PRODUCT : "product_id"
-    PRODUCT_CATEGORY }|..|| CATEGORY : "category_id"
-    ORDER }|..|| USER : "user_id"
-    ORDER_ITEM }|..|| ORDER : "order_id"
-    ORDER_ITEM }|..|| PRODUCT : "product_id"
-    PAYMENT ||--|| ORDER : "order_id"
-    REVIEW }|..|| USER : "user_id"
-    REVIEW }|..|| PRODUCT : "product_id"
-```
+* [example-codegen-plugin](example-codegen-plugin) - Uses [Doma CodeGen Plugin](https://github.com/domaframework/doma-codegen-plugin).
 
 Clone this repository
 ---------------------

example-codegen-plugin/.gitignore

@@ -0,0 +1,17 @@
+.classpath
+.factorypath
+.project
+.settings
+/.apt_generated
+/bin
+/build
+.gradle
+.idea
+out
+/.apt_generated_tests/
+.vscode
+.sdkmanrc
+
+src/main/java/example/generated/
+src/main/resources/META-INF/example/generated/
+src/test/java/example/generated/

example-codegen-plugin/README.md

@@ -0,0 +1,97 @@
+# example-codegen-plugin
+
+A sample project demonstrating code generation using the Doma Codegen Plugin.
+
+## Overview
+
+This project demonstrates how to use the [Doma Codegen Plugin](https://doma.readthedocs.io/en/stable/codegen/) to automatically generate entity classes and DAO classes from database schemas.
+
+It supports both MySQL and PostgreSQL databases and uses Testcontainers to automatically start databases during code generation.
+
+## Project Structure
+
+```
+example-codegen-plugin/
+├── build.gradle.kts           # Build configuration file
+├── src/
+│   ├── main/
+│   │   ├── java/
+│   │   │   └── example/
+│   │   │       └── generated/  # Auto-generated code
+│   │   │           ├── mysql/
+│   │   │           │   ├── dao/      # MySQL DAO classes
+│   │   │           │   └── entity/   # MySQL entity classes
+│   │   │           └── postgresql/
+│   │   │               ├── dao/      # PostgreSQL DAO classes
+│   │   │               └── entity/   # PostgreSQL entity classes
+│   │   └── resources/
+│   │       ├── META-INF/       # Auto-generated SQL files
+│   │       ├── init_mysql.sql      # MySQL initialization script
+│   │       └── init_postgresql.sql # PostgreSQL initialization script
+│   └── test/
+│       └── java/
+│           └── example/
+│               └── generated/  # Auto-generated test code
+```
+
+## Generated Tables
+
+Code is generated from the following four tables:
+
+- `DEPARTMENT` - Department information
+- `ADDRESS` - Address information
+- `EMPLOYEE` - Employee information (with foreign key constraints to DEPARTMENT and ADDRESS)
+- `COMP_KEY_ADDRESS` - Address information with composite primary key
+
+## Usage
+
+### Code Generation
+
+#### Generate code for MySQL
+```bash
+./gradlew domaCodeGenMysqlAll
+```
+
+#### Generate code for PostgreSQL
+```bash
+./gradlew domaCodeGenPostgresqlAll
+```
+
+### Clean up generated code
+```bash
+./gradlew clean
+```
+
+### Run tests
+```bash
+./gradlew test
+```
+
+## Configuration
+
+The following configurations are set in `build.gradle.kts`:
+
+### MySQL Configuration
+- Uses Testcontainers MySQL
+- Initialization script: `src/main/resources/init_mysql.sql`
+- Generated packages:
+  - Entities: `example.generated.mysql.entity`
+  - DAOs: `example.generated.mysql.dao`
+
+### PostgreSQL Configuration
+- Uses Testcontainers PostgreSQL
+- Initialization script: `src/main/resources/init_postgresql.sql`
+- Generated packages:
+  - Entities: `example.generated.postgresql.entity`
+  - DAOs: `example.generated.postgresql.dao`
+
+## Requirements
+
+- Java 17 or higher
+- Docker (required for running Testcontainers)
+
+## References
+
+- [Doma Official Documentation](https://doma.readthedocs.io/)
+- [Doma Codegen Plugin](https://doma.readthedocs.io/en/stable/codegen/)
+- [Testcontainers](https://www.testcontainers.org/)

example-codegen-plugin/build.gradle.kts

@@ -0,0 +1,94 @@
+plugins {
+    java
+    alias(libs.plugins.doma.codegen) // Doma code generation plugin
+}
+
+// Dependency configuration
+dependencies {
+    // Test runtime dependencies
+    testImplementation(platform(libs.testcontainers.bom)) // Testcontainers dependency management
+    testImplementation(libs.jdbc.mysql) // MySQL JDBC driver
+    testImplementation(libs.jdbc.postgresql) // PostgreSQL JDBC driver
+    testImplementation(libs.testcontainers.mysql) // MySQL Testcontainers
+    testImplementation(libs.testcontainers.postgresql) // PostgreSQL Testcontainers
+
+    // Doma code generation dependencies
+    domaCodeGen(platform(libs.testcontainers.bom)) // Testcontainers dependency management for code generation
+    domaCodeGen(libs.jdbc.mysql) // MySQL JDBC driver for code generation
+    domaCodeGen(libs.jdbc.postgresql) // PostgreSQL JDBC driver for code generation
+    domaCodeGen(libs.testcontainers.mysql) // MySQL Testcontainers for code generation
+    domaCodeGen(libs.testcontainers.postgresql) // PostgreSQL Testcontainers for code generation
+}
+
+// Doma code generation configuration
+domaCodeGen {
+    // Base package name for generated code
+    val basePackage = "example.generated"
+
+    // MySQL configuration
+    register("mysql") {
+        // Path to initialization script
+        val initScript = file("src/main/resources/init_mysql.sql")
+        // MySQL connection URL using Testcontainers with initialization script
+        url.set("jdbc:tc:mysql:8.4.5:///test?TC_INITSCRIPT=file:${initScript.absolutePath}")
+        user.set("test") // Database username
+        password.set("test") // Database password
+        // Entity class generation settings
+        entity {
+            packageName.set("$basePackage.mysql.entity") // Package name for entity classes
+        }
+        // DAO class generation settings
+        dao {
+            packageName.set("$basePackage.mysql.dao") // Package name for DAO classes
+        }
+    }
+    // PostgreSQL configuration
+    register("postgresql") {
+        // Path to initialization script
+        val initScript = file("src/main/resources/init_postgresql.sql")
+        // PostgreSQL connection URL using Testcontainers with initialization script
+        url.set("jdbc:tc:postgresql:13.21:///test?TC_INITSCRIPT=file:${initScript.absolutePath}")
+        user.set("test") // Database username
+        password.set("test") // Database password
+        // Entity class generation settings
+        entity {
+            packageName.set("$basePackage.postgresql.entity") // Package name for entity classes
+        }
+        // DAO class generation settings
+        dao {
+            packageName.set("$basePackage.postgresql.dao") // Package name for DAO classes
+        }
+    }
+}
+
+tasks {
+    // Clean task to remove generated source files
+    val cleanGeneratedSources by register<Delete>("cleanGeneratedSources") {
+        description = "Deletes generated source files by Doma code generation"
+        delete(
+            fileTree("src/main/java") {
+                include("example/generated/**")
+            }
+        )
+        delete(
+            fileTree("src/test/java") {
+                include("example/generated/**")
+            }
+        )
+        delete(
+            fileTree("src/main/resources/META-INF") {
+                include("example/generated/**")
+            }
+        )
+    }
+
+    // Configure the main clean task to also clean generated sources
+    clean {
+        dependsOn(cleanGeneratedSources)
+    }
+
+    // Configure test task to generate all source files before running tests
+    test {
+        dependsOn("domaCodeGenMysqlAll", "domaCodeGenPostgresqlAll")
+    }
+}

example-codegen-plugin/src/main/resources/init_mysql.sql

@@ -0,0 +1,38 @@
+CREATE TABLE IF NOT EXISTS DEPARTMENT(DEPARTMENT_ID INTEGER NOT NULL PRIMARY KEY, DEPARTMENT_NO INTEGER NOT NULL UNIQUE,DEPARTMENT_NAME VARCHAR(20),LOCATION VARCHAR(20) DEFAULT 'TOKYO', VERSION INTEGER);
+CREATE TABLE IF NOT EXISTS ADDRESS(ADDRESS_ID INTEGER NOT NULL PRIMARY KEY, STREET VARCHAR(20) UNIQUE, VERSION INTEGER);
+CREATE TABLE IF NOT EXISTS EMPLOYEE(EMPLOYEE_ID INTEGER NOT NULL PRIMARY KEY, EMPLOYEE_NO INTEGER NOT NULL ,EMPLOYEE_NAME VARCHAR(20),MANAGER_ID INTEGER,HIREDATE DATE,SALARY NUMERIC(7,2),DEPARTMENT_ID INTEGER,ADDRESS_ID INTEGER, VERSION INTEGER, CONSTRAINT FK_DEPARTMENT_ID FOREIGN KEY(DEPARTMENT_ID) REFERENCES DEPARTMENT(DEPARTMENT_ID),CONSTRAINT FK_ADDRESS_ID FOREIGN KEY(ADDRESS_ID) REFERENCES ADDRESS(ADDRESS_ID));
+CREATE TABLE IF NOT EXISTS COMP_KEY_ADDRESS(ADDRESS_ID1 INTEGER NOT NULL, ADDRESS_ID2 INTEGER NOT NULL, STREET VARCHAR(20), VERSION INTEGER, CONSTRAINT PK_COMP_KEY_ADDRESS PRIMARY KEY(ADDRESS_ID1, ADDRESS_ID2));
+
+INSERT INTO DEPARTMENT VALUES(1,10,'ACCOUNTING','NEW YORK',1);
+INSERT INTO DEPARTMENT VALUES(2,20,'RESEARCH','DALLAS',1);
+INSERT INTO DEPARTMENT VALUES(3,30,'SALES','CHICAGO',1);
+INSERT INTO DEPARTMENT VALUES(4,40,'OPERATIONS','BOSTON',1);
+INSERT INTO ADDRESS VALUES(1,'STREET 1',1);
+INSERT INTO ADDRESS VALUES(2,'STREET 2',1);
+INSERT INTO ADDRESS VALUES(3,'STREET 3',1);
+INSERT INTO ADDRESS VALUES(4,'STREET 4',1);
+INSERT INTO ADDRESS VALUES(5,'STREET 5',1);
+INSERT INTO ADDRESS VALUES(6,'STREET 6',1);
+INSERT INTO ADDRESS VALUES(7,'STREET 7',1);
+INSERT INTO ADDRESS VALUES(8,'STREET 8',1);
+INSERT INTO ADDRESS VALUES(9,'STREET 9',1);
+INSERT INTO ADDRESS VALUES(10,'STREET 10',1);
+INSERT INTO ADDRESS VALUES(11,'STREET 11',1);
+INSERT INTO ADDRESS VALUES(12,'STREET 12',1);
+INSERT INTO ADDRESS VALUES(13,'STREET 13',1);
+INSERT INTO ADDRESS VALUES(14,'STREET 14',1);
+INSERT INTO ADDRESS VALUES(15,'STREET 15',1);
+INSERT INTO EMPLOYEE VALUES(1,7369,'SMITH',13,'1980-12-17',800,2,1,1);
+INSERT INTO EMPLOYEE VALUES(2,7499,'ALLEN',6,'1981-02-20',1600,3,2,1);
+INSERT INTO EMPLOYEE VALUES(3,7521,'WARD',6,'1981-02-22',1250,3,3,1);
+INSERT INTO EMPLOYEE VALUES(4,7566,'JONES',9,'1981-04-02',2975,2,4,1);
+INSERT INTO EMPLOYEE VALUES(5,7654,'MARTIN',6,'1981-09-28',1250,3,5,1);
+INSERT INTO EMPLOYEE VALUES(6,7698,'BLAKE',9,'1981-05-01',2850,3,6,1);
+INSERT INTO EMPLOYEE VALUES(7,7782,'CLARK',9,'1981-06-09',2450,1,7,1);
+INSERT INTO EMPLOYEE VALUES(8,7788,'SCOTT',4,'1982-12-09',3000.0,2,8,1);
+INSERT INTO EMPLOYEE VALUES(9,7839,'KING',NULL,'1981-11-17',5000,1,9,1);
+INSERT INTO EMPLOYEE VALUES(10,7844,'TURNER',6,'1981-09-08',1500,3,10,1);
+INSERT INTO EMPLOYEE VALUES(11,7876,'ADAMS',8,'1983-01-12',1100,2,11,1);
+INSERT INTO EMPLOYEE VALUES(12,7900,'JAMES',6,'1981-12-03',950,3,12,1);
+INSERT INTO EMPLOYEE VALUES(13,7902,'FORD',4,'1981-12-03',3000,2,13,1);
+INSERT INTO EMPLOYEE VALUES(14,7934,'MILLER',7,'1982-01-23',1300,1,14,1);