Aug 12, 2016 · Aug 12, 2016 · Aug 12, 2016 · Aug 12, 2016 · Aug 12, 2016 · Aug 16, 2016
diff --git a/_images/components/workflow/pull_request.png b/_images/components/workflow/pull_request.png
diff --git a/workflow/state-machines.rst b/workflow/state-machines.rst
 commonly have cyclic path in the definition graph but it is common for a state
 machine.

 Example of state machine
 ------------------------

 Consider the states a GitHub pull request may have. We have an initial "start"
 state, a state for running tests on "travis", then we have the "review" state
 where we can require changes, reject or accept the pull request. At anytime we
 could also "update" the pull request which will result in another "travis" run.

 .. image:: /_images/components/workflow/pull_request.png

 Below is the configuration for the pull request state machine.

 .. configuration-block::

    .. code-block:: yaml

        framework:
            workflows:
                blog_publishing:
                    type:
                        type: 'state_machine'
                    supports:
                        - AppBundle\Entity\BlogPost
                    places:
                        - draft
                pull_request:
                   type: 'state_machine'
                   marking_store:
                       type: scalar
                   supports:
                        - AppBundle\Entity\PullRequest
                   places:
                        - start
                        - coding
                        - travis
                        - review
                        - rejected
                        - published
                    transitions:
                        to_review:
                            from: [draft, rejected]
                            to:   review
                        publish:
                        - merged
                        - closed
                   transitions:
                        submit:
                            from: start
                            to: travis
                        update:
                            from: [coding, travis, review]
                            to: travis
                        wait_for_reivew:
                            from: travis
                            to: review
                        change_needed:
                            from: review
                            to:  published
 reject:
                            to:coding
 accepted:
                            from: review
                            to:   rejected


 With the configuration above we allow an object in place ``draft`` **or**
 ``rejected`` to be moved to ``review``. If the marking store had been of
 type ``scalar`` the object had to be in **both** places. ::

    $workflow = $this->container->get('state_machine.blog_publishing');
    $post = new \BlogPost();

    $post->state = 'draft';
    $workflow->can($post, 'to_review'); // True
                            to: merged
                        rejected:
                            from: review
                            to: closed
                        reopened:
                            from: closed
                            to: review

    $post->state = 'rejected';
    $workflow->can($post, 'to_review'); // True

 .. _Petri net: https://en.wikipedia.org/wiki/Petri_net
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,45 +11,59 @@ one place simultaneously. It is also worth noting that a workflow does not
		commonly have cyclic path in the definition graph but it is common for a state
Copy link Member wouterjNov 9, 2016 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. "[...] definition graph, but it [...]"
		machine.

		Example of state machine
Copy link Member wouterjNov 9, 2016 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. "Example of a State Machine"
		------------------------

		Consider the states a GitHub pull request may have. We have an initial "start"
		state, a state for running tests on "travis", then we have the "review" state
		where we can require changes, reject or accept the pull request. At anytime we
		could also "update" the pull request which will result in another "travis" run.
Copy link Member wouterjNov 9, 2016 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Please remove the first-person usage: A pull request starts in an intial "start" state, a state for e.g. runningtests on Travis. When this is finished, the pull request is in the "review"state, where contributors can require changes, reject or accept thepull request. At any time, you can also "update" the pull request, whichwill result in another Travis run. Copy link MemberAuthor NyholmNov 9, 2016 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Thank you

		.. image:: /_images/components/workflow/pull_request.png

		Below is the configuration for the pull request state machine.

		.. configuration-block::

		.. code-block:: yaml

		framework:
Copy link Member wouterjNov 9, 2016 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. please add`# app/config/config.yml`
		workflows:
		blog_publishing:
		type:
		type: 'state_machine'
		supports:
		- AppBundle\Entity\BlogPost
		places:
		- draft
		pull_request:
		type: 'state_machine'
		marking_store:
		type: scalar
		supports:
		- AppBundle\Entity\PullRequest
		places:
		- start
