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). The ElementFinder is responsible for instantiating the NodeElement.
minkphp · Jun 13, 2023 · c76a7e6 · c76a7e6
1 parent c73d508
commit c76a7e6
Show file tree

Hide file tree

Showing 10 changed files with 25 additions and 102 deletions.
diff --git a/src/Driver/CoreDriver.php b/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->getElementFinder());
-        }
-
-        return $elements;
+        return $this->findElementXpaths($xpath);
     }
 
     /**

diff --git a/src/Driver/DriverInterface.php b/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

diff --git a/src/Element/Element.php b/src/Element/Element.php
@@ -95,7 +95,7 @@ public function find($selector, $locator)
     {
         $items = $this->findAll($selector, $locator);
 
-        return count($items) ? current($items) : null;
+        return count($items) ? $items[0] : null;
     }
 
     /**

diff --git a/src/Element/ElementFinder.php b/src/Element/ElementFinder.php
@@ -43,9 +43,9 @@ public function __construct(DriverInterface $driver, SelectorsHandler $selectors
     /**
      * @param string|array $locator
      *
-     * @return NodeElement[]
+     * @return list<NodeElement>
      */
-    public function findAll(string $selector, $locator, string $parentXpath)
+    public function findAll(string $selector, $locator, string $parentXpath): array
     {
         if ('named' === $selector) {
             $items = $this->findAll('named_exact', $locator, $parentXpath);
@@ -59,6 +59,12 @@ public function findAll(string $selector, $locator, string $parentXpath)
         $xpath = $this->selectorsHandler->selectorToXpath($selector, $locator);
         $xpath = $this->xpathManipulator->prepend($xpath, $parentXpath);
 
-        return $this->driver->find($xpath);
+        $elements = array();
+
+        foreach ($this->driver->find($xpath) as $elementXpath) {
+            $elements[] = new NodeElement($elementXpath, $this->driver, $this);
+        }
+
+        return $elements;
     }
 }
diff --git a/src/Element/NodeElement.php b/src/Element/NodeElement.php
@@ -30,7 +30,7 @@ class NodeElement extends TraversableElement
     /**
      * Initializes node element.
      *
-     * @param string          $xpath   element xpath
+     * @param string          $xpath         element xpath
      * @param DriverInterface $driver
      * @param ElementFinder   $elementFinder
      */

diff --git a/src/Session.php b/src/Session.php
@@ -12,8 +12,8 @@
 
 use Behat\Mink\Driver\DriverInterface;
 use Behat\Mink\Element\ElementFinder;
-use Behat\Mink\Selector\SelectorsHandler;
 use Behat\Mink\Element\DocumentElement;
+use Behat\Mink\Selector\SelectorsHandler;
 
 /**
  * Mink session.
@@ -30,18 +30,12 @@ class Session
      * @var DocumentElement
      */
     private $page;
