Added initial format support to wrmldoc

wrml · Mar 1, 2016 · 67603f1 · 67603f1
1 parent 4a0f09d
commit 67603f1
Show file tree

Hide file tree

Showing 40 changed files with 3,149 additions and 1,325 deletions.
diff --git a/core/src/main/java/org/wrml/model/rest/LinkTemplate.java b/core/src/main/java/org/wrml/model/rest/LinkTemplate.java
@@ -61,7 +61,7 @@
  * <p/>
  * <p>
  * A link ends with its pointy-end pointing to the end point. This end point is the resource that the referrer resource
- * was referencing with its link.
+ * is referencing with its link.
  * </p>
  *
  * @see Api
@@ -70,7 +70,6 @@
  * @see URI
  * @see Link
  * @see LinkRelation
- * @see org.wrml.runtime.schema.LinkSlot
  * @see LinkValue
  * @see Schema
  * @see Document

diff --git a/core/src/main/java/org/wrml/runtime/format/SystemFormat.java b/core/src/main/java/org/wrml/runtime/format/SystemFormat.java
@@ -82,7 +82,7 @@ public enum SystemFormat {
     vnd_wrml_swagger_api(new UniqueName("application/vnd.wrml.swagger.api+json"),
     "The WRML System Format representing the \"application/vnd.wrml.swagger.api\" media type.",
             URI.create("http://wrml.org"),
-            URI.create(""), "txt"),
+            URI.create(""), "json"),
 
     vnd_wrml_wrmldoc(new UniqueName("application/vnd.wrml.wrmldoc+json"),
     "The WRML System Format representing the \"application/vnd.wrml.wrmldoc\" media type.",

diff --git a/...rc/main/java/org/wrml/runtime/format/application/vnd/wrml/wrmldoc/WrmldocDataBuilder.java b/...rc/main/java/org/wrml/runtime/format/application/vnd/wrml/wrmldoc/WrmldocDataBuilder.java
@@ -25,9 +25,11 @@
 package org.wrml.runtime.format.application.vnd.wrml.wrmldoc;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ArrayNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import org.apache.commons.lang3.StringUtils;
 import org.wrml.model.Model;
+import org.wrml.model.format.Format;
 import org.wrml.model.rest.Api;
 import org.wrml.model.rest.Document;
 import org.wrml.model.rest.LinkRelation;
@@ -38,12 +40,16 @@
 import org.wrml.model.schema.Schema;
 import org.wrml.runtime.Context;
 import org.wrml.runtime.Keys;
+import org.wrml.runtime.format.FormatLoader;
+import org.wrml.runtime.format.Formatter;
 import org.wrml.runtime.format.application.vnd.wrml.complete.api.CompleteApiBuilder;
 import org.wrml.runtime.format.application.vnd.wrml.complete.schema.CompleteSchemaBuilder;
+import org.wrml.runtime.rest.ApiLoader;
 import org.wrml.runtime.schema.SchemaLoader;
 
 import java.io.IOException;
 import java.net.URI;
+import java.util.SortedSet;
 
 public class WrmldocDataBuilder {
 
@@ -166,10 +172,44 @@ else if (model instanceof DocumentNotFoundErrorReport) {
         final ObjectNode jstreeDataNode = _JstreeDataBuilder.buildJstreeData(objectMapper, context);
         wrmlDataNode.put(PropertyName.jstree.name(), jstreeDataNode);
 
+        final ObjectNode formatsDataNode = buildFormatsData(objectMapper, model);
+        wrmlDataNode.put(PropertyName.formats.name(), formatsDataNode);
+
         return wrmlDataNode;
     }
 
 
+    public ObjectNode buildFormatsData(final ObjectMapper objectMapper, final Model model) {
+
+        final ObjectNode formatsNode = objectMapper.createObjectNode();
+
+        final Context context = model.getContext();
+        final FormatLoader formatLoader = context.getFormatLoader();
+        final SortedSet<URI> formatUris = formatLoader.getLoadedFormatUris();
+        final URI defaultFormatUri = formatLoader.getDefaultFormatUri();
+
+        for (final URI formatUri : formatUris) {
+            final Formatter formatter = formatLoader.getFormatter(formatUri);
+            if (formatter.isApplicableTo(model.getSchemaUri())) {
+
+                final Format format = formatLoader.loadFormat(formatUri);
+                final String mediaTypeString = String.valueOf(format.getMediaType());
+                final ObjectNode formatNode = objectMapper.createObjectNode();
+                formatsNode.put(mediaTypeString, formatNode);
+
+                formatNode.put("uri", String.valueOf(formatUri));
+                formatNode.put("title", format.getTitle());
+                formatNode.put("mediaType", mediaTypeString);
+                formatNode.put("fileExtension", format.getFileExtension());
+                formatNode.put("isDefault", formatUri.equals(defaultFormatUri));
+
+            }
+        }
+
+        return formatsNode;
+    }
+
+
     public enum PropertyName {
         docroot,
         documentTitle,
@@ -179,7 +219,8 @@ public enum PropertyName {
         schema,
         api,
         relation,
-        jstree;
+        jstree,
+        formats;
     }
 }
 

diff --git a/core/src/main/java/org/wrml/runtime/format/text/html/WrmldocFormatter.java b/core/src/main/java/org/wrml/runtime/format/text/html/WrmldocFormatter.java
@@ -79,6 +79,8 @@ public void writeModel(final OutputStream out, final Model model, final ModelWri
 
         try {
 
+            final MessageFormat pageTemplate = getTemplate(SHELL_PAGE_TEMPLATE_RESOURCE);
+
             final ObjectNode wrmldocData = _WrmldocDataBuilder.buildWrmldocData(objectMapper, model);
 
             final String documentTitle = wrmldocData.get(WrmldocDataBuilder.PropertyName.documentTitle.name()).asText();
@@ -100,8 +102,23 @@ public void writeModel(final OutputStream out, final Model model, final ModelWri
             final JsonNode jstreeDataNode = wrmldocData.get(WrmldocDataBuilder.PropertyName.jstree.name());
             final String jstreeValue = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(jstreeDataNode);
 
-            final MessageFormat pageTemplate = getTemplate(SHELL_PAGE_TEMPLATE_RESOURCE);
-            final String renderedPage = renderPage(pageTemplate, _WrmldocDataBuilder.getDocroot(), dotMin, documentTitle, documentIcon, schemaUriString, modelValue, schemaValue, apiValue, relationValue, jstreeValue);
+            final JsonNode formatsDataNode = wrmldocData.get(WrmldocDataBuilder.PropertyName.formats.name());
+            final String formatsValue = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(formatsDataNode);
+
+            final String renderedPage =
+                    renderPage(
+                            pageTemplate,
+                            _WrmldocDataBuilder.getDocroot(),
+                            dotMin,
+                            documentTitle,
+                            documentIcon,
+                            schemaUriString,
+                            modelValue,
+                            schemaValue,
+                            apiValue,
+                            relationValue,
+                            jstreeValue,
+                            formatsValue);
 
             IOUtils.write(renderedPage, out);
 

diff --git a/core/src/main/java/org/wrml/runtime/rest/DefaultApiLoader.java b/core/src/main/java/org/wrml/runtime/rest/DefaultApiLoader.java
@@ -518,18 +518,10 @@ private void loadSystemApis() {
 
             apiBuilder.uri(apiUri).title(systemApi.getTitle()).description(systemApi.getDescription());
 
+            // NOTE: This call to docroot will automatically *Api* as a default response schema at the root
             apiBuilder.docroot(systemApi.getDocrootId());
             apiBuilder.resource(SYSTEM_API_PRIMARY_ENDPOINT_FULL_PATH, systemApi.getPrimaryEndpointId(), systemApi.getDefaultSchemaInterface(), true);
 
-            // TODO: Rework the SchemaNamespace
-            /*
-             * if (systemApi == SystemApi.Schema) { apiBuilder.link(SYSTEM_API_DOCROOT_FULL_PATH, SystemLinkRelation.self.getUri(), SYSTEM_API_DOCROOT_FULL_PATH,
-             * SchemaNamespace.class); apiBuilder.link(SYSTEM_API_DOCROOT_FULL_PATH, SystemLinkRelation.element.getUri(), SYSTEM_API_PRIMARY_ENDPOINT_FULL_PATH, Schema.class);
-             * apiBuilder.link(SYSTEM_API_DOCROOT_FULL_PATH, SystemLinkRelation.child.getUri(), SYSTEM_API_PRIMARY_ENDPOINT_FULL_PATH, SchemaNamespace.class);
-             * apiBuilder.link(SYSTEM_API_PRIMARY_ENDPOINT_FULL_PATH, SystemLinkRelation.element.getUri(), SYSTEM_API_PRIMARY_ENDPOINT_FULL_PATH, Schema.class);
-             * apiBuilder.link(SYSTEM_API_PRIMARY_ENDPOINT_FULL_PATH, SystemLinkRelation.child.getUri(), SYSTEM_API_PRIMARY_ENDPOINT_FULL_PATH, SchemaNamespace.class); }
-             */
-
             final Api api = apiBuilder.toApi();
             loadApi(api);
         }

diff --git a/core/src/main/resources/org/wrml/runtime/format/text/html/index.html b/core/src/main/resources/org/wrml/runtime/format/text/html/index.html
@@ -55,7 +55,9 @@
 
                 "relation" : {8},
 
-                "jstree" : {9}
+                "jstree" : {9},
+
+                "formats" : {10}
 
             '}';
 
@@ -66,6 +68,13 @@
 
         <script type="text/javascript" src="{0}jstree/jstree{1}.js"></script>
 
+        <script type="text/javascript" src="{0}ace/ace.js"></script>
+        <script type="text/javascript" src="{0}ace/mode-html.js"></script>
+        <script type="text/javascript" src="{0}ace/mode-java.js"></script>
+        <script type="text/javascript" src="{0}ace/mode-json.js"></script>
+        <script type="text/javascript" src="{0}ace/mode-xml.js"></script>
+        <script type="text/javascript" src="{0}ace/mode-yaml.js"></script>
+
         <!-- Uses wrmldoc for app logic -->
         <script type="text/javascript" src="{0}js/wrmldoc{1}.js"></script>
 

diff --git a/wrmldoc/ace/ace.js b/wrmldoc/ace/ace.js
diff --git a/wrmldoc/ace/mode-html.js b/wrmldoc/ace/mode-html.js
diff --git a/wrmldoc/ace/mode-java.js b/wrmldoc/ace/mode-java.js
diff --git a/wrmldoc/ace/mode-json.js b/wrmldoc/ace/mode-json.js