diff --git a/.docs/README.md b/.docs/README.md new file mode 100644 index 0000000..a65905e --- /dev/null +++ b/.docs/README.md @@ -0,0 +1,55 @@ +## State + +A state in state machine that can be verified whether can be transitioned to another state. State accepts unique ID and optional context + +## Transitions + +You can use 2 predefined transitions. Transition has one role to decide whether you can go from one state to another + +* `StaticTransition` - which accepts FROM and TO states and boolean +* `CallableTransition` - which accepts FROM and TO states and callback. Callback is passed both states and must return boolean + +## Example usage + +```php +use Tlapnet\Stamus\State\State; +use Tlapnet\Stamus\StateMachineBuilder; +use Tlapnet\Stamus\Transition\StaticTransition; +use Tlapnet\Stamus\Transition\CallableTransition; + +// Create states +$state1 = new State('START'); +$state2 = new State('S2', ['isReady' => TRUE]); +$state3 = new State('END'); + +// Create transitions +$transition1 = new StaticTransition($state1, $state2); +$transition2 = new CallableTransition( + $state2, + $state3, + function(State $s2, State $s3): bool { + return $s2->getContext()['isReady'] === TRUE; + }); + +// Build state machine +$smb = new StateMachineBuilder(); +$smb->addState($state1); +$smb->addState($state2); +$smb->addState($state3); + +$smb->addTransition($transition1); +$smb->addTransition($transition2); + +$sm = $smb->build(); + +// Use machine +$sm->setCurrentState('START'); +if ($sm->canChange('S2')) { + $sm->change('S2'); +} + +if ($sm->getCurrentState()->getId() === 'S2') { + $sm->change('END'); +} + +``` diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..575834a --- /dev/null +++ b/.editorconfig @@ -0,0 +1,16 @@ +# EditorConfig is awesome: http://EditorConfig.org + +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +indent_style = tab +indent_size = tab +tab_width = 4 + +[{*.json,*.yml,*.md}] +indent_style = space +indent_size = 2 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..12910b6 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# Not archived +.docs export-ignore +tests export-ignore +.editorconfig export-ignore +.gitattributes export-ignore +.gitignore export-ignore +.travis.yml export-ignore +Makefile export-ignore +phpstan.neon export-ignore +README.md export-ignore +ruleset.xml export-ignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b1b6f4d --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +# IDE +/.idea + +# Composer +/vendor +/composer.lock + +# Tests +/temp +/coverage.xml diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..d21f2ca --- /dev/null +++ b/.travis.yml @@ -0,0 +1,55 @@ +language: php +php: + - 7.2 + - 7.3 + - 7.4snapshot + - nightly + +before_install: + - phpenv config-rm xdebug.ini || return 0 # Turn off XDebug + +install: + - travis_retry composer install --no-progress --prefer-dist # Install dependencies + +script: + - make tests # Tests + +jobs: + include: + - env: title="Lowest Dependencies 7.2" + php: 7.2 + install: + - travis_retry composer update --no-progress --prefer-dist --prefer-lowest --prefer-stable + script: + - make tests + + - stage: Quality Assurance + php: 7.3 + script: + - make qa + + - stage: Test Coverage + if: branch = master AND type = push + php: 7.3 + script: + - make coverage + after_script: + - composer global require php-coveralls/php-coveralls ^2.1.0 + - ~/.composer/vendor/bin/php-coveralls --verbose --config tests/.coveralls.yml + + - stage: Outdated Dependencies + if: branch = master AND type = cron + php: 7.3 + script: + - composer outdated --direct + + allow_failures: + - stage: Test Coverage + - php: 7.4snapshot + - php: nightly + +sudo: false + +cache: + directories: + - $HOME/.composer/cache diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a612ad9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..5c23fc5 --- /dev/null +++ b/Makefile @@ -0,0 +1,27 @@ +.PHONY: qa lint cs csf phpstan tests coverage + +all: + @$(MAKE) -pRrq -f $(lastword $(MAKEFILE_LIST)) : 2>/dev/null | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' | sort | egrep -v -e '^[^[:alnum:]]' -e '^$@$$' | xargs + +vendor: composer.json composer.lock + composer install + +qa: lint phpstan cs + +lint: vendor + vendor/bin/linter src tests + +cs: vendor + vendor/bin/codesniffer src tests + +csf: vendor + vendor/bin/codefixer src tests + +phpstan: vendor + vendor/bin/phpstan analyse -l max -c phpstan.neon src + +tests: vendor + vendor/bin/phpunit tests --colors=always + +coverage: vendor + phpdbg -qrr vendor/bin/phpunit tests --colors=always -c tests/coverage.xml diff --git a/README.md b/README.md new file mode 100644 index 0000000..446688f --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# Tlapnet Stamus + +Simple state machine library for verifying State transitions + +[![Build Status](https://img.shields.io/travis/tlapnet/stamus.svg?style=flat-square)](https://travis-ci.org/tlapnet/stamus) +[![Code coverage](https://img.shields.io/coveralls/tlapnet/stamus.svg?style=flat-square)](https://coveralls.io/r/tlapnet/stamus) +[![Licence](https://img.shields.io/packagist/l/tlapnet/stamus.svg?style=flat-square)](https://packagist.org/packages/tlapnet/stamus) +[![Downloads this Month](https://img.shields.io/packagist/dm/tlapnet/stamus.svg?style=flat-square)](https://packagist.org/packages/tlapnet/stamus) +[![Downloads total](https://img.shields.io/packagist/dt/tlapnet/stamus.svg?style=flat-square)](https://packagist.org/packages/tlapnet/stamus) +[![Latest stable](https://img.shields.io/packagist/v/tlapnet/stamus.svg?style=flat-square)](https://packagist.org/packages/tlapnet/stamus) +[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-brightgreen.svg?style=flat-square)](https://github.com/phpstan/phpstan) + +## Documentation + +- [State](.docs/README.md#state) +- [Transitions](.docs/README.md#transitions) +- [Example usage](.docs/README.md#example-usage) + +## Versions + +| State | Version | Branch | PHP | +|-------------|---------|----------|--------| +| stable | `^0.1` | `master` | `^7.2` | + + +## Maintainers + + + + + + + +
+ + + +
+ Milan Felix Šulc +
diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..2e5f381 --- /dev/null +++ b/composer.json @@ -0,0 +1,43 @@ +{ + "name": "tlapnet/stamus", + "description": "State Machine", + "type": "library", + "license": "MPL-2.0", + "homepage": "https://github.com/tlapnet/stamus", + "authors": [ + { + "name": "Milan Felix Šulc", + "homepage": "https://f3l1x.io" + } + ], + "require": { + "php": "^7.2" + }, + "require-dev": { + "ninjify/qa": "^0.9.0", + "phpstan/phpstan-deprecation-rules": "^0.11", + "phpstan/phpstan-shim": "^0.11", + "phpstan/phpstan-strict-rules": "^0.11", + "phpunit/phpunit": "^8.1" + }, + "autoload": { + "psr-4": { + "Tlapnet\\Stamus\\": "src" + } + }, + "autoload-dev": { + "psr-4": { + "Tests\\Tlapnet\\Stamus\\": "tests" + } + }, + "minimum-stability": "dev", + "prefer-stable": true, + "config": { + "sort-packages": true + }, + "extra": { + "branch-alias": { + "dev-develop": "0.1.x-dev" + } + } +} diff --git a/phpstan.neon b/phpstan.neon new file mode 100644 index 0000000..d72e6af --- /dev/null +++ b/phpstan.neon @@ -0,0 +1,3 @@ +includes: + - vendor/phpstan/phpstan-deprecation-rules/rules.neon + - vendor/phpstan/phpstan-strict-rules/rules.neon diff --git a/ruleset.xml b/ruleset.xml new file mode 100644 index 0000000..91ea5c4 --- /dev/null +++ b/ruleset.xml @@ -0,0 +1,16 @@ + + + + + + + + + + + + + diff --git a/src/Exception/Logical/DuplicateStateException.php b/src/Exception/Logical/DuplicateStateException.php new file mode 100644 index 0000000..331faa0 --- /dev/null +++ b/src/Exception/Logical/DuplicateStateException.php @@ -0,0 +1,10 @@ +transitions = $transitions; + } + + /** + * @return Transition[] + */ + public function getTransitions(): array + { + return $this->transitions; + } + +} diff --git a/src/Exception/RuntimeException.php b/src/Exception/RuntimeException.php new file mode 100644 index 0000000..5e0ed00 --- /dev/null +++ b/src/Exception/RuntimeException.php @@ -0,0 +1,8 @@ +id = $id; + $this->context = $context; + } + + public function getId(): string + { + return $this->id; + } + + /** + * @return mixed|null + */ + public function getContext() + { + return $this->context; + } + +} diff --git a/src/StateMachine.php b/src/StateMachine.php new file mode 100644 index 0000000..2924596 --- /dev/null +++ b/src/StateMachine.php @@ -0,0 +1,216 @@ +getId(), $this->states)) { + throw new DuplicateStateException(sprintf('State (%s) alredy exists.', $state->getId())); + } + + $this->states[$state->getId()] = $state; + } + + $this->transitions = $transitions; + } + + /** + * @return State[] + */ + public function getStates(): array + { + return $this->states; + } + + /** + * @return Transition[] + */ + public function getTransitions(): array + { + return $this->transitions; + } + + public function getCurrentState(): ?State + { + return $this->currentState; + } + + public function setCurrentState(string $state): void + { + // Lookup for state by ID + $found = $this->findState($state); + + // Validation + if ($found === null) { + throw new InvalidArgumentException(sprintf('State "%s" not found', $state)); + } + + $this->currentState = $found; + } + + /** + * STATE API *************************************************************** + */ + + /** + * Try to change SM to given state + * + * @throws UniqueTransitionException + */ + public function canChange(string $state): bool + { + // Validate current state + if ($this->currentState === null) { + throw new InvalidStateException('No current state selected'); + } + + try { + $this->resolveTransition($this->currentState, $state); + + return true; + } catch (NoSuitableTransitionException $e) { + return false; + } + } + + /** + * Sets current state if possible + * + * @throws UniqueTransitionException + */ + public function change(string $state): void + { + if (!$this->canChange($state)) { + throw new CannotGoToNextStateException( + sprintf( + 'Cannot go from "%s" to "%s"', + $this->currentState !== null ? $this->currentState->getId() : 'unknown', + $state + ) + ); + } + + $this->currentState = $this->findState($state); + } + + /** + * HELPERS ***************************************************************** + */ + + /** + * Lookup for state by ID + */ + protected function findState(string $state): ?State + { + return $this->states[$state] ?? null; + } + + /** + * Lookup for transitions by state + * + * @return Transition[] + */ + protected function findTransitionsByState(State $state): array + { + if (!isset($this->states[$state->getId()])) { + throw new InvalidStateException( + sprintf('Cannot search transitions for unknown state "%s"', $state->getId()) + ); + } + + $transitions = []; + + foreach ($this->transitions as $t) { + if ($t->getFrom() === $state) { + $transitions[] = $t; + } + } + + return $transitions; + } + + /** + * Resolve transition between two states + * + * @throws NoSuitableTransitionException + * @throws UniqueTransitionException + */ + protected function resolveTransition(State $fromState, string $toState): bool + { + if (!isset($this->states[$toState])) { + throw new InvalidStateException( + sprintf('Unknown go-to state "%s"', $toState) + ); + } + + // Lookup for transitions by states + $transitions = $this->findTransitionsByState($fromState); + + if ($transitions === []) { + throw new InvalidStateException( + sprintf('No transitions defined for state "%s"', $fromState->getId()) + ); + } + + // Iterate over all transitions from $fromState + // Only one possible is allowed + $validTransitions = []; + + foreach ($transitions as $t) { + if ($t->evaluate($fromState, $t->getTo()) === false) { + continue; + } + + $validTransitions[] = $t; + } + + if (count($validTransitions) > 1) { + throw new UniqueTransitionException( + sprintf('State "%s" transitions to multiple states under same condition.', $fromState->getId()), + $validTransitions + ); + } + + // If there is transition to correct state + if (count($validTransitions) === 1 && $validTransitions[0]->getTo()->getId() === $toState) { + return true; + } + + throw new NoSuitableTransitionException('Not suitable transition found'); + } + +} diff --git a/src/StateMachineBuilder.php b/src/StateMachineBuilder.php new file mode 100644 index 0000000..b378571 --- /dev/null +++ b/src/StateMachineBuilder.php @@ -0,0 +1,32 @@ +states[] = $state; + } + + public function addTransition(Transition $transition): void + { + $this->transitions[] = $transition; + } + + public function build(): StateMachine + { + return new StateMachine($this->states, $this->transitions); + } + +} diff --git a/src/Transition/CallableTransition.php b/src/Transition/CallableTransition.php new file mode 100644 index 0000000..074ddc3 --- /dev/null +++ b/src/Transition/CallableTransition.php @@ -0,0 +1,24 @@ +callback = $callback; + } + + public function evaluate(State $from, State $to): bool + { + return call_user_func($this->callback, $from, $to); + } + +} diff --git a/src/Transition/StaticTransition.php b/src/Transition/StaticTransition.php new file mode 100644 index 0000000..e08e3ff --- /dev/null +++ b/src/Transition/StaticTransition.php @@ -0,0 +1,24 @@ +evaluator = $evaluator; + } + + public function evaluate(State $from, State $to): bool + { + return $this->evaluator; + } + +} diff --git a/src/Transition/Transition.php b/src/Transition/Transition.php new file mode 100644 index 0000000..be49b8c --- /dev/null +++ b/src/Transition/Transition.php @@ -0,0 +1,34 @@ +from = $from; + $this->to = $to; + } + + public function getFrom(): State + { + return $this->from; + } + + public function getTo(): State + { + return $this->to; + } + + abstract public function evaluate(State $from, State $to): bool; + +} diff --git a/tests/.coveralls.yml b/tests/.coveralls.yml new file mode 100644 index 0000000..82764a3 --- /dev/null +++ b/tests/.coveralls.yml @@ -0,0 +1,4 @@ +# for php-coveralls +service_name: travis-ci +coverage_clover: coverage.xml +json_path: coverage.json diff --git a/tests/Unit/StateMachineTest.php b/tests/Unit/StateMachineTest.php new file mode 100644 index 0000000..741a4f5 --- /dev/null +++ b/tests/Unit/StateMachineTest.php @@ -0,0 +1,213 @@ +expectException(InvalidArgumentException::class); + $sm = new StateMachine([], []); + } + + public function testNoTransitionsGiven(): void + { + $this->expectException(InvalidArgumentException::class); + $sm = new StateMachine([new State('S1')], []); + } + + public function testDuplicateStatesGiven(): void + { + $this->expectException(DuplicateStateException::class); + + $s1 = new State('S1'); + $s2 = new State('S2'); + $s3 = new State('S1'); + $sm = new StateMachine( + [$s1, $s2, $s3], + [new StaticTransition($s1, $s3)] + ); + } + + public function testUniqueTransition(): void + { + $this->expectException(UniqueTransitionException::class); + + $s1 = new State('S1'); + $s2 = new State('S2'); + $s3 = new State('S3'); + $sm = new StateMachine( + [$s1, $s2, $s3], + [new StaticTransition($s1, $s2), new StaticTransition($s1, $s3)] + ); + + $sm->setCurrentState('S1'); + $sm->canChange('S3'); + } + + public function testStateMachine1(): void + { + $state1 = new State('START'); + $state2 = new State('S2'); + $state3 = new State('S3'); + $state4 = new State('END'); + + $t1 = new StaticTransition($state1, $state2); + $t2 = new StaticTransition($state2, $state3); + $t3 = new StaticTransition($state3, $state4); + + $sm = new StateMachine([ + $state1, + $state2, + $state3, + $state4, + ], [ + $t1, + $t2, + $t3, + ]); + + $this->assertNull($sm->getCurrentState()); + + // Change initialize state + $sm->setCurrentState('START'); + $this->assertSame($state1, $sm->getCurrentState()); + + $this->assertTrue($sm->canChange('S2')); + $sm->change('S2'); + $this->assertSame($state2, $sm->getCurrentState()); + + $this->assertTrue($sm->canChange('S3')); + $sm->change('S3'); + $this->assertSame($state3, $sm->getCurrentState()); + + $this->assertTrue($sm->canChange('END')); + $sm->change('END'); + $this->assertSame($state4, $sm->getCurrentState()); + } + + public function testStateMachine2(): void + { + $state1 = new State('START'); + $state2 = new State('END'); + + $t1 = new StaticTransition($state1, $state2, false); + + $sm = new StateMachine([ + $state1, + $state2, + ], [ + $t1, + ]); + + // Change initialize state + $sm->setCurrentState('START'); + $this->assertSame($state1, $sm->getCurrentState()); + + $this->assertFalse($sm->canChange('END')); + } + + public function testStateMachine3(): void + { + $state1 = new State('START'); + $state2 = new State('END'); + + $t1 = new StaticTransition($state1, $state2, false); + $t2 = new StaticTransition($state1, $state2, true); + + $sm = new StateMachine([ + $state1, + $state2, + ], [ + $t1, + $t2, + ]); + + // Change initialize state + $sm->setCurrentState('START'); + $this->assertSame($state1, $sm->getCurrentState()); + + $this->assertTrue($sm->canChange('END')); + } + + public function testStateMachine4(): void + { + $state1 = new State('START'); + $state2 = new State('END'); + + $t1 = new StaticTransition($state1, $state2, false); + $t2 = new StaticTransition($state1, $state2, false); + + $sm = new StateMachine([ + $state1, + $state2, + ], [ + $t1, + $t2, + ]); + + // Change initialize state + $sm->setCurrentState('START'); + $this->assertSame($state1, $sm->getCurrentState()); + + $this->assertFalse($sm->canChange('END')); + } + + public function testStateMachine5(): void + { + $process = new stdClass(); + $process->foo = false; + + $state1 = new State('START'); + $state2 = new State('S1'); + $state3 = new State('S2', $process); + $state4 = new State('END'); + + $t1 = new StaticTransition($state1, $state2); + $t2 = new StaticTransition($state2, $state3); + $t3 = new CallableTransition($state3, $state4, function (State $from, State $to): bool { + return $from->getContext()->foo; + }); + $t4 = new CallableTransition($state3, $state2, function (State $from, State $to): bool { + return !$from->getContext()->foo; + }); + + $sm = new StateMachine([ + $state1, + $state2, + $state3, + $state4, + ], [ + $t1, + $t2, + $t3, + $t4, + ]); + + $sm->setCurrentState('START'); + $this->assertTrue($sm->canChange('S1')); + $sm->change('S1'); + $this->assertTrue($sm->canChange('S2')); + $sm->change('S2'); + $this->assertFalse($sm->canChange('END')); + $this->assertTrue($sm->canChange('S1')); + $sm->change('S1'); + $process->foo = true; + $this->assertTrue($sm->canChange('S2')); + $sm->change('S2'); + $this->assertTrue($sm->canChange('END')); + $sm->change('END'); + } + +} diff --git a/tests/Unit/StateTest.php b/tests/Unit/StateTest.php new file mode 100644 index 0000000..c8bc7d8 --- /dev/null +++ b/tests/Unit/StateTest.php @@ -0,0 +1,18 @@ +expectException(InvalidArgumentException::class); + new State(''); + } + +} diff --git a/tests/coverage.xml b/tests/coverage.xml new file mode 100644 index 0000000..180ebfa --- /dev/null +++ b/tests/coverage.xml @@ -0,0 +1,11 @@ + + + + + ./../src + + + + + +