[3250] Change the reference widget generated code package

Bug: #3250 Signed-off-by: Michaël Charfadi <michael.charfadi@obeosoft.com>
eclipse-sirius · Mar 20, 2024 · 176d8bc · 176d8bc
1 parent 4ce24de
commit 176d8bc
Show file tree

Hide file tree

Showing 30 changed files with 257 additions and 178 deletions.
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -73,6 +73,7 @@ Having `Viewer` as a type did not bring any additional value and it created some
 - https://github.com/eclipse-sirius/sirius-web/issues/3096[#3096] [tree] `TreeConfiguration` has a new parameter `List<String> activeFilterIds`.
 - https://github.com/eclipse-sirius/sirius-web/issues/3019[#3019] [form] Allow consumers of Sirius Components to reuse the reference widget without the form description editor or the view DSL.
 - https://github.com/eclipse-sirius/sirius-web/issues/3246[#3246] [view] Remove representation specific code from `ViewRepresentationDescriptionSearchService`
+- https://github.com/eclipse-sirius/sirius-web/issues/3250[#3250] [form] Change the base package of the reference widget from `org.eclipse.sirius.components.widgets.reference` to `org.eclipse.sirius.components.widgets.reference.view`
 
 
 === Dependency update

diff --git a/...omponents/formdescriptioneditors/widget/reference/ReferenceWidgetDescriptionProvider.java b/...omponents/formdescriptioneditors/widget/reference/ReferenceWidgetDescriptionProvider.java
@@ -17,7 +17,7 @@
 import org.eclipse.emf.ecore.EClass;
 import org.eclipse.sirius.components.collaborative.widget.reference.ReferenceWidgetDescriptor;
 import org.eclipse.sirius.components.formdescriptioneditors.IWidgetDescriptionProvider;