Copy link Contributor HeahDudeNov 11, 2016 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. I've started with many comments, so here a resume of what I suggest for the following: pull_request:type:'state_machine'supports: -AppBundle\Entity\PullRequestplaces: -started -coding -travis -needs_review -reviewed -merged -closedtransitions:test:from:[started, coding]to:travissubmit:from:travisto:needs_reviewrequest_change:from:[travis, needs_review, reviewed]to:codingaccept:from:needs_reviewto:reviewedreject:from:[coding, needs_review, reviewed]to:closedreopen:from:closedto:needs_reviewmerge:from:reviewedto:merged Wdyt? Actually when trying to dump it I've found a bug and submittedsymfony/symfony#20497 :)
		- coding
		- travis
		- review
		- rejected
		- published
		transitions:
		to_review:
		from: [draft, rejected]
		to: review
		publish:
		- merged
		- closed
		transitions:
		submit:
		from: start
		to: travis
		update:
		from: [coding, travis, review]
		to: travis
		wait_for_reivew:
		from: travis
		to: review
		change_needed:
		from: review
		to: published
		reject:
		to:coding
		accepted:
		from: review
		to: rejected


		With the configuration above we allow an object in place ``draft`` or
		``rejected`` to be moved to ``review``. If the marking store had been of
		type ``scalar`` the object had to be in both places. ::

		$workflow = $this->container->get('state_machine.blog_publishing');
		$post = new \BlogPost();

		$post->state = 'draft';
		$workflow->can($post, 'to_review'); // True
		to: merged
		rejected:
		from: review
		to: closed
		reopened:
Copy link Member xabbuhNov 11, 2016 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. What do you think about renaming the last four transitions to`request_change`,`accept`,`reject`, and`reopen` as we are describing actions and not events that just happened? Copy link MemberAuthor NyholmNov 11, 2016 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. 👍 You are correct
		from: closed
		to: review
Copy link Member wouterjNov 9, 2016 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. please add XML and PHP formats. <!-- app/config/config.xml--><?xml version="1.0" encoding="utf-8" ?><containerxmlns="http://symfony.com/schema/dic/services"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:framework="http://symfony.com/schema/dic/symfony"xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd"> <framework:config> <framework:workflowname="pull_request"type="state_machine"> <framework:marking-storetype="scalar"/> <framework:support>AppBundle\Entity\PullRequest</framework:support> <framework:place>start</framework:place> <framework:place>coding</framework:place> <framework:place>travis</framework:place> <framework:place>review</framework:place> <framework:place>merged</framework:place> <framework:place>closed</framework:place> <framework:transitionname="submit"> <framework:from>start</framework:from> <framework:to>travis</framework:to> </framework:transition> <framework:transitionname="update"> <framework:from>coding</framework:from> <framework:from>travis</framework:from> <framework:from>review</framework:from> <framework:to>travis</framework:to> </framework:transition> <framework:transitionname="wait_for_review"> <framework:from>travis</framework:from> <framework:to>review</framework:to> </framework:transition> <framework:transitionname="change_needed"> <framework:from>review</framework:from> <framework:to>coding</framework:to> </framework:transition> <framework:transitionname="accepted"> <framework:from>review</framework:from> <framework:to>merged</framework:to> </framework:transition> <framework:transitionname="rejected"> <framework:from>review</framework:from> <framework:to>closed</framework:to> </framework:transition> <framework:transitionname="reopened"> <framework:from>closed</framework:from> <framework:to>review</framework:to> </framework:transition> </framework:workflow> </framework:config></container> Copy link MemberAuthor NyholmNov 9, 2016 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Thank you. Im embarrassingly bad at the XML syntax for the config.

		$post->state = 'rejected';
		$workflow->can($post, 'to_review'); // True

		.. _Petri net: https://en.wikipedia.org/wiki/Petri_net