Merge pull request #154 from makevook/issue/151,152,153

refactor,chore,docs: 템플릿 용어집 도메인 분리, 미사용 의존성 제거, 문서 최신화
makevook · Jul 15, 2024 · 475ab70 · 475ab70
2 parents 558d356 + b7f893e
commit 475ab70
Show file tree

Hide file tree

Showing 33 changed files with 111 additions and 124 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,28 @@
-# vook-server
+# Vook Server
 
-- [Introduction](docs/introduction/240622/README.md)
-- [DB Schema](docs/schema/README.md)
+<br />
+
+<p align="center">
+    <a href="https://vook.app">
+      <img src="docs/introduction/240622/assets/logo.svg" alt="Vook Logo" width="170">
+    </a>
+</p>
+
+<br />
+
+<p align="center"><b>드래그앤드롭</b>으로 용어의 의미를 가장 쉽고 빠르게 찾는 방법</p>
+
+<p align="center">
+  <img
+    src="docs/introduction/240622/assets/drag-and-drop.png"
+    alt="Vook Chrome Extension"
+    width="50%"
+  />
+</p>
+
+<p align="center">
+    <a href="docs/diagram"><b>Diagram</b></a> •
+    <a href="docs/schema"><b>Schema</b></a>
+</p>
+
+<br />
diff --git a/api/build.gradle b/api/build.gradle
@@ -42,7 +42,6 @@ dependencies {
 
     // spring modulith
     implementation 'org.springframework.modulith:spring-modulith-starter-core'
-    implementation 'org.springframework.modulith:spring-modulith-starter-jpa'
     testImplementation 'org.springframework.modulith:spring-modulith-starter-test'
 
     // lombok

diff --git a/api/src/main/java/vook/server/api/devhelper/app/InitService.java b/api/src/main/java/vook/server/api/devhelper/app/InitService.java
@@ -6,14 +6,14 @@
 import vook.server.api.domain.demo.model.DemoTerm;
 import vook.server.api.domain.demo.model.DemoTermRepository;
 import vook.server.api.domain.demo.model.DemoTermSynonymRepository;
+import vook.server.api.domain.template_vocabulary.logic.TemplateVocabularyLogic;
+import vook.server.api.domain.template_vocabulary.logic.dto.TemplateVocabularyCreateCommand;
+import vook.server.api.domain.template_vocabulary.model.TemplateTermRepository;
+import vook.server.api.domain.template_vocabulary.model.TemplateVocabularyRepository;
+import vook.server.api.domain.template_vocabulary.model.TemplateVocabularyType;
 import vook.server.api.domain.user.model.SocialUserRepository;
 import vook.server.api.domain.user.model.UserInfoRepository;
 import vook.server.api.domain.user.model.UserRepository;
-import vook.server.api.domain.vocabulary.logic.TemplateVocabularyLogic;
-import vook.server.api.domain.vocabulary.logic.dto.TemplateVocabularyCreateCommand;
-import vook.server.api.domain.vocabulary.model.TemplateTermRepository;
-import vook.server.api.domain.vocabulary.model.TemplateVocabularyRepository;
-import vook.server.api.domain.vocabulary.model.TemplateVocabularyType;
 import vook.server.api.domain.vocabulary.model.TermRepository;
 import vook.server.api.infra.search.demo.MeilisearchDemoTermSearchService;
 import vook.server.api.infra.vocabulary.cache.UserVocabularyCacheRepository;

diff --git a/.../api/domain/vocabulary/model/Synonym.java → ...rver/api/domain/common/model/Synonym.java b/.../api/domain/vocabulary/model/Synonym.java → ...rver/api/domain/common/model/Synonym.java
@@ -1,4 +1,4 @@
-package vook.server.api.domain.vocabulary.model;
+package vook.server.api.domain.common.model;
 
 import jakarta.persistence.Embeddable;
 

diff --git a/...bulary/logic/TemplateVocabularyLogic.java → ...bulary/logic/TemplateVocabularyLogic.java b/...bulary/logic/TemplateVocabularyLogic.java → ...bulary/logic/TemplateVocabularyLogic.java
@@ -1,9 +1,9 @@
-package vook.server.api.domain.vocabulary.logic;
+package vook.server.api.domain.template_vocabulary.logic;
 
 import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
-import vook.server.api.domain.vocabulary.logic.dto.TemplateVocabularyCreateCommand;
-import vook.server.api.domain.vocabulary.model.*;
+import vook.server.api.domain.template_vocabulary.logic.dto.TemplateVocabularyCreateCommand;
+import vook.server.api.domain.template_vocabulary.model.*;
 import vook.server.api.globalcommon.annotation.DomainLogic;
 
 import java.util.List;

diff --git a/.../dto/TemplateVocabularyCreateCommand.java → .../dto/TemplateVocabularyCreateCommand.java b/.../dto/TemplateVocabularyCreateCommand.java → .../dto/TemplateVocabularyCreateCommand.java
@@ -1,8 +1,8 @@
-package vook.server.api.domain.vocabulary.logic.dto;
+package vook.server.api.domain.template_vocabulary.logic.dto;
 
-import vook.server.api.domain.vocabulary.model.TemplateTerm;
-import vook.server.api.domain.vocabulary.model.TemplateVocabulary;
-import vook.server.api.domain.vocabulary.model.TemplateVocabularyType;
+import vook.server.api.domain.template_vocabulary.model.TemplateTerm;
+import vook.server.api.domain.template_vocabulary.model.TemplateVocabulary;
+import vook.server.api.domain.template_vocabulary.model.TemplateVocabularyType;
 
 import java.util.List;
 

diff --git a/...domain/vocabulary/model/TemplateTerm.java → ...mplate_vocabulary/model/TemplateTerm.java b/...domain/vocabulary/model/TemplateTerm.java → ...mplate_vocabulary/model/TemplateTerm.java
@@ -1,8 +1,9 @@
-package vook.server.api.domain.vocabulary.model;
+package vook.server.api.domain.template_vocabulary.model;
 
 import jakarta.persistence.*;
 import lombok.AccessLevel;
 import lombok.Getter;
+import vook.server.api.domain.common.model.Synonym;
 
 import java.util.List;
 

diff --git a/...abulary/model/TemplateTermRepository.java → ...abulary/model/TemplateTermRepository.java b/...abulary/model/TemplateTermRepository.java → ...abulary/model/TemplateTermRepository.java
@@ -1,4 +1,4 @@
-package vook.server.api.domain.vocabulary.model;
+package vook.server.api.domain.template_vocabulary.model;
 
 import org.springframework.data.jpa.repository.JpaRepository;
 

diff --git a/.../vocabulary/model/TemplateVocabulary.java → ..._vocabulary/model/TemplateVocabulary.java b/.../vocabulary/model/TemplateVocabulary.java → ..._vocabulary/model/TemplateVocabulary.java
@@ -1,4 +1,4 @@
-package vook.server.api.domain.vocabulary.model;
+package vook.server.api.domain.template_vocabulary.model;
 
 import jakarta.persistence.*;
 import lombok.Getter;

diff --git a/...y/model/TemplateVocabularyRepository.java → ...y/model/TemplateVocabularyRepository.java b/...y/model/TemplateVocabularyRepository.java → ...y/model/TemplateVocabularyRepository.java
@@ -1,4 +1,4 @@
-package vook.server.api.domain.vocabulary.model;
+package vook.server.api.domain.template_vocabulary.model;
 
 import org.springframework.data.jpa.repository.JpaRepository;
 

diff --git a/...abulary/model/TemplateVocabularyType.java → ...abulary/model/TemplateVocabularyType.java b/...abulary/model/TemplateVocabularyType.java → ...abulary/model/TemplateVocabularyType.java
@@ -1,4 +1,4 @@
-package vook.server.api.domain.vocabulary.model;
+package vook.server.api.domain.template_vocabulary.model;
 
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;

diff --git a/api/src/main/java/vook/server/api/domain/template_vocabulary/package-info.java b/api/src/main/java/vook/server/api/domain/template_vocabulary/package-info.java
@@ -0,0 +1,10 @@
+@ApplicationModule(
+        type = ApplicationModule.Type.OPEN,
+        displayName = "Template Vocabulary Domain",
+        allowedDependencies = {
+                "vook.server.api.domain.common"
+        }
+)
+package vook.server.api.domain.template_vocabulary;
+
+import org.springframework.modulith.ApplicationModule;
diff --git a/api/src/main/java/vook/server/api/domain/vocabulary/model/Term.java b/api/src/main/java/vook/server/api/domain/vocabulary/model/Term.java
@@ -4,6 +4,7 @@
 import lombok.AccessLevel;
 import lombok.Getter;
 import vook.server.api.domain.common.model.BaseEntity;
+import vook.server.api.domain.common.model.Synonym;
 
 import java.util.List;
 import java.util.UUID;

diff --git a/api/src/main/java/vook/server/api/web/user/package-info.java b/api/src/main/java/vook/server/api/web/user/package-info.java
@@ -5,6 +5,7 @@
                 "vook.server.api.web.common",
                 "vook.server.api.domain.user",
                 "vook.server.api.domain.vocabulary",
+                "vook.server.api.domain.template_vocabulary"
         }
 )
 package vook.server.api.web.user;

