[2027] Make library publication dependencies computation more extensible

Bug: #2027
Signed-off-by: Florent Latombe <florent.latombe@obeo.fr>

Author: flatombe

CHANGELOG.adoc

@@ -22,6 +22,15 @@ The following methods have been added:
 
 - https://github.com/eclipse-syson/syson/issues/1988[#1988] [syson] Extract Elasticsearch container initialization in a dedicated abstract test class.
 The property `SysONTestsProperties#ELASTICSEARCH` has been removed, tests that require Elasticsearch should extend `AbstractIntegrationTestsWithElasticsearch`.
+- https://github.com/eclipse-syson/syson/issues/2027[#2027] [publication] `org.eclipse.syson.application.publication.SysONSysMLLibraryPublisher` has been reworked to be more extensible.
+As a result, the following method has been deleted:
+
+** `getDependencies(DependencyGraph<Resource>, Set<Resource>)`
++
+And the following methods have been added:
++
+** `getDependenciesForPublishedLibrary(IEMFEditingContext, Set<Resource>)`
+** `getDependenciesBasedOnResources(IEMFEditingContext, Set<Resource>)`
 
 - [validation] The following classes have been renamed, and some of them reworked:
 
@@ -32,6 +41,16 @@ The property `SysONTestsProperties#ELASTICSEARCH` has been removed, tests that r
 ** `org.eclipse.syson.sysml.validation.SysONQueryServices`: renamed into `org.eclipse.syson.sysml.validation.rules.SysMLValidationRuleQueryServices`.
 ** `org.eclipse.syson.sysml.validation.SysMLv2ValidatorConfiguration`: renamed into `org.eclipse.syson.sysml.validation.SysMLValidatorRegistrationConfiguration` and now expects an injected `org.eclipse.syson.sysml.validation.rules.api.ISysMLValidationRulesProvider`, for which SysON provides default implementation `org.eclipse.syson.sysml.validation.rules.SysONValidationRulesProvider`.
 
+- https://github.com/eclipse-syson/syson/issues/2027[#2027] [publication] `org.eclipse.syson.application.publication.SysONSysMLLibraryPublisher` has been reworked to be more extensible.
+As a result, the following method has been deleted:
+
+** `getDependencies(DependencyGraph<Resource>, Set<Resource>)`
++
+And the following methods have been added:
++
+** `getDependenciesForPublishedLibrary(IEMFEditingContext, Set<Resource>)`
+** `getDependenciesBasedOnResources(IEMFEditingContext, Set<Resource>)`
+
 
 === Dependency update
 

backend/application/syson-application-configuration/src/main/java/org/eclipse/syson/application/publication/SysONSysMLLibraryPublisher.java

@@ -145,12 +145,11 @@ public IPayload publish(final ICause cause, final IEditingContext libraryAuthori
     protected IPayload doPublish(final ICause cause, final IEMFEditingContext emfEditingContext, final String libraryNamespace, final String libraryName,
             final String libraryVersion, final String libraryDescription) {
         final Set<Resource> resourcesToPublish = this.getResourcesToPublish(emfEditingContext);
-        final DependencyGraph<Resource> dependencyGraph = this.sysONLibraryDependencyCollector.collectDependencies(emfEditingContext.getDomain().getResourceSet());
 
-        final List<AggregateReference<SemanticData, UUID>> dependencies = this.getDependencies(dependencyGraph, resourcesToPublish);
+        final List<AggregateReference<SemanticData, UUID>> dependenciesOfPublishedLibrary = this.getDependenciesForPublishedLibrary(emfEditingContext, resourcesToPublish);
 
         final Optional<SemanticData> maybePublishedLibrarySemanticData = this.publishAsLibrary(cause, resourcesToPublish, libraryNamespace, libraryName, libraryVersion, libraryDescription,
-                dependencies);
+                dependenciesOfPublishedLibrary);
         // After this transaction is done, SysONLibraryPublicationListener reacts by also creating the
         // associated Library metadata.
 
@@ -162,7 +161,54 @@ protected IPayload doPublish(final ICause cause, final IEMFEditingContext emfEdi
                                 List.of(new Message("Failed to publish library '%s:%s@%s'.".formatted(libraryNamespace, libraryName, libraryVersion), MessageLevel.ERROR))));
     }
 
