Merge pull request #206 from adobe/type-error-fix

Type error tests and fixes

lib/locales/en_US.json

@@ -176,6 +176,7 @@
     "the string must be a JSON Pointer, according to ": "the string must be a JSON Pointer, according to ",
     "the string must be a URI template, according to ": "the string must be a URI template, according to ",
     "the string must be a regular expression, according to ": "the string must be a regular expression, according to ",
-    "the string must be a relative JSON Pointer, according to ": "the string must be a relative JSON Pointer, according to "
+    "the string must be a relative JSON Pointer, according to ": "the string must be a relative JSON Pointer, according to ",
+    "Unknown Type": "Unknown Type"
   }
 }

lib/markdownBuilder.js

@@ -277,6 +277,9 @@ function build({
   }
 
   function type(property) {
+    if (typeof property[keyword`type`] === 'object') {
+      return text(i18n`Unknown Type`);
+    }
     const types = Array.isArray(property[keyword`type`]) ? property[keyword`type`] : [property[keyword`type`]];
     const realtypes = flist(filter(types, mytype => mytype !== 'null' && mytype !== undefined));
     if (property[keyword`allOf`] || property[keyword`anyOf`] || property[keyword`oneOf`] || property[keyword`not`]) {

package.json

@@ -53,7 +53,7 @@
     "nyc": "^14.1.1",
     "semantic-release": "^15.13.20",
     "unist-util-select": "^3.0.0",
-    "json-logic-js": "axa-ch/json-logic-js"
+    "json-logic-js": "git://github.com/axa-ch/cyclic-schemas-test.git#fix/type-key-exception"
   },
   "engines": {
     "node": ">= 10.0.0"

test/fixtures/type/button.schema.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$id": "http://www.example.com/schemas/components/Button.json",
+  "type": "object",
+  "title": "Button",
+  "description": "Renders a Button.",
+  "additionalProperties": false,
+  "properties": {
+    "properties": {
+      "type": "object",
+      "title": "Properties",
+      "description": "Properties of Button.",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": [
+            "button",
+            "submit",
+            "reset"
+          ],
+          "title": "Type",
+          "description": "The type of the Button (not used for anchors)."
+        }
+      }
+    }
+  }
+}

test/fixtures/type/type.schema.json

@@ -0,0 +1,20 @@
+{
+  "type": "object",
+  "title": "Properties",
+  "description": "Properties of Button.",
+
+  "additionalProperties": false,
+  "properties": {
+    "value": {
+      "type": "string",
+      "title": "Value",
+      "description": "The value of the Button."
+    },
+    "type": {
+      "type": "string",
+      "enum": ["button", "submit", "reset"],
+      "title": "Type",
+      "description": "The type of the Button (not used for anchors)."
+    }
+}
+}

test/markdownBuilder.test.js

@@ -82,6 +82,28 @@ describe('Testing Markdown Builder: title', () => {
   });
 });
 
+describe('Testing Markdown Builder: type', () => {
+  let results;
+
+  before(async () => {
+    const schemas = await loadschemas('type');
+    const builder = build({ header: false });
+    results = builder(schemas);
+  });
+
+  it('Type Schema looks OK', () => {
+    assertMarkdown(results.type)
+      .fuzzy`The type of the Button (not used for anchors).`
+      .print();
+  });
+
+  it('Button Schema looks OK', () => {
+    assertMarkdown(results.button)
+      .fuzzy`## Button Type`
+      .print();
+  });
+});
+
 describe('Testing Markdown Builder: format', () => {
   let results;
 

test/readmeBuilder.test.js

@@ -28,6 +28,16 @@ describe('Testing Readme Builder', () => {
     assert.equal(builder(), null);
   });
 
+  it('Readme Builder builds a README for type', async () => {
+    const schemas = await loadschemas('type');
+    const builder = build({ readme: true });
+    const result = builder(schemas);
+
+    assertMarkdown(result)
+      .contains('# README')
+      .print();
+  });
+
   it('Readme Builder builds a medium README for multiple Schemas', async () => {
     const schemas = await loadschemas('readme-1');
     const builder = build({ readme: true });