diff --git a/api/src/main/java/vook/server/api/web/user/usecase/OnboardingUserUseCase.java b/api/src/main/java/vook/server/api/web/user/usecase/OnboardingUserUseCase.java
@@ -1,17 +1,17 @@
 package vook.server.api.web.user.usecase;
 
 import lombok.RequiredArgsConstructor;
+import vook.server.api.domain.template_vocabulary.logic.TemplateVocabularyLogic;
+import vook.server.api.domain.template_vocabulary.model.TemplateTerm;
+import vook.server.api.domain.template_vocabulary.model.TemplateVocabularyType;
 import vook.server.api.domain.user.logic.UserLogic;
 import vook.server.api.domain.user.logic.dto.UserOnboardingCommand;
 import vook.server.api.domain.user.model.Funnel;
 import vook.server.api.domain.user.model.Job;
-import vook.server.api.domain.vocabulary.logic.TemplateVocabularyLogic;
 import vook.server.api.domain.vocabulary.logic.TermLogic;
 import vook.server.api.domain.vocabulary.logic.VocabularyLogic;
 import vook.server.api.domain.vocabulary.logic.dto.TermCreateAllCommand;
 import vook.server.api.domain.vocabulary.logic.dto.VocabularyCreateCommand;
-import vook.server.api.domain.vocabulary.model.TemplateTerm;
-import vook.server.api.domain.vocabulary.model.TemplateVocabularyType;
 import vook.server.api.domain.vocabulary.model.UserUid;
 import vook.server.api.domain.vocabulary.model.Vocabulary;
 import vook.server.api.globalcommon.annotation.UseCase;

