Fix 146

build/docker/docker-entrypoint.sh

@@ -5,7 +5,7 @@ WH_WORDPRESS_DIR=/usr/src/wordpress
 
 # wait for mysql to come up
 
-while ! mysqladmin ping -h "db" --silent; do
+while ! mysqladmin ping -h "db"; do
     echo "Waiting for mysql..."
     sleep 5
 done

build/templates/docker-compose.yml.template

@@ -2,7 +2,7 @@ version: '3'
 
 services:
    db:
-     image: healthcheck/mysql:latest
+     image: mysql:5.7.22
      ports:
        - "3306:3306"
      environment:
@@ -30,6 +30,6 @@ services:
        - seccomp:unconfined
 
    selenium:
-      image: selenium/standalone-chrome-debug:latest
+      image: selenium/standalone-chrome-debug:3.11.0
       ports:
       - "4444:4444"

phpstan.neon

@@ -1,5 +1,5 @@
 parameters:
   excludes_analyse:
     # These reference global WP functions.
-    - %rootDir%/../../../src/Driver/Element/Wpphp/*
-    - src/Driver/WpphpDriver.php
+    - %rootDir%/../../../src/Driver/Wpphp/Element/*
+    - src/Driver/Wpphp/WpphpDriver.php

src/Compiler/DriverElementPass.php

@@ -2,8 +2,8 @@
 declare(strict_types=1);
 namespace PaulGibbs\WordpressBehatExtension\Compiler;
 
+use PaulGibbs\WordpressBehatExtension\Driver\Element\Interfaces\PluginElementInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 
 /**
@@ -18,22 +18,7 @@ class DriverElementPass implements CompilerPassInterface
      */
     public function process(ContainerBuilder $container)
     {
-        $wordpress = $container->getDefinition('wordpress.wordpress');
-        if (! $wordpress) {
-            return;
-        }
-
-        foreach ($container->findTaggedServiceIds('wordpress.element') as $id => $attributes) {
-            foreach ($attributes as $attribute) {
-                if (! isset($attribute['alias'], $attribute['driver'])) {
-                    continue;
-                }
-
-                $wordpress->addMethodCall(
-                    'registerDriverElement',
-                    [$attribute['alias'], new Reference($id), $attribute['driver']]
-                );
-            }
-        }
+        $container->registerForAutoconfiguration(PluginElementInterface::class)
+            ->addTag('wordpress.driver.element.plugin');
     }
 }

src/Compiler/DriverPass.php

@@ -1,41 +1,78 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 namespace PaulGibbs\WordpressBehatExtension\Compiler;
 
