-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #188 from amarzavery/uml
Generate Uml diagram
Showing
14 changed files
with
871 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. See License.txt in the project root for license information. | ||
|
|
||
| 'use strict'; | ||
| var util = require('util'), | ||
| log = require('../util/logging'), | ||
| validate = require('../validate'); | ||
|
|
||
| exports.command = 'generate-uml <spec-path>'; | ||
|
|
||
| exports.describe = 'Generates a class diagram of the model definitions in the given swagger spec.'; | ||
|
|
||
| exports.builder = { | ||
| d: { | ||
| alias: 'outputDir', | ||
| describe: 'Output directory where the class diagram will be stored.', | ||
| string: true, | ||
| default: './' | ||
| }, | ||
| p: { | ||
| alias: 'disableProperties', | ||
| describe: 'Should model properties not be generated?', | ||
| boolean: true, | ||
| default: false | ||
| }, | ||
| a: { | ||
| alias: 'disableAllof', | ||
| describe: 'Should allOf references not be generated?', | ||
| boolean: true, | ||
| default: false | ||
| }, | ||
| r: { | ||
| alias: 'disableRefs', | ||
| describe: 'Should model references not be generated?', | ||
| boolean: true, | ||
| default: false | ||
| }, | ||
| i: { | ||
| alias: 'direction', | ||
| describe: 'The direction of the generated diagram:\n' + | ||
| '"TB" - TopToBottom (default),\n' + '"LR" - "LeftToRight",\n' + '"RL" - "RightToLeft"', | ||
| string: true, | ||
| default: "TB", | ||
| choices: ["TB", "LR", "RL"] | ||
| } | ||
| }; | ||
|
|
||
| exports.handler = function (argv) { | ||
| log.debug(argv); | ||
| let specPath = argv.specPath; | ||
| let vOptions = {}; | ||
| vOptions.consoleLogLevel = argv.logLevel; | ||
| vOptions.logFilepath = argv.f; | ||
| vOptions.shouldDisableProperties = argv.p; | ||
| vOptions.shouldDisableAllof = argv.a; | ||
| vOptions.shouldDisableRefs = argv.r; | ||
| vOptions.direction = argv.i; | ||
| function execGenerateUml() { | ||
| return validate.generateUml(specPath, argv.d, vOptions); | ||
| } | ||
| return execGenerateUml().catch((err) => { process.exitCode = 1; }); | ||
| }; | ||
|
|
||
| exports = module.exports; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. See License.txt in the project root for license information. | ||
|
|
||
| 'use strict'; | ||
|
|
||
| var util = require('util'), | ||
| JsonRefs = require('json-refs'), | ||
| yuml2svg = require('yuml2svg'), | ||
| utils = require('./util/utils'), | ||
| Constants = require('./util/constants'), | ||
| log = require('./util/logging'), | ||
| ErrorCodes = Constants.ErrorCodes; | ||
|
|
||
| /** | ||
| * @class | ||
| * Generates a Uml Diagaram in svg format. | ||
| */ | ||
| class UmlGenerator { | ||
|
|
||
| /** | ||
| * @constructor | ||
| * Initializes a new instance of the UmlGenerator class. | ||
| * | ||
| * @param {object} specInJson the parsed spec in json format | ||
| * | ||
| * @return {object} An instance of the UmlGenerator class. | ||
| */ | ||
| constructor(specInJson, options) { | ||
| if (specInJson === null || specInJson === undefined || typeof specInJson !== 'object') { | ||
| throw new Error('specInJson is a required property of type object') | ||
| } | ||
| this.specInJson = specInJson; | ||
| this.graphDefinition = ''; | ||
| if (!options) options = {}; | ||
| this.options = options; | ||
| this.bg = '{bg:cornsilk}'; | ||
| } | ||
|
|
||
| generateGraphDefinition() { | ||
| this.generateModelPropertiesGraph(); | ||
| if (!this.options.shouldDisableAllof) { | ||
| this.generateAllOfGraph(); | ||
| } | ||
| } | ||
|
|
||
| generateAllOfGraph() { | ||
| let spec = this.specInJson; | ||
| let definitions = spec.definitions; | ||
| for (let modelName in definitions) { | ||
| let model = definitions[modelName]; | ||
| if (model.allOf) { | ||
| model.allOf.map((item) => { | ||
| let referencedModel = item; | ||
| let ref = item['$ref']; | ||
| let segments = ref.split('/'); | ||
| let parent = segments[segments.length - 1]; | ||
| this.graphDefinition += `\n[${parent}${this.bg}]^-.-allOf[${modelName}${this.bg}]`; | ||
| }); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| generateModelPropertiesGraph() { | ||
| let spec = this.specInJson; | ||
| let definitions = spec.definitions; | ||
| let references = []; | ||
| for (let modelName in definitions) { | ||
| let model = definitions[modelName]; | ||
| let modelProperties = model.properties; | ||
| let props = ''; | ||
| if (modelProperties) { | ||
| for (let propertyName in modelProperties) { | ||
| let property = modelProperties[propertyName]; | ||
| let propertyType = this.getPropertyType(modelName, property, references); | ||
| let discriminator = ''; | ||
| if (model.discriminator && model.discriminator === propertyName) { | ||
| discriminator = '(discriminator)'; | ||
| } | ||
| props += `-${propertyName}${discriminator}:${propertyType};`; | ||
| } | ||
| } | ||
| if (!this.options.shouldDisableProperties) { | ||
| this.graphDefinition += props.length ? `[${modelName}|${props}${this.bg}]\n` : `[${modelName}${this.bg}]\n`; | ||
| } | ||
|
|
||
| } | ||
| if (references.length && !this.options.shouldDisableRefs) { | ||
| this.graphDefinition += references.join('\n'); | ||
| } | ||
| } | ||
|
|
||
| getPropertyType(modelName, property, references) { | ||
| if (property.type && property.type.match(/^(string|number|boolean)$/i) !== null) { | ||
| return property.type; | ||
| } | ||
|
|
||
| if (property.type === 'array') { | ||
| let result = 'Array<' | ||
| if (property.items) { | ||
| result += this.getPropertyType(modelName, property.items, references); | ||
| } | ||
| result += '>'; | ||
| return result; | ||
| } | ||
|
|
||
| if (property['$ref']) { | ||
| let segments = property['$ref'].split('/'); | ||
| let referencedModel = segments[segments.length - 1]; | ||
| references.push(`[${modelName}${this.bg}]->[${referencedModel}${this.bg}]`); | ||
| return referencedModel; | ||
| } | ||
|
|
||
| if (property.additionalProperties && typeof property.additionalProperties === 'object') { | ||
| let result = 'Dictionary<'; | ||
| result += this.getPropertyType(modelName, property.additionalProperties, references); | ||
| result += '>'; | ||
| return result; | ||
| } | ||
|
|
||
| if (property.type === 'object') { | ||
| return 'Object' | ||
| } | ||
| return ''; | ||
| } | ||
|
|
||
| generateDiagramFromGraph() { | ||
| this.generateGraphDefinition(); | ||
| let svg = ''; | ||
| try { | ||
| log.info(this.graphDefinition); | ||
| svg = yuml2svg(this.graphDefinition, false, { dir: this.options.direction, type: 'class' }); | ||
| //console.log(svg); | ||
| } catch (err) { | ||
| return Promise.reject(err); | ||
| } | ||
| return Promise.resolve(svg); | ||
| } | ||
| } | ||
|
|
||
| module.exports = UmlGenerator; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.