[cleanup] Improve the code of EditProjectView

Signed-off-by: Stéphane Bégaudeau <[email protected]>

packages/sirius-web/backend/sirius-web-application/src/main/java/org/eclipse/sirius/web/application/project/dto/NatureDTO.java

@@ -0,0 +1,23 @@
+/*******************************************************************************
+ * Copyright (c) 2024 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.sirius.web.application.project.dto;
+
+import jakarta.validation.constraints.NotNull;
+
+/**
+ * DTO used to represent the nature of a project.
+ *
+ * @author sbegaudeau
+ */
+public record NatureDTO(@NotNull String name) {
+}

packages/sirius-web/backend/sirius-web-application/src/main/java/org/eclipse/sirius/web/application/project/dto/ProjectDTO.java

@@ -12,6 +12,7 @@
  *******************************************************************************/
 package org.eclipse.sirius.web.application.project.dto;
 
+import java.util.List;
 import java.util.UUID;
 
 import jakarta.validation.constraints.NotNull;
@@ -23,5 +24,6 @@
  */
 public record ProjectDTO(
         @NotNull UUID id,
-        @NotNull String name) {
+        @NotNull String name,
+        @NotNull List<NatureDTO> natures) {
 }

packages/sirius-web/backend/sirius-web-application/src/main/java/org/eclipse/sirius/web/application/project/services/ProjectMapper.java

@@ -12,6 +12,7 @@
  *******************************************************************************/
 package org.eclipse.sirius.web.application.project.services;
 
+import org.eclipse.sirius.web.application.project.dto.NatureDTO;
 import org.eclipse.sirius.web.application.project.services.api.IProjectMapper;
 import org.eclipse.sirius.web.domain.boundedcontexts.project.Project;
 import org.eclipse.sirius.web.application.project.dto.ProjectDTO;
@@ -26,6 +27,9 @@
 public class ProjectMapper implements IProjectMapper {
     @Override
     public ProjectDTO toDTO(Project project) {
-        return new ProjectDTO(project.getId(), project.getName());
+        var natures = project.getNatures().stream()
+                .map(nature -> new NatureDTO(nature.name()))
+                .toList();
+        return new ProjectDTO(project.getId(), project.getName(), natures);
     }
 }

packages/sirius-web/backend/sirius-web-application/src/main/resources/schema/siriusweb.graphqls

