Merge pull request #63 from paxtonhare/5_spec_for_plugins

5 spec for plugins

Author: paxtonhare

data-hub/src/main/java/com/marklogic/hub/FlowComplexity.java

@@ -0,0 +1,24 @@
+package com.marklogic.hub;
+
+public enum FlowComplexity {
+    SIMPLE("simple"), ADVANCED("advanced");
+
+    private String name;
+
+    FlowComplexity(String name) {
+        this.name = name;
+    }
+
+    public static FlowComplexity getFlowComplexity(String complexity) {
+        for (FlowComplexity flowComplexity : FlowComplexity.values()) {
+            if (flowComplexity.toString().equals(complexity)) {
+                return flowComplexity;
+            }
+        }
+        return null;
+    }
+
+    public String toString() {
+        return name;
+    }
+}

data-hub/src/main/java/com/marklogic/hub/FlowManager.java

@@ -204,13 +204,13 @@ public void runFlowsInParallel(Flow ... flows) {
     public static Flow flowFromXml(Element doc) {
         Flow f = null;
 
-        String format = null;
-        NodeList elements = doc.getElementsByTagNameNS(HUB_NS, "format");
+        String complexity = null;
+        NodeList elements = doc.getElementsByTagNameNS(HUB_NS, "complexity");
         if (elements.getLength() == 1) {
-            format = elements.item(0).getTextContent();
+            complexity = elements.item(0).getTextContent();
         }
 
-        if (format.equals("simple")) {
+        if (complexity.equals(FlowComplexity.SIMPLE.toString())) {
             SimpleFlow sf = new SimpleFlow(doc);
             f = sf;
         }

data-hub/src/main/java/com/marklogic/hub/PluginFormat.java

@@ -0,0 +1,24 @@
+package com.marklogic.hub;
+
+public enum PluginFormat {
+    JAVASCRIPT("sjs"), XQUERY("xqy");
+
+    private String name;
+
+    PluginFormat(String name) {
+        this.name = name;
+    }
+
+    public static PluginFormat getPluginFormat(String format) {
+        for (PluginFormat pluginFormat : PluginFormat.values()) {
+            if (pluginFormat.toString().equals(format)) {
+                return pluginFormat;
+            }
+        }
+        return null;
+    }
+
+    public String toString() {
+        return name;
+    }
+}

data-hub/src/main/java/com/marklogic/hub/RestAssetLoader.java

@@ -28,6 +28,8 @@
 import java.util.HashSet;
 import java.util.Set;
 
+import org.apache.commons.io.FilenameUtils;
+
 import com.marklogic.client.DatabaseClient;
 import com.marklogic.client.admin.ExtensionLibrariesManager;
 import com.marklogic.client.admin.ExtensionLibraryDescriptor;
@@ -142,7 +144,19 @@ protected void loadFile(String uri, File f) {
         moduleDescriptor.setPath(uri);
 
         FileHandle handle = new FileHandle(f);
-        handle.setFormat(Format.TEXT);
+
+        String ext = FilenameUtils.getExtension(f.getName());
+        switch(ext) {
+        case "xml":
+            handle.setFormat(Format.XML);
+            break;
+        case "json":
+            handle.setFormat(Format.JSON);
+            break;
+        default:
+            handle.setFormat(Format.TEXT);
+        }
+
         libsMgr.write(moduleDescriptor, handle);
 
         if (modulesManager != null) {

data-hub/src/main/java/com/marklogic/hub/Scaffolding.java

@@ -18,45 +18,66 @@
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.PrintWriter;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.marklogic.client.io.Format;
+import com.marklogic.hub.flow.Flow;
+import com.marklogic.hub.flow.FlowType;
+import com.marklogic.hub.flow.SimpleFlow;
+
 public class Scaffolding {
 
+    static final private Logger LOGGER = LoggerFactory.getLogger(Scaffolding.class);
+
     public static void createDomain(String domainName, File userlandPath) {
         File domainDir = new File(userlandPath, domainName);
         domainDir.mkdirs();
     }
 
-    public static void createFlow(String name, String type, File domainPath)
+    public static void createFlow(File domainPath, String domainName, String name, FlowType flowType, PluginFormat pluginFormat, Format dataFormat)
             throws IOException {
-        File typeDir = new File(domainPath, type);
+        File typeDir = new File(domainPath, flowType.toString());
         File flowDir = new File(typeDir, name);
 
-        File collectorDir = new File(flowDir, "collector");
-        collectorDir.mkdirs();
-        writeFile("scaffolding/collector.xqy",
-                Paths.get(collectorDir.getPath(), "collector.xqy"));
+        if (flowType.equals(FlowType.CONFORMANCE)) {
+            File collectorDir = new File(flowDir, "collector");
+            collectorDir.mkdirs();
+            writeFile("scaffolding/" + flowType + "/" + pluginFormat + "/collector." + pluginFormat,
+                    Paths.get(collectorDir.getPath(), "collector." + pluginFormat));
+        }
 
         File contentDir = new File(flowDir, "content");
         contentDir.mkdirs();
-        writeFile("scaffolding/content.xqy",
-                Paths.get(contentDir.getPath(), "content.xqy"));
+        writeFile("scaffolding/" + flowType + "/" + pluginFormat + "/content." + pluginFormat,
+                Paths.get(contentDir.getPath(), "content." + pluginFormat));
 
         File headerDir = new File(flowDir, "headers");
         headerDir.mkdirs();
-        writeFile("scaffolding/headers.xqy",
-                Paths.get(headerDir.getPath(), "headers.xqy"));
+        writeFile("scaffolding/" + flowType + "/" + pluginFormat + "/headers." + pluginFormat,
+                Paths.get(headerDir.getPath(), "headers." + pluginFormat));
 
         File triplesDir = new File(flowDir, "triples");
         triplesDir.mkdirs();
-        writeFile("scaffolding/triples.xqy",
-                Paths.get(triplesDir.getPath(), "triples.xqy"));
+        writeFile("scaffolding/" + flowType + "/" + pluginFormat + "/triples." + pluginFormat,
+                Paths.get(triplesDir.getPath(), "triples." + pluginFormat));
+
+        SimpleFlow flow = new SimpleFlow(domainName, name, flowType, dataFormat);
+        flow.serialize();
+        File flowFile = new File(flowDir, name + ".xml");
+        try(PrintWriter out = new PrintWriter(flowFile)) {
+            out.println(flow.serialize());
+        }
     }
 
     private static void writeFile(String srcFile, Path dstFile)
             throws IOException {
+        LOGGER.info(srcFile);
         InputStream inputStream = Scaffolding.class.getClassLoader()
                 .getResourceAsStream(srcFile);
         Files.copy(inputStream, dstFile);

data-hub/src/main/java/com/marklogic/hub/collector/AbstractCollector.java

@@ -20,16 +20,18 @@
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamWriter;
 
+import com.marklogic.hub.plugin.PluginType;
+
 public abstract class AbstractCollector implements Collector {
 
-    private String type;
+    private PluginType type;
 
-    public AbstractCollector(String type) {
+    public AbstractCollector(PluginType type) {
         this.type = type;
     }
 
     @Override
-    public String getType() {
+    public PluginType getType() {
         return this.type;
     }
 

data-hub/src/main/java/com/marklogic/hub/collector/Collector.java

@@ -20,9 +20,11 @@
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamWriter;
 
+import com.marklogic.hub.plugin.PluginType;
+
 public interface Collector {
 
-    String getType();
+    PluginType getType();
     List<String> run();
     void serialize(XMLStreamWriter serializer) throws XMLStreamException;
 }

data-hub/src/main/java/com/marklogic/hub/collector/QueryCollector.java

@@ -17,12 +17,14 @@
 
 import java.util.List;
 
+import com.marklogic.hub.plugin.PluginType;
+
 public class QueryCollector extends ServerCollector {
 
     public static final String MODULE = "/com.marklogic.hub/collectors/query.xqy";
 
     public QueryCollector() {
-        super("xquery", MODULE);
+        super(PluginType.XQUERY, MODULE);
     }
 
     @Override

data-hub/src/main/java/com/marklogic/hub/collector/ServerCollector.java

@@ -27,13 +27,14 @@
 import com.marklogic.client.extensions.ResourceServices.ServiceResultIterator;
 import com.marklogic.client.io.JacksonDatabindHandle;
 import com.marklogic.client.util.RequestParameters;
+import com.marklogic.hub.plugin.PluginType;
 
 public class ServerCollector extends AbstractCollector {
 
     private DatabaseClient client = null;
     private String module;
 
-    public ServerCollector(String type, String module) {
+    public ServerCollector(PluginType type, String module) {
         super(type);
         this.module = module;
     }
@@ -53,7 +54,7 @@ public String getModule() {
     @Override
     public void serialize(XMLStreamWriter serializer) throws XMLStreamException {
         serializer.writeStartElement("collector");
-        serializer.writeAttribute("type", getType());
+        serializer.writeAttribute("type", getType().toString());
         serializer.writeAttribute("module", this.module);
         serializer.writeEndElement();