+use PaulGibbs\WordpressBehatExtension\Driver\DriverManagerInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 
 /**
- * WordpressBehatExtension container compilation pass.
+ * This class is a Symfony compiler pass. It is registered with
+ * Symfony by BehatWordpressExtension.
+ *
+ * During compilation Symfony will call the process method.
+ *
+ * Initially it grabs the wordhat configuration from the ContainerBuilder. This
+ * was previously saved by BehatWordpressExtension, which in turn was read from
+ * behat.yml.
+ *
+ * Then it scans the existing services for those tagged with 'wordpress.driver'.
+ * For each tagged service it:
+ * 1) Grabs the shortname
+ * 2) Executes the bootstrap method on the driver class
+ * 3) Checks if shortname matched the default driver in the configuration. If it does is:
+ *   - Binds the driverManager class to the DriverManagerInterface
+ *   - Calls the setParameters method on the driver class which loads the driver configuration
+ *     and binds in each of the elements.
+ *
+ * @see PaulGibbs\WordpressBehatExtension\ServiceContainer\BehatWordpressExtension
  */
 class DriverPass implements CompilerPassInterface
 {
     /**
-     * Modify the container before Symfony compiles it.
+     * Entrypoint for the Symfony compiler path
      *
      * @param ContainerBuilder $container
      */
     public function process(ContainerBuilder $container)
     {
-        $wordpress = $container->getDefinition('wordpress.wordpress');
-        if (! $wordpress) {
-            return;
-        }
+        $config = $this->getConfigs($container);
+
+        // Grab the default driver name from the config
+        $defaultDriverName = $container->getParameter('wordpress.default_driver');
+
+        // Tell WordpressDriverManager about the default driver name
+        //$wordpress->addMethodCall('setDefaultDriverName', [
+        //   $defaultDriverName
+        //]);
 
         foreach ($container->findTaggedServiceIds('wordpress.driver') as $id => $attributes) {
-            foreach ($attributes as $attribute) {
-                if (empty($attribute['alias'])) {
-                    continue;
-                }
+            // Grab the definition
+            $definition = $container->getDefinition($id);
+            $class = $definition->getClass();
+
+            /* TODO: The setParameters method below should be split into an activate
+             * method and a setParameters method. The setParameters part should be called
+             * here.
+             */
+
+            $driverName = call_user_func($class . '::getShortName');
 
-                $wordpress->addMethodCall('registerDriver', [$attribute['alias'], new Reference($id)]);
+            // bootstrap the driver at the point it is created
+            $definition->addMethodCall('bootstrap');
+
+            if ($driverName === $defaultDriverName) {
+                $container->setAlias(DriverManagerInterface::class, $id);
+                $driverName = call_user_func($class . '::setParameters', $container, $config);
             }
         }
+    }
 
-        $wordpress->addMethodCall(
-            'setDefaultDriverName',
-            [$container->getParameter('wordpress.wordpress.default_driver')]
-        );
+    /**
+     * grab the configuration from the container builder
+     */
+    protected function getConfigs(ContainerBuilder $container)
+    {
+        return $container->getParameter('wordpress.parameters');
     }
 }

src/Compiler/EventSubscriberPass.php

@@ -2,29 +2,48 @@
 declare(strict_types=1);
 namespace PaulGibbs\WordpressBehatExtension\Compiler;
 
-use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use RuntimeException;
 
 /**
- * Event subscribers pass.
+ * A specific driver can be specified for a scenario or example by using the @driver tag in the gherkin feature file.
+ *
+ * To make this work, we need to be able to switch drivers at the start of a scenario (if necessary). This
+ * is done by the DriverListener which has its prepareWordpressDriver method called whenever a scenario or
+ * example is started.
+ *
+ * It is the role of this class to make that happen. It is a Symfony compiler pass and is registered as such
+ * by BehatWordpressExtension. During compilation it scans for services which are tagged with 'wordpress.event_subscriber',
+ * and adds a call to the event_dispatchers 'addSubscriber' method for each service.
  *
- * Register all available event subscribers.
  */
 class EventSubscriberPass implements CompilerPassInterface
 {
     /**
-     * Processes container.
+     * This method registers each service tagged with 'wordpress.event_subscriber' to the event_dispatcher service.
+     *
+     * Firstly it gets the event_dispatcher from the ServiceContainer by looking for a service named 'event_dispatcher'; this
+     * service is automatically provided by the event_dispatcher bundle.
+     *
+     * Then it scans for 'wordpress.event_subscriber' tagged services. These services are tagged by WordpressBehatExtension,
+     * which reads them (at the moment) from behat.yml.
+     *
+     * It checks if a priority has been configured on the service, if it has it uses that value, otherwise it uses 0.
+     *
+     * Finally it adds a call to the addSubsciber method at creation time of the event_dispatcher with a reference to the
+     * subscriber service and the priority as arguments.
      *
      * @param ContainerBuilder $container
      */
     public function process(ContainerBuilder $container)
     {
-        if (! $container->hasDefinition('wordpress.event_dispatcher')) {
-            return;
+        if (! $container->hasDefinition('event_dispatcher')) {
+            throw new RuntimeException('Event dispatcher cannot be found');
         }
 
-        $dispatcher = $container->getDefinition('wordpress.event_dispatcher');
+        $dispatcher = $container->getDefinition('event_dispatcher');
 
         foreach ($container->findTaggedServiceIds('wordpress.event_subscriber') as $id => $attributes) {
             foreach ($attributes as $attribute) {

src/Context/ContentContext.php

@@ -2,16 +2,18 @@
 declare(strict_types=1);
 namespace PaulGibbs\WordpressBehatExtension\Context;
 
-use UnexpectedValueException;
-use RuntimeException;
 use Behat\Gherkin\Node\TableNode;
+use PaulGibbs\WordpressBehatExtension\Context\Interfaces\ContentAwareContextInterface;
+use PaulGibbs\WordpressBehatExtension\Context\Interfaces\UserAwareContextInterface;
 use PaulGibbs\WordpressBehatExtension\Context\Traits\ContentAwareContextTrait;
 use PaulGibbs\WordpressBehatExtension\Context\Traits\UserAwareContextTrait;
+use RuntimeException;
+use UnexpectedValueException;
 
 /**
  * Provides step definitions for creating content: post types, comments, and terms.
  */
-class ContentContext extends RawWordpressContext
+class ContentContext extends RawWordpressContext implements UserAwareContextInterface, ContentAwareContextInterface
 {
     use ContentAwareContextTrait, UserAwareContextTrait;
 

src/Context/EditPostContext.php

@@ -6,11 +6,12 @@
 use Behat\Gherkin\Node\PyStringNode;
 use Behat\Mink\Exception\ExpectationException;
 use PaulGibbs\WordpressBehatExtension\Context\Traits\ContentAwareContextTrait;
+use PaulGibbs\WordpressBehatExtension\Context\Interfaces\ContentAwareContextInterface;
 
 /**
  * Provides step definitions relating to editing content in wp-admin.
  */
-class EditPostContext extends RawWordpressContext
+class EditPostContext extends RawWordpressContext implements ContentAwareContextInterface
 {
     use ContentAwareContextTrait;
     /**