Escape labels in UmlDotGraphStyle#597
Merged
mclift merged 2 commits intodotnet-state-machine:devfrom Dec 23, 2024
nightroman:dev
Merged
Escape labels in UmlDotGraphStyle#597mclift merged 2 commits intodotnet-state-machine:devfrom nightroman:dev
UmlDotGraphStyle#597mclift merged 2 commits intodotnet-state-machine:devfrom
nightroman:dev
Conversation
Contributor
Author
|
Any feedback please? If it's not being addressed, I'd rather close the PR than have it in my TODO list... |
Collaborator
|
Hi @nightroman, just getting around to reviewing this, thanks for the bump. It might take a day or two. |
Contributor
Author
|
bump |
Member
|
Thanks for this, @nightroman. |
Contributor
Author
|
@mclift Thank you, looking forward to the NuGet package update! |
Merged
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
UmlDotGraphdoes not escape special characters like"and\in state,trigger, description labels. As a result, the generated DOT is invalid when
such labels exist.
This is not a big deal perhaps when labels are carefully selected in order to
work around this issue. But state machines may be dynamically created from
data/strings not originally designed with
Statelessand this issue in mind.This PR includes:
UmlDotGraphStyle.EscapeLabelUmlDotGraphStyleuses this method when requiredSimpleTransitionWithEscaping, similar toSimpleTransitionbut using problematic labelsSimpleTransitionUMLbecause it seems to be completely identical toSimpleTransitionSpacedUmlWithSubstateso that it uses problematic states, triggers, descriptionsP.S. I hit this issue with real use cases on making state machines in PowerShell for using with FarNet.Stateless.