-import org.eclipse.sirius.components.widgets.reference.ReferencePackage;
+import org.eclipse.sirius.components.view.widget.reference.ReferencePackage;
 import org.springframework.stereotype.Service;
 
 /**

diff --git a/...ents/formdescriptioneditors/widget/reference/ReferenceWidgetPreviewConverterProvider.java b/...ents/formdescriptioneditors/widget/reference/ReferenceWidgetPreviewConverterProvider.java
@@ -24,8 +24,8 @@
 import org.eclipse.sirius.components.view.emf.widget.reference.ReferenceWidgetStyleProvider;
 import org.eclipse.sirius.components.widget.reference.ReferenceWidgetDescription;
 import org.eclipse.sirius.components.widget.reference.ReferenceWidgetStyle;
-import org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescriptionStyle;
-import org.eclipse.sirius.components.widgets.reference.util.ReferenceSwitch;
+import org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescriptionStyle;
+import org.eclipse.sirius.components.view.widget.reference.util.ReferenceSwitch;
 import org.springframework.stereotype.Service;
 
 /**
@@ -40,7 +40,7 @@ public class ReferenceWidgetPreviewConverterProvider implements IWidgetPreviewCo
     public Switch<AbstractWidgetDescription> getWidgetConverter(FormDescriptionEditorDescription formDescriptionEditorDescription, VariableManager variableManager) {
         return new ReferenceSwitch<>() {
             @Override
-            public AbstractWidgetDescription caseReferenceWidgetDescription(org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescription referenceDescription) {
+            public AbstractWidgetDescription caseReferenceWidgetDescription(org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescription referenceDescription) {
                 VariableManager childVariableManager = variableManager.createChild();
                 childVariableManager.put(VariableManager.SELF, referenceDescription);
                 String id = formDescriptionEditorDescription.getTargetObjectIdProvider().apply(childVariableManager);
@@ -54,7 +54,7 @@ public AbstractWidgetDescription caseReferenceWidgetDescription(org.eclipse.siri
         };
     }
 
-    public ReferenceWidgetDescription.Builder getReferenceWidgetDescriptionBuilder(org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescription referenceDescription, String id) {
+    public ReferenceWidgetDescription.Builder getReferenceWidgetDescriptionBuilder(org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescription referenceDescription, String id) {
         return ReferenceWidgetDescription.newReferenceWidgetDescription(UUID.randomUUID().toString())
                 .idProvider(vm -> id)
                 .targetObjectIdProvider(vm -> "")
@@ -107,7 +107,7 @@ public String getWidgetHelpText(org.eclipse.sirius.components.view.form.WidgetDe
         return helpText;
     }
 
-    private ReferenceWidgetStyle getWidgetStyle(org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescription referenceDescription, VariableManager variableManager) {
+    private ReferenceWidgetStyle getWidgetStyle(org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescription referenceDescription, VariableManager variableManager) {
         ReferenceWidgetDescriptionStyle style = referenceDescription.getStyle();
         if (style == null) {
             return null;

diff --git a/...src/main/java/org/eclipse/sirius/web/sample/configuration/DomainPropertiesConfigurer.java b/...src/main/java/org/eclipse/sirius/web/sample/configuration/DomainPropertiesConfigurer.java
@@ -43,8 +43,8 @@
 import org.eclipse.sirius.components.view.form.SelectDescription;
 import org.eclipse.sirius.components.view.form.TextfieldDescription;
 import org.eclipse.sirius.components.view.form.WidgetDescription;
-import org.eclipse.sirius.components.widgets.reference.ReferenceFactory;
-import org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescription;
+import org.eclipse.sirius.components.view.widget.reference.ReferenceFactory;
+import org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescription;
 import org.eclipse.sirius.web.sample.services.DomainAttributeServices;
 import org.eclipse.sirius.web.services.api.representations.IInMemoryViewRegistry;
 import org.springframework.context.annotation.Configuration;

diff --git a/packages/view/backend/sirius-components-view-builder/pom.xml b/packages/view/backend/sirius-components-view-builder/pom.xml
@@ -112,6 +112,25 @@
 					</execution>
 				</executions>
 			</plugin>
+			<plugin>
+				<groupId>org.jacoco</groupId>
+				<artifactId>jacoco-maven-plugin</artifactId>
+				<version>0.8.10</version>
+				<executions>
+					<execution>
+						<goals>
+							<goal>prepare-agent</goal>
+						</goals>
+					</execution>
+					<execution>
+						<id>report</id>
+						<phase>prepare-package</phase>
+						<goals>
+							<goal>report</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
 			<plugin>
 				<groupId>org.codehaus.mojo</groupId>
 				<artifactId>exec-maven-plugin</artifactId>

diff --git a/.../components/view/builder/generated/ConditionalReferenceWidgetDescriptionStyleBuilder.java b/.../components/view/builder/generated/ConditionalReferenceWidgetDescriptionStyleBuilder.java
@@ -12,6 +12,9 @@
  *******************************************************************************/
 package org.eclipse.sirius.components.view.builder.generated;
 
+import org.eclipse.sirius.components.view.widget.reference.ConditionalReferenceWidgetDescriptionStyle;
+import org.eclipse.sirius.components.view.widget.reference.ReferenceFactory;
+
 /**
  * Builder for ConditionalReferenceWidgetDescriptionStyleBuilder.
  *
@@ -21,24 +24,24 @@
 public class ConditionalReferenceWidgetDescriptionStyleBuilder {
 
     /**
-     * Create instance org.eclipse.sirius.components.widgets.reference.ConditionalReferenceWidgetDescriptionStyle.
+     * Create instance org.eclipse.sirius.components.view.widget.reference.ConditionalReferenceWidgetDescriptionStyle.
      * @generated
      */
