Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix edge handling and arrow type #4582

Closed
wants to merge 11 commits into from
Closed

Fix edge handling and arrow type #4582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
6d07941
add implementation/realization edge type, fix arrow heads to be hollow
jgreywolf Jul 3, 2023
ada4ddc
Merge branch 'develop' into UpdateClasstoMatchUmlSpecs
jgreywolf Jul 3, 2023
824feb5
Update packages/mermaid/src/dagre-wrapper/markers.js
jgreywolf Jul 3, 2023
7a987a2
Merge branch 'develop' into UpdateClasstoMatchUmlSpecs
jgreywolf Jul 3, 2023
96e5151
prettier fixes
jgreywolf Jul 3, 2023
65c0c0a
small test fix
jgreywolf Jul 3, 2023
dc1308a
Merge branch 'develop' into UpdateClasstoMatchUmlSpecs
jgreywolf Aug 26, 2023
c323293
add comment
jgreywolf Aug 26, 2023
67ff83a
Update packages/mermaid/src/dagre-wrapper/markers.js
jgreywolf Aug 27, 2023
f1a6ef1
Merge branch 'develop' into UpdateClasstoMatchUmlSpecs
sidharthv96 Sep 5, 2023
de6add6
chore: Remove background color logic
sidharthv96 Sep 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions packages/mermaid/src/dagre-wrapper/edges.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -522,6 +522,7 @@
default:
strokeClasses = '';
}