diff --git a/...ry/logic/TemplateVocabularyLogicTest.java → ...ry/logic/TemplateVocabularyLogicTest.java b/...ry/logic/TemplateVocabularyLogicTest.java → ...ry/logic/TemplateVocabularyLogicTest.java
@@ -1,11 +1,11 @@
-package vook.server.api.domain.vocabulary.logic;
+package vook.server.api.domain.template_vocabulary.logic;
 
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.transaction.annotation.Transactional;
-import vook.server.api.domain.vocabulary.logic.dto.TemplateVocabularyCreateCommand;
-import vook.server.api.domain.vocabulary.model.*;
+import vook.server.api.domain.template_vocabulary.logic.dto.TemplateVocabularyCreateCommand;
+import vook.server.api.domain.template_vocabulary.model.*;
 import vook.server.api.testhelper.IntegrationTestBase;
 
 import java.util.List;

diff --git a/api/src/test/java/vook/server/api/testhelper/creator/TestTemplateVocabularyCreator.java b/api/src/test/java/vook/server/api/testhelper/creator/TestTemplateVocabularyCreator.java
@@ -3,9 +3,9 @@
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Component;
 import org.springframework.transaction.annotation.Transactional;
-import vook.server.api.domain.vocabulary.logic.TemplateVocabularyLogic;
-import vook.server.api.domain.vocabulary.logic.dto.TemplateVocabularyCreateCommand;
-import vook.server.api.domain.vocabulary.model.TemplateVocabularyType;
+import vook.server.api.domain.template_vocabulary.logic.TemplateVocabularyLogic;
+import vook.server.api.domain.template_vocabulary.logic.dto.TemplateVocabularyCreateCommand;
+import vook.server.api.domain.template_vocabulary.model.TemplateVocabularyType;
 
 import java.util.List;
 

