(fix):Split 'Thing' definitions into separate files

Author: Callan Peter Milne

src/Thing.js

@@ -15,6 +15,11 @@
  */
 'use strict';
 
+const HTTP_VERB_GET = 'GET';
+const HTTP_VERB_PUT = 'PUT';
+const HTTP_VERB_POST = 'POST';
+const HTTP_VERB_DELETE = 'DELETE';
+
 module.exports = class Thing {
 
  constructor (opt) {
@@ -95,24 +100,20 @@ module.exports = class Thing {
 
  thisRouteURI = `${prefix}/${this.uriPrefix}{${this.idProperty}}`;
 
- let canCreate = this.hasCreateRoute;
- if (canCreate) {
- route('POST', `${prefix}/${this.pluralUriName}`, `create${this.name}`);
- }
+ this.hasCreateRoute &&
+ route(HTTP_VERB_POST, `${prefix}/${this.pluralUriName}`, `create${this.name}`);
 
- let canList = this.hasListRoute;
- if (canList) {
- route('GET', `${prefix}/${this.uriName}/List`, `get${this.name}List`);
- }
+ this.hasListRoute &&
+ route(HTTP_VERB_GET, `${prefix}/${this.uriName}/List`, `get${this.name}List`);
 
  this.hasReadRoute &&
- route('GET', thisRouteURI, `get${this.name}By${this.idProperty}`);
+ route(HTTP_VERB_GET, thisRouteURI, `get${this.name}By${this.idProperty}`);
 
  this.hasUpdateRoute &&
- route('PUT', thisRouteURI, `update${this.name}By${this.idProperty}`);
+ route(HTTP_VERB_PUT, thisRouteURI, `update${this.name}By${this.idProperty}`);
 
  this.hasDeleteRoute &&
- route('DELETE', thisRouteURI, `delete${this.name}By${this.idProperty}`);
+ route(HTTP_VERB_DELETE, thisRouteURI, `delete${this.name}By${this.idProperty}`);
 
  this.additionalSubRoutes.forEach((route) => {
  route(route.method, `${thisRouteURI}/${route.uri}`, route.operationId);

src/swagger.js

@@ -86,6 +86,7 @@ module.exports = function (routes) {
 
  e.responses['200'] = {
  description: 'Success',
+ $ref: `#/definitions/${route.modelType}`,
  };
 
  e.responses['404'] = {

src/thing.js

@@ -21,69 +21,23 @@ module.exports = function () {
 
  let things = {};
 
- things.User = new Thing({
- name: 'User',
- uriPrefix: 'U/',
- idProperty: 'UserID',
- });
+ let routes;
 
- things.Type = new Thing({
- name: 'Type',
- uriPrefix: 'T/',
- idProperty: 'ClassName',
- parentThing: things.User,
- provide: {
- l: true,
- c: true,
- r: true,
- },
- });
+ things.User = requireThing('User');
+ things.Type = requireThing('Type');
+ things.TypeAttribute = requireThing('TypeAttribute');
+ things.Entity = requireThing('Entity');
+ things.EntityAttribute = requireThing('EntityAttribute');
 
- things.TypeAttribute = new Thing({
- name: 'TypeAttribute',
- uriName: 'Attribute',
- uriPrefix: 'A/',
- idProperty: 'AttributeKey',
- parentThing: things.Type,
- provide: {
- c: true,
- r: true,
- u: true,
- },
- });
-
- things.Entity = new Thing({
- name: 'Entity',
- pluralUriName: 'Entities',
- uriPrefix: 'E/',
- idProperty: 'EntityID',
- parentThing: things.Type,
- provide: {
- l: true,
- c: true,
- r: true,
- d: true,
- },
- });
-
- things.EntityAttribute = new Thing({
- name: 'EntityAttribute',
- uriName: 'Attribute',
- uriPrefix: 'A/',
- idProperty: 'AttributeKey',
- parentThing: things.Entity,
- provide: {
- r: true,
- u: true,
- d: true,
- },
- });
-
- let routes = things.User.routes();
+ routes = things.User.routes();
 
  process.stdout.write(JSON.stringify(routes, undefined, ' '));
  process.stdout.write(''+routes.length);
 
  return routes;
 
+ function requireThing (name) {
+ return require(`./things/${name}`)(Thing, things);
+ }
+
 };

src/things/Entity.js

@@ -0,0 +1,32 @@
+/**
+ * Copyright (c) 2017 Callan Peter Milne
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+ * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+ * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+ * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+ * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+ * PERFORMANCE OF THIS SOFTWARE.
+ */
+'use strict';
+
+module.exports = function (Thing, things) {
+ return things.Entity = new Thing({
+ name: 'Entity',
+ pluralUriName: 'Entities',
+ uriPrefix: 'E/',
+ idProperty: 'EntityID',
+ parentThing: things.Type,
+ provide: {
+ l: true,
+ c: true,
+ r: true,
+ d: true,
+ },
+ });
+};

src/things/EntityAttribute.js

@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) 2017 Callan Peter Milne
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+ * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+ * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+ * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+ * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+ * PERFORMANCE OF THIS SOFTWARE.
+ */
+'use strict';
+
+module.exports = function (Thing, things) {
+ return things.EntityAttribute = new Thing({
+ name: 'EntityAttribute',
+ uriName: 'Attribute',
+ uriPrefix: 'A/',
+ idProperty: 'AttributeKey',
+ parentThing: things.Entity,
+ provide: {
+ r: true,
+ u: true,
+ d: true,
+ },
+ });
+};

src/things/Type.js

@@ -0,0 +1,30 @@
+/**
+ * Copyright (c) 2017 Callan Peter Milne
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+ * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+ * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+ * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+ * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+ * PERFORMANCE OF THIS SOFTWARE.
+ */
+'use strict';
+
+module.exports = function (Thing, things) {
+ return things.Type = new Thing({
+ name: 'Type',
+ uriPrefix: 'T/',
+ idProperty: 'ClassName',
+ parentThing: things.User,
+ provide: {
+ l: true,
+ c: true,
+ r: true,
+ },
+ });
+};

src/things/TypeAttribute.js

@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) 2017 Callan Peter Milne
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+ * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+ * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+ * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+ * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+ * PERFORMANCE OF THIS SOFTWARE.
+ */
+'use strict';
+
+module.exports = function (Thing, things) {
+ return things.TypeAttribute = new Thing({
+ name: 'TypeAttribute',
+ uriName: 'Attribute',
+ uriPrefix: 'A/',
+ idProperty: 'AttributeKey',
+ parentThing: things.Type,
+ provide: {
+ c: true,
+ r: true,
+ u: true,
+ },
+ });
+};

src/things/User.js

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) 2017 Callan Peter Milne
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+ * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+ * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+ * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+ * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+ * PERFORMANCE OF THIS SOFTWARE.
+ */
+'use strict';
+
+module.exports = function (Thing, things) {
+ return things.User = new Thing({
+ name: 'User',
+ uriPrefix: 'U/',
+ idProperty: 'UserID',
+ });
+};