-    protected List<AggregateReference<SemanticData, UUID>> getDependencies(final DependencyGraph<Resource> dependencyGraph, final Set<Resource> resourcesToPublish) {
+    /**
+     * Provides the resources to include in the contents of the library being published.
+     * <p>
+     * <b>Note:</b> If this implementation gets extended to include additional resources, consider also extending
+     * {@link #getDependenciesForPublishedLibrary(IEMFEditingContext, Set)} to express the impact on the dependencies to
+     * include.
+     * </p>
+     *
+     * @param emfEditingContext
+     *            the (non-{@code null}) {@link IEMFEditingContext} that authors the library.
+     * @return a (non-{@code null}) {@link Set} of {@link Resource}, most likely a subset of the resources in
+     *         {@code emfEditingContext}.
+     */
+    protected Set<Resource> getResourcesToPublish(final IEMFEditingContext emfEditingContext) {
+        return emfEditingContext.getDomain().getResourceSet().getResources().stream()
+                .filter(Predicate.not(ElementUtil::isStandardLibraryResource))
+                .filter(resource -> !this.sysONResourceService.isFromReferencedLibrary(emfEditingContext, resource))
+                // Only the ".sysml" resources can be published.
+                .filter(this.sysONResourceService::isSysML)
+                .collect(Collectors.toCollection(LinkedHashSet::new));
+    }
+
+    /**
+     * Provides the dependencies to set up for the library being published.
+     *
+     * @param emfEditingContext
+     *            the (non-{@code null}) {@link IEMFEditingContext} that authors the library.
+     * @param resourcesToPublish
+     *            the (non-{@code null}) {@link Set} of {@link Resource} to include as contents of the library.
+     * @return a (non-{@code null}) {@link List} of the desired dependencies for the library.
+     */
+    protected List<AggregateReference<SemanticData, UUID>> getDependenciesForPublishedLibrary(final IEMFEditingContext emfEditingContext, final Set<Resource> resourcesToPublish) {
+        return this.getDependenciesBasedOnResources(emfEditingContext, resourcesToPublish);
+    }
+
+    /**
+     * Provides the dependencies based on the existing actual EMF cross-references from the resources being published to
+     * resources coming from published libraries.
+     *
+     * @param emfEditingContext
+     *            the (non-{@code null}) {@link IEMFEditingContext} that authors the library.
+     * @param resourcesToPublish
+     *            the (non-{@code null}) {@link Set} of {@link Resource} to include as contents of the library.
+     * @return a (non-{@code null}) {@link List} of the dependencies required for the library, if we want
+     *         {@code resourcesToPublish} to not have any unresolved proxies.
+     */
+    protected List<AggregateReference<SemanticData, UUID>> getDependenciesBasedOnResources(final IEMFEditingContext emfEditingContext, final Set<Resource> resourcesToPublish) {
+        final DependencyGraph<Resource> dependencyGraph = this.sysONLibraryDependencyCollector.collectDependencies(emfEditingContext.getDomain().getResourceSet());
         final List<AggregateReference<SemanticData, UUID>> dependencies = new ArrayList<>();
 
         for (final Resource resourceToPublish : resourcesToPublish) {
@@ -225,15 +271,6 @@ protected Optional<SemanticData> createSemanticData(final ICause cause, final Co
         }
     }
 
-    protected Set<Resource> getResourcesToPublish(final IEMFEditingContext emfEditingContext) {
-        return emfEditingContext.getDomain().getResourceSet().getResources().stream()
-                .filter(Predicate.not(ElementUtil::isStandardLibraryResource))
-                .filter(resource -> !this.sysONResourceService.isFromReferencedLibrary(emfEditingContext, resource))
-                // Only the ".sysml" resources can be published.
-                .filter(this.sysONResourceService::isSysML)
-                .collect(Collectors.toCollection(LinkedHashSet::new));
-    }
-
     protected Optional<LibraryMetadataAdapter> getLibraryMetadata(final Resource resource) {
         return resource.eAdapters().stream()
                 .filter(LibraryMetadataAdapter.class::isInstance)