Merge pull request #128 from wttech/repo-move

Repo copy/move/rename

Author: krystian-panek-vmltech

README.md

@@ -44,6 +44,7 @@ It works seamlessly across AEM on-premise, AMS, and AEMaaCS environments.
         - [Minimal Example](#minimal-example)
         - [Arguments Example](#arguments-example)
         - [ACL Example](#acl-example)
+        - [Repo Example](#repo-example)
         - [History](#history)
     - [Extension Scripts](#extension-scripts)
     - [Snippets](#snippets)
@@ -243,7 +244,7 @@ Be inspired by reviewing examples like [page thumbnail script](https://github.co
 
 #### ACL example
 
-The following example demonstrates how to create a user and a group, assign permissions, and add members to the group.
+The following example demonstrates how to create a user and a group, assign permissions, and add members to the group using the [ACL service](https://github.com/wttech/acm/blob/main/core/src/main/java/dev/vml/es/acm/core/acl/Acl.java) (`acl`).
 
 ```groovy
 boolean canRun() {
@@ -282,6 +283,58 @@ Logging is very descriptive allowing you to see what was done and what was skipp
 
 <img src="docs/screenshot-content-script-acl-output.png" width="720" alt="ACM ACL Script Output">
 
+#### Repo example
+
+You can leverage the [repository service](https://github.com/wttech/acm/blob/main/core/src/main/java/dev/vml/es/acm/core/repo/Repo.java) (repo) to efficiently perform JCR operations such as reading, writing, and deleting nodes with concise, expressive code.
+The out-of-the-box AEM API often requires extensive boilerplate code and can behave unpredictably in certain scenarios. The [RepoResource](https://github.com/wttech/acm/blob/main/core/src/main/java/dev/vml/es/acm/core/repo/RepoResource.java) API streamlines these operations, making repository programming more enjoyable, concise, and reliable.
+
+The repo service abstracts away the complexity of managing dry-run and auto-commit behaviors—features that are often error-prone and cumbersome to implement manually—ensuring safe, predictable, and streamlined repository operations.
+
+```groovy
+void describeRun() {
+    arguments.bool("dryRun") { value = true; switcher(); description = "Do not commit changes to the repository" }
+    arguments.bool("clean") { value = true; switcher(); description = "Finally delete all created resources" }
+}
+
+boolean canRun() {
+    return condition.idleSelf()
+}
+
+void doRun() {
+    out.fromLogs()
+
+    repo.dryRun(arguments.value("dryRun")) {
+        println "Creating a folder structure in the temporary directory of the repository."
+        def dataFolder = repo.get("/tmp/acm/demo/data").ensureFolder()
+        for (int i = 0; i < 5; i++) {
+            def child = dataFolder.child("child-\${i+1}")
+            child.save(["foo": "bar"])
+            child.updateProperty("foo") { v -> v.toUpperCase() }
+        }
+        println "Folder '${dataFolder.path}' has now ${dataFolder.descendants().count()} descendant(s)."
+
+        println "Creating a post in the temporary directory of the repository."
+        def postFolder = repo.get("/tmp/acm/demo/posts").ensureFolder()
+        def post = postFolder.child("hello-world.yml")
+        post.saveFile("application/x-yaml") { output ->
+            formatter.yml.write(output, [
+                    title: "Hello World",
+                    description: "This is a sample post.",
+                    tags: ["sample", "post"]
+            ])
+        }
+        println "Post '${post.path}' has been created at ${post.property("jcr:created", java.time.LocalDateTime)}"
+
+        if (arguments.value("clean")) {
+            dataFolder.delete()
+            postFolder.delete()
+        }
+    }
+}
+```
+
+<img src="docs/screenshot-content-script-repo-output.png" width="720" alt="ACM ACL Repo Output">
+
 ### History
 
 All code executions are logged in the history. You can see the status of each execution, including whether it was successful or failed. The history also provides detailed logs for each execution, including any errors that occurred.

core/src/main/java/dev/vml/es/acm/core/code/CodePrintStream.java

@@ -5,7 +5,6 @@
 import ch.qos.logback.classic.PatternLayout;
 import ch.qos.logback.classic.spi.ILoggingEvent;
 import ch.qos.logback.core.OutputStreamAppender;
-
 import java.io.OutputStream;
 import java.io.PrintStream;
 import java.util.LinkedList;

core/src/main/java/dev/vml/es/acm/core/code/ExecutionQuery.java

@@ -27,7 +27,8 @@ public class ExecutionQuery {
 
     private Range<Integer> duration;
 
-    // TODO do more escaping e.g. for JCR illegal characters, but beware that e.g. Text.escapeIllegalJcrChars is too aggressive for paths
+    // TODO do more escaping e.g. for JCR illegal characters
+    // TODO beware that e.g. Text.escapeIllegalJcrChars is too aggressive for paths
     public static String escape(String param) {
         String escaped = StringUtils.replace(param, "%", "%%");
         return StringUtils.replace(escaped, WILDCARD, "%");

core/src/main/java/dev/vml/es/acm/core/code/FileManager.java

@@ -1,18 +1,17 @@
 package dev.vml.es.acm.core.code;
 
 import dev.vml.es.acm.core.AcmException;
-import org.apache.commons.io.FileUtils;
-import org.apache.commons.io.IOUtils;
-import org.apache.commons.lang3.StringUtils;
-import org.osgi.service.component.annotations.Component;
-
 import java.io.*;
 import java.nio.file.Files;
 import java.text.SimpleDateFormat;
 import java.util.Collections;
 import java.util.Date;
 import java.util.List;
 import java.util.stream.Collectors;
+import org.apache.commons.io.FileUtils;
+import org.apache.commons.io.IOUtils;
+import org.apache.commons.lang3.StringUtils;
+import org.osgi.service.component.annotations.Component;
 
 @Component(immediate = true, service = FileManager.class)
 public class FileManager {
@@ -23,15 +22,16 @@ public File root() {
 
     public File get(String path) {
         if (!StringUtils.startsWith(path, root().getAbsolutePath())) {
-            throw new AcmException(String.format("File path must start with the root directory'%s'!", root().getAbsolutePath()));
+            throw new AcmException(
+                    String.format("File path must start with the root directory '%s'!", root().getAbsolutePath()));
         }
         return new File(path);
     }
 
     public File save(InputStream stream, String fileName) {
         try {
             String datePath = new SimpleDateFormat("yyyy/MM/dd").format(new Date());
-            String randomDir = System.currentTimeMillis() + "-" + (int)(Math.random() * 10000);
+            String randomDir = System.currentTimeMillis() + "-" + (int) (Math.random() * 10000);
             File dir = new File(root(), datePath + "/" + randomDir);
             if (!dir.exists() && !dir.mkdirs()) {
                 throw new AcmException("File directory cannot be created: " + dir.getAbsolutePath());

core/src/main/java/dev/vml/es/acm/core/code/arg/AbstractFileArgument.java

@@ -2,7 +2,6 @@
 
 import dev.vml.es.acm.core.code.Argument;
 import dev.vml.es.acm.core.code.ArgumentType;
-
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
@@ -29,14 +28,12 @@ public void setMimeTypes(List<String> mimeTypes) {
 
     public void images() {
         this.mimeTypes = Arrays.asList(
-                "image/png", "image/jpeg", "image/gif", "image/webp", "image/bmp", "image/tiff", "image/svg+xml"
-        );
+                "image/png", "image/jpeg", "image/gif", "image/webp", "image/bmp", "image/tiff", "image/svg+xml");
     }
 
     public void videos() {
-        this.mimeTypes = Arrays.asList(
-                "video/mp4", "video/webm", "video/ogg", "video/avi", "video/mpeg", "video/quicktime"
-        );
+        this.mimeTypes =
+                Arrays.asList("video/mp4", "video/webm", "video/ogg", "video/avi", "video/mpeg", "video/quicktime");
     }
 
     public void audios() {
@@ -45,9 +42,13 @@ public void audios() {
 
     public void archives() {
         this.mimeTypes = Arrays.asList(
-                "application/zip", "application/x-zip-compressed", "application/gzip", "application/x-gzip",
-                "application/x-tar", "application/x-rar-compressed", "application/x-7z-compressed"
-        );
+                "application/zip",
+                "application/x-zip-compressed",
+                "application/gzip",
+                "application/x-gzip",
+                "application/x-tar",
+                "application/x-rar-compressed",
+                "application/x-7z-compressed");
     }
 
     public void zips() {

core/src/main/java/dev/vml/es/acm/core/code/arg/FileArgument.java

@@ -1,7 +1,6 @@
 package dev.vml.es.acm.core.code.arg;
 
 import dev.vml.es.acm.core.code.ArgumentType;
-
 import java.io.File;
 
 public class FileArgument extends AbstractFileArgument<File> {

core/src/main/java/dev/vml/es/acm/core/code/arg/MultiFileArgument.java

@@ -1,7 +1,6 @@
 package dev.vml.es.acm.core.code.arg;
 
 import dev.vml.es.acm.core.code.ArgumentType;
-
 import java.io.File;
 
 public class MultiFileArgument extends AbstractFileArgument<File[]> {
@@ -29,4 +28,4 @@ public Integer getMax() {
     public void setMax(Integer max) {
         this.max = max;
     }
-}
+}