Merge pull request #1667 from sw5678/master

Added file tree functionality

Author: a3957273

src/core/config/Categories.json

@@ -296,7 +296,8 @@
             "Escape string",
             "Unescape string",
             "Pseudo-Random Number Generator",
-            "Sleep"
+            "Sleep",
+            "File Tree"
         ]
     },
     {

src/core/operations/FileTree.mjs

@@ -0,0 +1,93 @@
+/**
+ * @author sw5678
+ * @copyright Crown Copyright 2016
+ * @license Apache-2.0
+ */
+
+import Operation from "../Operation.mjs";
+import Utils from "../Utils.mjs";
+import {INPUT_DELIM_OPTIONS} from "../lib/Delim.mjs";
+
+/**
+ * Unique operation
+ */
+class FileTree extends Operation {
+
+    /**
+     * Unique constructor
+     */
+    constructor() {
+        super();
+
+        this.name = "File Tree";
+        this.module = "Default";
+        this.description = "Creates file tree from list of file paths (Similar too tree linux command)";
+        this.inputType = "string";
+        this.outputType = "string";
+        this.args = [
+            {
+                name: "File Path Delimiter",
+                type: "binaryString",
+                value: "/"
+            },
+            {
+                name: "Delimiter",
+                type: "option",
+                value: INPUT_DELIM_OPTIONS
+            }
+        ];
+    }
+
+    /**
+     * @param {string} input
+     * @param {Object[]} args
+     * @returns {string}
+     */
+    run(input, args) {
+
+        // Set up arrow and pipe for nice output display
+        const ARROW = "|---";
+        const PIPE = "|   ";
+
+        // Get args from input
+        const fileDelim = args[0];
+        const entryDelim = Utils.charRep(args[1]);
+
+        // Store path to print
+        const completedList = [];
+        const printList = [];
+
+        // Loop through all entries
+        const filePaths = input.split(entryDelim).unique().sort();
+        for (let i = 0; i < filePaths.length; i++) {
+            // Split by file delimiter
+            let path = filePaths[i].split(fileDelim);
+
+            if (path[0] === "") {
+                path = path.slice(1, path.length);
+            }
+
+            for (let j = 0; j < path.length; j++) {
+                let printLine;
+                let key;
+                if (j === 0) {
+                    printLine = path[j];
+                    key = path[j];
+                } else {
+                    printLine = PIPE.repeat(j-1) + ARROW + path[j];
+                    key = path.slice(0, j+1).join("/");
+                }
+
+                // Check to see we have already added that path
+                if (!completedList.includes(key)) {
+                    completedList.push(key);
+                    printList.push(printLine);
+                }
+            }
+        }
+        return printList.join("\n");
+    }
+
+}
+
+export default FileTree;

tests/operations/tests/FileTree.mjs

@@ -0,0 +1,21 @@
+/**
+ * @author sw5678
+ * @copyright Crown Copyright 2023
+ * @license Apache-2.0
+ */
+import TestRegister from "../../lib/TestRegister.mjs";
+
+TestRegister.addTests([
+    {
+        "name": "Swap Case: basic example",
+        "input": "/test_dir1/test_file1.txt\n/test_dir1/test_file2.txt\n/test_dir2/test_file1.txt",
+        "expectedOutput": "test_dir1\n|---test_file1.txt\n|---test_file2.txt\ntest_dir2\n|---test_file1.txt",
+        "recipeConfig": [
+            {
+                "op": "File Tree",
+                "args": [
+                ],
+            },
+        ],
+    }
+]);