More cleaning up and added more tests for merge

A few bug fixes and more tests

Author: Anthropic

README.md

@@ -4,6 +4,9 @@ Core library for working with JSON-Schema with a UI-Schema (Form) definition tha
 This library, through the use of its merge module, combines the schema and ui-schema
 into a canonical schema for use by its services and external libraries.
 
+You **DO NOT** use this file in addition to Angular Schema Form, it is embedded at
+build into any frameworks using it.
+
 ## Work-In-Progress!
 There is [test output](docs/test.md) that forms some super basic documentation
 and I intend to expand them much further to the point of almost being

dist/json-schema-form-core.js.map

@@ -16,12 +16,11 @@ _merge.merge.should.be.an('function');
 
 <a name="mergejs-merge"></a>
 ## merge
-should combine a schema and form definition, regardless of order.
+should handle a schema lookup or schema for first argument.
 
 ```js
-(0, _merge.merge)(schema, ['name', 'gender']).should.be.deep.equal(stdForm.form);
-(0, _merge.merge)(schema, ['gender']).should.be.deep.equal([stdForm.form[1]]);
-(0, _merge.merge)(schema, ['gender', 'name']).should.be.deep.equal([stdForm.form[1], stdForm.form[0]]);
+(0, _merge.merge)(stdForm.lookup, ['name', 'shoe', 'gender']).should.be.deep.equal(stdForm.form);
+(0, _merge.merge)(schema, ['*']).should.be.deep.equal(stdForm.form);
 ```
 
 should handle a wildcard * in the form definition.
