fixes, simpler example given, cleanups

Author: coff

.gitignore

@@ -5,5 +5,5 @@ composer.phar
 
 # Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
 # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
-# composer.lock
+composer.lock
 

README.md

@@ -33,10 +33,13 @@ Maybe state machines are not what you usually do with PHP but when you do... jus
         public function init() {
             $this->setInitState(PetitionEnum::DRAFT());
 
-            // defines machine's allowed behavior, when no Assertion is given uses DefaultCallbackAssertion
+            // defines machine's allowed behavior
             $this
-                ->allowTransition(PetitionEnum::DRAFT(), PetitionEnum::SENT())
-                ->allowTransition(PetitionEnum::DRAFT(), PetitionEnum::CANCELED())
+                // prevents changing state upon assertion when AlwaysFalseAssertion is given
+                ->allowTransition(PetitionEnum::DRAFT(), PetitionEnum::SENT(), new AlwaysFalseAssertion())
+                ->allowTransition(PetitionEnum::DRAFT(), PetitionEnum::CANCELED(), new AlwaysFalseAssertion())
+                
+                // when no Assertion is given uses DefaultCallbackAssertion which calls assertXToY methods
                 ->allowTransition(PetitionEnum::SENT(), PetitionEnum::VOTED())
                 ->allowTransition(PetitionEnum::VOTED(), PetitionEnum::ACCEPTED())
                 ->allowTransition(PetitionEnum::VOTED(), PetitionEnum::REJECTED())

composer.json

@@ -12,7 +12,7 @@
   "autoload": {
     "psr-4": {
       "Coff\\SMF\\": "src/",
-      "Coff\\SMF\\Example": "example/"
+      "Coff\\SMF\\Example\\": "example/"
     }
   },
   "require": {

example/Boiler.php

@@ -0,0 +1,107 @@
+<?php
+
+namespace Coff\SMF\Example;
+
+use Coff\SMF\Assertion\AlwaysFalseAssertion;
+use Coff\SMF\Machine;
+use Coff\SMF\StateEnum;
+use Coff\SMF\Transition\Transition;
+
+include (__DIR__ . '/../vendor/autoload.php');
+
+class PetitionEnum extends StateEnum
+{
+    const __default = self::DRAFT,
+        DRAFT = 'draft',
+        SENT = 'sent',
+        VOTED = 'voted',
+        ACCEPTED = 'accepted',
+        REJECTED = 'rejected',
+        CANCELED = 'canceled';
+
+}
+
+class Petition extends Machine
+{
+
+    protected $votesYes, $votesNo;
+
+    public function init()
+    {
+        $this->setInitState(PetitionEnum::DRAFT());
+
+        // defines machine's allowed behavior, when no Assertion is given uses DefaultCallbackAssertion
+        $this
+            // prevents changing state upon assertion when AlwaysFalseAssertion is given
+            ->allowTransition(PetitionEnum::DRAFT(), PetitionEnum::SENT(), new AlwaysFalseAssertion())
+            ->allowTransition(PetitionEnum::DRAFT(), PetitionEnum::CANCELED(), new AlwaysFalseAssertion())
+
+            // when no Assertion is given uses DefaultCallbackAssertion which calls assertXToY methods
+            ->allowTransition(PetitionEnum::SENT(), PetitionEnum::VOTED())
+            ->allowTransition(PetitionEnum::VOTED(), PetitionEnum::ACCEPTED())
+            ->allowTransition(PetitionEnum::VOTED(), PetitionEnum::REJECTED());
+
+    }
+
+    public function send()
+    {
+        // shall throw an exception if current state is not DRAFT because it wasn't allowed transition
+        $this->setMachineState(PetitionEnum::SENT());
+    }
+
+    public function cancel()
+    {
+        // shall throw an exception if current state is not DRAFT because it wasn't allowed transition
+        $this->setMachineState(PetitionEnum::CANCELED());
+    }
+
+
+    public function setVotes($ya, $nay)
+    {
+        $this->votesYes = $ya;
+        $this->votesNo = $nay;
+    }
+
+    public function assertSentToVoted()
+    {
+        // Method name used here is based upon DefaultCallbackAssertion. This can be changed though.
+        return (null !== $this->votesYes && null !== $this->votesNo) ? true : false;
+    }
+
+
+    public function assertVotedToAccepted()
+    {
+        return $this->votesYes > $this->votesNo ? true : false;
+    }
+
+    public function assertVotedToRejected()
+    {
+        return $this->votesYes <= $this->votesNo ? true : false;
+    }
+
+    public function onTransition(Transition $transition)
+    {
+        /* for purpose of this example we only echo this transition but you can
+           easily dispatch an event from here */
+        echo 'State changed from ' . $transition->getFromState() . ' to ' . $transition->getToState() . PHP_EOL;
+    }
+}
+
+
+$p = new Petition();
+$p->init();
+
+echo 'Running...' . PHP_EOL;
+$p->run();
+
+echo 'Sending...' . PHP_EOL;
+$p->send();
+
+echo 'Running...' . PHP_EOL;
+$p->run();
+
+echo 'Setting votes...' . PHP_EOL;
+$p->setVotes(5, 1);
+
+echo 'Running...' . PHP_EOL;
+$p->run();

example/BoilerPump.php

@@ -14,7 +14,7 @@ class CallbackAssertion extends Assertion
     /** @var array */
     protected $params;
 
-    public function __construct(callable $callback = [], array $params = [])
+    public function __construct(callable $callback = null, array $params = [])
     {
         $this->callback = $callback;