[DOCS] Regenerate the class diagram in the README

[oliverklee]

The class diagram is (almost) unchanged to the output from tasuku43/mermaid-class-diagram, except for the kept direction LR.

This is in preparation for adding a script for auto-creating the class diagram in #1297.

[coveralls]

coverage: 59.658%. remained the same
when pulling 3da94d4 on docs/update-class-diagram
into f5ad2e7 on main.

[oliverklee]

Marking this as draft for now. I'll first reorder the classes in the diagram to make this PR here a bit smaller.

[JakeQZ]

It would be nice if the diagram had fewer criss-crossing paths. AI should be good at that, but seems to be vastly overrated :/

[JakeQZ]

The previous source for the diagram had entries like

URL --> "1" CSSString: url

whereas now we have

URL ..> CSSString: dependency

So we no longer identify the property that has the dependency (or whether it's as a single object, array, or whatever). Is there any reason for this change?

[oliverklee]

So we no longer identify the property that has the dependency (or whether it's as a single object, array, or whatever). Is there any reason for this change?

The old version of the generator which we used did not recognize associations at all. That's why I manually added those to the diagram, including the name of the corresponding property.

The current version of the generator does recognize associations, even though it only labels them as "dependency", but not with the name of the corresponding property.

[JakeQZ]

I spent a bit of time reordering the original 'relationships' section, after changing to the now-generated syntax, to conclude that there a quite a few differences there.

I think this needs three separate pre-patches so the diffs can be more clearly seen (along the lines of #1299):

1. Move class URL to be ASCII-sorted;
2. Change to use ..>, dependency and remove "*"/"1";
3. Reorder the relationships to be consistent with the generated order.

For reference, what I did for reviewing is on the branch at https://github.com/MyIntervals/PHP-CSS-Parser/tree/docs/class-diagram-review and includes all three of the above, which need to be split. And I may have made mistakes: there was a lot of cutting and pasting

[oliverklee]

I think this needs three separate pre-patches so the diffs can be more clearly seen

Makes sense, will do.

[JakeQZ]

It looks like it's adding all dependencies, even if they are only passed as method parameters, and not actually stored in class properties. This rather clutters the class diagram. The current one is reasonably easy to understand. The diagram after this change harder to understand and about three times the size.

Would it be possible to exclude dependencies that are only ever used as method parameters?

There seems to be a bug in that traits are completely ignored.

[JakeQZ]

Looks like it's now also picking up dependencies that are method parameters, not just properties.

[JakeQZ]

Looks like it's losing dependencies that are class properties via traits. The CommentContainer trait was added for classes that have Comments. Given that traits are not included in the class diagram, this looks to me like a bug in the generator (for which I think the better fix would be to include traits in their own right, like interfaces and classes).

[JakeQZ]

ValueList extents Value and also has Values as properties. It looks like the latter connection is being lost.

[oliverklee]

Okay, putting this on the backburner until the diagram generator has these two bugfixes/features.

I've created two tickets for that:

• Include associations from traits tasuku43/php-mermaid-class-diagram#26
• Feature request: Add switch to include/exclude parameters and return types from the diagram tasuku43/php-mermaid-class-diagram#27