Fix code style, improve coverage (#6)

* Fix code style, improve coverage

* Tiny change

Author: uuf6429

README.md

@@ -25,7 +25,7 @@ This library provides some interfaces and a basic implementation of a State Engi
 The recommended and easiest way to install this library is through [Composer](https://getcomposer.org/):
 
 ```bash
-composer require uuf6429/state-engine-php "^2.0"
+composer require "uuf6429/state-engine-php" "^2.0"
 ```
 
 ## 🧐 Why?
@@ -110,7 +110,8 @@ use uuf6429\StateEngine\Implementation\Entities\State;
 $door = Door::find(123);
 
 $doorStateMutator = Builder::makeStateMutator(
-    static function () use ($door): State {             // getter
+    // define how we get the state
+    static function () use ($door): State {
         if ($door->is_locked) {
             return new State('locked');
         }
@@ -119,7 +120,8 @@ $doorStateMutator = Builder::makeStateMutator(
             ? new State('open')
             : new State('closed');
     },
-    function (State $newState) use ($door): void {      // setter
+    // define how we set the state
+    static function (State $newState) use ($door): void {
         $door->update([
             'is_locked' => $newState->getName() === 'locked',
             'is_open' => $newState->getName() === 'open',

src/Implementation/AbstractEngine.php

@@ -5,7 +5,6 @@
 use Psr\EventDispatcher\EventDispatcherInterface;
 use uuf6429\StateEngine\Exceptions\TransitionNotDeclaredException;
 use uuf6429\StateEngine\Interfaces\EngineInterface;
-use uuf6429\StateEngine\Interfaces\StateInterface;
 use uuf6429\StateEngine\Interfaces\StateAwareInterface;
 use uuf6429\StateEngine\Interfaces\TransitionInterface;
 use uuf6429\StateEngine\Interfaces\TransitionRepositoryInterface;

src/Implementation/Entities/TransitionWithData.php

@@ -2,17 +2,15 @@
 
 namespace uuf6429\StateEngine\Implementation\Entities;
 
-use uuf6429\StateEngine\Interfaces\DescribableInterface;
 use uuf6429\StateEngine\Interfaces\StateInterface;
-use uuf6429\StateEngine\Interfaces\TransitionInterface;
 
 class TransitionWithData extends Transition
 {
     private array $data;
 
     public function __construct(StateInterface $oldState, array $data, StateInterface $newState, ?string $description = null)
     {
-        parent::__construct($oldState,$newState,$description);
+        parent::__construct($oldState, $newState, $description);
 
         $this->data = $data;
         ksort($this->data);

src/Implementation/Events/StateChanged.php

@@ -1,40 +1,29 @@
 <?php
 
-
 namespace uuf6429\StateEngine\Implementation\Events;
 
-
-use uuf6429\StateEngine\Interfaces\StateInterface;
 use uuf6429\StateEngine\Interfaces\StateAwareInterface;
+use uuf6429\StateEngine\Interfaces\StateInterface;
 
+/**
+ * Represents the event triggered after a state is changed.
+ */
 class StateChanged
 {
     private StateAwareInterface $item;
     private StateInterface $oldState;
 
-    /**
-     * Event triggered after a state is changed.
-     *
-     * @param StateAwareInterface $item
-     * @param StateInterface $oldState
-     */
     public function __construct(StateAwareInterface $item, StateInterface $oldState)
     {
         $this->item = $item;
         $this->oldState = $oldState;
     }
 
-    /**
-     * @return StateAwareInterface
-     */
     public function getItem(): StateAwareInterface
     {
         return $this->item;
     }
 
-    /**
-     * @return StateInterface
-     */
     public function getOldState(): StateInterface
     {
         return $this->oldState;

src/Implementation/Events/StateChanging.php

@@ -1,40 +1,29 @@
 <?php
 
-
 namespace uuf6429\StateEngine\Implementation\Events;
 
-
-use uuf6429\StateEngine\Interfaces\StateInterface;
 use uuf6429\StateEngine\Interfaces\StateAwareInterface;
+use uuf6429\StateEngine\Interfaces\StateInterface;
 
+/**
+ * Represents the event triggered before a state is changed.
+ */
 class StateChanging
 {
     private StateAwareInterface $item;
     private StateInterface $newState;
 
-    /**
-     * Event triggered before a state is changed.
-     *
-     * @param StateAwareInterface $item
-     * @param StateInterface $newState
-     */
     public function __construct(StateAwareInterface $item, StateInterface $newState)
     {
         $this->item = $item;
         $this->newState = $newState;
     }
 
-    /**
-     * @return StateAwareInterface
-     */
     public function getItem(): StateAwareInterface
     {
         return $this->item;
     }
 
-    /**
-     * @return StateInterface
-     */
     public function getNewState(): StateInterface
     {
         return $this->newState;

src/Implementation/Repositories/AbstractTraversable.php

@@ -2,6 +2,7 @@
 
 namespace uuf6429\StateEngine\Implementation\Repositories;
 
+use Exception;
 use IteratorAggregate;
 use Traversable;
 use uuf6429\StateEngine\Implementation\Traits\FindsTransition;
@@ -12,6 +13,9 @@ abstract class AbstractTraversable implements TransitionRepositoryInterface, Ite
 {
     use FindsTransition, StateTraversion;
 
+    /**
+     * @throws Exception
+     */
     public function all(): Traversable
     {
         return $this->getIterator();

src/Implementation/StateMachine.php

@@ -11,11 +11,11 @@ class StateMachine extends AbstractEngine
      * A shortcut to avoid getting a transition.
      *
      * @param StateAwareInterface $item
-     * @param array $input
+     * @param array $inputData
      */
-    public function processInput(StateAwareInterface $item, array $input): void
+    public function processInput(StateAwareInterface $item, array $inputData): void
     {
-        $transition = new Entities\TransitionWithData($item->getState(), $input, new State(''));
+        $transition = new Entities\TransitionWithData($item->getState(), $inputData, new State(''));
         $this->execute($item, $transition);
     }
 }

src/Implementation/Traits/FindsTransition.php

@@ -2,6 +2,7 @@
 
 namespace uuf6429\StateEngine\Implementation\Traits;
 
+use Exception;
 use uuf6429\StateEngine\Interfaces\TransitionInterface;
 use uuf6429\StateEngine\Interfaces\TransitionRepositoryInterface;
 
@@ -10,6 +11,9 @@
  */
 trait FindsTransition
 {
+    /**
+     * @throws Exception
+     */
     public function find(TransitionInterface $search): ?TransitionInterface
     {
         foreach ($this->all() as $match) {

src/Implementation/Traits/StateTraversion.php

@@ -2,6 +2,7 @@
 
 namespace uuf6429\StateEngine\Implementation\Traits;
 
+use Exception;
 use uuf6429\StateEngine\Interfaces\StateInterface;
 use uuf6429\StateEngine\Interfaces\TransitionInterface;
 use uuf6429\StateEngine\Interfaces\TransitionRepositoryInterface;
@@ -12,6 +13,9 @@
  */
 trait StateTraversion
 {
+    /**
+     * @throws Exception
+     */
     public function getForwardTransitions(StateInterface $state): array
     {
         /** @var $this TransitionRepositoryInterface */
@@ -23,6 +27,9 @@ static function (TransitionInterface $transition) use ($state): bool {
         ));
     }
 
+    /**
+     * @throws Exception
+     */
     public function getBackwardTransitions(StateInterface $state): array
     {
         /** @var $this TransitionRepositoryInterface */

src/Interfaces/EngineInterface.php

@@ -5,7 +5,7 @@
 interface EngineInterface
 {
     /**
-     * Transition an item to a new state given a transition.
+     * Transition an item to a new state given a {@see TransitionInterface} object.
      *
      * @param StateAwareInterface $item
      * @param TransitionInterface $transition