@@ -17,6 +17,11 @@ type Project {
   id: ID!
   name: String!
   currentEditingContext: EditingContext!
+  natures: [Nature!]!
+}
+
+type Nature {
+  name: String!
 }
 
 type ViewerProjectTemplatesConnection {

packages/sirius-web/backend/sirius-web-graphql/src/main/resources/schema/siriusweb.graphqls

@@ -18,6 +18,11 @@ type Project {
   name: String!
   currentEditingContext: EditingContext!
   images: [ImageMetadata!]!
+  natures: [Nature!]!
+}
+
+type Nature {
+  name: String!
 }
 
 extend type Subscription {

packages/sirius-web/backend/sirius-web-services-api/src/main/java/org/eclipse/sirius/web/services/api/projects/Project.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2019, 2023 Obeo.
+ * Copyright (c) 2019, 2024 Obeo.
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
@@ -13,6 +13,7 @@
 package org.eclipse.sirius.web.services.api.projects;
 
 import java.text.MessageFormat;
+import java.util.List;
 import java.util.Objects;
 import java.util.UUID;
 
@@ -26,9 +27,12 @@ public class Project {
 
     private final String name;
 
-    public Project(UUID id, String name) {
+    private final List<Nature> natures;
+
+    public Project(UUID id, String name, List<Nature> natures) {
         this.id = Objects.requireNonNull(id);
         this.name = Objects.requireNonNull(name);
+        this.natures = Objects.requireNonNull(natures);
     }
 
     public UUID getId() {
@@ -39,6 +43,10 @@ public String getName() {
         return this.name;
     }
 
+    public List<Nature> getNatures() {
+        return this.natures;
+    }
+
     @Override
     public String toString() {
         String pattern = "{0} '{'id: {1}, name: {2}'}'";

packages/sirius-web/backend/sirius-web-services/src/main/java/org/eclipse/sirius/web/services/documents/DocumentMapper.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2019, 2023 Obeo.
+ * Copyright (c) 2019, 2024 Obeo.
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
@@ -12,6 +12,8 @@
  *******************************************************************************/
 package org.eclipse.sirius.web.services.documents;
 
+import java.util.List;
+
 import org.eclipse.sirius.web.persistence.entities.DocumentEntity;
 import org.eclipse.sirius.web.persistence.entities.ProjectEntity;
 import org.eclipse.sirius.web.services.api.document.Document;
@@ -26,7 +28,7 @@ public class DocumentMapper {
     public Document toDTO(DocumentEntity documentEntity) {
         ProjectEntity projectEntity = documentEntity.getProject();
 
-        Project project = new Project(projectEntity.getId(), projectEntity.getName());
+        Project project = new Project(projectEntity.getId(), projectEntity.getName(), List.of());
         return new Document(documentEntity.getId(), project, documentEntity.getName(), documentEntity.getContent());
     }
 }

packages/sirius-web/backend/sirius-web-services/src/main/java/org/eclipse/sirius/web/services/projects/ProjectMapper.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2019, 2023 Obeo.
+ * Copyright (c) 2019, 2024 Obeo.
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
@@ -12,6 +12,8 @@
  *******************************************************************************/
 package org.eclipse.sirius.web.services.projects;
 
+import java.util.List;
+
 import org.eclipse.sirius.web.persistence.entities.ProjectEntity;
 import org.eclipse.sirius.web.services.api.projects.Project;
 
@@ -22,6 +24,6 @@
  */
 public class ProjectMapper {
     public Project toDTO(ProjectEntity projectEntity) {
-        return new Project(projectEntity.getId(), projectEntity.getName());
+        return new Project(projectEntity.getId(), projectEntity.getName(), List.of());
     }
 }

packages/sirius-web/backend/sirius-web-services/src/test/java/org/eclipse/sirius/web/services/documents/CreateDocumentEventHandlerTests.java

@@ -87,7 +87,7 @@ public void testCreateDocument() {
         IDocumentService documentService = new IDocumentService.NoOp() {
             @Override
             public Optional<Document> createDocument(String projectId, String name, String content) {
-                return Optional.of(new Document(UUID.randomUUID(), new Project(UUID.fromString(projectId), ""), name, content));
+                return Optional.of(new Document(UUID.randomUUID(), new Project(UUID.fromString(projectId), "", List.of()), name, content));
             }
         };
         IStereotypeService stereotypeService = new IStereotypeService.NoOp() {
@@ -127,7 +127,7 @@ public void testCreateTwoDocumentWithSameName() {
         IDocumentService documentService = new IDocumentService.NoOp() {
             @Override
             public Optional<Document> createDocument(String projectId, String name, String content) {
-                return Optional.of(new Document(UUID.randomUUID(), new Project(UUID.fromString(projectId), ""), name, content));
+                return Optional.of(new Document(UUID.randomUUID(), new Project(UUID.fromString(projectId), "", List.of()), name, content));
             }
         };
         IStereotypeService stereotypeService = new IStereotypeService.NoOp() {

packages/sirius-web/backend/sirius-web-services/src/test/java/org/eclipse/sirius/web/services/documents/DeleteDocumentEventHandlerTests.java

@@ -48,7 +48,7 @@ public class DeleteDocumentEventHandlerTests {
     @Test
     public void testDeleteDocument() {
         UUID projectId = UUID.randomUUID();
-        Document document = new Document(UUID.randomUUID(), new Project(projectId, ""), "name", "content");
+        Document document = new Document(UUID.randomUUID(), new Project(projectId, "", List.of()), "name", "content");
 
         IDocumentService documentService = new IDocumentService.NoOp() {
             @Override

packages/sirius-web/backend/sirius-web-services/src/test/java/org/eclipse/sirius/web/services/documents/RenameDocumentEventHandlerTests.java

@@ -57,7 +57,7 @@ public void testRenameDocument() {
         IDocumentService noOpDocumentService = new IDocumentService.NoOp() {
             @Override
             public Optional<Document> rename(UUID documentId, String newName) {
-                return Optional.of(new Document(documentId, new Project(UUID.randomUUID(), ""), newName, "noContent"));
+                return Optional.of(new Document(documentId, new Project(UUID.randomUUID(), "", List.of()), newName, "noContent"));
             }
         };
         RenameDocumentEventHandler handler = new RenameDocumentEventHandler(noOpDocumentService, new NoOpServicesMessageService(), new SimpleMeterRegistry());

packages/sirius-web/backend/sirius-web-services/src/test/java/org/eclipse/sirius/web/services/documents/UploadDocumentEventHandlerTests.java

@@ -171,7 +171,7 @@ private EditingDomain uploadDocument(InputStream inputstream, String expectedCha
         IDocumentService documentService = new IDocumentService.NoOp() {
             @Override
             public Optional<Document> createDocument(String projectId, String name, String content) {
-                return Optional.of(new Document(UUID.randomUUID(), new Project(UUID.fromString(projectId), ""), name, content));
+                return Optional.of(new Document(UUID.randomUUID(), new Project(UUID.fromString(projectId), "", List.of()), name, content));
             }
         };
         IServicesMessageService messageService = new NoOpServicesMessageService();
@@ -206,7 +206,7 @@ private EditingDomain uploadDocumentAndCheckReport(InputStream inputstream, Stri
         IDocumentService documentService = new IDocumentService.NoOp() {
             @Override
             public Optional<Document> createDocument(String projectId, String name, String content) {
-                return Optional.of(new Document(UUID.randomUUID(), new Project(UUID.fromString(projectId), ""), name, content));
+                return Optional.of(new Document(UUID.randomUUID(), new Project(UUID.fromString(projectId), "", List.of()), name, content));
             }
         };
         IServicesMessageService messageService = new NoOpServicesMessageService();
@@ -302,7 +302,7 @@ private void simulatesDocumentUpload(AdapterFactoryEditingDomain editingDomain,
 
             @Override
             public Optional<Document> createDocument(String projectId, String name, String content) {
-                return Optional.of(new Document(documentId, new Project(UUID.fromString(projectId), ""), name, content));
+                return Optional.of(new Document(documentId, new Project(UUID.fromString(projectId), "", List.of()), name, content));
             }
         };
         IServicesMessageService messageService = new NoOpServicesMessageService();

packages/sirius-web/backend/sirius-web-services/src/test/java/org/eclipse/sirius/web/services/projects/RenameProjectEventHandlerTests.java

@@ -14,6 +14,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+import java.util.List;
 import java.util.Optional;
 import java.util.UUID;
 import java.util.concurrent.atomic.AtomicBoolean;
@@ -39,7 +40,7 @@
 public class RenameProjectEventHandlerTests {
     @Test
     public void testRenameProject() {
-        Project project = new Project(UUID.randomUUID(), "newName");
+        Project project = new Project(UUID.randomUUID(), "newName", List.of());
 
         AtomicBoolean hasBeenCalled = new AtomicBoolean();
         IProjectService projectService = new IProjectService.NoOp() {

packages/sirius-web/frontend/sirius-web-application/src/index.ts

@@ -42,6 +42,9 @@ export {
 export { routerExtensionPoint } from './router/RouterExtensionPoints';
 export { type EditProjectNavbarSubtitleProps } from './views/edit-project/EditProjectNavbar/EditProjectNavbar.types';
 export { editProjectNavbarSubtitleExtensionPoint } from './views/edit-project/EditProjectNavbar/EditProjectNavbarExtensionPoints';
+export { useCurrentProject } from './views/edit-project/useCurrentProject';
+export type { UseCurrentProjectValue } from './views/edit-project/useCurrentProject.types';
+export type { GQLProject } from './views/edit-project/useProjectAndRepresentationMetadata.types';
 export { type CreateProjectAreaCardProps } from './views/project-browser/create-projects-area/CreateProjectArea.types';
 export { createProjectAreaCardExtensionPoint } from './views/project-browser/create-projects-area/CreateProjectAreaExtensionPoints';
 export { projectActionButtonMenuItemExtensionPoint } from './views/project-browser/list-projects-area/ProjectActionButtonExtensionPoints';

packages/sirius-web/frontend/sirius-web-application/src/views/edit-project/EditProjectNavbar/EditProjectNavbar.types.ts

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2021, 2023 Obeo.
+ * Copyright (c) 2021, 2024 Obeo.
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
@@ -10,11 +10,10 @@
  * Contributors:
  *     Obeo - initial API and implementation
  *******************************************************************************/
-
-import { Project } from '../EditProjectView.types';
+import { GQLProject } from '../useProjectAndRepresentationMetadata.types';
 
 export interface EditProjectNavbarProps {
-  project: Project;
+  project: GQLProject;
 }
 
 export interface EditProjectNavbarSubtitleProps {}