Add mermaid renderer for Entity relations #13

butschster · 2022-11-16T16:53:16Z

#10
Usage:

use Cycle\Schema\Renderer\MermaidRenderer\MermaidRenderer;
use Cycle\ORM\SchemaInterface;

$mermaid = new MermaidRenderer();

$mermaid->render([
    'comment' => [
        SchemaInterface::DATABASE => 'default',
        SchemaInterface::TABLE => 'comment',
        SchemaInterface::PRIMARY_KEY => ['id'],
        SchemaInterface::FIND_BY_KEYS => ['id'],
        SchemaInterface::COLUMNS => [
            'id' => 'id',
            'public' => 'public',
            'content' => 'content',
            'created_at' => 'created_at',
            'updated_at' => 'updated_at',
            'published_at' => 'published_at',
            'deleted_at' => 'deleted_at',
            'user_id' => 'user_id',
            'post_id' => 'post_id',
        ],
        SchemaInterface::RELATIONS => [
            'user' => [
                Relation::TYPE => Relation::BELONGS_TO,
                Relation::TARGET => 'user',
                Relation::LOAD => Relation::LOAD_EAGER,
                Relation::SCHEMA => [
                    Relation::CASCADE => true,
                    Relation::NULLABLE => false,
                    Relation::INNER_KEY => 'user_id',
                    Relation::OUTER_KEY => ['id'],
                ],
            ],
            'post' => [
                Relation::TYPE => Relation::BELONGS_TO,
                Relation::TARGET => 'post',
                Relation::LOAD => Relation::LOAD_PROMISE,
                Relation::SCHEMA => [
                    Relation::CASCADE => true,
                    Relation::NULLABLE => false,
                    Relation::INNER_KEY => 'post_id',
                    Relation::OUTER_KEY => ['id'],
                ],
            ],
        ],
        SchemaInterface::TYPECAST => [
            'id' => 'int',
            'public' => 'bool',
            'created_at' => 'datetime',
            'updated_at' => 'datetime',
            'published_at' => 'datetime',
            'deleted_at' => 'datetime',
            'user_id' => 'int',
            'post_id' => 'int',
        ],
        SchemaInterface::SCHEMA => [],
    ],
    'post' => [
        SchemaInterface::DATABASE => 'default',
        SchemaInterface::TABLE => 'post',
        SchemaInterface::PRIMARY_KEY => ['id'],
        SchemaInterface::FIND_BY_KEYS => ['id'],
        SchemaInterface::COLUMNS => [
            'id' => 'id',
            'slug' => 'slug',
            'title' => 'title',
            'public' => 'public',
            'content' => 'content',
            'created_at' => 'created_at',
            'updated_at' => 'updated_at',
            'published_at' => 'published_at',
            'deleted_at' => 'deleted_at',
            'user_id' => 'user_id',
        ],
        SchemaInterface::RELATIONS => [
            'user' => [
                Relation::TYPE => Relation::BELONGS_TO,
                Relation::TARGET => 'user',
                Relation::LOAD => Relation::LOAD_PROMISE,
                Relation::SCHEMA => [
                    Relation::CASCADE => true,
                    Relation::NULLABLE => false,
                    Relation::INNER_KEY => 'user_id',
                    Relation::OUTER_KEY => ['id'],
                ],
            ],
            'tags' => [
                Relation::TYPE => Relation::MANY_TO_MANY,
                Relation::TARGET => 'tag',
                Relation::COLLECTION_TYPE => 'array',
                Relation::LOAD => Relation::LOAD_PROMISE,
                Relation::SCHEMA => [
                    Relation::CASCADE => true,
                    Relation::NULLABLE => false,
                    Relation::WHERE => [],
                    Relation::ORDER_BY => [],
                    Relation::INNER_KEY => ['id'],
                    Relation::OUTER_KEY => ['id'],
                    Relation::THROUGH_ENTITY => 'postTag',
                    Relation::THROUGH_INNER_KEY => 'post_id',
                    Relation::THROUGH_OUTER_KEY => 'tag_id',
                    Relation::THROUGH_WHERE => [],
                ],
            ],
            'comments' => [
                Relation::TYPE => Relation::HAS_MANY,
                Relation::TARGET => 'comment',
                Relation::COLLECTION_TYPE => 'array',
                Relation::LOAD => Relation::LOAD_PROMISE,
                Relation::SCHEMA => [
                    Relation::CASCADE => true,
                    Relation::NULLABLE => false,
                    Relation::WHERE => [],
                    Relation::ORDER_BY => [],
                    Relation::INNER_KEY => ['id'],
                    Relation::OUTER_KEY => 'post_id',
                ],
            ],
            'image' => [
                Relation::TYPE => Relation::MORPHED_HAS_ONE,
                Relation::TARGET => 'image',
                Relation::SCHEMA => [
                    Relation::CASCADE => true,
                    Relation::INNER_KEY => 'id',
                    Relation::OUTER_KEY => 'parentId',
                    Relation::MORPH_KEY => 'parentType',
                ],
            ],
        ],
        SchemaInterface::TYPECAST => [
            'id' => 'int',
            'public' => 'bool',
            'created_at' => 'datetime',
            'updated_at' => 'datetime',
            'published_at' => 'datetime',
            'deleted_at' => 'datetime',
            'user_id' => 'int',
        ],
        SchemaInterface::SCHEMA => [],
    ],
    'postTag' => [
        SchemaInterface::DATABASE => 'default',
        SchemaInterface::TABLE => 'post_tag',
        SchemaInterface::PRIMARY_KEY => ['id'],
        SchemaInterface::FIND_BY_KEYS => ['id'],
        SchemaInterface::COLUMNS => [
            'id' => 'id',
            'post_id' => 'post_id',
            'tag_id' => 'tag_id',
        ],
        SchemaInterface::RELATIONS => [],
        SchemaInterface::SCOPE => null,
        SchemaInterface::TYPECAST => [
            'id' => 'int',
            'post_id' => 'int',
            'tag_id' => 'int',
        ],
        SchemaInterface::SCHEMA => [],
    ],
    'tag' => [
        SchemaInterface::DATABASE => 'default',
        SchemaInterface::TABLE => 'tag',
        SchemaInterface::PRIMARY_KEY => ['id'],
        SchemaInterface::FIND_BY_KEYS => ['id'],
        SchemaInterface::COLUMNS => [
            'id' => 'id',
            'label' => 'label',
            'created_at' => 'created_at',
        ],
        SchemaInterface::RELATIONS => [
            'posts' => [
                Relation::TYPE => Relation::MANY_TO_MANY,
                Relation::TARGET => 'post',
                Relation::COLLECTION_TYPE => 'array',
                Relation::LOAD => Relation::LOAD_PROMISE,
                Relation::SCHEMA => [
                    Relation::CASCADE => true,
                    Relation::NULLABLE => false,
                    Relation::WHERE => [],
                    Relation::ORDER_BY => [],
                    Relation::INNER_KEY => ['id'],
                    Relation::OUTER_KEY => ['id'],
                    Relation::THROUGH_ENTITY => 'postTag',
                    Relation::THROUGH_INNER_KEY => 'tag_id',
                    Relation::THROUGH_OUTER_KEY => 'post_id',
                    Relation::THROUGH_WHERE => [],
                ],
            ],
        ],
        SchemaInterface::SCOPE => null,
        SchemaInterface::TYPECAST => [
            'id' => 'int',
            'created_at' => 'datetime',
        ],
        SchemaInterface::SCHEMA => [],
    ],
    'user' => [
        SchemaInterface::DATABASE => 'default',
        SchemaInterface::TABLE => 'user',
        SchemaInterface::PRIMARY_KEY => ['id'],
        SchemaInterface::FIND_BY_KEYS => ['id'],
        SchemaInterface::COLUMNS => [
            'id' => 'id',
            'login' => 'login',
            'passwordHash' => 'password_hash',
            'created_at' => 'created_at',
            'updated_at' => 'updated_at',
        ],
        SchemaInterface::RELATIONS => [
            'posts' => [
                Relation::TYPE => Relation::HAS_MANY,
                Relation::TARGET => 'post',
                Relation::COLLECTION_TYPE => 'array',
                Relation::LOAD => Relation::LOAD_PROMISE,
                Relation::SCHEMA => [
                    Relation::CASCADE => true,
                    Relation::NULLABLE => true,
                    Relation::WHERE => [],
                    Relation::ORDER_BY => [],
                    Relation::INNER_KEY => ['id'],
                    Relation::OUTER_KEY => 'user_id',
                ],
            ],
            'comments' => [
                Relation::TYPE => Relation::HAS_MANY,
                Relation::TARGET => 'comment',
                Relation::COLLECTION_TYPE => 'array',
                Relation::LOAD => Relation::LOAD_PROMISE,
                Relation::SCHEMA => [
                    Relation::CASCADE => true,
                    Relation::NULLABLE => false,
                    Relation::WHERE => [],
                    Relation::ORDER_BY => [],
                    Relation::INNER_KEY => ['id'],
                    Relation::OUTER_KEY => 'user_id',
                ],
            ],
            'image' => [
                Relation::TYPE => Relation::MORPHED_HAS_ONE,
                Relation::TARGET => 'image',
                Relation::SCHEMA => [
                    Relation::CASCADE => true,
                    Relation::INNER_KEY => 'id',
                    Relation::OUTER_KEY => 'parentId',
                    Relation::MORPH_KEY => 'parentType',
                ],
            ],
            'foo' => [
                Relation::TYPE => Relation::MORPHED_HAS_MANY,
                Relation::TARGET => 'foo',
                Relation::SCHEMA => [
                    Relation::CASCADE => true,
                    Relation::INNER_KEY => 'id',
                    Relation::OUTER_KEY => 'parentId',
                    Relation::MORPH_KEY => 'parentType',
                ],
            ],
        ],
        SchemaInterface::SCOPE => null,
        SchemaInterface::TYPECAST => [
            'id' => 'int',
            'created_at' => 'datetime',
            'updated_at' => 'datetime',
        ],
        SchemaInterface::SCHEMA => [],
    ],
    'image' => [
        SchemaInterface::DATABASE => 'default',
        SchemaInterface::TABLE => 'image',
        SchemaInterface::PRIMARY_KEY => 'id',
        SchemaInterface::COLUMNS => [
            'id' => 'id',
            'parentId' => 'parent_id',
            'parentType' => 'parent_type',
            'url' => 'url',
        ],
        SchemaInterface::SCHEMA => [],
        SchemaInterface::RELATIONS => []
    ],
    'foo' => [
        SchemaInterface::MAPPER => Mapper::class,
        SchemaInterface::DATABASE => 'default',
        SchemaInterface::TABLE => 'foo',
        SchemaInterface::PRIMARY_KEY => 'id',
        SchemaInterface::COLUMNS => [
            'id' => 'id',
            'parentId' => 'parent_id',
            'parentType' => 'parent_type',
            'url' => 'url',
        ],
        SchemaInterface::SCHEMA => [],
    ],
    'bar' => [
        SchemaInterface::MAPPER => Mapper::class,
        SchemaInterface::DATABASE => 'default',
        SchemaInterface::TABLE => 'bar',
        SchemaInterface::PRIMARY_KEY => 'id',
        SchemaInterface::COLUMNS => [
            'id' => 'id',
            'title' => 'title',
            'body' => 'body',
        ],
        SchemaInterface::SCHEMA => [],
        SchemaInterface::RELATIONS => [
            'foo' => [
                Relation::TYPE => Relation::BELONGS_TO_MORPHED,
                Relation::TARGET => 'foo',
                Relation::SCHEMA => [
                    Relation::CASCADE => true,
                    Relation::INNER_KEY => 'id',
                    Relation::OUTER_KEY => 'parentId',
                    Relation::MORPH_KEY => 'parentType',
                ],
            ],
        ]
    ],
]);

