Merge pull request #55 from apiaryio/pksunkara/fix

Don't error when there is empty OneOf
apiaryio · Apr 30, 2015 · d881db4 · d881db4
2 parents 8499bf0 + 4b3708c
commit d881db4
Show file tree

Hide file tree

Showing 10 changed files with 208 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 lib
 node_modules
+.idea
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "boutique",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "author": "Apiary.io <support@apiary.io>",
   "description": "The finest representations to emphasize natural beauty of your MSON AST",
   "license": "MIT",

diff --git a/src/formats/json.coffee b/src/formats/json.coffee
@@ -47,6 +47,8 @@ resolveProperties = (props, inherited, cb) ->
   results = []
   async.eachSeries props, (prop, next) ->
     if prop.class is 'oneOf'
+      return next() if !prop.content.length
+
       # oneOf can result in multiple properties
       resolveOneOf prop, inherited, (err, resolvedProps) ->
         results = results.concat resolvedProps

diff --git a/src/formats/jsonschema-v4.coffee b/src/formats/jsonschema-v4.coffee
@@ -35,6 +35,8 @@ addDefault = (element, resolvedType, repr, cb) ->
 # object with both representation in JSON Schema and optionally also
 # some additional info.
 resolveProperty = (prop, inherited, cb) ->
+  return cb(null, {}) if prop.class is 'oneOf'
+
   handleElement prop, inherited, (err, repr) ->
     return cb err if err
 

diff --git a/src/inspect.coffee b/src/inspect.coffee
@@ -27,7 +27,7 @@ findTypeName = (typeSpec) ->
 # Finds type name within *Element* node of *property* class.
 findPropertyName = (propNode, variable = true) ->
   nameNode = propNode.content.name
-  nameNode.literal or (nameNode.variable?.values?[0].literal if variable)
+  nameNode.literal or (nameNode.variable?.values?[0]?.literal if variable)
 
 
 # Finds inline description for given *Element* node.

diff --git a/test/formats/formats-test.coffee b/test/formats/formats-test.coffee
@@ -88,6 +88,7 @@ testFormat
     # 'one-of'
     # 'one-of-complex'
     # 'one-of-properties'
+    # 'one-of-empty'
     'optional'
     'required'
     'required-array'
@@ -150,6 +151,7 @@ testFormat
     'one-of'
     'one-of-complex'
     'one-of-properties'
+    'one-of-empty'
     'optional'
     'required'
     'required-array'
@@ -161,4 +163,5 @@ testFormat
     'string'
     'string-literal'
     'variable-property'
+    'deep-nested'
   ]
diff --git a/test/formats/samples-ast/deep-nested.json b/test/formats/samples-ast/deep-nested.json
@@ -0,0 +1,139 @@
+{
+  "element": "resolvedDataStructure",
+  "name": null,
+  "typeDefinition": {
+    "typeSpecification": {
+      "name": "object",
+      "nestedTypes": []
+    },
+    "attributes": []
+  },
+  "sections": [
+    {
+      "class": "memberType",
+      "content": [
+        {
+          "content": {
+            "name": {
+              "literal": "a"
+            },
+            "description": "",
+            "valueDefinition": {
+              "values": [
+                {
+                  "literal": "b",
+                  "variable": false
+                }
+              ],
+              "typeDefinition": {
+                "typeSpecification": {
+                  "name": null,
+                  "nestedTypes": []
+                },
+                "attributes": []
+              }
+            },
+            "sections": []
+          },
+          "class": "property"
+        },
+        {
+          "content": {
+            "name": {
+              "literal": "c"
+            },
+            "description": "",
+            "valueDefinition": {
+              "values": [],
+              "typeDefinition": {
+                "typeSpecification": {
+                  "name": "array",
+                  "nestedTypes": []
+                },
+                "attributes": []
+              }
+            },
+            "sections": [
+              {
+                "class": "memberType",
+                "content": [
+                  {
+                    "content": {
+                      "description": "",
+                      "valueDefinition": {
+                        "values": [],
+                        "typeDefinition": {
+                          "typeSpecification": {
+                            "name": "object",
+                            "nestedTypes": []
+                          },
+                          "attributes": []
+                        }
+                      },
+                      "sections": [
+                        {
+                          "class": "memberType",
+                          "content": [
+                            {
+                              "content": {
+                                "name": {
+                                  "literal": "id"
+                                },
+                                "description": "",
+                                "valueDefinition": {
+                                  "values": [
+                                    {
+                                      "literal": "pavan",
+                                      "variable": false
+                                    }
+                                  ],
+                                  "typeDefinition": {
+                                    "typeSpecification": {
+                                      "name": null,
+                                      "nestedTypes": []
+                                    },
+                                    "attributes": []
+                                  }
+                                },
+                                "sections": []
+                              },
+                              "class": "property"
+                            }
+                          ]
+                        }
+                      ]
+                    },
+                    "class": "value"
+                  },
+                  {
+                    "content": {
+                      "description": "",
+                      "valueDefinition": {
+                        "values": [
+                          {
+                            "literal": "pkumar",
+                            "variable": false
+                          }
+                        ],
+                        "typeDefinition": {
+                          "typeSpecification": {
+                            "name": null,
+                            "nestedTypes": []
+                          },
+                          "attributes": []
+                        }
+                      },
+                      "sections": []
+                    },
+                    "class": "value"
+                  }
+                ]
+              }
+            ]
+          },
+          "class": "property"
+        }
+      ]
+    }
+  ]
+}
diff --git a/test/formats/samples-ast/one-of-empty.json b/test/formats/samples-ast/one-of-empty.json
@@ -0,0 +1,47 @@
+{
+  "element": "resolvedDataStructure",
+  "name": null,
+  "typeDefinition": {
+    "typeSpecification": {
+      "name": "object",
+      "nestedTypes": []
+    },
+    "attributes": []
+  },
+  "sections": [
+    {
+      "class": "memberType",
+      "content": [
+        {
+          "class": "property",
+          "content": {
+            "name": {
+              "literal": "city"
+            },
+            "description": "",
+            "valueDefinition": {
+              "values": [
+                {
+                  "literal": "prague",
+                  "variable": false
+                }
+              ],
+              "typeDefinition": {
+                "typeSpecification": {
+                  "name": null,
+                  "nestedTypes": []
+                },
+                "attributes": []
+              }
+            },
+            "sections": []
+          }
+        },
+        {
+          "class": "oneOf",
+          "content": []
+        }
+      ]
+    }
+  ]
+}
diff --git a/test/formats/samples-json/deep-nested.json b/test/formats/samples-json/deep-nested.json
@@ -0,0 +1,9 @@
+{
+  "a": "b",
+  "c": [
+    {
+      "id": "pavan"
+    },
+    "pkumar"
+  ]
+}
diff --git a/test/formats/samples-json/one-of-empty.json b/test/formats/samples-json/one-of-empty.json
@@ -0,0 +1,3 @@
+{
+  "city": "prague"
+}