diff --git a/api/src/test/java/vook/server/api/web/user/usecase/OnboardingUserUseCaseTest.java b/api/src/test/java/vook/server/api/web/user/usecase/OnboardingUserUseCaseTest.java
@@ -4,10 +4,10 @@
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.transaction.annotation.Transactional;
+import vook.server.api.domain.template_vocabulary.model.TemplateVocabularyType;
 import vook.server.api.domain.user.model.Funnel;
 import vook.server.api.domain.user.model.Job;
 import vook.server.api.domain.user.model.UserRepository;
-import vook.server.api.domain.vocabulary.model.TemplateVocabularyType;
 import vook.server.api.domain.vocabulary.model.TermRepository;
 import vook.server.api.domain.vocabulary.model.UserUid;
 import vook.server.api.domain.vocabulary.model.VocabularyRepository;

diff --git a/docs/diagram/README.md b/docs/diagram/README.md
@@ -0,0 +1,23 @@
+# Diagram
+
+> Generated by [Spring Modulith](https://spring.io/projects/spring-modulith) 
+
+## Overview
+
+![Overview](components.png)
+
+## User Web
+
+![User Web](module-vook.server.api.web.user.png)
+
+## Term Web
+
+![Term Web](module-vook.server.api.web.term.png)
+
+## Vocabulary Web
+
+![Vocabulary Web](module-vook.server.api.web.vocabulary.png)
+
+## Demo Web
+
+![Demo Web](module-vook.server.api.web.demo.png)
diff --git a/docs/diagram/components.png b/docs/diagram/components.png
diff --git a/docs/diagram/module-vook.server.api.web.demo.png b/docs/diagram/module-vook.server.api.web.demo.png
diff --git a/docs/diagram/module-vook.server.api.web.term.png b/docs/diagram/module-vook.server.api.web.term.png
diff --git a/docs/diagram/module-vook.server.api.web.user.png b/docs/diagram/module-vook.server.api.web.user.png
diff --git a/docs/diagram/module-vook.server.api.web.vocabulary.png b/docs/diagram/module-vook.server.api.web.vocabulary.png
diff --git a/docs/schema/README.md b/docs/schema/README.md
@@ -6,7 +6,6 @@
 | ---- | ------- | ------- | ---- |
 | [demo_term](demo_term.md) | 5 |  | BASE TABLE |
 | [demo_term_synonym](demo_term_synonym.md) | 3 |  | BASE TABLE |
-| [event_publication](event_publication.md) | 6 |  | BASE TABLE |
 | [social_user](social_user.md) | 5 |  | BASE TABLE |
 | [template_term](template_term.md) | 5 |  | BASE TABLE |
 | [template_vocabulary](template_vocabulary.md) | 2 |  | BASE TABLE |
@@ -38,14 +37,6 @@ erDiagram
   varchar_100_ synonym
   bigint_20_ demo_term_id FK
 }
