[Workfow] Rename current MarkingStore #20462

lyrixx · 2016-11-09T13:41:13Z

Q	A
Branch?	master
Bug fix?	no
New feature?	no
BC breaks?	yes (in un-released branch)
Deprecations?	no
Tests pass?	yes
Fixed tickets	-
License	MIT
Doc PR	-

ScalarMarkingStore -> SingleStateMarkingStore
PropertyAccessorMarkingStore -> MultipleStateMarkingStore

And I also made optionnal the marking_store config, to let the
componant choose the best marking store depending on the type
(state_machine or workflow).

Note: I did that to ease the on-boarding

Nyholm · 2016-11-09T13:45:56Z

I like this change. It makes it easier to understand the differences between the two.

👍

wouterj · 2016-11-09T13:51:23Z

👍 Lot more descriptive (still a bit confused by "MarkingStore" but it's probably more correct if you're into the workflow nets)

Nyholm · 2016-11-09T14:00:10Z

The term is "marking" from the Petri net and that is something we should not change. But "store".. if we are not happy with it we can maybe could consider renaming it to "Strategy"

lyrixx · 2016-11-09T14:03:19Z

Actually, I made the marking_store configuration optional.

So this is the minimal config:

Workflow:

framework:
    workflows:
        article:
            supports:
                - AppBundle\Entity\Article
            places:
                - draft
                - wait_for_journalist
                - approved_by_journalist
                - wait_for_spellchecker
                - approved_by_spellchecker
                - published
            transitions:
                request_review:
                    from: draft
                    to:
                        - wait_for_journalist
                        - wait_for_spellchecker
                journalist_approval:
                    from: wait_for_journalist
                    to: approved_by_journalist
                spellchecker_approval:
                    from: wait_for_spellchecker
                    to: approved_by_spellchecker
                publish:
                    from:
                        - approved_by_journalist
                        - approved_by_spellchecker
                    to: published

state machine:

        task:
            type: state_machine
            supports:
                - AppBundle\Entity\Task
            places:
                - backlog
                - in_progress
                - done
            transitions:
                processing:
                    from: backlog
                    to: in_progress
                done:
                    from: in_progress
                    to: done

As you can see, we never talk about the marking store.

About the class name: it really save / get the Marking from a POPO. So I prefer MarkingStore to MarkingStrategy.

Nyholm · 2016-11-09T14:06:19Z

Im also fine with "store". I just tried to consider the alternatives because Wouter pointed it out.

nicolas-grekas · 2016-11-09T14:22:35Z

👍

fabpot · 2016-11-09T14:53:39Z

src/Symfony/Component/Workflow/MarkingStore/MultipleStateMarkingStore.php

