Merge pull request #710 from apiaryio/tjanc/fix-709

Support top level Reference Element when translating API Elements to JSON & JSON Schema
apiaryio · May 31, 2019 · 8d6762d · 8d6762d
2 parents 5b0f267 + ea42d1e
commit 8d6762d
Show file tree

Hide file tree

Showing 8 changed files with 609 additions and 22 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,12 @@
 
 ## Master
 
+### Bug Fixes
+
+* JSON value & JSON schema backends now support top-level Reference Elements.
+  This prevents crashes on `Include` statements in `enum` contexts.
+  [#709](https://github.com/apiaryio/drafter/issues/709)
+
 ### Enhancements
 
 * The default build type is now release when using cmake.

diff --git a/src/refract/JsonSchema.cc b/src/refract/JsonSchema.cc
@@ -323,28 +323,29 @@ namespace
     void renderProperty(ObjectSchema& s, const ExtendElement& e, TypeAttributes options);
     void renderProperty(ObjectSchema& s, const IElement& e, TypeAttributes options);
 
-    so::Object& renderSchema(so::Object& schema, const ObjectElement& e, TypeAttributes options);
-    so::Object& renderSchema(so::Object& schema, const ArrayElement& e, TypeAttributes options);
-    so::Object& renderSchema(so::Object& schema, const EnumElement& e, TypeAttributes options);
-    so::Object& renderSchema(so::Object& schema, const NullElement& e, TypeAttributes options);
-    so::Object& renderSchema(so::Object& schema, const StringElement& e, TypeAttributes options);
-    so::Object& renderSchema(so::Object& schema, const NumberElement& e, TypeAttributes options);
-    so::Object& renderSchema(so::Object& schema, const BooleanElement& e, TypeAttributes options);
-    so::Object& renderSchema(so::Object& schema, const ExtendElement& e, TypeAttributes options);
+    so::Object& renderSchemaSpecific(so::Object& schema, const ObjectElement& e, TypeAttributes options);
+    so::Object& renderSchemaSpecific(so::Object& schema, const ArrayElement& e, TypeAttributes options);
+    so::Object& renderSchemaSpecific(so::Object& schema, const EnumElement& e, TypeAttributes options);
+    so::Object& renderSchemaSpecific(so::Object& schema, const NullElement& e, TypeAttributes options);
+    so::Object& renderSchemaSpecific(so::Object& schema, const StringElement& e, TypeAttributes options);
+    so::Object& renderSchemaSpecific(so::Object& schema, const NumberElement& e, TypeAttributes options);
+    so::Object& renderSchemaSpecific(so::Object& schema, const BooleanElement& e, TypeAttributes options);
+    so::Object& renderSchemaSpecific(so::Object& schema, const ExtendElement& e, TypeAttributes options);
+    so::Object& renderSchemaSpecific(so::Object& schema, const RefElement& e, TypeAttributes options);
     so::Object& renderSchema(so::Object& schema, const IElement& e, TypeAttributes options);
 
     template <typename T>
     void renderProperty(ObjectSchema&, const T& e, so::Object&, TypeAttributes)
     {
         LOG(error) << "invalid property element: " << e.element();
-        assert(false);
+        abort();
     }
 
     template <typename T>
-    so::Object& renderSchema(so::Object& s, so::Object&, const T& e, TypeAttributes)
+    so::Object& renderSchemaSpecific(so::Object& s, const T& e, TypeAttributes)
     {
         LOG(error) << "invalid top level element: " << e.element();
-        assert(false);
+        abort();
         return s;
     }
 
@@ -355,7 +356,7 @@ namespace
         template <typename ElementT>
         void operator()(const ElementT& el)
         {
-            renderSchema(*schemaPtr, el, options);
+            renderSchemaSpecific(*schemaPtr, el, options);
         }
     };
 