Will return something like this...

erDiagram
post {
    int id
    string slug
    bool public
    string content
    datetime created_at
    datetime updated_at
    datetime published_at
    datetime deleted_at
    int user_id
}
post ||--|| student : "BT author"
post ||--|{ postTag : many_to_many
tag ||--|{ postTag : many_to_many
postTag {
    int id
    int post_id
    int tag_id
}

tag {
    int id
    string label
    datetime created_at
}
tag ||--|{ postTag : many_to_many
post ||--|{ postTag : many_to_many
identity {
    int id
    datetime created_at
    datetime updated_at
}
user {
    int id
    string login
    string password_hash
}
identity ||--o{ user : "STI"
user ||--o{ admin : "JTI [id:id]"
user ||--o{ student : "JTI [id:id]"
admin ||--o{ teacher : "JTI [id:id]"
admin {
    int id
    string email
}
student {
    int id
    int iq
}
teacher {
    int id
    bool salary
}
message {
    int id
    string title
}
student ||--o{ post : "HM posts > student"

Co-authored-by: StyleCI Bot <[email protected]>

roxblnfk · 2022-12-02T15:28:57Z

Why didn't phpunit actions start?

codecov · 2022-12-05T21:08:37Z

Codecov Report

Merging #13 (e4bea89) into 1.x (c733781) will increase coverage by 0.76%.
The diff coverage is 98.68%.

@@             Coverage Diff              @@
##                1.x      #13      +/-   ##
============================================
+ Coverage     96.42%   97.18%   +0.76%     
- Complexity      156      235      +79     
============================================
  Files            21       51      +30     
  Lines           447      676     +229     
============================================
+ Hits            431      657     +226     
- Misses           16       19       +3

Impacted Files	Coverage Δ
src/MermaidRenderer/MermaidRenderer.php	`96.93% <96.93%> (ø)`
src/MermaidRenderer/Annotation.php	`100.00% <100.00%> (ø)`
src/MermaidRenderer/Column.php	`100.00% <100.00%> (ø)`
src/MermaidRenderer/Entity/EntityRelation.php	`100.00% <100.00%> (ø)`
src/MermaidRenderer/Entity/EntityTable.php	`100.00% <100.00%> (ø)`
src/MermaidRenderer/Method.php	`100.00% <100.00%> (ø)`
src/MermaidRenderer/Method/BelongsToMethod.php	`100.00% <100.00%> (ø)`
.../MermaidRenderer/Method/BelongsToMorphedMethod.php	`100.00% <100.00%> (ø)`
src/MermaidRenderer/Method/EmbeddedMethod.php	`100.00% <100.00%> (ø)`
src/MermaidRenderer/Method/HasManyMethod.php	`100.00% <100.00%> (ø)`
... and 20 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

src/MermaidRenderer/Annotation.php

Co-authored-by: StyleCI Bot <[email protected]>

…rmaid

meekstellar and others added 2 commits November 16, 2022 20:52

Add mermaid renderer

0157d41

Apply fixes from StyleCI

3d08782

butschster added the type:feature New feature. label Nov 16, 2022

butschster requested a review from roxblnfk November 16, 2022 16:53

butschster assigned roxblnfk Nov 16, 2022

meekstellar and others added 12 commits November 22, 2022 17:01

Fix namespace bug

0319196

Add typecast formatting

0b11d73

Add aliases

4ac507c

Fixes

0923889

Avoid reflection usage

645db6a

Apply fixes from StyleCI

2f3e0e1

Refactor

2a4db92

Refactor

fadc896

Add relation tests

b7e41ff

Suppress psalm

7007f63

Fix psalm and add ColumnTest

e466631

Apply fixes from StyleCI (#14)

364311f

Co-authored-by: StyleCI Bot <[email protected]>

Update README.md

3a69100

butschster changed the title ~~Add mermaid renderer~~ Add mermaid renderer for Entity relations Dec 5, 2022

Update psalm version to ^5.1

ecddbca

meekstellar added 8 commits December 6, 2022 21:28

Add support CycleORM v1

58db81f

Delete SCOPE constant from tests

8c11fe2

Delete SCOPE constant from ManyToManyTest

3374592

Delete ORDER_BY constant from ManyToManyTest

fd26dbf

Fix SingleTableInheritanceTest in OutputSchemaRenderer

8eed1f4

Rollback SingleTableInheritanceTest

28274c6

Fix STI test

e586eed

Fix styleci

0cc1f72

roxblnfk reviewed Dec 8, 2022

View reviewed changes

src/MermaidRenderer/Annotation.php Show resolved Hide resolved

butschster requested a review from roxblnfk December 8, 2022 12:04

meekstellar and others added 15 commits December 8, 2022 14:47

Add regex that remove all symbols from string in Annotation

84268c4

fix

1490b73

Except : symbol from regex in annotation

b9eecfe

Rollback STI test

ba1112e

Add own Stringable interface to support php 7.4

9330391

Add Stringable to ClassDiagram

44c2804

Fix

c635393

Fix

a2ac9ea

Replace preg_replace by htmlentities in Annotation

f81d03c

Update AnnotationTest

1284f05

Skip STI test

3bae80d

Skip STI test if orm v1

0c36561

Apply fixes from StyleCI (#15)

8429735

Co-authored-by: StyleCI Bot <[email protected]>

Fix

cbcd48d

Merge remote-tracking branch 'origin/feature/mermaid' into feature/me…

e4bea89

…rmaid

butschster merged commit a9995e0 into 1.x Dec 14, 2022

butschster deleted the feature/mermaid branch December 14, 2022 09:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add mermaid renderer for Entity relations #13

Add mermaid renderer for Entity relations #13

butschster commented Nov 16, 2022 •

edited

Loading

roxblnfk commented Dec 2, 2022

codecov bot commented Dec 5, 2022 •

edited

Loading

Add mermaid renderer for Entity relations #13

Add mermaid renderer for Entity relations #13

Conversation

butschster commented Nov 16, 2022 • edited Loading

roxblnfk commented Dec 2, 2022

codecov bot commented Dec 5, 2022 • edited Loading

Codecov Report

butschster commented Nov 16, 2022 •

edited

Loading

codecov bot commented Dec 5, 2022 •

edited

Loading