switch (edge.pattern) {
case 'solid':
strokeClasses += ' edge-pattern-solid';
Expand Down Expand Up @@ -586,6 +587,9 @@
case 'extension':
svgPath.attr('marker-start', 'url(' + url + '#' + diagramType + '-extensionStart' + ')');
break;
case 'realization':
svgPath.attr('marker-start', 'url(' + url + '#' + diagramType + '-realizationStart' + ')');
break;

Check warning on line 592 in packages/mermaid/src/dagre-wrapper/edges.js

View check run for this annotation

Codecov / codecov/patch

packages/mermaid/src/dagre-wrapper/edges.js#L591-L592 

Added lines #L591 - L592 were not covered by tests
case 'composition':
svgPath.attr('marker-start', 'url(' + url + '#' + diagramType + '-compositionStart' + ')');
break;
Expand Down Expand Up @@ -616,6 +620,9 @@
case 'extension':
svgPath.attr('marker-end', 'url(' + url + '#' + diagramType + '-extensionEnd' + ')');
break;
case 'realization':
svgPath.attr('marker-end', 'url(' + url + '#' + diagramType + '-realizationEnd' + ')');
break;
case 'composition':
svgPath.attr('marker-end', 'url(' + url + '#' + diagramType + '-compositionEnd' + ')');
break;
Expand Down
32 changes: 32 additions & 0 deletions packages/mermaid/src/dagre-wrapper/markers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ const insertMarkers = (elem, markerArray, type, id) => {

const extension = (elem, type, id) => {
log.trace('Making markers for ', id);

elem
.append('defs')
.append('marker')
Expand Down Expand Up @@ -38,6 +39,36 @@ const extension = (elem, type, id) => {
.attr('d', 'M 1,1 V 13 L18,7 Z'); // this is actual shape for arrowhead
};

const realization = (elem, type, id) => {
log.trace('Making markers for ', id);

elem
.append('defs')
.append('marker')
.attr('id', type + '-realizationStart')
.attr('class', 'marker realization ' + type)
.attr('refX', 18)
.attr('refY', 7)
.attr('markerWidth', 190)
.attr('markerHeight', 240)
.attr('orient', 'auto')
.append('path')
.attr('d', 'M 1,7 L18,13 V 1 Z');

elem
.append('defs')
.append('marker')
.attr('id', type + '-realizationEnd')
.attr('class', 'marker realization ' + type)
.attr('refX', 1)
.attr('refY', 7)
.attr('markerWidth', 20)
.attr('markerHeight', 28)
.attr('orient', 'auto')
.append('path')
.attr('d', 'M 1,1 V 13 L18,7 Z'); // this is actual shape for arrowhead
};

const composition = (elem, type) => {
elem
.append('defs')
Expand Down Expand Up @@ -282,6 +313,7 @@ const barb = (elem, type) => {
// TODO rename the class diagram markers to something shape descriptive and semantic free
const markers = {
extension,
realization,
composition,
aggregation,
dependency,
Expand Down
1 change: 1 addition & 0 deletions packages/mermaid/src/diagrams/class/classDb.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,6 +366,7 @@ export const relationType = {
COMPOSITION: 2,
DEPENDENCY: 3,
LOLLIPOP: 4,
REALIZATION: 5,
};

const setupToolTips = function (element: Element) {
Expand Down
10 changes: 6 additions & 4 deletions packages/mermaid/src/diagrams/class/classDiagram.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1193,16 +1193,18 @@ describe('given a class diagram with relationships, ', function () {
});

it('should handle relation definitions with type only on right side', function () {
const str = 'classDiagram\n' + 'Class1 --|> Class02';
const str = 'classDiagram\n' + 'Class1 --|> Class2';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already support Extension --|> and Realization ..|>.
Wouldn't releasing this change mark the extension as a realization, changing the meaning of a lot of existing diagrams?

classDiagram
classA <|-- classB
classM <|.. classN
Loading


parser.parse(str);

const relations = parser.yy.getRelations();
const class1 = parser.yy.getClass('Class1');
const class2 = parser.yy.getClass('Class2');

expect(parser.yy.getClass('Class1').id).toBe('Class1');
expect(parser.yy.getClass('Class02').id).toBe('Class02');
expect(class1.id).toBe('Class1');
expect(class2.id).toBe('Class2');
expect(relations[0].relation.type1).toBe('none');
expect(relations[0].relation.type2).toBe(classDb.relationType.EXTENSION);
expect(relations[0].relation.type2).toBe(classDb.relationType.REALIZATION);
expect(relations[0].relation.lineType).toBe(classDb.lineType.LINE);
});

Expand Down
5 changes: 4 additions & 1 deletion packages/mermaid/src/diagrams/class/classRenderer-v2.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ export const draw = async function (text: string, id: string, _version: string,
await render(
element,
g,
['aggregation', 'extension', 'composition', 'dependency', 'lollipop'],
['aggregation', 'extension', 'realization', 'composition', 'dependency', 'lollipop'],
'classDiagram',
id
);
Expand Down Expand Up @@ -406,6 +406,9 @@ function getArrowMarker(type: number) {
case 4:
marker = 'lollipop';
break;
case 5:
marker = 'realization';
break;
default:
marker = 'none';
}
Expand Down
54 changes: 32 additions & 22 deletions packages/mermaid/src/diagrams/class/parser/classDiagram.jison
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,28 +121,37 @@ line was introduced with 'click'.
<*>"_parent" return 'LINK_TARGET';
<*>"_top" return 'LINK_TARGET';

<*>\s*\<\| return 'EXTENSION';
<*>\s*\|\> return 'EXTENSION';
<*>\s*\> return 'DEPENDENCY';
<*>\s*\< return 'DEPENDENCY';
<*>\s*\* return 'COMPOSITION';
<*>\s*o return 'AGGREGATION';
<*>\s*\(\) return 'LOLLIPOP';
<*>\-\- return 'LINE';
<*>\.\. return 'DOTTED_LINE';
<*>":"{1}[^:\n;]+ return 'LABEL';
<*>":"{3} return 'STYLE_SEPARATOR';
<*>\- return 'MINUS';
<*>"." return 'DOT';
<*>\+ return 'PLUS';
<*>\% return 'PCT';
<*>"=" return 'EQUALS';
<*>\= return 'EQUALS';
<*>\w+ return 'ALPHA';
<*>"[" return 'SQS';
<*>"]" return 'SQE';
<*>[!"#$%&'*+,-.`?\\/] return 'PUNCTUATION';
<*>[0-9]+ return 'NUM';
<bqstring>[`] this.popState();
<bqstring>[^`]+ return "BQUOTE_STR";
<*>[`] this.begin("bqstring");

<*>"_self" return 'LINK_TARGET';
<*>"_blank" return 'LINK_TARGET';
<*>"_parent" return 'LINK_TARGET';
<*>"_top" return 'LINK_TARGET';

<*>\s*\<\| return 'EXTENSION';
<*>\s*\|\> return 'REALIZATION';
<*>\s*\> return 'DEPENDENCY';
<*>\s*\< return 'DEPENDENCY';
<*>\s*\* return 'COMPOSITION';
<*>\s*o return 'AGGREGATION';
<*>\s*\(\) return 'LOLLIPOP';
<*>\-\- return 'LINE';
<*>\.\. return 'DOTTED_LINE';
<*>":"{1}[^:\n;]+ return 'LABEL';
<*>":"{3} return 'STYLE_SEPARATOR';
<*>\- return 'MINUS';
<*>"." return 'DOT';
<*>\+ return 'PLUS';
<*>\% return 'PCT';
<*>"=" return 'EQUALS';
<*>\= return 'EQUALS';
<*>\w+ return 'ALPHA';
<*>"[" return 'SQS';
<*>"]" return 'SQE';
<*>[!"#$%&'*+,-.`?\\/] return 'PUNCTUATION';
<*>[0-9]+ return 'NUM';
<*>[\u00AA\u00B5\u00BA\u00C0-\u00D6\u00D8-\u00F6]|
[\u00F8-\u02C1\u02C6-\u02D1\u02E0-\u02E4\u02EC\u02EE\u0370-\u0374\u0376\u0377]|
[\u037A-\u037D\u0386\u0388-\u038A\u038C\u038E-\u03A1\u03A3-\u03F5]|
Expand Down Expand Up @@ -368,6 +377,7 @@ relation
relationType
: AGGREGATION { $$=yy.relationType.AGGREGATION;}
| EXTENSION { $$=yy.relationType.EXTENSION;}
| REALIZATION { $$=yy.relationType.REALIZATION;}
| COMPOSITION { $$=yy.relationType.COMPOSITION;}
| DEPENDENCY { $$=yy.relationType.DEPENDENCY;}
| LOLLIPOP { $$=yy.relationType.LOLLIPOP;}
Expand Down
12 changes: 12 additions & 0 deletions packages/mermaid/src/diagrams/class/styles.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,18 @@ g.classGroup line {
stroke-width: 1;
}

#realizationStart, .realization {
fill: transparent !important;
stroke: ${options.lineColor} !important;
stroke-width: 1;
}

#realizationEnd, .realization {
fill: transparent !important;
stroke: ${options.lineColor} !important;
stroke-width: 1;
}

#aggregationStart, .aggregation {
fill: transparent !important;
stroke: ${options.lineColor} !important;
Expand Down
2 changes: 2 additions & 0 deletions packages/mermaid/src/diagrams/class/svgDraw.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ export const drawEdge = function (elem, path, relation, conf, diagObj) {
switch (type) {
case diagObj.db.relationType.AGGREGATION:
return 'aggregation';
case diagObj.db.relationType.REALIZATION:
return 'realization';
case diagObj.db.relationType.EXTENSION:
return 'extension';
case diagObj.db.relationType.COMPOSITION:
Expand Down
Loading