@@ -30,12 +29,107 @@ should handle a wildcard * in the form definition.
 (0, _merge.merge)(schema, ['*']).should.be.deep.equal(stdForm.form);
 ```
 
+should not handle a wildcard * if the schema is a lookup.
+
+```js
+(0, _merge.merge)(stdForm.lookup, ['*']).should.not.be.deep.equal(stdForm.form);
+```
+
+should combine a schema and form definition, regardless of order.
+
+```js
+(0, _merge.merge)(schema, ['name', 'shoe', 'gender']).should.be.deep.equal(stdForm.form);
+(0, _merge.merge)(schema, ['gender']).should.be.deep.equal([stdForm.form[2]]);
+(0, _merge.merge)(schema, ['gender', 'name']).should.be.deep.equal([stdForm.form[2], stdForm.form[0]]);
+```
+
 should allow items that are not in the schema.
 
 ```js
 (0, _merge.merge)(schema, ['*', { type: 'fieldset' }]).should.be.deep.equal(stdForm.form.concat([{ type: 'fieldset' }]));
 ```
 
+should translate "readOnly" in schema to "readonly" on the merged form defintion.
+
+```js
+var merged = (0, _merge.merge)(schema, ['gender']);
+merged[0].should.have.property('readonly');
+merged[0].readonly.should.eq(true);
+```
+
+should push readOnly in schema down into objects and arrays.
+
+```js
+var subschema = {
+  'type': 'object',
+  'readOnly': true,
+  'properties': {
+    'sub': {
+      'type': 'object',
+      'properties': {
+        'array': {
+          'type': 'array',
+          'items': {
+            'type': 'object',
+            'properties': {
+              'foo': {
+                'type': 'string'
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+};
+var merged = (0, _merge.merge)(subschema, ['*']);
+//sub
+merged[0].should.have.property('readonly');
+merged[0].readonly.should.eq(true);
+//array
+merged[0].items[0].should.have.property('readonly');
+merged[0].items[0].readonly.should.eq(true);
+//array items
+merged[0].items[0].items[0].should.have.property('readonly');
+merged[0].items[0].items[0].readonly.should.eq(true);
+```
+
+should push readonly in form def down into objects and arrays.
+
+```js
+var subschema = {
+  'type': 'object',
+  'properties': {
+    'sub': {
+      'type': 'object',
+      'properties': {
+        'array': {
+          'type': 'array',
+          'items': {
+            'type': 'object',
+            'properties': {
+              'foo': {
+                'type': 'string'
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+};
+var merged = (0, _merge.merge)(subschema, [{ key: 'sub', readonly: true }]);
+//sub
+merged[0].should.have.property('readonly');
+merged[0].readonly.should.eq(true);
+//array
+merged[0].items[0].should.have.property('readonly');
+merged[0].items[0].readonly.should.eq(true);
+//array items
+merged[0].items[0].items[0].should.have.property('readonly');
+merged[0].items[0].items[0].readonly.should.eq(true);
+```
+
 <a name="schema-defaultsjs"></a>
 # schema-defaults.js
 should hold functions for generating a default form schema from defaults it creates.

docs/test.md

@@ -1,10 +1,11 @@
 {
   "name": "json-schema-form-core",
-  "version": "1.0.0-alpha.5",
+  "version": "1.0.0-alpha.6",
   "description": "JSON-Schema and JSON-UI-Schema utilities for form generation.",
   "main": "dist/json-schema-form-core.js",
   "scripts": {
     "build": "webpack",
+    "dist-untested": "webpack --config webpack.config.dist.js",
     "tslint": "tslint \"src/**/*.ts\"",
     "test": "mocha --opts .mocha",
     "testdoc": "mocha --opts .mocha && mocha --opts .mocha.md > docs/test.md"

package.json

@@ -3,19 +3,23 @@ import { defaultForm, createDefaults } from './schema-defaults';
 import canonicalTitleMap from './canonical-title-map';
 
 // export function merge(schema, form, schemaDefaultTypes, ignore, options, readonly, asyncTemplates) {
-export function merge(lookup, form, options, readonly, asyncTemplates) {
+export function merge(lookup, form, ignore, options, readonly, asyncTemplates) {
+  let formItems = [];
   form  = form || [];
+  let idx = form.indexOf('*');
   options = options || {};
 
-  const stdForm = defaultForm(lookup, createDefaults());
   if(typeof lookup === 'object' && lookup.hasOwnProperty('properties')) {
-    let defaultForm = stdForm.lookup;
-    lookup = defaultForm || lookup;
+    readonly = readonly || lookup.readonly || lookup.readOnly;
+    const stdForm = defaultForm(lookup, createDefaults(), ignore, options);
+    let defaultFormLookup = stdForm.lookup;
+
+    lookup = defaultFormLookup || lookup;
+    formItems = formItems.concat(stdForm.form);
   };
 
-  let idx = form.indexOf('*');
   if (idx !== -1) {
-    form = form.slice(0, idx).concat(stdForm.form).concat(form.slice(idx + 1));
+    form = form.slice(0, idx).concat(formItems).concat(form.slice(idx + 1));
   };
 
   // ok let's merge!
@@ -59,14 +63,14 @@ export function merge(lookup, form, options, readonly, asyncTemplates) {
 
     // if it's a type with items, merge 'em!
     if (obj.items) {
-      obj.items = merge(lookup, obj.items, options, obj.readonly, asyncTemplates);
+      obj.items = merge(lookup, obj.items, ignore, options, obj.readonly, asyncTemplates);
     }
 
     // if its has tabs, merge them also!
     if (obj.tabs) {
       obj.tabs.forEach((tab) => {
         if (tab.items) {
-          tab.items = merge(lookup, tab.items, options, obj.readonly, asyncTemplates);
+          tab.items = merge(lookup, tab.items, ignore, options, obj.readonly, asyncTemplates);
         }
       });
     }

src/lib/merge.js

@@ -28,6 +28,17 @@ describe('merge.js', () => {
         "description": "Gimme yea name lad",
         "type": "string"
       },
+      "shoe": {
+        "title": "Shoes",
+        "description": "Shoe details",
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "brand": {"type":"string"}
+          }
+        }
+      },
       "gender": {
         "readOnly": true,
         "title": "Choose",
@@ -48,53 +59,38 @@ describe('merge.js', () => {
   })
 
   describe('merge', () => {
-    it('should combine a schema and form definition, regardless of order', () => {
-      merge(schema, ['name','gender']).should.be.deep.equal(stdForm.form);
-      merge(schema, ['gender']).should.be.deep.equal([stdForm.form[1]]);
-      merge(schema, ['gender','name']).should.be.deep.equal([stdForm.form[1],stdForm.form[0]]);
+    it('should handle a schema lookup or schema for first argument', () => {
+      merge(stdForm.lookup, ['name','shoe','gender']).should.be.deep.equal(stdForm.form);
+      merge(schema, ['*']).should.be.deep.equal(stdForm.form);
     });
 
     it('should handle a wildcard * in the form definition', () => {
       merge(schema, ['*']).should.be.deep.equal(stdForm.form);
     });
 
+    it('should not handle a wildcard * if the schema is a lookup', () => {
+      merge(stdForm.lookup, ['*']).should.not.be.deep.equal(stdForm.form);
+    });
+
+    it('should combine a schema and form definition, regardless of order', () => {
+      merge(schema, ['name','shoe','gender']).should.be.deep.equal(stdForm.form);
+      merge(schema, ['gender']).should.be.deep.equal([stdForm.form[2]]);
+      merge(schema, ['gender','name']).should.be.deep.equal([stdForm.form[2],stdForm.form[0]]);
+    });
+
+
     it('should allow items that are not in the schema', () => {
       merge(schema, ['*', { type:'fieldset' }]).should.be.deep.equal(stdForm.form.concat([{ type:'fieldset' }]));
     });
-  });
-/**
-  it('should translate "readOnly" in schema to "readonly" on the merged form defintion', () => {
-    inject(function(schemaForm){
-      var schema = {
-        "type": "object",
-        "properties": {
-          "name": {
-            "title": "Name",
-            "description": "Gimme yea name lad",
-            "type": "string"
-          },
-          "gender": {
-            "readOnly": true,
-            "title": "Choose",
-            "type": "string",
-            "enum": [
-              "undefined",
-              "null",
-              "NaN",
-            ]
-          }
-        }
-      };
 
-      var merged = schemaForm.merge(schema, ['gender']);
+    it('should translate "readOnly" in schema to "readonly" on the merged form defintion', () => {
+      var merged = merge(schema, ['gender']);
       merged[0].should.have.property('readonly');
       merged[0].readonly.should.eq(true)
     });
-  });
 
-  it('should push readOnly in schema down into objects and arrays', () => {
-    inject(function(schemaForm) {
-      var schema = {
+    it('should push readOnly in schema down into objects and arrays', () => {
+      let subschema = {
         'type': 'object',
         'readOnly': true,
         'properties': {
@@ -117,7 +113,7 @@ describe('merge.js', () => {
         }
       };
 
-      var merged = schemaForm.merge(schema, ['*']);
+      var merged = merge(subschema, ['*']);
 
       //sub
       merged[0].should.have.property('readonly');
@@ -130,13 +126,10 @@ describe('merge.js', () => {
       //array items
       merged[0].items[0].items[0].should.have.property('readonly');
       merged[0].items[0].items[0].readonly.should.eq(true);
-
     });
-  });
 
-  it('should push readonly in form def down into objects and arrays', () => {
-    inject(function(schemaForm) {
-      var schema = {
+    it('should push readonly in form def down into objects and arrays', () => {
+      let subschema = {
         'type': 'object',
         'properties': {
           'sub': {
@@ -158,7 +151,7 @@ describe('merge.js', () => {
         }
       };
 
-      var merged = schemaForm.merge(schema, [{key: 'sub', readonly: true}]);
+      var merged = merge(subschema, [{key: 'sub', readonly: true}]);
 
       //sub
       merged[0].should.have.property('readonly');
@@ -171,8 +164,6 @@ describe('merge.js', () => {
       //array items
       merged[0].items[0].items[0].should.have.property('readonly');
       merged[0].items[0].items[0].readonly.should.eq(true);
-
     });
   });
-*/
 });

src/lib/merge.spec.js

@@ -0,0 +1,12 @@
+const config = require('./webpack.config.js');
+const path = require('path');
+const includes = [
+  path.join(__dirname, 'src', 'lib', 'index')
+];
+
+config.entry = {
+  "json-schema-form-core": includes,
+  "json-schema-form-core.min": includes
+}
+
+module.exports = config;

webpack.config.dist.js

@@ -1,9 +1,9 @@
 /* global __dirname */
-var webpack = require('webpack');
-var path = require('path');
-var pjson = require('./package.json');
-var library = 'JSONSchemaFormCore';
-console.log('JSON Schema Form Core v' + pjson.version);
+const webpack = require('webpack');
+const path = require('path');
+const package = require('./package.json');
+const buildDate = new Date();
+console.log('JSON Schema Form Core v' + package.version);
 const plugins = [
   new webpack.BannerPlugin(
     'json-schema-form-core\n' +
@@ -19,14 +19,15 @@ const plugins = [
       minimize: true
     })
 ];
+let library = 'JSONSchemaFormCore';
 
 module.exports = {
   entry: {
-    "lib": './src/lib/index'
+    "json-schema-form-core": [ path.join(__dirname, 'src', 'lib', 'index') ]
   },
   output: {
     path: path.join(__dirname, 'dist'),
-    filename: 'json-schema-form-core.js',
+    filename: '[name].js',
     library: library,
     libraryTarget: 'commonjs2'
   },