@@ -389,8 +390,13 @@ so::Object schema::generateJsonSchema(const IElement& el)
 
 namespace
 {
+    so::Object& renderSchemaSpecific(so::Object& s, const RefElement& e, TypeAttributes options)
+    {
+        const auto& resolved = resolve(e);
+        return renderSchema(s, resolved, passFlags(options));
+    }
 
-    so::Object& renderSchema(so::Object& s, const ObjectElement& e, TypeAttributes options)
+    so::Object& renderSchemaSpecific(so::Object& s, const ObjectElement& e, TypeAttributes options)
     {
         constexpr const char* TYPE_NAME = "object";
 
@@ -421,7 +427,7 @@ namespace
         return schema;
     }
 
-    so::Object& renderSchema(so::Object& s, const ArrayElement& e, TypeAttributes options)
+    so::Object& renderSchemaSpecific(so::Object& s, const ArrayElement& e, TypeAttributes options)
     {
         constexpr const char* TYPE_NAME = "array";
 
@@ -463,7 +469,7 @@ namespace
         return s;
     }
 
-    so::Object& renderSchema(so::Object& schema, const EnumElement& e, TypeAttributes options)
+    so::Object& renderSchemaSpecific(so::Object& schema, const EnumElement& e, TypeAttributes options)
     {
         options = updateTypeAttributes(e, options);
 
@@ -524,7 +530,7 @@ namespace
         return schema;
     }
 
-    so::Object& renderSchema(so::Object& schema, const NullElement& e, TypeAttributes options)
+    so::Object& renderSchemaSpecific(so::Object& schema, const NullElement& e, TypeAttributes options)
     {
         addType(schema, "null");
         return schema;
@@ -573,22 +579,22 @@ namespace
         return s;
     }
 
-    so::Object& renderSchema(so::Object& s, const StringElement& e, TypeAttributes options)
+    so::Object& renderSchemaSpecific(so::Object& s, const StringElement& e, TypeAttributes options)
     {
         return renderSchemaPrimitive(s, e, options);
     }
 
-    so::Object& renderSchema(so::Object& s, const NumberElement& e, TypeAttributes options)
+    so::Object& renderSchemaSpecific(so::Object& s, const NumberElement& e, TypeAttributes options)
     {
         return renderSchemaPrimitive(s, e, options);
     }
 
-    so::Object& renderSchema(so::Object& s, const BooleanElement& e, TypeAttributes options)
+    so::Object& renderSchemaSpecific(so::Object& s, const BooleanElement& e, TypeAttributes options)
     {
         return renderSchemaPrimitive(s, e, options);
     }
 
-    so::Object& renderSchema(so::Object& s, const ExtendElement& e, TypeAttributes options)
+    so::Object& renderSchemaSpecific(so::Object& s, const ExtendElement& e, TypeAttributes options)
     {
         auto merged = e.get().merge();
         renderSchema(s, *merged, options);

diff --git a/src/refract/JsonValue.cc b/src/refract/JsonValue.cc
@@ -86,13 +86,14 @@ namespace
     so::Value renderValueSpecific(const NumberElement& element, TypeAttributes options);
     so::Value renderValueSpecific(const BooleanElement& element, TypeAttributes options);
     so::Value renderValueSpecific(const ExtendElement& element, TypeAttributes options);
+    so::Value renderValueSpecific(const RefElement& element, TypeAttributes options);
     so::Value renderValue(const IElement& element, TypeAttributes options);
 
     template <typename T>
     void renderProperty(so::Object&, const T& element, TypeAttributes)
     {
         LOG(error) << "invalid property element: " << element.element();
-        assert(false);
+        abort();
     }
 
     template <typename Element>
@@ -117,7 +118,7 @@ namespace
     so::Value renderValueSpecific(const T& element, TypeAttributes)
     {
         LOG(error) << "invalid top level element: " << element.element();
-        assert(false);
+        abort();
         return so::Null{}; // unreachable
     }
 
@@ -284,6 +285,12 @@ namespace
         return renderValue(*merged, options);
     }
 
+    so::Value renderValueSpecific(const RefElement& element, TypeAttributes options)
+    {
+        const auto& resolved = resolve(element);
+        return renderValue(resolved, passFlags(options));
+    }
+
 } // namespace
 
 namespace

diff --git a/test/fixtures/mson/issue-709-b.apib b/test/fixtures/mson/issue-709-b.apib
@@ -0,0 +1,17 @@
+# GET /
+
++ Response 200 (application/json)
+    + Attributes
+        + code (Post Code)
+
+# Data Structures
+
+## Post Code (enum)
+
++ Include East Code
+
+## East Code (enum)
+
++ EC2A
++ E1
+