Update rdoc packages (#165)

* cleanup of non ascii TM and updated rdoc generation

* remove <sup> and scenario schema which is now in reporting gem

* remove schema from these docks

* temporary gemfile edit

* update link to rdocs

* update rdoc link

Co-authored-by: Nathan Moore <[email protected]>

RDOC_MAIN.md

@@ -2,9 +2,9 @@
 
 ### [back to main docs](../)
 
-The URBANopt™ Scenario Gem includes functionality for defining scenarios, running simulations, and post-processing results. User defined SimulationMapper classes translate each Feature to a SimulationDir which is a directory containing simulation input files. A ScenarioRunner is used to perform simulations for each SimulationDir. Finally, a ScenarioPostProcessor can run on a Scenario to generate scenario level results.
+The URBANopt™ Scenario Gem includes functionality for defining scenarios, running simulations, and post-processing results. User defined SimulationMapper classes translate each Feature to a SimulationDir which is a directory containing simulation input files. A ScenarioRunner is used to perform simulations for each SimulationDir. Finally, a ScenarioPostProcessor can run on a Scenario to generate scenario level results.
 
-[RDoc Documentation](https://urbanopt.github.io/urbanopt-scenario-gem/)
+[RDoc Documentation](https://urbanopt.github.io/urbanopt-scenario-gem/rdoc)
 
 ## Installation
 

README.md

@@ -1,6 +1,6 @@
 # URBANopt Scenario Gem 
 
-The URBANopt<sup>&trade;</sup> Scenario Gem includes functionality for defining scenarios, running simulations, and post-processing results. User defined SimulationMapper classes translate each Feature to a SimulationDir which is a directory containing simulation input files. The ScenarioRunner is used to perform simulations for each SimulationDir. Finally, a ScenarioPostProcessor can run on a Scenario to generate scenario level results.
+The URBANopt&trade; Scenario Gem includes functionality for defining scenarios, running simulations, and post-processing results. User defined SimulationMapper classes translate each Feature to a SimulationDir which is a directory containing simulation input files. The ScenarioRunner is used to perform simulations for each SimulationDir. Finally, a ScenarioPostProcessor can run on a Scenario to generate scenario level results.
 
 [RDoc Documentation](https://urbanopt.github.io/urbanopt-scenario-gem/)
 

docs/.vuepress/components/InnerJsonSchema.vue

@@ -13,7 +13,6 @@ import highlightJson from "../highlight";
 import { emptyPromise } from '../utils';
 
 const JSONSchemaViewP = emptyPromise();
-const $RefParserP = emptyPromise();
 
 export default {
   name: "InnerJsonSchema",
@@ -24,27 +23,24 @@ export default {
     };
   },
   created() {
+    // created only runs on the client, which is good because
+    // this module causes an error if we load it in a server context
     import("json-schema-view-js").then(JSONSchemaViewP.resolve);
-    import("json-schema-ref-parser/dist/ref-parser.js").then($RefParserP.resolve);
   },
   computed: {
     view() {
-      return Promise.all([$RefParserP, JSONSchemaViewP])
-        .then(([$RefParser]) => $RefParser.default.dereference(this.schema))
-        .then(
-          s =>
-            new window.JSONSchemaView(s, 2, {
-              theme: "dark"
-            })
-        );
+      return JSONSchemaViewP
+        .then( () => new window.JSONSchemaView(this.schema, 2, {
+          theme: "dark"
+        }));
     },
     schemaFormatted() {
       return highlightJson(JSON.stringify(this.schema, null, 2));
     }
   },
   methods: {
     async replaceRenderedSchema() {
-      const v = await this.view;
+      const v = await this.view; // this never resolves on the server
       this.$refs.schemaTarget.innerHtml = "";
       this.$refs.schemaTarget.appendChild(v.render());
     }
@@ -63,7 +59,6 @@ export default {
   background-color: #282c34;
   padding: 1.25rem 1.5rem;
   border-radius: 6px;
-  width: fit-content
 }
 .json-formatter-row a {
   color: white;
@@ -78,7 +73,4 @@ export default {
 .json-schema-view .object .inner.oneOf b {
   color: aqua;
 }
-.json-schema-view .default {
-  color:  #5f96df
-}
 </style>

docs/.vuepress/config.js

@@ -1,15 +1,19 @@
+const path = require('path');
+
 module.exports = {
   base: '/urbanopt-scenario-gem/',
   themeConfig: {
     navbar: false,
     sidebar: [
-      "/",
-      {
-        title: "Schemas",
-        children: [
-          "/schemas/scenario-schema.md"
-        ]
-      }
+      "/"
     ]
-  }
-};
+  },
+  chainWebpack: config => {
+    config.module
+      .rule('json')
+        .test(/\.json$/)
+        .use(path.join(__dirname, 'json-schema-deref-loader.js'))
+          .loader(path.join(__dirname, 'json-schema-deref-loader.js'))
+          .end()
+  },
+};

docs/.vuepress/highlight.js

@@ -1,4 +1,4 @@
-import hljs from "highlight.js/lib/highlight.js";
+import hljs from "highlight.js";
 import json from "highlight.js/lib/languages/json";
 
 hljs.registerLanguage("json", json);

docs/.vuepress/json-schema-deref-loader.js

@@ -0,0 +1,22 @@
+// thanks to https://gist.github.com/mgesmundo/07d6ea3958ed4c7d19d1161551fa46ca
+const $RefParser = require('@apidevtools/json-schema-ref-parser')
+
+module.exports = async function () {
+  const parser = new $RefParser()
+  const schema = await parser.dereference(this.resourcePath, {
+    dereference: {
+      circular: false
+    }
+  })
+  const resolve = await parser.resolve(this.resourcePath, {
+    dereference: {
+      circular: false
+    }
+  })
+
+  for (const dep in resolve._$refs) {
+    this.addDependency(dep)
+  }
+
+  return JSON.stringify(schema)
+}

docs/README.md

@@ -2,9 +2,9 @@
 
 ### <StaticLink href="rdoc/">Rdocs</StaticLink>
 
-The URBANopt™ Scenario Gem includes functionality for defining scenarios, running simulations, and post-processing results. User defined SimulationMapper classes translate each Feature to a SimulationDir which is a directory containing simulation input files. A ScenarioRunner is used to perform simulations for each SimulationDir. Finally, a ScenarioPostProcessor can run on a Scenario to generate scenario level results.
+The URBANopt&trade; Scenario Gem includes functionality for defining scenarios, running simulations, and post-processing results. User defined SimulationMapper classes translate each Feature to a SimulationDir which is a directory containing simulation input files. A ScenarioRunner is used to perform simulations for each SimulationDir. Finally, a ScenarioPostProcessor can run on a Scenario to generate scenario level results.
 
-[RDoc Documentation](https://urbanopt.github.io/urbanopt-scenario-gem/)
+[RDoc Documentation](https://urbanopt.github.io/urbanopt-scenario-gem/rdoc)
 
 ## Installation