Delegate annotation handling to hooked services

Author: Rodrigue Villetard

.gitignore

@@ -1,2 +1,3 @@
 vendor
 composer.lock
+.php_cs.cache

argumentsExt/Annotation/StepInjectorArgument.php

@@ -17,11 +17,8 @@
 interface StepInjectorArgument
 {
     /**
-     * @return string
-     */
-    public function getName();
-
-    /**
+     * The argument name this annotation is targeting to inject.
+     *
      * @return string
      */
     public function getArgument();

argumentsExt/Argument/ArgumentOrganiser.php

@@ -13,7 +13,6 @@
 
 use Behat\Testwork\Argument\ArgumentOrganiser as BehatArgumentOrganiser;
 use Doctrine\Common\Annotations\Reader;
-use Gorghoa\StepArgumentInjectorBehatExtension\Annotation\StepArgumentInjectorArgument;
 use Gorghoa\StepArgumentInjectorBehatExtension\Annotation\StepInjectorArgument;
 // use Gorghoa\StepArgumentInjectorBehatExtension\Context\Initializer\StepArgumentInjectorInitializer;
 use ReflectionFunctionAbstract;
@@ -30,19 +29,19 @@ final class ArgumentOrganiser implements BehatArgumentOrganiser
     private $baseOrganiser;
 
     /**
-     * @var StepArgumentInjectorInitializer
+     * @var StepArgumentHolder[]
      */
-    private $hookers;
+    private $stepArgumentHolders;
 
     /**
      * @var Reader
      */
     private $reader;
 
-    public function __construct(BehatArgumentOrganiser $organiser, array $hookers, Reader $reader)
+    public function __construct(BehatArgumentOrganiser $organiser, array $stepArgumentHolders, Reader $reader)
     {
         $this->baseOrganiser = $organiser;
-        $this->hookers = $hookers;
+        $this->stepArgumentHolders = $stepArgumentHolders;
         $this->reader = $reader;
     }
 
@@ -60,18 +59,18 @@ public function organiseArguments(ReflectionFunctionAbstract $function, array $m
             return $this->baseOrganiser->organiseArguments($function, $match);
         }
 
-        /** @var StepArgumentInjectorArgument[] $annotations */
         $annotations = $this->reader->getMethodAnnotations($function);
 
         foreach ($annotations as $annotation) {
             if ($annotation instanceof StepInjectorArgument &&
                 in_array($annotation->getArgument(), $paramsKeys)
             ) {
-                foreach ($this->hookers as $hooker) {
-                    if ($hooker->hasStepArgumentFor($annotation->getName())) {
+                /* @var StepInjectorArgument $annotation */
+                foreach ($this->stepArgumentHolders as $hooker) {
+                    if ($hooker->doesHandleStepArgument($annotation)) {
                         $match[$annotation->getArgument()]
                             = $match[strval(++$i)]
-                            = $hooker->getStepArgumentFor($annotation->getName())
+                            = $hooker->getStepArgumentValueFor($annotation)
                         ;
                     }
                 }

argumentsExt/Argument/StepArgumentHolder.php

@@ -11,12 +11,28 @@
 
 namespace Gorghoa\StepArgumentInjectorBehatExtension\Argument;
 
+use Gorghoa\StepArgumentInjectorBehatExtension\Annotation\StepInjectorArgument;
+
 /**
  * @author Rodrigue Villetard <rodrigue.villetard@gmail.com>
  */
 interface StepArgumentHolder
 {
-    public function hasStepArgumentFor($key);
+    /**
+     * Check if an annotation is handled by the service.
+     *
+     * @param StepInjectorArgument $annotation
+     *
+     * @return bool
+     */
+    public function doesHandleStepArgument(StepInjectorArgument $annotation);
 
-    public function getStepArgumentFor($key);
+    /**
+     * Get value to inject for a step argument.
+     *
+     * @param StepInjectorArgument $annotation
+     *
+     * @return mixed
+     */
+    public function getStepArgumentValueFor(StepInjectorArgument $annotation);
 }

argumentsExt/Exception/RejectedAnnotationException.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of the StepArgumentInjectorBehatExtension project.
+ *
+ * (c) Rodrigue Villetard <rodrigue.villetard@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Gorghoa\StepArgumentInjectorBehatExtension\Exception;
+
+/**
+ * @author Rodrigue Villetard <rodrigue.villetard@gmail.com>
+ */
+class RejectedAnnotationException extends \LogicException
+{
+}

argumentsExt/Resolver/ArgumentsResolver.php

@@ -25,16 +25,19 @@ class ArgumentsResolver
     private $reader;
 
     /**
-     * @var array
+     * @var StepArgumentHolder[]
      */
-    private $hookers;
+    private $stepArgumentHolders;
 
     /**
-     * @param Reader $reader
+     * ArgumentsResolver constructor.
+     *
+     * @param StepArgumentHolder[] $stepArgumentHolders
+     * @param Reader               $reader
      */
-    public function __construct(array $hookers, Reader $reader)
+    public function __construct($stepArgumentHolders, Reader $reader)
     {
-        $this->hookers = $hookers;
+        $this->stepArgumentHolders = $stepArgumentHolders;
         $this->reader = $reader;
     }
 
@@ -56,15 +59,15 @@ public function resolve(\ReflectionMethod $function, array $arguments)
         }, $function->getParameters());
 
         // Prepare arguments from annotations
-        /** @var StepArgumentInjectorArgument[] $annotations */
         $annotations = $this->reader->getMethodAnnotations($function);
         foreach ($annotations as $annotation) {
             if ($annotation instanceof StepInjectorArgument &&
                 in_array($annotation->getArgument(), $paramsKeys)
             ) {
-                foreach ($this->hookers as $hooker) {
-                    if ($hooker->hasStepArgumentFor($annotation->getName())) {
-                        $arguments[$annotation->getArgument()] = $hooker->getStepArgumentFor($annotation->getName());
+                /* @var StepArgumentInjectorArgument $annotation */
+                foreach ($this->stepArgumentHolders as $hooker) {
+                    if ($hooker->doesHandleStepArgument($annotation)) {
+                        $arguments[$annotation->getArgument()] = $hooker->getStepArgumentValueFor($annotation);
                     }
                 }
             }

src/Context/Initializer/ScenarioStateInitializer.php

@@ -14,10 +14,13 @@
 use Behat\Behat\Context\Context;
 use Behat\Behat\Context\Initializer\ContextInitializer;
 use Behat\Behat\EventDispatcher\Event\ScenarioTested;
+use Gorghoa\ScenarioStateBehatExtension\Annotation\ScenarioStateArgument;
 use Gorghoa\ScenarioStateBehatExtension\Context\ScenarioStateAwareContext;
 use Gorghoa\ScenarioStateBehatExtension\ScenarioState;
 use Gorghoa\ScenarioStateBehatExtension\ScenarioStateInterface;
+use Gorghoa\StepArgumentInjectorBehatExtension\Annotation\StepInjectorArgument;
 use Gorghoa\StepArgumentInjectorBehatExtension\Argument\StepArgumentHolder;
+use Gorghoa\StepArgumentInjectorBehatExtension\Exception\RejectedAnnotationException;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 /**
@@ -70,13 +73,34 @@ public function getStore()
         return $this->store;
     }
 
-    public function hasStepArgumentFor($key)
+    /**
+     * Test if this service should handle specific argument injection.
+     *
+     * @param StepInjectorArgument $annotation
+     *
+     * @return bool
+     */
+    public function doesHandleStepArgument(StepInjectorArgument $annotation)
     {
-        return $this->store->hasStateFragment($key);
+        return $annotation instanceof ScenarioStateArgument && $this->store->hasStateFragment($annotation->getName());
     }
 
-    public function getStepArgumentFor($key)
+    /**
+     * Get an argument value to inject.
+     *
+     * @param StepInjectorArgument $annotation
+     *
+     * @throws RejectedAnnotationException
+     *
+     * @return mixed
+     */
+    public function getStepArgumentValueFor(StepInjectorArgument $annotation)
     {
-        return $this->store->getStateFragment($key);
+        if (!($annotation instanceof ScenarioStateArgument)) {
+            $class = get_class($annotation);
+            throw new RejectedAnnotationException("$class not handled by ScenarioStateBehatExtension");
+        }
+
+        return $this->store->getStateFragment($annotation->getName());
     }
 }