A demo application to discover HexaGlue step by step.

• Java 17+
• Maven 3.8+

hexaglue-demo/
├── pom.xml                              # Maven + HexaGlue configuration
├── src/main/java/io/hexaglue/demo/
│   ├── DemoApplication.java             # Spring Boot application
│   ├── domain/
│   │   ├── Task.java                    # Aggregate root (contains an intentional violation)
│   │   ├── TaskId.java                  # Value Object (record)
│   │   └── TaskStatus.java              # Enum
│   ├── ports/
│   │   ├── in/TaskUseCases.java         # Driving port
│   │   └── out/TaskRepository.java      # Driven port
│   └── application/
│       └── TaskService.java             # Application service
└── src/test/java/
    └── TaskRepositoryIntegrationTest.java  # Integration tests

git clone https://github.com/hexaglue/hexaglue-demo.git
cd hexaglue-demo

1. In pom.xml, uncomment the hexaglue-plugin-living-doc dependency in the HexaGlue plugin <dependencies> block
2. Run:

   mvn clean compile

3. Check the generated documentation in target/hexaglue/reports/living-doc/

1. In pom.xml, uncomment the hexaglue-plugin-audit dependency
2. Run:

   mvn clean verify -DskipTests

   The -DskipTests option is required because tests would fail: the JPA infrastructure has not been generated yet.
3. The build fails! The audit detects an architectural violation:
   • Task.java imports jakarta.persistence.Entity (domain dependency on infrastructure)

1. Open src/main/java/io/hexaglue/demo/domain/Task.java
2. Remove the @Entity annotation from the class
3. Remove the jakarta.persistence.Entity import
4. Run again:

   mvn clean verify -DskipTests

5. The build passes! The audit is satisfied.

1. In pom.xml, uncomment the hexaglue-plugin-jpa and hexaglue-plugin-rest dependencies

2. Run:

   mvn clean verify

3. HexaGlue automatically generates the following in target/generated-sources/hexaglue/:

   JPA (driven adapter from TaskRepository port):

   • TaskEntity.java: JPA entity
   • TaskJpaRepository.java: Spring Data repository
   • TaskMapper.java: Domain/entity mapper
   • TaskRepositoryAdapter.java: Adapter implementing the driven port

   REST (driving adapter from TaskUseCases port):

   • TaskController.java: REST controller with 6 endpoints
   • CreateTaskRequest.java: Request DTO with bean validation
   • TaskResponse.java: Response DTO with from() factory method
   • GlobalExceptionHandler.java: Centralized exception handling
   • RestConfiguration.java: Spring @Configuration with @Bean for TaskUseCases

   The REST plugin derives HTTP verbs automatically from use case signatures:

   • createTask → POST /api/tasks (201)
   • getTask → GET /api/tasks/{id} (200)
   • listAllTasks → GET /api/tasks (200)
   • startTask → POST /api/tasks/{id}/start-task (204)
   • completeTask → POST /api/tasks/{id}/complete-task (204)
   • deleteTask → DELETE /api/tasks/{id} (204)

   Generated sources are automatically added to the classpath thanks to <extensions>true</extensions>.

4. Integration tests pass, the audit validates the final architecture, and OpenAPI documentation is available at http://localhost:8080/swagger-ui.html.

• Quick Start Guide
• GitHub HexaGlue