Merge pull request #8 from VisualSJ/master-schema

Support inheritance

Author: jwu

lib/main.js

@@ -10,9 +10,11 @@ const path = require('path');
 const schema = require('./utils/schema');
 
 let _url2profile = {};
-let _type2path = {};
 let _url2schema = {};
 
+let _type2path = {};
+let _type2parent = {};
+
 // register profile://
 protocols.register('profile', uri => {
   let base = _type2path[uri.hostname];
@@ -119,6 +121,21 @@ profile.register = function ( type, path ) {
   _type2path[type] = path;
 };
 
+/**
+ * @method inherit
+ * @param {string} type - Current type
+ * @param {string} parent - The parent type
+ * 
+ * Set up a type of inheritance relationship
+ * When the data cannot be found, it will query the data at the parent type
+ */
+profile.inherit = function ( type, parent ) {
+  if (!_type2path[parent]) {
+    console.warn(`The type of inheritance is not registered yet - ${parent}`);
+  }
+  _type2parent[type] = parent;
+};
+
 /**
  * @method reset
  *
@@ -146,6 +163,17 @@ profile.registerSchema = function ( url, json ) {
   if (!_url2profile[url] || !json) {
     return;
   }
+
+  if ( url.indexOf('profile://') !== 0 ) {
+    console.error(`Failed to load profile ${url}: invalid protocol.`);
+    return;
+  }
+
+  let type = url.match(/^profile:\/\/([^\/]+)/)[1];
+
+  if (_type2parent[type]) {
+    console.log(`Failed to register schema ${url}: only root profile can register schema`);
+  }
   _url2schema[url] = schema.json2schema(json);
 };
 
@@ -158,12 +186,26 @@ class _Profile extends EventEmitter {
     super();
     this._url = url;
     this._data = data;
+
+    let match = url.match(/^profile\:\/\/([^\/]+)\/(.*)$/);
+    this._type = match[1];
+    this._file = match[2];
   }
 
   get (key) {
-    let schema = _url2schema[this._url];
+    let schema = this.getSchema(this._type, this._file);
     let target = this._data[key];
 
+    // Find the data on the inheritance chain
+    let type = this._type;
+    while (target === undefined && _type2parent[type]) {
+      let parent = _type2parent[type];
+      let parentUrl = `profile://${parent}/${this._file}`;
+      let patentProfile = _url2profile[parentUrl];
+      target = patentProfile ? patentProfile._data[key] : undefined;
+      type = parent;
+    }
+
     if (schema && target === undefined) {
       let property = schema.properties[key];
       target = property ? property.default : target;
@@ -177,7 +219,8 @@ class _Profile extends EventEmitter {
   }
 
   set (key, value) {
-    let error = schema.validate(_url2schema[this._url], key, value);
+    let json = this.getSchema(this._type, this._file);
+    let error = schema.validate(json, key, value);
     if (error) {
       return console.warn(`Failed to set profile ${key}: ${error}`);
     }
@@ -218,6 +261,14 @@ class _Profile extends EventEmitter {
     this._data = data;
   }
 
+  getSchema () {
+    let type = this._type;
+    while (_type2parent[type]) {
+      type = _type2parent[type];
+    }
+    return _url2schema[`profile://${type}/${this._file}`];
+  }
+
 } // end class Profile
 
 // ==========================

test/unit/inherit.spec.js

@@ -0,0 +1,69 @@
+'use strict';
+
+const path = require('path');
+const fsJetpack = require('fs-jetpack');
+const profile = require('../../index');
+
+suite(tap, 'profile inherit', { timeout: 2000 }, t => {
+  let global = path.join(__dirname, '../fixtures/global');
+  let local = path.join(__dirname, '../fixtures/local');
+  fsJetpack.dir(global);
+  fsJetpack.dir(local);
+
+  profile.register('global', global);
+  profile.register('local', local);
+
+  profile.inherit('local', 'global');
+
+  let globalJson = {
+    foo: 'foo',
+    bar: 'bar'
+  };
+  let localJson = {
+    bar: ''
+  };
+
+  let globalJsonPath = path.join(global, 'inherit.json');
+  let localJsonPath = path.join(local, 'inherit.json');
+  fsJetpack.write(globalJsonPath, globalJson);
+  fsJetpack.write(localJsonPath, localJson);
+
+  let globalProfile = profile.load('profile://global/inherit.json');
+  let localProfile = profile.load('profile://local/inherit.json');
+
+  let globalSchema = {
+      'foo': '',
+      'bar': '',
+      'boolean': true,
+  };
+  let localSchema = {
+      'foo': 0,
+      'bar': 0,
+  };
+  profile.registerSchema('profile://global/inherit.json', globalSchema);
+  profile.registerSchema('profile://local/inherit.json', localSchema);
+
+  t.test('profile inherit', (t) => {
+    t.equal(globalProfile.get('foo'), globalJson['foo']);
+    t.equal(globalProfile.get('bar'), globalJson['bar']);
+    t.equal(localProfile.get('foo'), globalJson['foo']);
+    t.equal(localProfile.get('bar'), localJson['bar']);
+    t.end();
+  });
+
+  t.test('profile inherit and schema', (t) => {
+
+    localProfile.set('foo', 2);
+    t.equal(globalProfile.get('foo'), globalJson['foo']);
+    t.equal(localProfile.get('foo'), globalJson['foo']);
+
+    globalProfile.set('foo', 'abc');
+    t.equal(globalProfile.get('foo'), 'abc');
+    t.equal(localProfile.get('foo'), 'abc');
+
+    t.end();
+  });
+
+  fsJetpack.remove(global);
+  fsJetpack.remove(local);
+});