Decoupled the DriverInterface from the NodeElement

This avoids a circular dependency. The driver interface now returns an
array of XPath for found elements, and Element::find() instantiates the
NodeElement for them.
The driver is now the low level API which does not depend on any other
part of Mink (but used by other parts).

Author: stof

src/Driver/CoreDriver.php

@@ -10,10 +10,8 @@
 
 namespace Behat\Mink\Driver;
 
-use Behat\Mink\Element\NodeElement;
 use Behat\Mink\Exception\UnsupportedDriverActionException;
 use Behat\Mink\KeyModifier;
-use Behat\Mink\Session;
 
 /**
  * Core driver.
@@ -23,21 +21,6 @@
  */
 abstract class CoreDriver implements DriverInterface
 {
-    /**
-     * @var Session
-     */
-    private $session;
-
-    /**
-     * @return void
-     *
-     * @final since 1.11
-     */
-    public function setSession(Session $session)
-    {
-        $this->session = $session;
-    }
-
     /**
      * @return void
      */
@@ -99,19 +82,13 @@ public function getContent()
     /**
      * @param string $xpath
      *
-     * @return NodeElement[]
+     * @return string[]
      *
      * @final since 1.11
      */
     public function find($xpath)
     {
-        $elements = array();
-
-        foreach ($this->findElementXpaths($xpath) as $xpath) {
-            $elements[] = new NodeElement($xpath, $this, $this->session->getSelectorsHandler());
-        }
-
-        return $elements;
+        return $this->findElementXpaths($xpath);
     }
 
     /**

src/Driver/DriverInterface.php

@@ -10,11 +10,9 @@
 
 namespace Behat\Mink\Driver;
 
-use Behat\Mink\Element\NodeElement;
 use Behat\Mink\Exception\DriverException;
 use Behat\Mink\Exception\UnsupportedDriverActionException;
 use Behat\Mink\KeyModifier;
-use Behat\Mink\Session;
 
 /**
  * Driver interface.
@@ -23,15 +21,6 @@
  */
 interface DriverInterface
 {
-    /**
-     * Sets driver's current session.
-     *
-     * @param Session $session
-     *
-     * @return void
-     */
-    public function setSession(Session $session);
-
     /**
      * Starts driver.
      *
@@ -299,7 +288,7 @@ public function getWindowName();
      *
      * @param string $xpath
      *
-     * @return NodeElement[]
+     * @return string[] An array of XPath queries for the found elements
      *
      * @throws UnsupportedDriverActionException When operation not supported by the driver
      * @throws DriverException                  When the operation cannot be done

src/Element/Element.php

@@ -38,17 +38,24 @@ abstract class Element implements ElementInterface
      */
     private $xpathManipulator;
 
+    /**
+     * @var ElementFactory
+     */
+    private $elementFactory;
+
     /**
      * Initialize element.
      *
      * @param DriverInterface  $driver
      * @param SelectorsHandler $selectorsHandler
+     * @param ElementFactory   $elementFactory
      */
-    public function __construct(DriverInterface $driver, SelectorsHandler $selectorsHandler)
+    public function __construct(DriverInterface $driver, SelectorsHandler $selectorsHandler, ElementFactory $elementFactory)
     {
         $this->xpathManipulator = new Manipulator();
         $this->driver = $driver;
         $this->selectorsHandler = $selectorsHandler;
+        $this->elementFactory = $elementFactory;
     }
 
     /**
@@ -109,7 +116,7 @@ public function find($selector, $locator)
     {
         $items = $this->findAll($selector, $locator);
 
-        return count($items) ? current($items) : null;
+        return count($items) ? $items[0] : null;
     }
 
     /**
@@ -129,7 +136,13 @@ public function findAll($selector, $locator)
         $xpath = $this->selectorsHandler->selectorToXpath($selector, $locator);
         $xpath = $this->xpathManipulator->prepend($xpath, $this->getXpath());
 
-        return $this->getDriver()->find($xpath);
+        $elements = array();
+
+        foreach ($this->getDriver()->find($xpath) as $elementXpath) {
+            $elements[] = $this->elementFactory->createNodeElement($elementXpath, $this->driver, $this->selectorsHandler);
+        }
+
+        return $elements;
     }
 
     /**

src/Element/ElementFactory.php

@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of the Mink package.
+ * (c) Konstantin Kudryashov <ever.zet@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Behat\Mink\Element;
+
+use Behat\Mink\Driver\DriverInterface;
+use Behat\Mink\Selector\SelectorsHandler;
+
+/**
+ * Factory for element node.
+ *
+ * @author Christophe Coevoet <stof@notk.org>
+ */
+class ElementFactory
+{
+    public function createNodeElement(string $xpath, DriverInterface $driver, SelectorsHandler $selectorsHandler): NodeElement
+    {
+        return new NodeElement($xpath, $driver, $selectorsHandler, $this);
+    }
+}

src/Element/NodeElement.php

@@ -31,15 +31,16 @@ class NodeElement extends TraversableElement
     /**
      * Initializes node element.
      *
-     * @param string           $xpath   element xpath
+     * @param string           $xpath element xpath
      * @param DriverInterface  $driver
      * @param SelectorsHandler $selectorsHandler
+     * @param ElementFactory   $elementFactory
      */
-    public function __construct($xpath, DriverInterface $driver, SelectorsHandler $selectorsHandler)
+    public function __construct($xpath, DriverInterface $driver, SelectorsHandler $selectorsHandler, ElementFactory $elementFactory)
     {
         $this->xpath = $xpath;
 
-        parent::__construct($driver, $selectorsHandler);
+        parent::__construct($driver, $selectorsHandler, $elementFactory);
     }
 
     /**

src/Session.php

@@ -11,6 +11,7 @@
 namespace Behat\Mink;
 
 use Behat\Mink\Driver\DriverInterface;
+use Behat\Mink\Element\ElementFactory;
 use Behat\Mink\Selector\SelectorsHandler;
 use Behat\Mink\Element\DocumentElement;
 
@@ -39,18 +40,21 @@ class Session
      *
      * @param DriverInterface       $driver
      * @param SelectorsHandler|null $selectorsHandler
+     * @param ElementFactory|null   $elementFactory
      */
-    public function __construct(DriverInterface $driver, SelectorsHandler $selectorsHandler = null)
+    public function __construct(DriverInterface $driver, SelectorsHandler $selectorsHandler = null, ElementFactory $elementFactory = null)
     {
-        $driver->setSession($this);
-
         if (null === $selectorsHandler) {
             $selectorsHandler = new SelectorsHandler();
         }
 
+        if (null === $elementFactory) {
+            $elementFactory = new ElementFactory();
+        }
+
         $this->driver = $driver;
         $this->selectorsHandler = $selectorsHandler;
-        $this->page = new DocumentElement($driver, $selectorsHandler);
+        $this->page = new DocumentElement($driver, $selectorsHandler, $elementFactory);
     }
 
     /**

tests/Driver/CoreDriverTest.php

@@ -2,8 +2,6 @@
 
 namespace Behat\Mink\Tests\Driver;
 
-use Behat\Mink\Element\NodeElement;
-use Behat\Mink\Selector\SelectorsHandler;
 use PHPUnit\Framework\TestCase;
 
 class CoreDriverTest extends TestCase
@@ -27,29 +25,19 @@ public function testCreateNodeElements()
             ->setMethods(array('findElementXpaths'))
             ->getMockForAbstractClass();
 
-        $session = $this->getMockBuilder('Behat\Mink\Session')
-            ->disableOriginalConstructor()
-            ->getMock();
-
-        $session->method('getSelectorsHandler')->willReturn($this->createMock(SelectorsHandler::class));
-
-        $driver->setSession($session);
-
         $driver->expects($this->once())
             ->method('findElementXpaths')
             ->with('xpath')
             ->willReturn(array('xpath1', 'xpath2'));
 
-        /** @var NodeElement[] $elements */
         $elements = $driver->find('xpath');
 
         $this->assertIsArray($elements);
 
         $this->assertCount(2, $elements);
-        $this->assertContainsOnlyInstancesOf('Behat\Mink\Element\NodeElement', $elements);
 
-        $this->assertSame('xpath1', $elements[0]->getXpath());
-        $this->assertSame('xpath2', $elements[1]->getXpath());
+        $this->assertSame('xpath1', $elements[0]);
+        $this->assertSame('xpath2', $elements[1]);
     }
 
     /**