Track adding/removing/changing files in AspectChangeContext

atextor · atextor · commit c1e05b8bafb1 · 2024-08-13T08:44:42.000+02:00
diff --git a/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/AspectChangeContext.java b/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/AspectChangeContext.java
@@ -13,21 +13,42 @@
 
 package org.eclipse.esmf.aspectmodel.edit;
 
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.ArrayDeque;
 import java.util.Deque;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Stream;
 
 import org.eclipse.esmf.aspectmodel.AspectModelBuilder;
+import org.eclipse.esmf.aspectmodel.AspectModelFile;
 import org.eclipse.esmf.metamodel.AspectModel;
 import org.eclipse.esmf.metamodel.impl.DefaultAspectModel;
 
-public class AspectChangeContext {
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class AspectChangeContext implements ChangeContext {
+   private static final Logger LOG = LoggerFactory.getLogger( AspectChangeContext.class );
+
    private final Deque<Change> undoStack = new ArrayDeque<>();
    private final Deque<Change> redoStack = new ArrayDeque<>();
    private final DefaultAspectModel aspectModel;
    private final AspectChangeContextConfig config;
+   private final Map<AspectModelFile, FileState> fileState = new HashMap<>();
+   private boolean isUndoOperation = false;
+
+   private enum FileState {
+      CREATED, CHANGED, REMOVED
+   }
 
    public AspectChangeContext( final AspectChangeContextConfig config, final AspectModel aspectModel ) {
       this.config = config;
+      resetFileStates();
       if ( aspectModel instanceof final DefaultAspectModel defaultAspectModel ) {
          this.aspectModel = defaultAspectModel;
       } else {
@@ -40,7 +61,9 @@ public AspectChangeContext( final AspectModel aspectModel ) {
    }
 
    public synchronized ChangeReport applyChange( final Change change ) {
-      final ChangeReport result = change.fire( new ChangeContext( aspectModel.files(), config ) );
+      resetFileStates();
+      isUndoOperation = false;
+      final ChangeReport result = change.fire( this );
       updateAspectModelAfterChange();
       undoStack.offerLast( change.reverse() );
       return result;
@@ -50,8 +73,10 @@ public synchronized void undoChange() {
       if ( undoStack.isEmpty() ) {
          return;
       }
+      isUndoOperation = true;
+      resetFileStates();
       final Change change = undoStack.pollLast();
-      change.fire( new ChangeContext( aspectModel.files(), config ) );
+      change.fire( this );
       updateAspectModelAfterChange();
       redoStack.offerLast( change.reverse() );
    }
@@ -60,8 +85,10 @@ public synchronized void redoChange() {
       if ( redoStack.isEmpty() ) {
          return;
       }
+      resetFileStates();
       final Change change = redoStack.pollLast();
-      change.fire( new ChangeContext( aspectModel.files(), config ) );
+      isUndoOperation = false;
+      change.fire( this );
       updateAspectModelAfterChange();
       undoStack.offerLast( change.reverse() );
    }
@@ -72,4 +99,63 @@ private void updateAspectModelAfterChange() {
       aspectModel.setElements( updatedModel.elements() );
       aspectModel.setFiles( updatedModel.files() );
    }
+
+   @Override
+   public Stream<AspectModelFile> aspectModelFiles() {
+      return aspectModel.files().stream();
+   }
+
+   @Override
+   public AspectChangeContextConfig config() {
+      return config;
+   }
+
+   @Override
+   public List<AspectModelFile> createdFiles() {
+      return fileState.entrySet().stream()
+            .filter( entry -> entry.getValue() == FileState.CREATED )
+            .map( Map.Entry::getKey )
+            .toList();
+   }
+
+   @Override
+   public List<AspectModelFile> modifiedFiles() {
+      return fileState.entrySet().stream()
+            .filter( entry -> entry.getValue() == FileState.CHANGED )
+            .map( Map.Entry::getKey )
+            .toList();
+   }
+
+   @Override
+   public List<AspectModelFile> removedFiles() {
+      return fileState.entrySet().stream()
+            .filter( entry -> entry.getValue() == FileState.REMOVED )
+            .map( Map.Entry::getKey )
+            .toList();
+   }
+
+   @Override
+   public void resetFileStates() {
+      fileState.clear();
+   }
+
+   @Override
+   public void indicateFileIsAdded( final AspectModelFile file ) {
+      fileState.put( file, FileState.CREATED );
+      aspectModel.files().add( file );
+   }
+
+   @Override
+   public void indicateFileIsRemoved( final AspectModelFile file ) {
+      fileState.put( file, FileState.REMOVED );
+      aspectModel.files().remove( file );
+   }
+
+   @Override
+   public void indicateFileHasChanged( final AspectModelFile file ) {
+      // If the file was newly created, keep this state even if we now change the file content
+      if ( fileState.get( file ) != FileState.CREATED ) {
+         fileState.put( file, FileState.CHANGED );
+      }
+   }
 }
diff --git a/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/ChangeContext.java b/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/ChangeContext.java
@@ -14,10 +14,26 @@
 package org.eclipse.esmf.aspectmodel.edit;
 
 import java.util.List;
+import java.util.stream.Stream;
 
 import org.eclipse.esmf.aspectmodel.AspectModelFile;
 
-public record ChangeContext(
-      List<AspectModelFile> aspectModelFiles,
-      AspectChangeContextConfig config ) {
+public interface ChangeContext {
+   Stream<AspectModelFile> aspectModelFiles();
+
+   AspectChangeContextConfig config();
+
+   List<AspectModelFile> createdFiles();
+
+   List<AspectModelFile> modifiedFiles();
+
+   List<AspectModelFile> removedFiles();
+
+   void indicateFileIsAdded( AspectModelFile file );
+
+   void indicateFileIsRemoved( AspectModelFile file );
+
+   void indicateFileHasChanged( AspectModelFile file );
+
+   void resetFileStates();
 }
diff --git a/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/change/AddAspectModelFile.java b/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/change/AddAspectModelFile.java
@@ -33,7 +33,7 @@ public AddAspectModelFile( final AspectModelFile newFile ) {
 
    @Override
    public ChangeReport fire( final ChangeContext changeContext ) {
-      changeContext.aspectModelFiles().add( newFile );
+      changeContext.indicateFileIsAdded( newFile );
       final Model contentToAdd = ModelFactory.createDefaultModel();
       contentToAdd.add( newFile.sourceModel() );
       return new ChangeReport.EntryWithDetails( "Add file " + show( newFile ),
@@ -46,7 +46,7 @@ public Change reverse() {
          @Override
          public ChangeReport fire( final ChangeContext changeContext ) {
             final AspectModelFile file = fileToRemove( changeContext );
-            changeContext.aspectModelFiles().remove( file );
+            changeContext.indicateFileIsRemoved( file );
             return new ChangeReport.EntryWithDetails( "Remove file " + show( file ),
                   Map.of( "model content to remove", file.sourceModel() ) );
          }
@@ -57,7 +57,7 @@ public Change reverse() {
          }
 
          private AspectModelFile fileToRemove( final ChangeContext changeContext ) {
-            return changeContext.aspectModelFiles().stream()
+            return changeContext.aspectModelFiles()
                   .filter( file -> file.sourceLocation().equals( newFile.sourceLocation() ) )
                   .findFirst()
                   .orElseThrow( () -> new ModelChangeException( "Unable to remove Aspect Model File" ) );
diff --git a/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/change/EditAspectModel.java b/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/change/EditAspectModel.java
@@ -28,41 +28,37 @@ protected record ModelChanges( Model add, Model remove, String description ) {
       public static final ModelChanges NONE = new ModelChanges( null, null, "" );
    }
 
-   protected Map<AspectModelFile, ModelChanges> changesPerFile = null;
-
-   synchronized protected void prepare( final ChangeContext changeContext ) {
-      if ( changesPerFile == null ) {
-         changesPerFile = changeContext.aspectModelFiles().stream()
-               .map( file -> new AbstractMap.SimpleEntry<>( file, calculateChangesForFile( file ) ) )
-               .filter( entry -> entry.getValue() != ModelChanges.NONE )
-               .collect( Collectors.toMap( AbstractMap.SimpleEntry::getKey, AbstractMap.SimpleEntry::getValue ) );
-      }
-   }
-
    abstract protected ModelChanges calculateChangesForFile( AspectModelFile aspectModelFile );
 
    @Override
    public ChangeReport fire( final ChangeContext changeContext ) {
-      prepare( changeContext );
+      final Map<AspectModelFile, ModelChanges> changesPerFile = changeContext.aspectModelFiles()
+            .map( file -> new AbstractMap.SimpleEntry<>( file, calculateChangesForFile( file ) ) )
+            .filter( entry -> entry.getValue() != ModelChanges.NONE )
+            .collect( Collectors.toMap( AbstractMap.SimpleEntry::getKey, AbstractMap.SimpleEntry::getValue ) );
+
       changesPerFile.forEach( ( file, modelChanges ) -> {
-         if ( changeContext.aspectModelFiles().contains( file ) ) {
+         if ( changeContext.aspectModelFiles().anyMatch( file::equals ) ) {
             file.sourceModel().add( modelChanges.add() );
             file.sourceModel().remove( modelChanges.remove() );
+
+            if ( !modelChanges.add().isEmpty() || !modelChanges.remove().isEmpty() ) {
+               changeContext.indicateFileHasChanged( file );
+            }
          }
       } );
 
       return new ChangeReport.MultipleEntries(
             changesPerFile.entrySet().stream().<ChangeReport> map( entry -> {
-                     final AspectModelFile file = entry.getKey();
-                     final ModelChanges modelChanges = entry.getValue();
-                     return new ChangeReport.EntryWithDetails( modelChanges.description(), Map.of(
-                                 "Add content in " + show( file ), modelChanges.add(),
-                                 "Remove content from " + show( file ), modelChanges.remove() )
-                           .entrySet().stream()
-                           .filter( descriptionEntry -> !descriptionEntry.getValue().isEmpty() )
-                           .collect( Collectors.toMap( Map.Entry::getKey, Map.Entry::getValue ) ) );
-                  }
-            ).toList()
+               final AspectModelFile file = entry.getKey();
+               final ModelChanges modelChanges = entry.getValue();
+               return new ChangeReport.EntryWithDetails( modelChanges.description(), Map.of(
+                           "Add content in " + show( file ), modelChanges.add(),
+                           "Remove content from " + show( file ), modelChanges.remove() )
+                     .entrySet().stream()
+                     .filter( descriptionEntry -> !descriptionEntry.getValue().isEmpty() )
+                     .collect( Collectors.toMap( Map.Entry::getKey, Map.Entry::getValue ) ) );
+            } ).toList()
       );
    }
 }
diff --git a/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/change/MoveElementToExistingFile.java b/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/change/MoveElementToExistingFile.java
@@ -48,7 +48,7 @@ public MoveElementToExistingFile( final AspectModelUrn elementUrn, final AspectM
 
    @Override
    public ChangeReport fire( final ChangeContext changeContext ) {
-      final AspectModelFile targetFile = changeContext.aspectModelFiles().stream()
+      final AspectModelFile targetFile = changeContext.aspectModelFiles()
             .filter( file -> file.sourceLocation().equals( targetFileLocation ) )
             .findFirst()
             .orElseThrow( () -> new ModelChangeException( "Can not determine target file to move element" ) );
diff --git a/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/change/MoveRenameAspectModelFile.java b/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/change/MoveRenameAspectModelFile.java
@@ -40,7 +40,7 @@ public MoveRenameAspectModelFile( final AspectModelFile file, final Optional<URI
 
    @Override
    public ChangeReport fire( final ChangeContext changeContext ) {
-      final AspectModelFile targetFile = changeContext.aspectModelFiles().stream()
+      final AspectModelFile targetFile = changeContext.aspectModelFiles()
             .filter( file -> file.sourceLocation().equals( file.sourceLocation() ) )
             .findFirst()
             .orElseThrow( () -> new ModelChangeException( "Can not find file to move/rename" ) );
diff --git a/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/change/RemoveAspectModelFile.java b/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/change/RemoveAspectModelFile.java
@@ -29,7 +29,7 @@ public RemoveAspectModelFile( final AspectModelFile fileToRemove ) {
 
    @Override
    public ChangeReport fire( final ChangeContext changeContext ) {
-      changeContext.aspectModelFiles().remove( fileToRemove );
+      changeContext.indicateFileIsRemoved( fileToRemove );
       return new ChangeReport.EntryWithDetails( "Remove file " + show( fileToRemove ),
             Map.of( "model content", fileToRemove.sourceModel() ) );
    }
diff --git a/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/change/StructuralChange.java b/core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/edit/change/StructuralChange.java
@@ -25,7 +25,7 @@
 
 public abstract class StructuralChange extends AbstractChange {
    protected AspectModelFile sourceFile( final ChangeContext changeContext, final AspectModelUrn elementUrn ) {
-      return changeContext.aspectModelFiles().stream().filter( aspectModelFile -> {
+      return changeContext.aspectModelFiles().filter( aspectModelFile -> {
                final Resource elementResource = aspectModelFile.sourceModel().createResource( elementUrn.toString() );
                return Streams.stream( aspectModelFile.sourceModel().listStatements( elementResource, RDF.type, (RDFNode) null ) )
                      .count() == 1;
diff --git a/core/esmf-aspect-meta-model-java/src/test/java/org/eclipse/esmf/aspectmodel/edit/AspectChangeContextTest.java b/core/esmf-aspect-meta-model-java/src/test/java/org/eclipse/esmf/aspectmodel/edit/AspectChangeContextTest.java

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public RemoveAspectModelFile( final AspectModelFile fileToRemove ) {`
`29`	`29`
`30`	`30`	`@Override`
`31`	`31`	`public ChangeReport fire( final ChangeContext changeContext ) {`
`32`		`- changeContext.aspectModelFiles().remove( fileToRemove );`
	`32`	`+ changeContext.indicateFileIsRemoved( fileToRemove );`
`33`	`33`	`return new ChangeReport.EntryWithDetails( "Remove file " + show( fileToRemove ),`
`34`	`34`	`Map.of( "model content", fileToRemove.sourceModel() ) );`
`35`	`35`	`}`