Implements optional fields

Author: kawasima

README.md

@@ -52,13 +52,15 @@ const sp = require('@json-spec/spec-profiles');
 const sb = require('@json-spec/spec-basic');
 
 const person = s.object({
-  firstName: sp.name({ size: 100 }),
-  lastName:  sp.name({ size: 100 }),
-  birthDay:  sp.birthDay,
-  postalCd:  sp.postalCode_JP,
-  languages: s.array([
-    "C", "C++", "Java"
-  ])
+  required: {
+    firstName: sp.name({ size: 100 }),
+    lastName:  sp.name({ size: 100 }),
+    birthDay:  sp.birthDay,
+    postalCd:  sp.postalCode_JP,
+    languages: s.array([
+      "C", "C++", "Java"
+    ])
+  }
 });
 
 gen.sample(s.gen(person))

examples/tutorial/src/tut1.js

@@ -7,13 +7,17 @@ const sb = require('@json-spec/spec-basic');
  Specification of a person object.
  */
 const person = s.object({
-  firstName: sp.name({ size: 100 }),
-  lastName:  sp.name({ size: 100 }),
-  birthDay:  sp.birthDay,
-  postalCd:  sp.postalCode_JP,
-  languages: s.array([
-    "C", "C++", "Java"
-  ], { distinct: true, maxCount: 3 })
+  required: {
+    firstName: sp.firstName({ size: 100, locale:"ja"}),
+    lastName:  sp.lastName({ size: 100, locale: "ja" }),
+    languages: s.array([
+      "C", "C++", "Java"
+    ], { distinct: true, maxCount: 3 })
+  },
+  optional: {
+    birthDay:  sp.birthDay,
+    postalCd:  sp.postalCode_JP
+  }
 });
 
 console.log(gen.sample(s.gen(person)));

lib/core/src/base.js

@@ -231,15 +231,18 @@ class ObjectSpec extends Spec {
 
   gen(overrides, path, rmap) {
     if (this.gfn) return this.gfn();
-    const generators = {};
+    const requiredGenerators = {};
     for (const k in this.required) {
-      generators[k] = gensub(this.required[k], overrides, [...path, k], rmap, this.required[k]);
+      requiredGenerators[k] = gensub(
+        this.required[k], overrides, [...path, k], rmap, this.required[k]);
     }
-    // TODO optional keys
-    for (const k in this.optional) {
 
+    const optionalGenerators = {};
+    for (const k in this.optional) {
+      optionalGenerators[k] = gensub(
+        this.optional[k], overrides, [...path, k], rmap, this.optional[k]);
     }
-    return g.genObject(generators);
+    return g.genObject(requiredGenerators, optionalGenerators);
   }
 
   explain(path, via, in_, x) {

lib/openapi/README.md

@@ -11,5 +11,11 @@ npm install @json-spec/openapi --save-developers
 example for Mock server
 
 ```
-json-spec-server --openapi=[openapi-specification] --jsonspec=[jsonspec-file]
+json-spec-server --openapi=[openapi-specification] --jsonspec=[jsonspec-file] --port=[listen-port]
+```
+
+example for Mock client
+
+```
+json-spec-client --openapi=[openapi-specification] --jsonspec=[jsonspec-file] --base-url=[base-url]
 ```

lib/openapi/src/core.js

@@ -5,6 +5,28 @@ const SwaggerParser = require('swagger-parser');
 const parser = new SwaggerParser();
 const sb = require('@json-spec/spec-basic');
 const s = require('@json-spec/core');
+const gen = require('@json-spec/core/gen');
+const faker = require('faker')
+
+function stringFormatToSpec(format, jsonSpecs) {
+  switch(format) {
+  case 'date':
+    return s.spec(x => typeof(x) === 'string',
+                  { gen: () => gen.fmap(d => d.getFullYear()
+                                        + '-' + ("0" + (d.getMonth() + 1)).slice(-2)
+                                        + '-' + ("0" + d.getDate()).slice(-2),
+                                        (rnd, size) => faker.date.past()) });
+  case 'date-time':
+    return s.spec(x => typeof(x) === 'string',
+                  { gen: () => gen.fmap(d => eval(JSON.stringify(d)),
+                                        (rnd, size) => faker.date.past()) });
+  case 'password':
+    return s.spec(x => typeof(x) === 'string',
+                  { gen: () => (rnd, size) => faker.internet.password() });
+  default:
+    return sb.string;
+  }
+}
 
 function schemaToSpec(schema, jsonSpecs) {
   if (schema['x-json-spec']) {
@@ -27,7 +49,7 @@ function schemaToSpec(schema, jsonSpecs) {
   case 'array':
     return s.array(schemaToSpec(schema.items, jsonSpecs));
   case 'string':
-    return sb.string;
+    return stringFormatToSpec(schema.format, jsonSpecs);
   case 'number':
     return sb.number;
   case 'integer':

lib/testcheck/src/generators.js

@@ -163,12 +163,24 @@ const generators = {
   get largeInteger() { return largeInteger_({}) },
 }
 
-function genObject(generators) {
+function genObject(requiredGenerators, optionalGenerators) {
   return (rnd, size) => {
     const obj = {};
-    for (k in generators) {
-      obj[k] = callGen(generators[k], rnd, size);
+    for (k in requiredGenerators) {
+      obj[k] = callGen(requiredGenerators[k], rnd, size);
     }
+
+    const optKeys = Object.keys(optionalGenerators);
+    const ary = Array.from({length: optKeys.length}, (v, k) => k);
+    for (let i = ary.length - 1; i >= 0; i--) {
+      const j = callGen(choose(0, i), rnd, size);
+      const tmp = ary[i]; ary[i] = ary[j]; ary[j] = tmp;
+    }
+    const cnt = callGen(choose(0, optKeys.length), rnd, size);
+    ary.slice(cnt).forEach(i => {
+      const k = optKeys[i];
+      obj[k] = callGen(optionalGenerators[k], rnd, size);
+    });
     return obj;
   };
 }

specs/profiles/src/index.js

@@ -20,6 +20,24 @@ const name = ({size=100, locale='en'}) =>
              faker.locale = orig;
              return ret;
            }});
+const firstName = ({size=100, locale='en'}) =>
+      spec(and(basic.string, x => 0 < x.length && x.length <= size),
+           {gen: () => (rnd, size) => {
+             const orig = faker.locale;
+             faker.locale = locale;
+             const ret = faker.name.firstName();
+             faker.locale = orig;
+             return ret;
+           }});
+const lastName = ({size=100, locale='en'}) =>
+      spec(and(basic.string, x => 0 < x.length && x.length <= size),
+           {gen: () => (rnd, size) => {
+             const orig = faker.locale;
+             faker.locale = locale;
+             const ret = faker.name.lastName();
+             faker.locale = orig;
+             return ret;
+           }});
 
 const account = ({size=100}) =>
       spec(and(basic.string, x => 0 < x.length && x.length <= size),
@@ -40,6 +58,8 @@ const birthDay = spec(and(basic.date, range.dateIn(new Date(1900, 1), new Date()
                         gen(range.dateIn(new Date(1900, 1), new Date())))});
 
 module.exports = {
+  firstName,
+  lastName,
   name,
   account,
   email,