[#41] Strategy for serializing Annotations?

Fix read/write of annotations details as JSON object.

Author: ghillairet

src/resource.js

@@ -48,6 +48,23 @@ Ecore.JSON = {
             };
         }
 
+        function processAnnotation(node, eObject) {
+            if (node.source) {
+                eObject.set('source', node.source);
+            }
+
+            if (node.details) {
+                if (_.isArray(node.details)) {
+
+                } else {
+                    var details = eObject.get('details');
+                    _.each(node.details, function(v, k) {
+                        details.add(Ecore.EStringToStringMapEntry.create({ 'key': k, 'value': v }));
+                    });
+                }
+            }
+        }
+
         function resolveReferences() {
             var index = buildIndex(model);
 
@@ -102,7 +119,11 @@ Ecore.JSON = {
                         child._id = object._id;
                     }
 
-                    _.each(eClass.get('eAllStructuralFeatures'), processFeature(object, child));
+                    if (eClass === Ecore.EAnnotation) {
+                        processAnnotation(object, child);
+                    } else {
+                        _.each(eClass.get('eAllStructuralFeatures'), processFeature(object, child));
+                    }
                 }
             }
 
@@ -183,14 +204,35 @@ Ecore.JSON = {
             };
         }
 
+        function processAnnotation(object, data) {
+            if (object.values.source) {
+                data.source = object.values.source;
+            }
+
+            if (object.values.details && object.values.details.size() > 0) {
+                data.details = {};
+                object.values.details.each(function (e) {
+                    var key = e.get("key");
+                    var value = e.get("value");
+                    if (key) {
+                        data.details[key] = value;
+                    }
+                });
+            }
+        }
+
         function jsonObject(object) {
             var eClass = object.eClass,
                 values = object.values,
                 data = { eClass: eClass.eURI() };
 
             if (object._id) { data._id = object._id; }
 
-            _.each( values, processFeature(object, data) );
+            if (eClass === Ecore.EAnnotation) {
+                processAnnotation(object, data);
+            } else {
+                _.each(values, processFeature(object, data));
+            }
 
             return data;
         }

test/annotations.test.js

@@ -0,0 +1,61 @@
+var assert = require('assert');
+var Ecore = require('../dist/ecore');
+var _ = require('underscore');
+var fs = require('fs');
+
+describe('Annotations', function () {
+
+    it('should read an ecore file containing annotations', function (done) {
+        var resourceSet = Ecore.ResourceSet.create();
+        var model = resourceSet.create({uri: 'http://www.example.org/example'});
+
+        fs.readFile('./test/models/annotations.json', 'utf8', function (err, data) {
+            if (err) {
+                console.log(err);
+                done();
+                return;
+            }
+
+            model.load(data, function (model, err) {
+                if (err) {
+                    console.log(err);
+                    done();
+                    return;
+                }
+
+                var pp = model.get('contents').at(0);
+                var fooClass = pp.get('eClassifiers').at(0);
+
+                assert.ok(fooClass);
+                assert.equal(1, fooClass.get('eAnnotations').size());
+
+                var details = fooClass.get('eAnnotations').at(0).get('details');
+
+                assert.equal("displayName", details.at(0).get('key'));
+                assert.equal("value", details.at(0).get('value'));
+
+                assert.equal("otherName", details.at(1).get('key'));
+                assert.equal("otherValue", details.at(1).get('value'));
+
+                done();
+            }, {format: Ecore.JSON});
+        });
+    });
+
+    it('should write annotations as object', function (done) {
+        var resourceSet = Ecore.ResourceSet.create();
+        var model = resourceSet.create({uri: 'http://www.example.org/example'});
+
+        fs.readFile('./test/models/annotations.json', 'utf8', function (err, data) {
+
+            model.load(data, function (model, err) {
+                var result = Ecore.JSON.to(model);
+
+                assert.equal("value", result.eClassifiers[0].eAnnotations[0].details.displayName);
+                assert.equal("otherValue", result.eClassifiers[0].eAnnotations[0].details.otherName);
+                done();
+            }, {format: Ecore.JSON});
+        });
+    });
+
+});

test/models/annotations.json

@@ -0,0 +1,21 @@
+{
+  "eClass": "http://www.eclipse.org/emf/2002/Ecore#//EPackage",
+  "name": "example",
+  "nsURI": "http://www.example.org/example",
+  "nsPrefix": "example",
+  "eClassifiers": [
+    {
+      "eClass": "http://www.eclipse.org/emf/2002/Ecore#//EClass",
+      "name": "Foo",
+      "eAnnotations": [
+        {
+          "source": "source",
+          "details": {
+            "displayName": "value",
+            "otherName": "otherValue"
+          }
+        }
+      ]
+    }
+  ]
+}