Rename ModelSourceChangedAction etc to SourceModelChangedAction

This is to be consistent with the term source model that we now use to refer to the underlying model from which the GModel is created. eclipse-glsp/glsp#655
eclipse-glsp · Jun 1, 2022 · b1d8a6b · b1d8a6b
1 parent ffbd1b5
commit b1d8a6b
Show file tree

Hide file tree

Showing 11 changed files with 25 additions and 24 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -29,6 +29,7 @@
 - [gmodel] Move base diagram module and operation handlers that operate directly on GModels (as a model source) to the dedicated package `org.eclipse.glsp.server.gmodel` and add prefix `GModel` in the class name [#165](https://github.com/eclipse-glsp/glsp-server/pull/165)
 - [logging] Update from log4j 1.x to log4j 2.17.1. [#163](https://github.com/eclipse-glsp/glsp-server/pull/163/)
   - Affects logger creation across all classes
+- [protocol] Rename `ModelSourceChangedAction` to `SourceModelChangedAction` including handlers [#171](https://github.com/eclipse-glsp/glsp-server/pull/171)
 
 ## [v0.9.0- 09/12/2021](https://github.com/eclipse-glsp/glsp/releases/tag/0.9.0)
 

diff --git a/...se.glsp.example.workflow/src/org/eclipse/glsp/example/workflow/WorkflowDiagramModule.java b/...se.glsp.example.workflow/src/org/eclipse/glsp/example/workflow/WorkflowDiagramModule.java
@@ -50,11 +50,11 @@
 import org.eclipse.glsp.server.features.core.model.SourceModelStorage;
 import org.eclipse.glsp.server.features.directediting.ContextEditValidator;
 import org.eclipse.glsp.server.features.directediting.LabelEditValidator;
-import org.eclipse.glsp.server.features.modelsourcewatcher.FileWatcher;
-import org.eclipse.glsp.server.features.modelsourcewatcher.SourceModelWatcher;
 import org.eclipse.glsp.server.features.navigation.NavigationTargetProvider;
 import org.eclipse.glsp.server.features.navigation.NavigationTargetResolver;
 import org.eclipse.glsp.server.features.popup.PopupModelFactory;
+import org.eclipse.glsp.server.features.sourcemodelwatcher.FileWatcher;
+import org.eclipse.glsp.server.features.sourcemodelwatcher.SourceModelWatcher;
 import org.eclipse.glsp.server.features.validation.ModelValidator;
 import org.eclipse.glsp.server.gmodel.GModelDiagramModule;
 import org.eclipse.glsp.server.gmodel.GModelStorage;

diff --git a/plugins/org.eclipse.glsp.server/META-INF/MANIFEST.MF b/plugins/org.eclipse.glsp.server/META-INF/MANIFEST.MF
@@ -26,9 +26,9 @@ Export-Package: org.eclipse.glsp.server.actions,
  org.eclipse.glsp.server.features.contextmenu,
  org.eclipse.glsp.server.features.core.model,
  org.eclipse.glsp.server.features.directediting,
- org.eclipse.glsp.server.features.modelsourcewatcher,
  org.eclipse.glsp.server.features.navigation,
  org.eclipse.glsp.server.features.popup,
+ org.eclipse.glsp.server.features.sourcemodelwatcher,
  org.eclipse.glsp.server.features.toolpalette,
  org.eclipse.glsp.server.features.undoredo,
  org.eclipse.glsp.server.features.validation,

diff --git a/...s/org.eclipse.glsp.server/src/org/eclipse/glsp/server/actions/SaveModelActionHandler.java b/...s/org.eclipse.glsp.server/src/org/eclipse/glsp/server/actions/SaveModelActionHandler.java
@@ -19,7 +19,7 @@
 import java.util.Optional;
 
 import org.eclipse.glsp.server.features.core.model.SourceModelStorage;
-import org.eclipse.glsp.server.features.modelsourcewatcher.SourceModelWatcher;
+import org.eclipse.glsp.server.features.sourcemodelwatcher.SourceModelWatcher;
 import org.eclipse.glsp.server.model.GModelState;
 
 import com.google.inject.Inject;

diff --git a/plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/di/DiagramModule.java b/plugins/org.eclipse.glsp.server/src/org/eclipse/glsp/server/di/DiagramModule.java
@@ -63,8 +63,6 @@
 import org.eclipse.glsp.server.features.directediting.LabelEditValidator;
 import org.eclipse.glsp.server.features.directediting.RequestEditValidationHandler;
 import org.eclipse.glsp.server.features.directediting.SetEditValidationResultAction;
-import org.eclipse.glsp.server.features.modelsourcewatcher.ModelSourceChangedAction;
-import org.eclipse.glsp.server.features.modelsourcewatcher.SourceModelWatcher;
 import org.eclipse.glsp.server.features.navigation.NavigateToExternalTargetAction;
 import org.eclipse.glsp.server.features.navigation.NavigateToTargetAction;
 import org.eclipse.glsp.server.features.navigation.NavigationTargetProvider;
@@ -77,6 +75,8 @@
 import org.eclipse.glsp.server.features.popup.PopupModelFactory;
 import org.eclipse.glsp.server.features.popup.RequestPopupModelActionHandler;
 import org.eclipse.glsp.server.features.popup.SetPopupModelAction;
+import org.eclipse.glsp.server.features.sourcemodelwatcher.SourceModelChangedAction;
+import org.eclipse.glsp.server.features.sourcemodelwatcher.SourceModelWatcher;
 import org.eclipse.glsp.server.features.toolpalette.ToolPaletteItemProvider;
 import org.eclipse.glsp.server.features.undoredo.UndoRedoActionHandler;
 import org.eclipse.glsp.server.features.validation.DeleteMarkersAction;
@@ -285,7 +285,7 @@ protected void configureClientActions(final MultiBinding<Action> binding) {
       binding.add(ExportSVGAction.class);
       binding.add(DeleteMarkersAction.class);
       binding.add(FitToScreenAction.class);
-      binding.add(ModelSourceChangedAction.class);
+      binding.add(SourceModelChangedAction.class);
       binding.add(NavigateToTargetAction.class);
       binding.add(NavigateToExternalTargetAction.class);
       binding.add(RequestBoundsAction.class);

diff --git a/...lsp.server/src/org/eclipse/glsp/server/features/core/model/RequestModelActionHandler.java b/...lsp.server/src/org/eclipse/glsp/server/features/core/model/RequestModelActionHandler.java
@@ -22,7 +22,7 @@
 import org.eclipse.glsp.server.actions.Action;
 import org.eclipse.glsp.server.actions.ActionDispatcher;
 import org.eclipse.glsp.server.di.DiagramModule;
-import org.eclipse.glsp.server.features.modelsourcewatcher.SourceModelWatcher;
+import org.eclipse.glsp.server.features.sourcemodelwatcher.SourceModelWatcher;
 import org.eclipse.glsp.server.model.GModelState;
 import org.eclipse.glsp.server.utils.ServerMessageUtil;
 import org.eclipse.glsp.server.utils.ServerStatusUtil;

diff --git a/...tures/modelsourcewatcher/FileWatcher.java → ...tures/sourcemodelwatcher/FileWatcher.java b/...tures/modelsourcewatcher/FileWatcher.java → ...tures/sourcemodelwatcher/FileWatcher.java
@@ -13,7 +13,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-package org.eclipse.glsp.server.features.modelsourcewatcher;
+package org.eclipse.glsp.server.features.sourcemodelwatcher;
 
 import static java.nio.file.StandardWatchEventKinds.ENTRY_DELETE;
 import static java.nio.file.StandardWatchEventKinds.ENTRY_MODIFY;
@@ -141,7 +141,7 @@ protected void scheduleClientNotification(final String clientId, final Path file
    }
 
    protected void notifyClient(final ClientNotification clientNotification) {
-      actionDispatcher.dispatch(new ModelSourceChangedAction(clientNotification.modelSourceName));
+      actionDispatcher.dispatch(new SourceModelChangedAction(clientNotification.modelSourceName));
    }
 
    class FileWatchWorker extends Thread {

diff --git a/...urcewatcher/ModelSourceChangedAction.java → ...odelwatcher/SourceModelChangedAction.java b/...urcewatcher/ModelSourceChangedAction.java → ...odelwatcher/SourceModelChangedAction.java
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020 EclipseSource and others.
+ * Copyright (c) 2020-2022 EclipseSource and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -13,23 +13,23 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-package org.eclipse.glsp.server.features.modelsourcewatcher;
+package org.eclipse.glsp.server.features.sourcemodelwatcher;
 
 import org.eclipse.glsp.server.actions.Action;
 
-public class ModelSourceChangedAction extends Action {
+public class SourceModelChangedAction extends Action {
 
-   private String modelSourceName = "";
+   private String sourceModelName = "";
 
-   public ModelSourceChangedAction() {
-      super("modelSourceChanged");
+   public SourceModelChangedAction() {
+      super("sourceModelChanged");
    }
 
-   public ModelSourceChangedAction(final String modelSource) {
+   public SourceModelChangedAction(final String sourceModelName) {
       this();
-      this.modelSourceName = modelSource;
+      this.sourceModelName = sourceModelName;
    }
 
-   public String getModelSourceName() { return modelSourceName; }
+   public String getSourceModelName() { return sourceModelName; }
 
 }
diff --git a/...odelsourcewatcher/SourceModelWatcher.java → ...ourcemodelwatcher/SourceModelWatcher.java b/...odelsourcewatcher/SourceModelWatcher.java → ...ourcemodelwatcher/SourceModelWatcher.java
@@ -13,7 +13,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-package org.eclipse.glsp.server.features.modelsourcewatcher;
+package org.eclipse.glsp.server.features.sourcemodelwatcher;
 
 /**
  * A source model watcher observes the source model resource and notifies the client if the source model has changed.

diff --git a/tests/org.eclipse.glsp.server.test/META-INF/MANIFEST.MF b/tests/org.eclipse.glsp.server.test/META-INF/MANIFEST.MF
@@ -8,6 +8,6 @@ Automatic-Module-Name: org.eclipse.glsp.graph.test
 Bundle-RequiredExecutionEnvironment: JavaSE-11
 Bundle-Vendor: Eclipse GLSP
 Export-Package: 
- org.eclipse.glsp.server.features.modelsourcewatcher
+ org.eclipse.glsp.server.features.sourcemodelwatcher
 Import-Package: org.junit;version="4.12.0",
  org.junit.jupiter.api;version="5.0.0"
diff --git a/...s/modelsourcewatcher/FileWatcherTest.java → ...s/sourcemodelwatcher/FileWatcherTest.java b/...s/modelsourcewatcher/FileWatcherTest.java → ...s/sourcemodelwatcher/FileWatcherTest.java
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020-2021 EclipseSource and others.
+ * Copyright (c) 2020-2022 EclipseSource and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -13,7 +13,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-package org.eclipse.glsp.server.features.modelsourcewatcher;
+package org.eclipse.glsp.server.features.sourcemodelwatcher;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertTrue;
@@ -151,7 +151,7 @@ private void assertNoNotification() {
    private void assertNotifications(final int size) throws InterruptedException {
       assertEquals(actionDispatcher.dispatchedActions.size(), size);
       for (int i = 0; i < size; i++) {
-         assertTrue(actionDispatcher.dispatchedActions.get(i) instanceof ModelSourceChangedAction);
+         assertTrue(actionDispatcher.dispatchedActions.get(i) instanceof SourceModelChangedAction);
       }
    }