systemview-plugin 1.0.0

package/README.md

@@ -0,0 +1,2 @@
+# systemview-plugin
+SystemView is a documentation and testing suite for SystemLynx

package/SystemViewModule.js

@@ -0,0 +1,97 @@
+const fs = require("fs");
+const getAllTests = require("./getAllTest");
+
+module.exports = (specs, projectCode, serviceId, helperMethods = {}) => {
+  specs = specs.substr(-1) === "/" ? specs.substr(0, specs.length - 1) : specs;
+
+  return function SystemViewPlugin() {
+    const { SystemView } = this.useService("SystemView");
+    Object.assign(this, helperMethods);
+
+    this.saveDoc = ({ documentation, namespace }) => {
+      const fileName = `${specs}/docs/${getName(namespace)}.md`;
+      ensureDir(`${specs}/docs/`);
+      if (documentation) {
+        fs.writeFileSync(fileName, documentation, "utf8");
+      } else {
+        deleteFile(fileName);
+      }
+      SystemView.updateSpecList(this.getSpecList(), projectCode, serviceId);
+      return { documentation, namespace };
+    };
+
+    this.getDoc = (namespace) => {
+      const fileName = `${specs}/docs/${getName(namespace)}.md`;
+      const documentation = getFile(fileName) || "";
+      return { namespace, documentation };
+    };
+
+    this.getTests = (namespace = {}) => {
+      const { moduleName, methodName } = namespace;
+      if (methodName) {
+        const fileName = `${specs}/tests/${moduleName}.${methodName}.json`;
+        const tests = JSON.parse(getFile(fileName) || "[]");
+        return tests;
+      } else if (moduleName) {
+        return getAllTests(`${specs}/tests/`, moduleName);
+      } else {
+        return getAllTests(`${specs}/tests/`);
+      }
+    };
+    this.saveTest = (test, index) => {
+      const fileName = `${specs}/tests/${getName(test.namespace)}.json`;
+      const tests = JSON.parse(getFile(fileName) || "[]");
+      if (typeof index === "number") {
+        tests[index] = test;
+      } else {
+        tests.push(test);
+      }
+      fs.writeFileSync(fileName, JSON.stringify(tests), "utf8");
+      SystemView.updateSpecList(this.getSpecList(), projectCode, serviceId);
+      return index || tests.length - 1;
+    };
+    this.deleteTest = (namespace, index) => {
+      const fileName = `${specs}/tests/${getName(namespace)}.json`;
+      const tests = JSON.parse(getFile(fileName) || "[]");
+      tests.splice(index, 1);
+      console.log(tests.length);
+      if (tests.length) {
+        fs.writeFileSync(fileName, JSON.stringify(tests), "utf8");
+      } else {
+        deleteFile(fileName);
+        SystemView.updateSpecList(this.getSpecList(), projectCode, serviceId);
+      }
+    };
+    this.getSpecList = () => ({
+      docs: fs.readdirSync(`${specs}/docs/`),
+      tests: fs.readdirSync(`${specs}/tests/`),
+    });
+  };
+
+  function deleteFile(fileName) {
+    try {
+      console.log(fileName);
+      fs.unlinkSync(fileName);
+    } catch (err) {
+      // console.error(err);
+    }
+  }
+  function getFile(fileName) {
+    try {
+      return fs.readFileSync(fileName, "utf8");
+    } catch (error) {
+      // console.log(error);
+    }
+  }
+  function ensureDir(dir) {
+    if (!fs.existsSync(dir)) {
+      fs.mkdirSync(dir, { recursive: true });
+    }
+  }
+
+  function getName({ serviceId, moduleName, methodName }) {
+    if (methodName) return `${moduleName}.${methodName}`;
+    else if (moduleName) return moduleName;
+    else if (serviceId) return serviceId;
+  }
+};

package/getAllTest.js

@@ -0,0 +1,21 @@
+const fs = require("fs");
+const path = require("path");
+
+module.exports = function getFilesByNamespace(folder, namespace) {
+  const files = fs.readdirSync(folder); // read the contents of the current directory
+  const namespacePattern = namespace
+    ? new RegExp(`^${namespace}\\..+\\.json$`)
+    : /\.json$/;
+
+  return files
+    .filter((file) => namespacePattern.test(file))
+    .reduce((sum, file) => {
+      const filePath = path.join(folder, file);
+      const fileContents = fs.readFileSync(filePath, "utf-8");
+      const parsedData = JSON.parse(fileContents);
+
+      return sum.concat(parsedData);
+    }, []);
+};
+
+// no namespace passed, return all files

package/index.js

@@ -0,0 +1,40 @@
+const SystemViewModule = require("./SystemViewModule");
+const fs = require("fs");
+
+function ensureDir(dir) {
+  if (!fs.existsSync(dir)) {
+    fs.mkdirSync(dir, { recursive: true });
+  }
+}
+
+const getSpecList = (specs) => {
+  ensureDir(`${specs}/docs/`);
+  ensureDir(`${specs}/tests/`);
+  return {
+    docs: fs.readdirSync(`${specs}/docs/`),
+    tests: fs.readdirSync(`${specs}/tests/`),
+  };
+};
+module.exports = function ({
+  connection = "http://localhost:3300/systemview/api",
+  specs = "./specs",
+  projectCode,
+  serviceId,
+  helperMethods,
+}) {
+  return function (App) {
+    App.loadService("SystemView", connection)
+      .module("Plugin", SystemViewModule(specs, projectCode, serviceId, helperMethods))
+      .on("ready", async function connectSystemView(system) {
+        try {
+          const { SystemView } = this.useService("SystemView");
+          const specList = getSpecList(specs);
+          console.log("reconnection");
+          await SystemView.connect({ system, projectCode, serviceId, specList });
+          // SystemView.on("reconnect", connectSystemView.bind(this, system));
+        } catch (error) {
+          console.log("SystemView connection failed---->", error);
+        }
+      });
+  };
+};

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "systemview-plugin",
+  "version": "1.0.0",
+  "description": "Connects your SystemLynx project to the SystemView UI",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Odion100/systemview-plugin.git"
+  },
+  "keywords": [
+    "systemlynx"
+  ],
+  "author": "Odion Edwards",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/Odion100/systemview-plugin/issues"
+  },
+  "homepage": "https://github.com/Odion100/systemview-plugin#readme"
+}