Skip to content

[Workflow] Allow spaces in place names so the PUML dump doesn't break #48738

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
Merged
merged 1 commit into from
Dec 21, 2022
Merged

[Workflow] Allow spaces in place names so the PUML dump doesn't break #48738

merged 1 commit into from
Dec 21, 2022

Conversation

kamilmusial
Copy link

Remove state alias as not needed and use escaped name for a description

Q A
Branch? 5.4
Bug fix? yes
New feature? no
Deprecations? no
License MIT

Current PlantUmlDumper implementation doesn't allow states to have a description if state name contains spaces.

Sample definition:

framework:
    workflows:
        test:
           ...
            places:
                - 'place a'
                - 'place b'
            transitions:
                't 1':
                    from: 'place a'
                    to:   'place b'

produces following puml:

state "place a" <<initial>> as place a
place a : My custom place description
state "place b"
agent "t 1"
"place a" --> "t 1"
"t 1" --> "place b"

which contains a syntax error in line state "place a" <<initial>> as place a

A solution is to remove the state alias and use escaped name as a key:

...
state "place a" <<initial>>
"place a" : My custom place description

And then the diagram looks like:

simple-workflow-with-spaces-SimpleDiagram

@kamilmusial kamilmusial requested a review from lyrixx as a code owner December 21, 2022 12:05
@carsonbot carsonbot added this to the 5.4 milestone Dec 21, 2022
@carsonbot
Copy link

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

  • Always add tests
  • Keep backward compatibility (see https://symfony.com/bc).
  • Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
  • Features and deprecations must be submitted against the 6.3 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

lyrixx
lyrixx reviewed Dec 21, 2022
View reviewed changes
Copy link
Member

@lyrixx lyrixx left a comment

Choose a reason for hiding this comment

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

Good catch. Thanks 👍🏼
I let a very minor comment.

@goetas
Copy link
Contributor

goetas commented Dec 21, 2022

@kamilmusial CS if failing, see https://fabbot.io/report/symfony/symfony/48738/2986a5f11efd2669c82d340c790649ea766bf035

@nicolas-grekas
Copy link
Member

Thank you @kamilmusial.

@nicolas-grekas nicolas-grekas merged commit 4e26f68 into symfony:5.4 Dec 21, 2022
@kamilmusial kamilmusial deleted the 5.4 branch December 22, 2022 08:54
@kamilmusial kamilmusial restored the 5.4 branch December 22, 2022 08:54
@kamilmusial kamilmusial deleted the 5.4 branch December 22, 2022 08:55
@kamilmusial kamilmusial restored the 5.4 branch December 22, 2022 09:34
This was referenced Dec 28, 2022
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lyrixx lyrixx lyrixx left review comments

Assignees
No one assigned
Labels
Bug Status: Needs Review Workflow
Projects
None yet
Milestone
5.4
Development

Successfully merging this pull request may close these issues.
5 participants
@kamilmusial @carsonbot @goetas @nicolas-grekas @lyrixx