[457] Fix rename Form representation from the project explorer

Bug: #457 Signed-off-by: Axel RICHARD <axel.richard@obeo.fr>
eclipse-sirius · Sep 12, 2022 · 14e24f9 · 14e24f9
1 parent 262d987
commit 14e24f9
Show file tree

Hide file tree

Showing 27 changed files with 317 additions and 36 deletions.
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -48,6 +48,7 @@ The `label` value is displayed before the widget to be consistent with other pro
 - https://github.com/eclipse-sirius/sirius-components/issues/1347[#1347] [form] Fix Conditional Style menu items (two menu items available instead of one)
 - https://github.com/eclipse-sirius/sirius-components/issues/1349[#1349] [form] Fix Form Representation scrolling on Y axis
 - https://github.com/eclipse-sirius/sirius-components/issues/1351[#1351] [form] Fix Style/ConditionalStyle not applied to List Widget
+- https://github.com/eclipse-sirius/sirius-components/issues/457[#457] [form] Fix rename Form representation from the project explorer
 
 === Improvements
 

diff --git a/...s/src/main/java/org/eclipse/sirius/components/collaborative/forms/FormEventProcessor.java b/...s/src/main/java/org/eclipse/sirius/components/collaborative/forms/FormEventProcessor.java
@@ -22,12 +22,14 @@
 import org.eclipse.sirius.components.collaborative.api.IRepresentationRefreshPolicy;
 import org.eclipse.sirius.components.collaborative.api.IRepresentationRefreshPolicyRegistry;
 import org.eclipse.sirius.components.collaborative.api.ISubscriptionManager;
+import org.eclipse.sirius.components.collaborative.dto.RenameRepresentationInput;
 import org.eclipse.sirius.components.collaborative.forms.api.FormCreationParameters;
 import org.eclipse.sirius.components.collaborative.forms.api.IFormEventHandler;
 import org.eclipse.sirius.components.collaborative.forms.api.IFormEventProcessor;
 import org.eclipse.sirius.components.collaborative.forms.api.IFormInput;
 import org.eclipse.sirius.components.collaborative.forms.api.IWidgetSubscriptionManager;
 import org.eclipse.sirius.components.collaborative.forms.dto.FormRefreshedEventPayload;
+import org.eclipse.sirius.components.collaborative.forms.dto.RenameFormInput;
 import org.eclipse.sirius.components.collaborative.forms.dto.UpdateWidgetFocusInput;
 import org.eclipse.sirius.components.collaborative.forms.dto.UpdateWidgetFocusSuccessPayload;
 import org.eclipse.sirius.components.core.api.IEditingContext;
