[Behat] Improve gatherContexts, use @var annotation instead of custom @context

Author: Miguel

Features/Context/ContentActions.php

@@ -15,13 +15,11 @@ class ContentActions extends PlatformUI
 {
     /**
      * @var EzSystems\PlatformUIBundle\Features\Context\SubContext\ContentEditContext
-     * @Context $contentEditContext EzSystems\PlatformUIBundle\Features\Context\SubContext\ContentEditContext
      */
     protected $contentEditContext;
 
     /**
      * @var EzSystems\PlatformUIBundle\Features\Context\SubContext\DashboardContext
-     * @Context $dashboardContext EzSystems\PlatformUIBundle\Features\Context\SubContext\DashboardContext
      */
     protected $dashboardContext;
 

Features/Context/Fields.php

@@ -19,13 +19,11 @@ class Fields extends PlatformUI
 
     /**
      * @var EzSystems\PlatformBehatBundle\Context\Object\FieldTypeContext
-     * @Context $fieldtypeContext EzSystems\PlatformBehatBundle\Context\Object\FieldTypeContext
      */
     protected $fieldtypeContext;
 
     /**
      * @var EzSystems\PlatformUIBundle\Features\Context\SubContext\DashboardContext
-     * @Context $dashboardContext EzSystems\PlatformUIBundle\Features\Context\SubContext\DashboardContext
      */
     protected $dashboardContext;
 

Features/Context/PlatformUI.php

@@ -101,16 +101,24 @@ public function __construct($uri = self::PLATFORM_URI, $user = null, $password =
 
     /**
      * @BeforeScenario
+     *
+     * Default gather contexts method.
+     * Uses doc comment type hint to get the contexts and set them
      */
     public function gatherContexts(BeforeScenarioScope $scope)
     {
         $refClass = new ReflectionClass($this);
         $refProperties = $refClass->getProperties();
         foreach ($refProperties as $refProperty) {
-            preg_match_all('#@(.*?)\n#s', $refProperty->getDocComment(), $matches);
-            $contexts = $this->parseAnnotations($matches[1]);
-            foreach ($contexts as $property => $context) {
-                $this->$property = $scope->getEnvironment()->getContext($context);
+            $propertyName = $refProperty->getName();
+            // get property type hint from doc comment
+            preg_match_all('#@var\s(.*?)\n#s', $refProperty->getDocComment(), $matches);
+            foreach ($matches[1] as $typeHint) {
+                // checks if the type hint implements Behat Context
+                $implements = @class_implements($typeHint);
+                if (!empty($implements) && in_array('Behat\Behat\Context\Context', $implements)) {
+                    $this->$propertyName = $scope->getEnvironment()->getContext($typeHint);
+                }
             }
         }
     }
@@ -449,30 +457,4 @@ protected function closeEditView()
         } catch (\Exception $e) {
         }
     }
-
-    /**
-     * Returns an array with the properties contexts,
-     * if the properties use the Context Annotation.
-     *
-     * @return array array of methods and their service dependencies
-     */
-    private function parseAnnotations($annotations)
-    {
-        // parse array from (numeric key => 'annotation <value>') to (annotation => value)
-        $propertiesContexts = [];
-        foreach ($annotations as $annotation) {
-            if (!preg_match('/^(\w+)\s+\$(\w+)\s+([\w\.\\\\]+)/', $annotation, $matches)) {
-                continue;
-            }
-
-            array_shift($matches);
-            $tag = array_shift($matches);
-            if ($tag == 'Context') {
-                list($property, $context) = $matches;
-                $propertiesContexts[$property] = $context;
-            }
-        }
-
-        return $propertiesContexts;
-    }
 }

Features/Context/Role.php

@@ -15,13 +15,11 @@ class Role extends PlatformUI
 {
     /**
      * @var EzSystems\PlatformUIBundle\Features\Context\SubContext\DashboardContext
-     * @Context $dashboardContext EzSystems\PlatformUIBundle\Features\Context\SubContext\DashboardContext
      */
     protected $dashboardContext;
 
     /**
      * @var EzSystems\PlatformUIBundle\Features\Context\SubContext\BrowserContext
-     * @Context $browserContext EzSystems\PlatformUIBundle\Features\Context\SubContext\BrowserContext
      */
     protected $browserContext;
 

Features/Context/SubContext/ContentEditContext.php

@@ -15,19 +15,17 @@
 class ContentEditContext extends PlatformUI
 {
     /**
-     * @Context $basicContentContext EzSystems\PlatformBehatBundle\Context\Object\BasicContentContext
+     * @var EzSystems\PlatformBehatBundle\Context\Object\BasicContentContext
      */
     protected $basicContentContext;
 
     /**
      * @var EzSystems\PlatformUIBundle\Features\Context\SubContext\DashboardContext
-     * @Context $dashboardContext EzSystems\PlatformUIBundle\Features\Context\SubContext\DashboardContext
      */
     protected $dashboardContext;
 
     /**
      * @var EzSystems\PlatformUIBundle\Features\Context\SubContext\BrowserContext
-     * @Context $browserContext EzSystems\PlatformUIBundle\Features\Context\SubContext\BrowserContext
      */
     protected $browserContext;
 

Features/Context/Users.php

@@ -15,13 +15,11 @@ class Users extends PlatformUI
 {
     /**
      * @var EzSystems\PlatformUIBundle\Features\Context\SubContext\DashboardContext
-     * @Context $dashboardContext EzSystems\PlatformUIBundle\Features\Context\SubContext\DashboardContext
      */
     protected $dashboardContext;
 
     /**
      * @var EzSystems\PlatformUIBundle\Features\Context\SubContext\BrowserContext
-     * @Context $browserContext EzSystems\PlatformUIBundle\Features\Context\SubContext\BrowserContext
      */
     protected $browserContext;