@@ -16,17 +16,17 @@
 use Symfony\Component\Workflow\Marking;

 /**
- * PropertyAccessorMarkingStore.
+ * MultipleStateMarkingStore.


You should describe the class instead of just using the class name, which does not really help.

I updated the wording.

fabpot · 2016-11-09T15:16:48Z

👍

* ScalarMarkingStore -> SingleStateMarkingStore * PropertyAccessorMarkingStore -> MultipleStateMarkingStore And I also made optionnal the `marking_store` config, to let the componant choose the best marking store depending on the type (state_machine or workflow).

This PR was merged into the 3.2-dev branch. Discussion ---------- [Workfow] Rename current MarkingStore | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | yes (in un-released branch) | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - * ScalarMarkingStore -> SingleStateMarkingStore * PropertyAccessorMarkingStore -> MultipleStateMarkingStore And I also made optionnal the `marking_store` config, to let the componant choose the best marking store depending on the type (state_machine or workflow). --- Note: I did that to ease the on-boarding Commits ------- 08464c9 [Workfow] Rename current MarkingStore

stof · 2016-11-09T20:23:06Z

PropertyAccessorMarkingStore -> MultipleStateMarkingStore looks weird to me. This marking store is special because it relies on PropertyAccess. We could have other marking stores supporting multiple state and using a different implementation internally

Nyholm · 2016-11-09T20:45:22Z

You are technically correct but in practice it will be considered an edge case that you would need a MultipleStateMarkingStore that has another implementation than PropertyAccess.

Since it is rare, I'm fine with the name MultipleStateMarkingStore because it is way easier in to understand what it does.

xabbuh · 2016-11-10T09:53:15Z

src/Symfony/Component/Workflow/MarkingStore/MultipleStateMarkingStore.php

+ * subject.
+ *
+ * This store deals with a "multiple state" Marking. It means a subject can be
+ * in many state at the same time.


xabbuh · 2016-11-10T09:53:31Z

src/Symfony/Component/Workflow/MarkingStore/MultipleStateMarkingStore.php

 {
    private $property;
    private $propertyAccessor;

    /**
-     * PropertyAccessorMarkingStore constructor.
+     * MultipleStateMarkingStore constructor.


This doesn't add any value.

xabbuh · 2016-11-10T09:53:52Z

src/Symfony/Component/Workflow/MarkingStore/SingleStateMarkingStore.php

+ * SingleStateMarkingStore stores the marking into a property of the subject.
+ *
+ * This store deals with a "single state" Marking. It means a subject can be in
+ * one and only state at the same time.


[...] and only one state [...]

xabbuh · 2016-11-10T09:54:03Z

src/Symfony/Component/Workflow/MarkingStore/SingleStateMarkingStore.php

 {
    private $property;
    private $propertyAccessor;

    /**
-     * ScalarMarkingStore constructor.
+     * SingleStateMarkingStore constructor.


same as above

lyrixx · 2016-11-10T10:45:39Z

@xabbuh Thanks for your review. I opened a new PR.

lyrixx added FrameworkBundle Workflow labels Nov 9, 2016

lyrixx mentioned this pull request Nov 9, 2016

Added docs for Workflow component symfony/symfony-docs#6871

Closed

lyrixx force-pushed the workflow-renaming branch from b89c93a to 7aa1564 Compare November 9, 2016 13:45

Nyholm approved these changes Nov 9, 2016

View reviewed changes

lyrixx force-pushed the workflow-renaming branch from 7aa1564 to 10f3aee Compare November 9, 2016 14:29

fabpot reviewed Nov 9, 2016

View reviewed changes

lyrixx force-pushed the workflow-renaming branch 3 times, most recently from a1dc444 to 0c1cba2 Compare November 9, 2016 15:16

javiereguiluz added this to the 3.2 milestone Nov 9, 2016

lyrixx force-pushed the workflow-renaming branch from 0c1cba2 to 08464c9 Compare November 9, 2016 15:22

lyrixx merged commit 08464c9 into symfony:master Nov 9, 2016

lyrixx deleted the workflow-renaming branch November 9, 2016 15:40

Nyholm added a commit to Nyholm/symfony-docs that referenced this pull request Nov 9, 2016

Updated to support changes in symfony/symfony#20462

c9b1656

xabbuh reviewed Nov 10, 2016

View reviewed changes

lyrixx mentioned this pull request Nov 10, 2016

[Workflow] Fixed PHPDocs #20470

Closed

fduch mentioned this pull request Nov 10, 2016

Update bundle to support new changes in 3.2's FrameworkBundle fduch/workflow-bundle#6

Closed

fduch mentioned this pull request Nov 23, 2016

update per changes to [email protected] fduch/workflow-bundle#7

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workfow] Rename current MarkingStore #20462

[Workfow] Rename current MarkingStore #20462

lyrixx commented Nov 9, 2016 •

edited

Loading

Nyholm commented Nov 9, 2016

wouterj commented Nov 9, 2016

Nyholm commented Nov 9, 2016

lyrixx commented Nov 9, 2016

Nyholm commented Nov 9, 2016

nicolas-grekas commented Nov 9, 2016

fabpot Nov 9, 2016

lyrixx Nov 9, 2016

fabpot commented Nov 9, 2016

stof commented Nov 9, 2016

Nyholm commented Nov 9, 2016 •

edited

Loading

xabbuh Nov 10, 2016

xabbuh Nov 10, 2016

xabbuh Nov 10, 2016

xabbuh Nov 10, 2016

lyrixx commented Nov 10, 2016

[Workfow] Rename current MarkingStore #20462

[Workfow] Rename current MarkingStore #20462

Conversation

lyrixx commented Nov 9, 2016 • edited Loading

Nyholm commented Nov 9, 2016

wouterj commented Nov 9, 2016

Nyholm commented Nov 9, 2016

lyrixx commented Nov 9, 2016

Nyholm commented Nov 9, 2016

nicolas-grekas commented Nov 9, 2016

fabpot Nov 9, 2016

Choose a reason for hiding this comment

lyrixx Nov 9, 2016

Choose a reason for hiding this comment

fabpot commented Nov 9, 2016

stof commented Nov 9, 2016

Nyholm commented Nov 9, 2016 • edited Loading

xabbuh Nov 10, 2016

Choose a reason for hiding this comment

xabbuh Nov 10, 2016

Choose a reason for hiding this comment

xabbuh Nov 10, 2016

Choose a reason for hiding this comment

xabbuh Nov 10, 2016

Choose a reason for hiding this comment

lyrixx commented Nov 10, 2016

lyrixx commented Nov 9, 2016 •

edited

Loading

Nyholm commented Nov 9, 2016 •

edited

Loading