Skip to content

[REFACTOR] Replace StyleIdentifier by the BpmnStyleIdentifier class #1581

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.

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

Merged
merged 3 commits into from
Nov 3, 2021

Conversation

tbouffard
Copy link
Member

@tbouffard tbouffard commented Oct 24, 2021

Rename to clarify the intent: mxgraph style identifiers for our custom BPMN
implementation. This let remove the BPMN_STYLE prefix in all entries.
Switch from enum to class: there is no need to enumerate or iterate on properties.
They are not connected to each other, so enum makes no sense here.

This new implementation may introduce breaking changes for users implementing
custom BPMN Theme. In particular, users that

  • customized edge start and/or end fill color
  • registered custom shape for edge and/or message flow icon

Migration guide:

  • Instead of StyleIdentifier.BPMN_STYLE_<name>, use BpmnStyleIdentifier.<name>
    and update imports.
  • Values hold by the BpmnStyleIdentifier properties are left unchanged.

@tbouffard tbouffard added depends on another PR ⚠️ Pull request depending on another one. The depending must be merged first refactoring Code refactoring labels Oct 24, 2021
@github-actions
Copy link

github-actions bot commented Oct 24, 2021

♻️ PR Preview e901c6b has been successfully destroyed since this PR has been closed.

🤖 By surge-preview

@github-actions
Copy link

github-actions bot commented Oct 24, 2021

♻️ PR Preview e901c6b has been successfully destroyed since this PR has been closed.

🤖 By surge-preview

Rename to clarify the intent: mxgraph style identifiers for our custom BPMN
implementation. This let remove the `BPMN_STYLE` prefix in all entries.
Switch from enum to class: there is no need to enumerate or iterate on entries.
They are not connected to each other, so enum has no sense here.

This new implementation may introduce breaking changes for users implementing
custom BPMN Theme. In particular, users that
  - customized edge start and/or end fill color
  - registered custom shape for edge and/or message flow icon

Migration guide:
  - Instead of `StyleIdentifier.BPMN_STYLE_<name>`, use `BpmnStyleIdentifier .<name>`
  and update imports.
  - Values hold by the BpmnStyleIdentifier properties are left unchanged.
@tbouffard tbouffard force-pushed the refactor/rename_style_identifier branch from 6ad4528 to 6f235c2 Compare October 25, 2021 08:15
@tbouffard tbouffard removed the depends on another PR ⚠️ Pull request depending on another one. The depending must be merged first label Oct 25, 2021
@tbouffard tbouffard marked this pull request as ready for review October 25, 2021 08:22
@tbouffard tbouffard requested a review from csouchet October 25, 2021 08:22
@sonarqubecloud
Copy link

sonarqubecloud bot commented Nov 2, 2021

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

100.0% 100.0% Coverage
0.0% 0.0% Duplication

@csouchet csouchet merged commit 67c4212 into master Nov 3, 2021
@csouchet csouchet deleted the refactor/rename_style_identifier branch November 3, 2021 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Code refactoring
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants