-
Notifications
You must be signed in to change notification settings - Fork 97
/
plantumlvisitor.js
277 lines (234 loc) · 9.9 KB
/
plantumlvisitor.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
const ModelFile = require('@accordproject/concerto-core').ModelFile;
const ModelManager = require('@accordproject/concerto-core').ModelManager;
const ClassDeclaration = require('@accordproject/concerto-core').ClassDeclaration;
const TransactionDeclaration = require('@accordproject/concerto-core').TransactionDeclaration;
const AssetDeclaration = require('@accordproject/concerto-core').AssetDeclaration;
const ParticipantDeclaration = require('@accordproject/concerto-core').ParticipantDeclaration;
const EnumDeclaration = require('@accordproject/concerto-core').EnumDeclaration;
const Field = require('@accordproject/concerto-core').Field;
const RelationshipDeclaration = require('@accordproject/concerto-core').RelationshipDeclaration;
const EnumValueDeclaration = require('@accordproject/concerto-core').EnumValueDeclaration;
/**
* Convert the contents of a ModelManager
* to PlantUML format files.
* Set a fileWriter property (instance of FileWriter) on the parameters
* object to control where the generated code is written to disk.
*
* @private
* @class
* @memberof module:concerto-tools
*/
class PlantUMLVisitor {
/**
* Visitor design pattern
* @param {Object} thing - the object being visited
* @param {Object} parameters - the parameter
* @return {Object} the result of visiting or null
* @private
*/
visit(thing, parameters) {
if (thing instanceof ModelManager) {
return this.visitModelManager(thing, parameters);
} else if (thing instanceof ModelFile) {
return this.visitModelFile(thing, parameters);
} else if (thing instanceof ParticipantDeclaration) {
return this.visitParticipantDeclaration(thing, parameters);
} else if (thing instanceof TransactionDeclaration) {
return this.visitTransactionDeclaration(thing, parameters);
} else if (thing instanceof AssetDeclaration) {
return this.visitAssetDeclaration(thing, parameters);
} else if (thing instanceof EnumDeclaration) {
return this.visitEnumDeclaration(thing, parameters);
} else if (thing instanceof ClassDeclaration) {
return this.visitClassDeclaration(thing, parameters);
} else if (thing instanceof Field) {
return this.visitField(thing, parameters);
} else if (thing instanceof RelationshipDeclaration) {
return this.visitRelationship(thing, parameters);
} else if (thing instanceof EnumValueDeclaration) {
return this.visitEnumValueDeclaration(thing, parameters);
} else {
throw new Error('Unrecognised ' + JSON.stringify(thing) );
}
}
/**
* Visitor design pattern
* @param {ModelManager} modelManager - the object being visited
* @param {Object} parameters - the parameter
* @return {Object} the result of visiting or null
* @private
*/
visitModelManager(modelManager, parameters) {
parameters.fileWriter.openFile('model.puml');
parameters.fileWriter.writeLine(0, '@startuml');
parameters.fileWriter.writeLine(0, 'title' );
parameters.fileWriter.writeLine(0, 'Model' );
parameters.fileWriter.writeLine(0, 'endtitle' );
modelManager.getModelFiles().forEach((decl) => {
decl.accept(this, parameters);
});
parameters.fileWriter.writeLine(0, '@enduml');
parameters.fileWriter.closeFile();
return null;
}
/**
* Visitor design pattern
* @param {ModelFile} modelFile - the object being visited
* @param {Object} parameters - the parameter
* @return {Object} the result of visiting or null
* @private
*/
visitModelFile(modelFile, parameters) {
modelFile.getAllDeclarations().forEach((decl) => {
decl.accept(this, parameters);
});
return null;
}
/**
* Visitor design pattern
* @param {ClassDeclaration} classDeclaration - the object being visited
* @param {Object} parameters - the parameter
* @return {Object} the result of visiting or null
* @private
*/
visitAssetDeclaration(classDeclaration, parameters) {
parameters.fileWriter.writeLine(0, 'class ' + classDeclaration.getFullyQualifiedName() + ' << (A,green) >> {' );
classDeclaration.getOwnProperties().forEach((property) => {
property.accept(this, parameters);
});
parameters.fileWriter.writeLine(0, '}' );
if(classDeclaration.getSuperType()) {
parameters.fileWriter.writeLine(0, classDeclaration.getFullyQualifiedName() + ' --|> ' + classDeclaration.getSuperType());
}
return null;
}
/**
* Visitor design pattern
* @param {ClassDeclaration} classDeclaration - the object being visited
* @param {Object} parameters - the parameter
* @return {Object} the result of visiting or null
* @private
*/
visitEnumDeclaration(classDeclaration, parameters) {
parameters.fileWriter.writeLine(0, 'class ' + classDeclaration.getFullyQualifiedName() + ' << (E,grey) >> {' );
classDeclaration.getOwnProperties().forEach((property) => {
property.accept(this, parameters);
});
parameters.fileWriter.writeLine(0, '}' );
if(classDeclaration.getSuperType()) {
parameters.fileWriter.writeLine(0, classDeclaration.getFullyQualifiedName() + ' --|> ' + classDeclaration.getSuperType());
}
return null;
}
/**
* Visitor design pattern
* @param {ClassDeclaration} classDeclaration - the object being visited
* @param {Object} parameters - the parameter
* @return {Object} the result of visiting or null
* @private
*/
visitParticipantDeclaration(classDeclaration, parameters) {
parameters.fileWriter.writeLine(0, 'class ' + classDeclaration.getFullyQualifiedName() + ' << (P,lightblue) >> {' );
classDeclaration.getOwnProperties().forEach((property) => {
property.accept(this, parameters);
});
parameters.fileWriter.writeLine(0, '}' );
if(classDeclaration.getSuperType()) {
parameters.fileWriter.writeLine(0, classDeclaration.getFullyQualifiedName() + ' --|> ' + classDeclaration.getSuperType());
}
return null;
}
/**
* Visitor design pattern
* @param {ClassDeclaration} classDeclaration - the object being visited
* @param {Object} parameters - the parameter
* @return {Object} the result of visiting or null
* @private
*/
visitTransactionDeclaration(classDeclaration, parameters) {
parameters.fileWriter.writeLine(0, 'class ' + classDeclaration.getFullyQualifiedName() + ' << (T,yellow) >> {' );
classDeclaration.getOwnProperties().forEach((property) => {
property.accept(this, parameters);
});
parameters.fileWriter.writeLine(0, '}' );
if(classDeclaration.getSuperType()) {
parameters.fileWriter.writeLine(0, classDeclaration.getFullyQualifiedName() + ' --|> ' + classDeclaration.getSuperType());
}
return null;
}
/**
* Visitor design pattern
* @param {ClassDeclaration} classDeclaration - the object being visited
* @param {Object} parameters - the parameter
* @return {Object} the result of visiting or null
* @private
*/
visitClassDeclaration(classDeclaration, parameters) {
parameters.fileWriter.writeLine(0, 'class ' + classDeclaration.getFullyQualifiedName() + ' {' );
classDeclaration.getOwnProperties().forEach((property) => {
property.accept(this, parameters);
});
parameters.fileWriter.writeLine(0, '}' );
if(classDeclaration.getSuperType()) {
parameters.fileWriter.writeLine(0, classDeclaration.getFullyQualifiedName() + ' --|> ' + classDeclaration.getSuperType());
}
return null;
}
/**
* Visitor design pattern
* @param {Field} field - the object being visited
* @param {Object} parameters - the parameter
* @return {Object} the result of visiting or null
* @private
*/
visitField(field, parameters) {
let array = '';
if(field.isArray()) {
array = '[]';
}
parameters.fileWriter.writeLine(1, '+ ' + field.getType() + array + ' ' + field.getName());
return null;
}
/**
* Visitor design pattern
* @param {EnumValueDeclaration} enumValueDeclaration - the object being visited
* @param {Object} parameters - the parameter
* @return {Object} the result of visiting or null
* @private
*/
visitEnumValueDeclaration(enumValueDeclaration, parameters) {
parameters.fileWriter.writeLine(1, '+ ' + enumValueDeclaration.getName());
return null;
}
/**
* Visitor design pattern
* @param {Relationship} relationship - the object being visited
* @param {Object} parameters - the parameter
* @return {Object} the result of visiting or null
* @private
*/
visitRelationship(relationship, parameters) {
let array = '';
if(relationship.isArray()) {
array = '[]';
}
// we export all relationships by capitalizing them
parameters.fileWriter.writeLine(1, '+ ' + relationship.getType() + array + ' ' + relationship.getName());
return null;
}
}
module.exports = PlantUMLVisitor;