Added resolvedDataStructures instead of expanding named types in-place

README.md

@@ -54,19 +54,22 @@ $ drafter blueprint.apib
 
 ## Resolved Named Types
 
-Named Types (and anonymous named types) are expanded in-place in the AST. The three rules for when MSON AST is expanded are:
+The three rules for when MSON AST is expanded are:
 
 * If a named type is a sub-type of another named type
 * If a named types includes a mixin
 * If a value member or property member is referencing a named type
 
+The expanded data structures are added to the array which has the original data structures with their element name set to `resolvedDataStructure`.
+
 ## Resolved Assets
 
 The resolved assets for a *payload body example* and *payload body schema* are added to the array in the `content` key of the **Payload Object** with their element name set to `resolvedAsset` and `role` in `attributes` set as `bodyExample` and `bodySchema` respectively.
 
+A sample part of payload object is given below
+
 ```json
 {
-  // This is the payload object
   "content": [
     {
       "element": "resolvedAsset",

package.json

@@ -16,11 +16,13 @@
     "prepublish": "scripts/build"
   },
   "dependencies": {
+    "async": "~0.9.0",
+    "boutique": "git+ssh://[email protected]:apiaryio/boutique.git",
     "coffee-script": "~1.7.1",
-    "yargs": "~1.3.3",
+    "deep-equal": "1.0.x",
+    "deepcopy": "0.4.x",
     "protagonist-experimental": "0.18.6",
-    "async": "~0.9.0",
-    "boutique": "git+ssh://[email protected]:apiaryio/boutique.git"
+    "yargs": "~1.3.3"
   },
   "devDependencies": {
     "chai": "~1.10.0",

src/drafter.coffee

@@ -3,6 +3,8 @@ boutique = require 'boutique'
 options = require './options'
 fs = require 'fs'
 async = require 'async'
+deepcopy = require 'deepcopy'
+deepEqual = require 'deep-equal'
 
 # Gather all payloads from the given parse result
 #
@@ -85,6 +87,10 @@ class Drafter
 
   # List of data structures
   @dataStructures: {}
+  @origDataStructures: {}
+
+  # References denoting where to append the resolved data structures
+  @appendResolved: {}
 
   # Default configuration
   @defaultConfig:
@@ -121,6 +127,9 @@ class Drafter
       rules = (require './rules/' + rule for rule in ruleList)
 
       @dataStructures = {}
+      @origDataStructures = {}
+      @appendResolved = {}
+
       delete result.ast.resourceGroups
 
       @expandNode result.ast, rules, 'blueprint'
@@ -168,15 +177,27 @@ class Drafter
 
             switch subElement.element
               when 'dataStructure'
-                @dataStructures[subElement.name.literal] = subElement
+                @dataStructures[subElement.name.literal] = deepcopy subElement
+                @origDataStructures[subElement.name.literal] = subElement
+                @appendResolved[subElement.name.literal] = element.content
               when 'resource'
                 for resourceSubElement in subElement.content
-                  @dataStructures[resourceSubElement.name.literal] = resourceSubElement if resourceSubElement.element is 'dataStructure'
+                  if resourceSubElement.element is 'dataStructure'
+
+                    @dataStructures[resourceSubElement.name.literal] = deepcopy resourceSubElement
+                    @origDataStructures[resourceSubElement.name.literal] = resourceSubElement
+                    @appendResolved[resourceSubElement.name.literal] = subElement.content
 
       # Expand the gathered data structures
       for rule in rules
         rule.init.call rule, @dataStructures if rule.init
 
+      # Append resolved data structures
+      for name, dataStructure of @dataStructures
+        if not deepEqual dataStructure, @origDataStructures[name]
+          dataStructure.element = 'resolvedDataStructure'
+          @appendResolved[name].push dataStructure
+
     # Apply rules to the current node
     for rule in rules
       rule[elementType].call rule, node if elementType in Object.keys(rule)

test/fixtures/dataStructures.apib

@@ -89,7 +89,7 @@ A clone of Coupon to be used for testing
 ## Subscription
 + id: 1000 (number)
 + plan: `Startup` (string) - Subscription plan name
-+ coupon (Coupon Base) - Coupon represting any existing discounts used by the customer during the subscription
++ coupon (Coupon Base) - Coupon representing any existing discounts used by the customer during the subscription
 + One Of
     + Include Timestamps
     + Properties