Feature: callbacks on states and transitions

.travis.yml

@@ -1,9 +1,7 @@
 language: php
 sudo: false
+# disabled old php build (http://php.net/eol.php)
 php:
-    - 5.3
-    - 5.4
-    - 5.5
     - 5.6
     - 7
     - hhvm

src/Finite/Bundle/FiniteBundle/DependencyInjection/Compiler/ContainerCallbackPass.php

@@ -2,6 +2,7 @@
 
 namespace Finite\Bundle\FiniteBundle\DependencyInjection\Compiler;
 
+use Finite\Event\Callback\Callback;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
@@ -24,14 +25,14 @@ public function process(ContainerBuilder $container)
             $definition = $container->getDefinition($id);
             $config = $definition->getArgument(0);
             if (isset($config['callbacks'])) {
-                foreach (array('before', 'after') as $position) {
+                foreach (array(Callback::CLAUSE_BEFORE, Callback::CLAUSE_AFTER) as $position) {
                     foreach ($config['callbacks'][$position] as &$callback) {
                         if (
-                            is_array($callback['do'])
-                            && 0 === strpos($callback['do'][0], '@')
-                            && $container->hasDefinition(substr($callback['do'][0], 1))
+                            is_array($callback[Callback::CLAUSE_DO])
+                            && 0 === strpos($callback[Callback::CLAUSE_DO][0], '@')
+                            && $container->hasDefinition(substr($callback[Callback::CLAUSE_DO][0], 1))
                         ) {
-                            $callback['do'][0] = new Reference(substr($callback['do'][0], 1));
+                            $callback[Callback::CLAUSE_DO][0] = new Reference(substr($callback[Callback::CLAUSE_DO][0], 1));
                         }
                     }
                 }

src/Finite/Bundle/FiniteBundle/DependencyInjection/Configuration.php

@@ -2,6 +2,7 @@
 
 namespace Finite\Bundle\FiniteBundle\DependencyInjection;
 
+use Finite\Event\Callback\Callback;
 use Symfony\Component\Config\Definition\Builder\NodeBuilder;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
@@ -86,8 +87,8 @@ protected function addTransitionSection(NodeBuilder $rootProto)
     protected function addCallbackSection(NodeBuilder $rootProto)
     {
         $callbacks = $rootProto->arrayNode('callbacks')->children();
-        $this->addSubCallbackSection($callbacks, 'before');
-        $this->addSubCallbackSection($callbacks, 'after');
+        $this->addSubCallbackSection($callbacks, Callback::CLAUSE_BEFORE);
+        $this->addSubCallbackSection($callbacks, Callback::CLAUSE_AFTER);
         $callbacks->end()->end();
     }
 

src/Finite/Bundle/FiniteBundle/DependencyInjection/FiniteFiniteExtension.php

@@ -2,6 +2,7 @@
 
 namespace Finite\Bundle\FiniteBundle\DependencyInjection;
 
+use Finite\Event\Callback\Callback;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader;
@@ -68,7 +69,7 @@ protected function removeDisabledCallbacks(array $config)
             return $config;
         }
 
-        foreach (array('before', 'after') as $position) {
+        foreach (array(Callback::CLAUSE_BEFORE, Callback::CLAUSE_AFTER) as $position) {
             foreach ($config['callbacks'][$position] as $i => $callback) {
                 if ($callback['disabled']) {
                     unset($config['callbacks'][$position][$i]);

src/Finite/Bundle/FiniteBundle/Resources/config/services.xml

@@ -42,5 +42,4 @@
             <tag name="twig.extension" />
         </service>
     </services>
-
 </container>

src/Finite/Event/Callback/Callback.php

@@ -9,19 +9,26 @@
  */
 class Callback implements CallbackInterface
 {
+    const CLAUSE_AFTER = 'after';
+    const CLAUSE_BEFORE = 'before';
+    const CLAUSE_FROM = 'from';
+    const CLAUSE_TO = 'to';
+    const CLAUSE_ON = 'on';
+    const CLAUSE_DO = 'do';
+
     /**
      * @var CallbackSpecificationInterface
      */
     private $specification;
 
     /**
-     * @var callable
+     * @var array callable
      */
     private $callable;
 
     /**
      * @param CallbackSpecificationInterface $callbackSpecification
-     * @param callable                       $callable
+     * @param $callable
      */
     public function __construct(CallbackSpecificationInterface $callbackSpecification, $callable)
     {
@@ -37,6 +44,22 @@ public function getSpecification()
         return $this->specification;
     }
 
+    /**
+     * @return array callable
+     */
+    public function getCallbacks()
+    {
+        return $this->callable;
+    }
+
+    /**
+     * @return array
+     */
+    public function getClauses()
+    {
+        return $this->specification->getClauses();
+    }
+
     /**
      * {@inheritdoc}
      */

src/Finite/Event/Callback/CallbackInterface.php

@@ -15,4 +15,19 @@ interface CallbackInterface
      * @param TransitionEvent $event
      */
     public function __invoke(TransitionEvent $event);
+
+    /**
+     * @return CallbackSpecificationInterface
+     */
+    public function getSpecification();
+
+    /**
+     * @return array callable
+     */
+    public function getCallbacks();
+
+    /**
+     * @return array
+     */
+    public function getClauses();
 }

src/Finite/Event/Callback/CallbackSpecification.php

@@ -36,7 +36,7 @@ public function __construct(StateMachineInterface $sm, array $from, array $to, a
         $isExclusion = function ($str) { return 0 === strpos($str, '-'); };
         $removeDash = function ($str) { return substr($str, 1); };
 
-        foreach (array('from', 'to', 'on') as $clause) {
+        foreach (array(Callback::CLAUSE_FROM, Callback::CLAUSE_TO, Callback::CLAUSE_ON) as $clause) {
             $excludedClause = 'excluded_'.$clause;
 
             $this->specs[$excludedClause] = array_filter(${$clause}, $isExclusion);
@@ -58,9 +58,17 @@ public function isSatisfiedBy(TransitionEvent $event)
     {
         return
             $event->getStateMachine() === $this->stateMachine &&
-            $this->supportsClause('from', $event->getInitialState()->getName()) &&
-            $this->supportsClause('to', $event->getTransition()->getState()) &&
-            $this->supportsClause('on', $event->getTransition()->getName());
+            $this->supportsClause(Callback::CLAUSE_FROM, $event->getInitialState()->getName()) &&
+            $this->supportsClause(Callback::CLAUSE_TO, $event->getTransition()->getState()) &&
+            $this->supportsClause(Callback::CLAUSE_ON, $event->getTransition()->getName());
+    }
+
+    /**
+     * @return array
+     */
+    public function getClauses()
+    {
+        return $this->specs;
     }
 
     /**

src/Finite/Event/Callback/CallbackSpecificationInterface.php

@@ -19,4 +19,9 @@ interface CallbackSpecificationInterface
      * @return bool
      */
     public function isSatisfiedBy(TransitionEvent $event);
+
+    /**
+     * @return array
+     */
+    public function getClauses();
 }

src/Finite/Event/CallbackHandler.php

@@ -40,23 +40,23 @@ public function __construct(EventDispatcherInterface $dispatcher)
         $this->specResolver = new OptionsResolver();
         $this->specResolver->setDefaults(
             array(
-                'on' => self::ALL,
-                'from' => self::ALL,
-                'to' => self::ALL,
+                Callback::CLAUSE_ON => self::ALL,
+                Callback::CLAUSE_FROM => self::ALL,
+                Callback::CLAUSE_TO => self::ALL,
             )
         );
 
-        $this->specResolver->setAllowedTypes('on', array('string', 'array'));
-        $this->specResolver->setAllowedTypes('from', array('string', 'array'));
-        $this->specResolver->setAllowedTypes('to', array('string', 'array'));
+        $this->specResolver->setAllowedTypes(Callback::CLAUSE_ON, array('string', 'array'));
+        $this->specResolver->setAllowedTypes(Callback::CLAUSE_FROM, array('string', 'array'));
+        $this->specResolver->setAllowedTypes(Callback::CLAUSE_TO, array('string', 'array'));
 
         $toArrayNormalizer = function (Options $options, $value) {
             return (array) $value;
         };
 
-        $this->specResolver->setNormalizer('on', $toArrayNormalizer);
-        $this->specResolver->setNormalizer('from', $toArrayNormalizer);
-        $this->specResolver->setNormalizer('to', $toArrayNormalizer);
+        $this->specResolver->setNormalizer(Callback::CLAUSE_ON, $toArrayNormalizer);
+        $this->specResolver->setNormalizer(Callback::CLAUSE_FROM, $toArrayNormalizer);
+        $this->specResolver->setNormalizer(Callback::CLAUSE_TO, $toArrayNormalizer);
     }
 
     /**
@@ -109,7 +109,7 @@ protected function add($smOrCallback, $event, $callable = null, array $specs = a
         );
 
         $specs = $this->specResolver->resolve($specs);
-        $callback = CallbackBuilder::create($smOrCallback, $specs['from'], $specs['to'], $specs['on'], $callable)->getCallback();
+        $callback = CallbackBuilder::create($smOrCallback, $specs[Callback::CLAUSE_FROM], $specs[Callback::CLAUSE_TO], $specs[Callback::CLAUSE_ON], $callable)->getCallback();
 
         $this->dispatcher->addListener($event, $callback);