Merge pull request #397 from richardlay/master

Added option to use "label" as the next model name prefix

Author: glennjones

lib/builder.js

@@ -240,6 +240,7 @@ internals.removeNoneSchemaOptions = function(options) {
         'reuseDefinitions',
         'uiCompleteScript',
         'deReference',
+        'definitionPrefix',
         'validatorUrl',
         'jsonEditor',
         'acceptToProduce',

lib/defaults.js

@@ -20,6 +20,7 @@ module.exports = {
     'uiCompleteScript': null,
     'xProperties': true,
     'reuseDefinitions': true,
+    'definitionPrefix': 'default',
     'deReference': false,
     'validatorUrl': '//online.swagger.io/validator',
     'acceptToProduce': true,  // internal, NOT public

lib/definitions.js

@@ -44,11 +44,11 @@ internals.definitions.prototype.append = function (definitionName, definition, c
             out = definitionName;
         } else {
             // create new definition
-            out = internals.append(null, definition, currentCollection, settings);
+            out = internals.append(definitionName, definition, currentCollection, true, settings);
         }
     } else {
         // create new definition
-        out = internals.append(definitionName, definition, currentCollection, settings);
+        out = internals.append(definitionName, definition, currentCollection, false, settings);
     }
 
     return out;
@@ -64,7 +64,7 @@ internals.definitions.prototype.append = function (definitionName, definition, c
  * @param  {Object} settings
  * @return {String}
  */
-internals.append = function (definitionName, definition, currentCollection, settings) {
+internals.append = function (definitionName, definition, currentCollection, forceDynamicName, settings) {
 
     let out;
     let foundDefinitionName;
@@ -79,7 +79,17 @@ internals.append = function (definitionName, definition, currentCollection, sett
         out = foundDefinitionName;
     } else {
         // else create a new item using definitionName or next model number
-        out = definitionName || internals.nextModelName(currentCollection);
+        if (forceDynamicName) {
+            if (settings.definitionPrefix === 'useLabel') {
+                out = internals.nextModelName(definitionName + ' ', currentCollection);
+            }
+            else {
+                out = internals.nextModelName('Model ', currentCollection);
+            }
+        }
+        else {
+            out = definitionName || internals.nextModelName('Model ', currentCollection);
+        }
         currentCollection[out] = definition;
     }
     return out;
@@ -126,22 +136,22 @@ internals.hash = function (obj) {
 /**
  * creates a new unique model name
  *
+ * @param  {String} nextModelNamePrefix
  * @param  {Object} currentCollection
  * @return {String}
  */
-internals.nextModelName = function (currentCollection) {
-
+internals.nextModelName = function (nextModelNamePrefix, currentCollection) {
     let highest = 0;
     let key;
     for (key in currentCollection) {
-        if (Utilities.startsWith(key, 'Model')) {
-            let num = parseInt(key.replace('Model', ''), 10);
+        if (Utilities.startsWith(key, nextModelNamePrefix)) {
+            let num = parseInt(key.replace(nextModelNamePrefix, ''), 10) || 0;
             if (num && num > highest) {
                 highest = num;
             }
         }
     }
-    return 'Model ' + (highest + 1);
+    return nextModelNamePrefix + (highest + 1);
 };
 
 

lib/index.js

@@ -31,6 +31,7 @@ const schema = Joi.object({
     uiCompleteScript: Joi.string().allow(null),
     xProperties: Joi.boolean(),
     reuseDefinitions: Joi.boolean(),
+    definitionPrefix: Joi.string(),
     deReference: Joi.boolean(),
     validatorUrl: Joi.string().allow(null),
     acceptToProduce: Joi.boolean(),

optionsreference.md

@@ -39,6 +39,7 @@ JSON (JSON endpoint needed to create UI)
 *  `produces`: (array) The mimetypes produced - default: `['application/json']`
 *  `xProperties`: Adds JOI data that cannot be use directly by swagger as metadata - default: `true`,
 *  `reuseDefinitions`: Reuse of definition models to save space - default: `true`,
+*  `definitionPrefix`: Dynamic naming convention. `default` or `useLabel` - default: `default`,
 *  `deReference`: Dereferences JSON output - default: `false`,
 *  `debug`: Validates the JSON ouput against swagger specification - default: `false`,
 

test/Integration/definitions-test.js

@@ -189,6 +189,70 @@ lab.experiment('definitions', () => {
         });
     });
 
+    lab.test('definitionPrefix = useLabel', (done) => {
+
+        // use the label as a prefix for dynamic model names
+
+        const tempRoutes = [{
+            method: 'POST',
+            path: '/store1/',
+            config: {
+                handler: Helper.defaultHandler,
+                tags: ['api'],
+                validate: {
+                    payload: Joi.object({
+                        a: Joi.number(),
+                        b: Joi.number(),
+                        operator: Joi.string(),
+                        equals: Joi.number()
+                    }).label('A')
+                }
+            }
+        }, {
+            method: 'POST',
+            path: '/store2/',
+            config: {
+                handler: Helper.defaultHandler,
+                tags: ['api'],
+                validate: {
+                    payload: Joi.object({
+                        c: Joi.number(),
+                        v: Joi.number(),
+                        operator: Joi.string(),
+                        equals: Joi.number()
+                    }).label('A A')
+                }
+            }
+        }, {
+            method: 'POST',
+            path: '/store3/',
+            config: {
+                handler: Helper.defaultHandler,
+                tags: ['api'],
+                validate: {
+                    payload: Joi.object({
+                        c: Joi.number(),
+                        f: Joi.number(),
+                        operator: Joi.string(),
+                        equals: Joi.number()
+                    }).label('A')
+                }
+            }
+        }];
+
+        Helper.createServer({ definitionPrefix: 'useLabel' }, tempRoutes, (err, server) => {
+
+            expect(err).to.equal(null);
+            server.inject({ method: 'GET', url: '/swagger.json' }, function (response) {
+
+                expect(response.statusCode).to.equal(200);
+                expect(response.result.definitions.A).to.exist();
+                expect(response.result.definitions['A A']).to.exist();
+                expect(response.result.definitions['A 1']).to.exist();
+                Helper.validate(response, done, expect);
+            });
+        });
+    });
 
     lab.test('test that optional array is not in swagger output', (done) => {
 

usageguide.md

@@ -119,7 +119,8 @@ validate: {
 ```
 __NOTE: the plugin reuses "definition models" these describe each JSON object use by an API i.e. a "user". This feature
 was added to reduce the size of the JSON. The reuse of models can cause names to be reused as well. Please switch
-`options.reuseDefinitions` to `false` if you are nameing your JOI objects.__
+`options.reuseDefinitions` to `false` if you are naming your JOI objects. By default objects are named in a "Model #"
+ format. To use the `label`, specify `options.definitionPrefix` as `useLabel`.__