-    private org.eclipse.sirius.components.widgets.reference.ConditionalReferenceWidgetDescriptionStyle conditionalReferenceWidgetDescriptionStyle = org.eclipse.sirius.components.widgets.reference.ReferenceFactory.eINSTANCE.createConditionalReferenceWidgetDescriptionStyle();
+    private org.eclipse.sirius.components.view.widget.reference.ConditionalReferenceWidgetDescriptionStyle conditionalReferenceWidgetDescriptionStyle = org.eclipse.sirius.components.view.widget.reference.ReferenceFactory.eINSTANCE.createConditionalReferenceWidgetDescriptionStyle();
 
     /**
-     * Return instance org.eclipse.sirius.components.widgets.reference.ConditionalReferenceWidgetDescriptionStyle.
+     * Return instance org.eclipse.sirius.components.view.widget.reference.ConditionalReferenceWidgetDescriptionStyle.
      * @generated
      */
-    protected org.eclipse.sirius.components.widgets.reference.ConditionalReferenceWidgetDescriptionStyle getConditionalReferenceWidgetDescriptionStyle() {
+    protected org.eclipse.sirius.components.view.widget.reference.ConditionalReferenceWidgetDescriptionStyle getConditionalReferenceWidgetDescriptionStyle() {
         return this.conditionalReferenceWidgetDescriptionStyle;
     }
 
     /**
-     * Return instance org.eclipse.sirius.components.widgets.reference.ConditionalReferenceWidgetDescriptionStyle.
+     * Return instance org.eclipse.sirius.components.view.widget.reference.ConditionalReferenceWidgetDescriptionStyle.
      * @generated
      */
-    public org.eclipse.sirius.components.widgets.reference.ConditionalReferenceWidgetDescriptionStyle build() {
+    public org.eclipse.sirius.components.view.widget.reference.ConditionalReferenceWidgetDescriptionStyle build() {
         return this.getConditionalReferenceWidgetDescriptionStyle();
     }
 

diff --git a/...g/eclipse/sirius/components/view/builder/generated/ReferenceWidgetDescriptionBuilder.java b/...g/eclipse/sirius/components/view/builder/generated/ReferenceWidgetDescriptionBuilder.java
@@ -12,6 +12,11 @@
  *******************************************************************************/
 package org.eclipse.sirius.components.view.builder.generated;
 
+import org.eclipse.sirius.components.view.widget.reference.ConditionalReferenceWidgetDescriptionStyle;
+import org.eclipse.sirius.components.view.widget.reference.ReferenceFactory;
+import org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescription;
+import org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescriptionStyle;
+
 /**
  * Builder for ReferenceWidgetDescriptionBuilder.
  *
@@ -21,24 +26,24 @@
 public class ReferenceWidgetDescriptionBuilder {
 
     /**
-     * Create instance org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescription.
+     * Create instance org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescription.
      * @generated
      */
-    private org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescription referenceWidgetDescription = org.eclipse.sirius.components.widgets.reference.ReferenceFactory.eINSTANCE.createReferenceWidgetDescription();
+    private org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescription referenceWidgetDescription = org.eclipse.sirius.components.view.widget.reference.ReferenceFactory.eINSTANCE.createReferenceWidgetDescription();
 
     /**
-     * Return instance org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescription.
+     * Return instance org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescription.
      * @generated
      */
-    protected org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescription getReferenceWidgetDescription() {
+    protected org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescription getReferenceWidgetDescription() {
         return this.referenceWidgetDescription;
     }
 
     /**
-     * Return instance org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescription.
+     * Return instance org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescription.
      * @generated
      */
-    public org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescription build() {
+    public org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescription build() {
         return this.getReferenceWidgetDescription();
     }
 
@@ -113,17 +118,18 @@ public ReferenceWidgetDescriptionBuilder body(org.eclipse.sirius.components.view
      *
      * @generated
      */
-    public ReferenceWidgetDescriptionBuilder style(org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescriptionStyle value) {
+    public ReferenceWidgetDescriptionBuilder style(org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescriptionStyle value) {
         this.getReferenceWidgetDescription().setStyle(value);
         return this;
     }
+
     /**
      * Setter for ConditionalStyles.
      *
      * @generated
      */
-    public ReferenceWidgetDescriptionBuilder conditionalStyles(org.eclipse.sirius.components.widgets.reference.ConditionalReferenceWidgetDescriptionStyle ... values) {
-        for (org.eclipse.sirius.components.widgets.reference.ConditionalReferenceWidgetDescriptionStyle value : values) {
+    public ReferenceWidgetDescriptionBuilder conditionalStyles(org.eclipse.sirius.components.view.widget.reference.ConditionalReferenceWidgetDescriptionStyle ... values) {
+        for (org.eclipse.sirius.components.view.widget.reference.ConditionalReferenceWidgetDescriptionStyle value : values) {
             this.getReferenceWidgetDescription().getConditionalStyles().add(value);
         }
         return this;

diff --git a/...ipse/sirius/components/view/builder/generated/ReferenceWidgetDescriptionStyleBuilder.java b/...ipse/sirius/components/view/builder/generated/ReferenceWidgetDescriptionStyleBuilder.java
@@ -12,6 +12,9 @@
  *******************************************************************************/
 package org.eclipse.sirius.components.view.builder.generated;
 
+import org.eclipse.sirius.components.view.widget.reference.ReferenceFactory;
+import org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescriptionStyle;
+
 /**
  * Builder for ReferenceWidgetDescriptionStyleBuilder.
  *
@@ -21,24 +24,24 @@
 public class ReferenceWidgetDescriptionStyleBuilder {
 
     /**
-     * Create instance org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescriptionStyle.
+     * Create instance org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescriptionStyle.
      * @generated
      */
-    private org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescriptionStyle referenceWidgetDescriptionStyle = org.eclipse.sirius.components.widgets.reference.ReferenceFactory.eINSTANCE.createReferenceWidgetDescriptionStyle();
+    private org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescriptionStyle referenceWidgetDescriptionStyle = org.eclipse.sirius.components.view.widget.reference.ReferenceFactory.eINSTANCE.createReferenceWidgetDescriptionStyle();
 
     /**
-     * Return instance org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescriptionStyle.
+     * Return instance org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescriptionStyle.
      * @generated
      */
-    protected org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescriptionStyle getReferenceWidgetDescriptionStyle() {
+    protected org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescriptionStyle getReferenceWidgetDescriptionStyle() {
         return this.referenceWidgetDescriptionStyle;
     }
 
     /**
-     * Return instance org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescriptionStyle.
+     * Return instance org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescriptionStyle.
      * @generated
      */
-    public org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescriptionStyle build() {
+    public org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescriptionStyle build() {
         return this.getReferenceWidgetDescriptionStyle();
     }
 

diff --git a/.../java/org/eclipse/sirius/components/view/builder/tests/architecture/ViewBuilderTests.java b/.../java/org/eclipse/sirius/components/view/builder/tests/architecture/ViewBuilderTests.java
@@ -0,0 +1,44 @@
+/*******************************************************************************
+ * 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.components.view.builder.tests.architecture;
+
+import org.eclipse.sirius.components.view.builder.generated.ReferenceWidgetDescriptionBuilder;
+import org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescription;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Tests for instancing widget with generated builder.
+ *
+ * @author mcharfadi
+ */
+public class ViewBuilderTests {
+    @Test
+    void testBuildWidgetDescription() {
+        var widgetReference = new ReferenceWidgetDescriptionBuilder()
+                .name("name")
+                .referenceNameExpression("referenceNameExpression")
+                .referenceOwnerExpression("referenceOwnerExpression")
+                .helpExpression("helpExpression")
+                .isEnabledExpression("isEnabledExpression")
+                .build();
+
+        assertThat(widgetReference).isInstanceOf(ReferenceWidgetDescription.class);
+        assertThat(widgetReference.getReferenceNameExpression()).isEqualTo("referenceNameExpression");
+        assertThat(widgetReference.getName()).isEqualTo("name");
+        assertThat(widgetReference.getReferenceOwnerExpression()).isEqualTo("referenceOwnerExpression");
+        assertThat(widgetReference.getHelpExpression()).isEqualTo("helpExpression");
+        assertThat(widgetReference.getIsEnabledExpression()).isEqualTo("isEnabledExpression");
+    }
+}
diff --git a/...va/org/eclipse/sirius/components/view/emf/widget/reference/ReferenceEMFConfiguration.java b/...va/org/eclipse/sirius/components/view/emf/widget/reference/ReferenceEMFConfiguration.java
@@ -16,7 +16,7 @@
 import org.eclipse.emf.ecore.EPackage;
 import org.eclipse.sirius.components.emf.configuration.ChildExtenderProvider;
 import org.eclipse.sirius.components.view.form.FormPackage;
-import org.eclipse.sirius.components.widgets.reference.ReferencePackage;
+import org.eclipse.sirius.components.view.widget.reference.ReferencePackage;
 import org.eclipse.sirius.components.widgets.reference.provider.ReferenceItemProviderAdapterFactory;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;

diff --git a/...irius/components/view/emf/widget/reference/ReferenceWidgetDescriptionConverterSwitch.java b/...irius/components/view/emf/widget/reference/ReferenceWidgetDescriptionConverterSwitch.java
@@ -53,9 +53,9 @@
 import org.eclipse.sirius.components.view.form.FormElementDescription;
 import org.eclipse.sirius.components.widget.reference.ReferenceWidgetComponent;
 import org.eclipse.sirius.components.widget.reference.ReferenceWidgetStyle;
-import org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescription;
-import org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescriptionStyle;
-import org.eclipse.sirius.components.widgets.reference.util.ReferenceSwitch;
+import org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescription;
+import org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescriptionStyle;
+import org.eclipse.sirius.components.view.widget.reference.util.ReferenceSwitch;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

diff --git a/...org/eclipse/sirius/components/view/emf/widget/reference/ReferenceWidgetStyleProvider.java b/...org/eclipse/sirius/components/view/emf/widget/reference/ReferenceWidgetStyleProvider.java
@@ -18,7 +18,7 @@
 import org.eclipse.sirius.components.representations.VariableManager;
 import org.eclipse.sirius.components.view.FixedColor;
 import org.eclipse.sirius.components.widget.reference.ReferenceWidgetStyle;
-import org.eclipse.sirius.components.widgets.reference.ReferenceWidgetDescriptionStyle;
+import org.eclipse.sirius.components.view.widget.reference.ReferenceWidgetDescriptionStyle;
 
 /**
  * The style provider for the Reference Widget.

diff --git a/...ts/widgets/reference/provider/ConditionalReferenceWidgetDescriptionStyleItemProvider.java b/...ts/widgets/reference/provider/ConditionalReferenceWidgetDescriptionStyleItemProvider.java
@@ -24,12 +24,12 @@
 import org.eclipse.emf.edit.provider.ViewerNotification;
 import org.eclipse.sirius.components.view.ViewPackage;
 import org.eclipse.sirius.components.view.provider.ConditionalItemProvider;
-import org.eclipse.sirius.components.widgets.reference.ConditionalReferenceWidgetDescriptionStyle;
-import org.eclipse.sirius.components.widgets.reference.ReferencePackage;
+import org.eclipse.sirius.components.view.widget.reference.ConditionalReferenceWidgetDescriptionStyle;
+import org.eclipse.sirius.components.view.widget.reference.ReferencePackage;
 
 /**
  * This is the item provider adapter for a
- * {@link org.eclipse.sirius.components.widgets.reference.ConditionalReferenceWidgetDescriptionStyle} object. <!--
+ * {@link ConditionalReferenceWidgetDescriptionStyle} object. <!--
  * begin-user-doc --> <!-- end-user-doc -->
  *
  * @generated