-"event_publication" {
-  uuid id PK
-  datetime_6_ completion_date
-  varchar_255_ event_type
-  varchar_255_ listener_id
-  datetime_6_ publication_date
-  varchar_255_ serialized_event
-}
 "social_user" {
   bigint_20_ id PK
   datetime_6_ created_at
@@ -62,7 +53,7 @@ erDiagram
 }
 "template_vocabulary" {
   bigint_20_ id PK
-  varchar_20_ name
+  varchar_20_ type
 }
 "term" {
   bigint_20_ id PK
@@ -99,7 +90,7 @@ erDiagram
   datetime_6_ updated_at
   varchar_20_ name
   varchar_255_ uid
-  bigint_20_ user_id
+  varchar_255_ user_uid
 }
 ```
 

diff --git a/docs/schema/event_publication.md b/docs/schema/event_publication.md
diff --git a/docs/schema/schema.json b/docs/schema/schema.json
diff --git a/docs/schema/template_term.md b/docs/schema/template_term.md
@@ -60,7 +60,7 @@ erDiagram
 }
 "template_vocabulary" {
   bigint_20_ id PK
-  varchar_20_ name
+  varchar_20_ type
 }
 ```
 

diff --git a/docs/schema/template_vocabulary.md b/docs/schema/template_vocabulary.md
@@ -8,9 +8,9 @@
 ```sql
 CREATE TABLE `template_vocabulary` (
   `id` bigint(20) NOT NULL AUTO_INCREMENT,
-  `name` varchar(20) NOT NULL,
+  `type` varchar(20) NOT NULL,
   PRIMARY KEY (`id`),
-  UNIQUE KEY `UK_7smfim1klyuu5rh21994clsl4` (`name`)
+  UNIQUE KEY `UKaqlv8ks5rgqvc9wbcoahewmpm` (`type`)
 ) ENGINE=InnoDB AUTO_INCREMENT=[Redacted by tbls] DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci
 ```
 
@@ -21,21 +21,21 @@ CREATE TABLE `template_vocabulary` (
 | Name | Type | Default | Nullable | Extra Definition | Children | Parents | Comment |
 | ---- | ---- | ------- | -------- | ---------------- | -------- | ------- | ------- |
 | id | bigint(20) |  | false | auto_increment | [template_term](template_term.md) |  |  |
-| name | varchar(20) |  | false |  |  |  |  |
+| type | varchar(20) |  | false |  |  |  |  |
 
 ## Constraints
 
 | Name | Type | Definition |
 | ---- | ---- | ---------- |
 | PRIMARY | PRIMARY KEY | PRIMARY KEY (id) |
-| UK_7smfim1klyuu5rh21994clsl4 | UNIQUE | UNIQUE KEY UK_7smfim1klyuu5rh21994clsl4 (name) |
+| UKaqlv8ks5rgqvc9wbcoahewmpm | UNIQUE | UNIQUE KEY UKaqlv8ks5rgqvc9wbcoahewmpm (type) |
 
 ## Indexes
 
 | Name | Definition |
 | ---- | ---------- |
 | PRIMARY | PRIMARY KEY (id) USING BTREE |
-| UK_7smfim1klyuu5rh21994clsl4 | UNIQUE KEY UK_7smfim1klyuu5rh21994clsl4 (name) USING BTREE |
+| UKaqlv8ks5rgqvc9wbcoahewmpm | UNIQUE KEY UKaqlv8ks5rgqvc9wbcoahewmpm (type) USING BTREE |
 
 ## Relations
 
@@ -46,7 +46,7 @@ erDiagram
 
 "template_vocabulary" {
   bigint_20_ id PK
-  varchar_20_ name
+  varchar_20_ type
 }
 "template_term" {
   bigint_20_ id PK