@@ -62,6 +64,8 @@ public class FormEventProcessor implements IFormEventProcessor {
 
     private final Logger logger = LoggerFactory.getLogger(FormEventProcessor.class);
 
+    private final IEditingContext editingContext;
+
     private final FormCreationParameters formCreationParameters;
 
     private final List<IFormEventHandler> formEventHandlers;
@@ -76,10 +80,11 @@ public class FormEventProcessor implements IFormEventProcessor {
 
     private final AtomicReference<Form> currentForm = new AtomicReference<>();
 
-    public FormEventProcessor(FormCreationParameters formCreationParameters, List<IFormEventHandler> formEventHandlers, ISubscriptionManager subscriptionManager,
+    public FormEventProcessor(IEditingContext editingContext, FormCreationParameters formCreationParameters, List<IFormEventHandler> formEventHandlers, ISubscriptionManager subscriptionManager,
             IWidgetSubscriptionManager widgetSubscriptionManager, IRepresentationRefreshPolicyRegistry representationRefreshPolicyRegistry) {
         this.logger.trace("Creating the form event processor {}", formCreationParameters.getId()); //$NON-NLS-1$
 
+        this.editingContext = Objects.requireNonNull(editingContext);
         this.formCreationParameters = Objects.requireNonNull(formCreationParameters);
         this.formEventHandlers = Objects.requireNonNull(formEventHandlers);
         this.subscriptionManager = Objects.requireNonNull(subscriptionManager);
@@ -103,21 +108,27 @@ public ISubscriptionManager getSubscriptionManager() {
 
     @Override
     public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, IRepresentationInput representationInput) {
-        if (representationInput instanceof IFormInput) {
-            IFormInput formInput = (IFormInput) representationInput;
+        IRepresentationInput effectiveInput = representationInput;
+        if (representationInput instanceof RenameRepresentationInput) {
+            RenameRepresentationInput renameRepresentationInput = (RenameRepresentationInput) representationInput;
+            effectiveInput = new RenameFormInput(renameRepresentationInput.getId(), renameRepresentationInput.getEditingContextId(), renameRepresentationInput.getRepresentationId(),
+                    renameRepresentationInput.getNewLabel());
+        }
+        if (effectiveInput instanceof IFormInput) {
+            IFormInput formInput = (IFormInput) effectiveInput;
 
             if (formInput instanceof UpdateWidgetFocusInput) {
                 UpdateWidgetFocusInput input = (UpdateWidgetFocusInput) formInput;
                 this.widgetSubscriptionManager.handle(input);
 
-                payloadSink.tryEmitValue(new UpdateWidgetFocusSuccessPayload(representationInput.getId(), input.getWidgetId()));
-                changeDescriptionSink.tryEmitNext(new ChangeDescription(ChangeKind.FOCUS_CHANGE, representationInput.getRepresentationId(), input));
+                payloadSink.tryEmitValue(new UpdateWidgetFocusSuccessPayload(input.getId(), input.getWidgetId()));
+                changeDescriptionSink.tryEmitNext(new ChangeDescription(ChangeKind.FOCUS_CHANGE, input.getRepresentationId(), input));
             } else {
                 Optional<IFormEventHandler> optionalFormEventHandler = this.formEventHandlers.stream().filter(handler -> handler.canHandle(formInput)).findFirst();
 
                 if (optionalFormEventHandler.isPresent()) {
                     IFormEventHandler formEventHandler = optionalFormEventHandler.get();
-                    formEventHandler.handle(payloadSink, changeDescriptionSink, this.currentForm.get(), formInput);
+                    formEventHandler.handle(payloadSink, changeDescriptionSink, this.editingContext, this.currentForm.get(), formInput);
                 } else {
                     this.logger.warn("No handler found for event: {}", formInput); //$NON-NLS-1$
                 }

diff --git a/...ain/java/org/eclipse/sirius/components/collaborative/forms/FormEventProcessorFactory.java b/...ain/java/org/eclipse/sirius/components/collaborative/forms/FormEventProcessorFactory.java
@@ -101,7 +101,7 @@ public <T extends IRepresentationEventProcessor> Optional<T> createRepresentatio
                             .build();
                     // @formatter:on
 
-                    IRepresentationEventProcessor formEventProcessor = new FormEventProcessor(formCreationParameters, this.formEventHandlers, this.subscriptionManagerFactory.create(),
+                    IRepresentationEventProcessor formEventProcessor = new FormEventProcessor(editingContext, formCreationParameters, this.formEventHandlers, this.subscriptionManagerFactory.create(),
                             this.widgetSubscriptionManagerFactory.create(), this.representationRefreshPolicyRegistry);
 
                     // @formatter:off

diff --git a/...va/org/eclipse/sirius/components/collaborative/forms/PropertiesEventProcessorFactory.java b/...va/org/eclipse/sirius/components/collaborative/forms/PropertiesEventProcessorFactory.java
@@ -101,7 +101,7 @@ public <T extends IRepresentationEventProcessor> Optional<T> createRepresentatio
                         .build();
                 // @formatter:on
 
-                IRepresentationEventProcessor formEventProcessor = new FormEventProcessor(formCreationParameters, this.formEventHandlers, this.subscriptionManagerFactory.create(),
+                IRepresentationEventProcessor formEventProcessor = new FormEventProcessor(editingContext, formCreationParameters, this.formEventHandlers, this.subscriptionManagerFactory.create(),
                         this.widgetSubscriptionManagerFactory.create(), this.representationRefreshPolicyRegistry);
 
                 // @formatter:off

diff --git a/...g/eclipse/sirius/components/collaborative/forms/RelatedElementsEventProcessorFactory.java b/...g/eclipse/sirius/components/collaborative/forms/RelatedElementsEventProcessorFactory.java
@@ -91,7 +91,7 @@ public <T extends IRepresentationEventProcessor> Optional<T> createRepresentatio
                         .build();
                 // @formatter:on
 
-                IRepresentationEventProcessor formEventProcessor = new FormEventProcessor(formCreationParameters, this.formEventHandlers, this.subscriptionManagerFactory.create(),
+                IRepresentationEventProcessor formEventProcessor = new FormEventProcessor(editingContext, formCreationParameters, this.formEventHandlers, this.subscriptionManagerFactory.create(),
                         this.widgetSubscriptionManagerFactory.create(), this.representationRefreshPolicyRegistry);
 
                 // @formatter:off

diff --git a/...g/eclipse/sirius/components/collaborative/forms/RepresentationsEventProcessorFactory.java b/...g/eclipse/sirius/components/collaborative/forms/RepresentationsEventProcessorFactory.java
@@ -86,7 +86,7 @@ public <T extends IRepresentationEventProcessor> Optional<T> createRepresentatio
                         .build();
                 // @formatter:on
 
-                FormEventProcessor formEventProcessor = new FormEventProcessor(formCreationParameters, this.formEventHandlers, this.subscriptionManagerFactory.create(),
+                FormEventProcessor formEventProcessor = new FormEventProcessor(editingContext, formCreationParameters, this.formEventHandlers, this.subscriptionManagerFactory.create(),
                         this.widgetSubscriptionManagerFactory.create(), this.representationRefreshPolicyRegistry);
 
                 // @formatter:off

diff --git a/...rc/main/java/org/eclipse/sirius/components/collaborative/forms/api/IFormEventHandler.java b/...rc/main/java/org/eclipse/sirius/components/collaborative/forms/api/IFormEventHandler.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2019, 2020 Obeo.
+ * Copyright (c) 2019, 2022 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.components.collaborative.forms.api;
 
 import org.eclipse.sirius.components.collaborative.api.ChangeDescription;
+import org.eclipse.sirius.components.core.api.IEditingContext;
 import org.eclipse.sirius.components.core.api.IPayload;
 import org.eclipse.sirius.components.forms.Form;
 
@@ -27,5 +28,5 @@
 public interface IFormEventHandler {
     boolean canHandle(IFormInput formInput);
 
-    void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, Form form, IFormInput formInput);
+    void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, IEditingContext editingContext, Form form, IFormInput formInput);
 }
diff --git a/.../src/main/java/org/eclipse/sirius/components/collaborative/forms/dto/RenameFormInput.java b/.../src/main/java/org/eclipse/sirius/components/collaborative/forms/dto/RenameFormInput.java
@@ -0,0 +1,70 @@
+/*******************************************************************************
+ * Copyright (c) 2022 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.components.collaborative.forms.dto;
+
+import java.text.MessageFormat;
+import java.util.Objects;
+import java.util.UUID;
+
+import org.eclipse.sirius.components.collaborative.forms.api.IFormInput;
+
+/**
+ * The input of the rename diagram mutation.
+ *
+ * @author arichard
+ */
+public final class RenameFormInput implements IFormInput {
+
+    private UUID id;
+
+    private String editingContextId;
+
+    private String formId;
+
+    private String newLabel;
+
+    public RenameFormInput() {
+        // Used by Jackson
+    }
+
+    public RenameFormInput(UUID id, String editingContextId, String formId, String newLabel) {
+        this.id = Objects.requireNonNull(id);
+        this.editingContextId = Objects.requireNonNull(editingContextId);
+        this.formId = Objects.requireNonNull(formId);
+        this.newLabel = Objects.requireNonNull(newLabel);
+    }
+
+    @Override
+    public UUID getId() {
+        return this.id;
+    }
+
+    public String getEditingContextId() {
+        return this.editingContextId;
+    }
+
+    @Override
+    public String getRepresentationId() {
+        return this.formId;
+    }
+
+    public String getNewLabel() {
+        return this.newLabel;
+    }
+
+    @Override
+    public String toString() {
+        String pattern = "{0} '{'id: {1}, editingContextId: {2}, formId: {3}, newLabel: {4}'}'"; //$NON-NLS-1$
+        return MessageFormat.format(pattern, this.getClass().getSimpleName(), this.id, this.editingContextId, this.formId, this.newLabel);
+    }
+}
diff --git a/...org/eclipse/sirius/components/collaborative/forms/handlers/ClickListItemEventHandler.java b/...org/eclipse/sirius/components/collaborative/forms/handlers/ClickListItemEventHandler.java
@@ -25,6 +25,7 @@
 import org.eclipse.sirius.components.collaborative.forms.dto.ClickListItemSuccessPayload;
 import org.eclipse.sirius.components.collaborative.forms.messages.ICollaborativeFormMessageService;
 import org.eclipse.sirius.components.core.api.ErrorPayload;
+import org.eclipse.sirius.components.core.api.IEditingContext;
 import org.eclipse.sirius.components.core.api.IPayload;
 import org.eclipse.sirius.components.forms.Form;
 import org.eclipse.sirius.components.forms.List;
@@ -69,7 +70,7 @@ public boolean canHandle(IFormInput formInput) {
     }
 
     @Override
-    public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, Form form, IFormInput formInput) {
+    public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, IEditingContext editingContext, Form form, IFormInput formInput) {
         this.counter.increment();
 
         String message = this.messageService.invalidInput(formInput.getClass().getSimpleName(), ClickListItemInput.class.getSimpleName());

diff --git a/...rg/eclipse/sirius/components/collaborative/forms/handlers/DeleteListItemEventHandler.java b/...rg/eclipse/sirius/components/collaborative/forms/handlers/DeleteListItemEventHandler.java
@@ -25,6 +25,7 @@
 import org.eclipse.sirius.components.collaborative.forms.dto.DeleteListItemSuccessPayload;
 import org.eclipse.sirius.components.collaborative.forms.messages.ICollaborativeFormMessageService;
 import org.eclipse.sirius.components.core.api.ErrorPayload;
+import org.eclipse.sirius.components.core.api.IEditingContext;
 import org.eclipse.sirius.components.core.api.IPayload;
 import org.eclipse.sirius.components.forms.Form;
 import org.eclipse.sirius.components.forms.List;
@@ -69,7 +70,7 @@ public boolean canHandle(IFormInput formInput) {
     }
 
     @Override
-    public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, Form form, IFormInput formInput) {
+    public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, IEditingContext editingContext, Form form, IFormInput formInput) {
         this.counter.increment();
 
         String message = this.messageService.invalidInput(formInput.getClass().getSimpleName(), DeleteListItemInput.class.getSimpleName());

diff --git a/.../org/eclipse/sirius/components/collaborative/forms/handlers/EditCheckboxEventHandler.java b/.../org/eclipse/sirius/components/collaborative/forms/handlers/EditCheckboxEventHandler.java
@@ -24,6 +24,7 @@
 import org.eclipse.sirius.components.collaborative.forms.dto.EditCheckboxSuccessPayload;
 import org.eclipse.sirius.components.collaborative.forms.messages.ICollaborativeFormMessageService;
 import org.eclipse.sirius.components.core.api.ErrorPayload;
+import org.eclipse.sirius.components.core.api.IEditingContext;
 import org.eclipse.sirius.components.core.api.IPayload;
 import org.eclipse.sirius.components.forms.Checkbox;
 import org.eclipse.sirius.components.forms.Form;
@@ -68,7 +69,7 @@ public boolean canHandle(IFormInput formInput) {
     }
 
     @Override
-    public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, Form form, IFormInput formInput) {
+    public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, IEditingContext editingContext, Form form, IFormInput formInput) {
         this.counter.increment();
         String message = this.messageService.invalidInput(formInput.getClass().getSimpleName(), EditCheckboxInput.class.getSimpleName());
         IPayload payload = new ErrorPayload(formInput.getId(), message);

diff --git a/...g/eclipse/sirius/components/collaborative/forms/handlers/EditMultiSelectEventHandler.java b/...g/eclipse/sirius/components/collaborative/forms/handlers/EditMultiSelectEventHandler.java
@@ -25,6 +25,7 @@
 import org.eclipse.sirius.components.collaborative.forms.dto.EditMultiSelectSuccessPayload;
 import org.eclipse.sirius.components.collaborative.forms.messages.ICollaborativeFormMessageService;
 import org.eclipse.sirius.components.core.api.ErrorPayload;
+import org.eclipse.sirius.components.core.api.IEditingContext;
 import org.eclipse.sirius.components.core.api.IPayload;
 import org.eclipse.sirius.components.forms.Form;
 import org.eclipse.sirius.components.forms.MultiSelect;
@@ -69,7 +70,7 @@ public boolean canHandle(IFormInput formInput) {
     }
 
     @Override
-    public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, Form form, IFormInput formInput) {
+    public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, IEditingContext editingContext, Form form, IFormInput formInput) {
         this.counter.increment();
         String message = this.messageService.invalidInput(formInput.getClass().getSimpleName(), EditMultiSelectInput.class.getSimpleName());
         IPayload payload = new ErrorPayload(formInput.getId(), message);

diff --git a/...ava/org/eclipse/sirius/components/collaborative/forms/handlers/EditRadioEventHandler.java b/...ava/org/eclipse/sirius/components/collaborative/forms/handlers/EditRadioEventHandler.java
@@ -24,6 +24,7 @@
 import org.eclipse.sirius.components.collaborative.forms.dto.EditRadioSuccessPayload;
 import org.eclipse.sirius.components.collaborative.forms.messages.ICollaborativeFormMessageService;
 import org.eclipse.sirius.components.core.api.ErrorPayload;
+import org.eclipse.sirius.components.core.api.IEditingContext;
 import org.eclipse.sirius.components.core.api.IPayload;
 import org.eclipse.sirius.components.forms.Form;
 import org.eclipse.sirius.components.forms.Radio;
@@ -68,7 +69,7 @@ public boolean canHandle(IFormInput formInput) {
     }
 
     @Override
-    public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, Form form, IFormInput formInput) {
+    public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, IEditingContext editingContext, Form form, IFormInput formInput) {
         this.counter.increment();
         String message = this.messageService.invalidInput(formInput.getClass().getSimpleName(), EditRadioInput.class.getSimpleName());
         IPayload payload = new ErrorPayload(formInput.getId(), message);

diff --git a/...va/org/eclipse/sirius/components/collaborative/forms/handlers/EditSelectEventHandler.java b/...va/org/eclipse/sirius/components/collaborative/forms/handlers/EditSelectEventHandler.java
@@ -25,6 +25,7 @@
 import org.eclipse.sirius.components.collaborative.forms.dto.EditSelectSuccessPayload;
 import org.eclipse.sirius.components.collaborative.forms.messages.ICollaborativeFormMessageService;
 import org.eclipse.sirius.components.core.api.ErrorPayload;
+import org.eclipse.sirius.components.core.api.IEditingContext;
 import org.eclipse.sirius.components.core.api.IPayload;
 import org.eclipse.sirius.components.forms.Form;
 import org.eclipse.sirius.components.forms.Select;
@@ -69,7 +70,7 @@ public boolean canHandle(IFormInput formInput) {
     }
 
     @Override
-    public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, Form form, IFormInput formInput) {
+    public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, IEditingContext editingContext, Form form, IFormInput formInput) {
         this.counter.increment();
         String message = this.messageService.invalidInput(formInput.getClass().getSimpleName(), EditSelectInput.class.getSimpleName());
         IPayload payload = new ErrorPayload(formInput.getId(), message);

diff --git a/...org/eclipse/sirius/components/collaborative/forms/handlers/EditTextfieldEventHandler.java b/...org/eclipse/sirius/components/collaborative/forms/handlers/EditTextfieldEventHandler.java
@@ -25,6 +25,7 @@
 import org.eclipse.sirius.components.collaborative.forms.dto.EditTextfieldSuccessPayload;
 import org.eclipse.sirius.components.collaborative.forms.messages.ICollaborativeFormMessageService;
 import org.eclipse.sirius.components.core.api.ErrorPayload;
+import org.eclipse.sirius.components.core.api.IEditingContext;
 import org.eclipse.sirius.components.core.api.IPayload;
 import org.eclipse.sirius.components.forms.Form;
 import org.eclipse.sirius.components.forms.Textarea;
@@ -70,7 +71,7 @@ public boolean canHandle(IFormInput formInput) {
     }
 
     @Override
-    public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, Form form, IFormInput formInput) {
+    public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, IEditingContext editingContext, Form form, IFormInput formInput) {
         this.counter.increment();
         String message = this.messageService.invalidInput(formInput.getClass().getSimpleName(), EditTextfieldInput.class.getSimpleName());
         IPayload payload = new ErrorPayload(formInput.getId(), message);