-    /**
-     * @var ElementFinder
-     */
-    private $elementFinder;
 
     public function __construct(DriverInterface $driver, SelectorsHandler $selectorsHandler = null)
     {
         $this->driver = $driver;
-        $this->elementFinder = new ElementFinder($driver, $selectorsHandler ?? new SelectorsHandler());
-        $this->page = new DocumentElement($driver, $this->elementFinder);
-
-        $driver->setSession($this);
+        $elementFinder = new ElementFinder($driver, $selectorsHandler ?? new SelectorsHandler());
+        $this->page = new DocumentElement($driver, $elementFinder);
     }
 
     /**
@@ -131,14 +125,6 @@ public function getPage()
         return $this->page;
     }
 
-    /**
-     * @internal
-     */
-    public function getElementFinder(): ElementFinder
-    {
-        return $this->elementFinder;
-    }
-
     /**
      * Visit specified URL and automatically start session if not already running.
      *

diff --git a/tests/Driver/CoreDriverTest.php b/tests/Driver/CoreDriverTest.php
@@ -2,8 +2,6 @@
 
 namespace Behat\Mink\Tests\Driver;
 
-use Behat\Mink\Element\ElementFinder;
-use Behat\Mink\Element\NodeElement;
 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('getElementFinder')->willReturn($this->createMock(ElementFinder::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]);
     }
 
     /**

diff --git a/tests/Element/ElementFinderTest.php b/tests/Element/ElementFinderTest.php
@@ -63,12 +63,6 @@ public function testNotFound()
 
     public function testFound()
     {
-        $element1 = $this->createStub(NodeElement::class);
-        $element1->method('getXpath')->willReturn('element1');
-
-        $element2 = $this->createStub(NodeElement::class);
-        $element2->method('getXpath')->willReturn('element2');
-
         $this->selectorsHandler->expects($this->once())
             ->method('selectorToXpath')
             ->with('css', 'h3 > a')
@@ -82,7 +76,7 @@ public function testFound()
         $this->driver->expects($this->once())
             ->method('find')
             ->with('full_xpath')
-            ->will($this->returnValue(array($element1, $element2)));
+            ->will($this->returnValue(array('element1', 'element2')));
 
         $results = $this->finder->findAll('css', 'h3 > a', 'parent_xpath');
 
@@ -94,12 +88,6 @@ public function testFound()
 
     public function testNamedFound()
     {
-        $element1 = $this->createStub(NodeElement::class);
-        $element1->method('getXpath')->willReturn('element1');
-
-        $element2 = $this->createStub(NodeElement::class);
-        $element2->method('getXpath')->willReturn('element2');
-
         $this->selectorsHandler->expects($this->once())
             ->method('selectorToXpath')
             ->with('named_exact', 'test')
@@ -113,7 +101,7 @@ public function testNamedFound()
         $this->driver->expects($this->once())
             ->method('find')
             ->with('full_xpath')
-            ->will($this->returnValue(array($element1, $element2)));
+            ->will($this->returnValue(array('element1', 'element2')));
 
         $results = $this->finder->findAll('named', 'test', 'parent_xpath');
 
@@ -125,12 +113,6 @@ public function testNamedFound()
 
     public function testNamedPartialFallback()
     {
-        $element1 = $this->createStub(NodeElement::class);
-        $element1->method('getXpath')->willReturn('element1');
-
-        $element2 = $this->createStub(NodeElement::class);
-        $element2->method('getXpath')->willReturn('element2');
-
         $this->selectorsHandler->expects($this->exactly(2))
             ->method('selectorToXpath')
             ->will($this->returnValueMap(array(
@@ -149,7 +131,7 @@ public function testNamedPartialFallback()
             ->method('find')
             ->willReturnMap(array(
                 array('full_xpath', array()),
-                array('full_partial_xpath', array($element1, $element2)),
+                array('full_partial_xpath', array('element1', 'element2')),
             ));
 
         $results = $this->finder->findAll('named', 'test', 'parent_xpath');

diff --git a/tests/Element/NodeElementTest.php b/tests/Element/NodeElementTest.php
@@ -52,7 +52,7 @@ public function testElementIsValid()
             ->expects($this->once())
             ->method('find')
             ->with($elementXpath)
-            ->willReturn(array($this->createStub(NodeElement::class)));
+            ->willReturn(array($elementXpath));
 
         $this->assertTrue($node->isValid());
     }
@@ -78,7 +78,7 @@ public function testElementIsNotValidWithMultipleFound()
             ->expects($this->once())
             ->method('find')
             ->with('some xpath')
-            ->willReturn(array($this->createStub(NodeElement::class), $this->createStub(NodeElement::class)));
+            ->willReturn(array('some xpath', 'some other xpath'));
 
         $this->assertFalse($node->isValid(), 'more then 1 element found is invalid element');
     }

diff --git a/tests/SessionTest.php b/tests/SessionTest.php
@@ -14,10 +14,6 @@ class SessionTest extends TestCase
      * @var DriverInterface&MockObject
      */
     private $driver;
-    /**
-     * @var SelectorsHandler
-     */
-    private $selectorsHandler;
 
     /**
      * Session.
@@ -32,8 +28,7 @@ class SessionTest extends TestCase
     protected function prepareSession(): void
     {
         $this->driver = $this->getMockBuilder('Behat\Mink\Driver\DriverInterface')->getMock();
-        $this->selectorsHandler = $this->getMockBuilder('Behat\Mink\Selector\SelectorsHandler')->getMock();
-        $this->session = new Session($this->driver, $this->selectorsHandler);
+        $this->session = new Session($this->driver);
     }
 
     public function testGetDriver()
-Original file line number
+Diff line change
@@ Expand Up / @@ -95,7 +95,7 @@ public function find($selector, $locator) @@
         {
             $items = $this->findAll($selector, $locator);
-            return count($items) ? current($items) : null;
+            return count($items) ? $items[0] : null;
         }
         /**
@@ Expand Down @@