FAIRSPC-79: light refactoring + important todo

projects/saturn/src/main/java/io/fairspace/saturn/config/MetadataConfig.java

@@ -1,16 +1,17 @@
 package io.fairspace.saturn.config;
 
-import io.fairspace.saturn.rdf.transactions.Transactions;
-import io.fairspace.saturn.services.metadata.MetadataPermissions;
-import io.fairspace.saturn.services.metadata.MetadataService;
-import io.fairspace.saturn.services.metadata.validation.ComposedValidator;
 import org.apache.jena.query.Dataset;
 import org.apache.jena.rdf.model.Model;
 import org.apache.jena.sparql.util.Symbol;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
+import io.fairspace.saturn.rdf.transactions.Transactions;
+import io.fairspace.saturn.services.metadata.MetadataPermissions;
+import io.fairspace.saturn.services.metadata.MetadataService;
+import io.fairspace.saturn.services.metadata.validation.ComposedValidator;
+
 @Configuration
 public class MetadataConfig {
 
@@ -26,6 +27,10 @@ public MetadataService metadataService(
             @Qualifier("composedValidator") ComposedValidator composedValidator) {
         var metadataService =
                 new MetadataService(transactions, vocabulary, systemVocabulary, composedValidator, metadataPermissions);
+        // This is a workaround (old, not a new one) to resolve circular dependency:
+        // MetadataService --> ComposedValidator --> URIPrefixValidator --> DavFactory --> DirectoryResource -->
+        // MetadataService
+        // See comment with a suggestion to refactor resources to be anemic (not rich)
         dataset.getContext().set(METADATA_SERVICE, metadataService);
         return metadataService;
     }

projects/saturn/src/main/java/io/fairspace/saturn/services/metadata/validation/ComposedValidator.java

@@ -1,11 +1,11 @@
 package io.fairspace.saturn.services.metadata.validation;
 
+import java.util.List;
+
 import org.apache.jena.graph.Node;
 import org.apache.jena.rdf.model.Model;
 import org.springframework.stereotype.Component;
 
-import java.util.List;
-
 /**
  * Combines a few validators into one. Stops on a first failing validator.
  */

projects/saturn/src/main/java/io/fairspace/saturn/services/metadata/validation/DeletionValidator.java

@@ -2,9 +2,9 @@
 
 import org.apache.jena.rdf.model.Model;
 import org.apache.jena.rdf.model.Resource;
+import org.springframework.stereotype.Component;
 
 import io.fairspace.saturn.vocabulary.FS;
-import org.springframework.stereotype.Component;
 
 @Component
 public class DeletionValidator implements MetadataRequestValidator {

projects/saturn/src/main/java/io/fairspace/saturn/services/metadata/validation/MachineOnlyClassesValidator.java

@@ -3,11 +3,11 @@
 import org.apache.jena.rdf.model.Model;
 import org.apache.jena.shacl.vocabulary.SHACLM;
 import org.apache.jena.vocabulary.RDF;
-
-import io.fairspace.saturn.vocabulary.FS;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.stereotype.Component;
 
+import io.fairspace.saturn.vocabulary.FS;
+
 import static io.fairspace.saturn.rdf.ModelUtils.getBooleanProperty;
 
 @Component

projects/saturn/src/main/java/io/fairspace/saturn/services/metadata/validation/ProtectMachineOnlyPredicatesValidator.java

@@ -8,11 +8,11 @@
 import org.apache.jena.rdf.model.Resource;
 import org.apache.jena.shacl.vocabulary.SHACLM;
 import org.apache.jena.vocabulary.RDF;
-
-import io.fairspace.saturn.vocabulary.FS;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.stereotype.Component;
 
+import io.fairspace.saturn.vocabulary.FS;
+
 import static io.fairspace.saturn.rdf.ModelUtils.getBooleanProperty;
 import static io.fairspace.saturn.rdf.ModelUtils.getResourceProperties;
 import static io.fairspace.saturn.vocabulary.ShapeUtils.getClassShapeForClass;

projects/saturn/src/main/java/io/fairspace/saturn/services/metadata/validation/URIPrefixValidator.java

@@ -1,11 +1,12 @@
 package io.fairspace.saturn.services.metadata.validation;
 
-import io.fairspace.saturn.webdav.DavFactory;
 import org.apache.jena.rdf.model.Model;
 import org.apache.jena.rdf.model.Resource;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.stereotype.Component;
 
+import io.fairspace.saturn.webdav.DavFactory;
+
 @Component
 public class URIPrefixValidator implements MetadataRequestValidator {
     private final String restrictedPrefix;

projects/saturn/src/main/java/io/fairspace/saturn/services/metadata/validation/UniqueLabelValidator.java

@@ -3,9 +3,9 @@
 import org.apache.jena.rdf.model.Model;
 import org.apache.jena.vocabulary.RDF;
 import org.apache.jena.vocabulary.RDFS;
+import org.springframework.stereotype.Component;
 
 import io.fairspace.saturn.vocabulary.FS;
-import org.springframework.stereotype.Component;
 
 @Component
 public class UniqueLabelValidator implements MetadataRequestValidator {

projects/saturn/src/main/java/io/fairspace/saturn/webdav/resources/DirectoryResource.java

@@ -374,6 +374,14 @@ private void uploadMetadata(FileItem file) throws BadRequestException, ConflictE
             throw new BadRequestException("Error parsing file " + file.getName(), e);
         }
 
+        // TODO: I would refactor all resources to be anemic rather than rich.
+        //  Due to the "rich" nature of the resources,
+        //  the resources (directory, collections, etc.) are responsible for handling the request and performing the
+        //  actions.
+        //  I would go more "spring way" and use services to handle the request and perform the actions over resources
+        //  via the services
+        //  It would suggest not to mix the responsibilities and make the code more maintainable.
+        //  It would let us avoid such an inelegant workaround as the one below.
         MetadataService metadataService = factory.context.get(METADATA_SERVICE);
         try {
             metadataService.patch(model, Boolean.TRUE);