[WIP] Move Mink toward 2.0

.github/workflows/tests.yml

@@ -2,6 +2,8 @@ name: CI
 
 on:
   push:
+    branches-ignore:
+      - '2-architecture-changes'
   pull_request:
 
 defaults:

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->session);
-        }
-
-        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

@@ -11,9 +11,6 @@
 namespace Behat\Mink\Element;
 
 use Behat\Mink\Driver\DriverInterface;
-use Behat\Mink\Exception\ElementNotFoundException;
-use Behat\Mink\Selector\SelectorsHandler;
-use Behat\Mink\Session;
 
 /**
  * Base element.
@@ -22,11 +19,6 @@
  */
 abstract class Element implements ElementInterface
 {
-    /**
-     * @var Session
-     */
-    private $session;
-
     /**
      * Driver.
      *
@@ -39,31 +31,10 @@ abstract class Element implements ElementInterface
      */
     private $elementFinder;
 
-    /**
-     * Initialize element.
-     *
-     * @param Session $session
-     */
-    public function __construct(Session $session)
-    {
-        $this->session = $session;
-
-        $this->driver = $session->getDriver();
-        $this->elementFinder = $session->getElementFinder();
-    }
-
-    /**
-     * Returns element session.
-     *
-     * @return Session
-     *
-     * @deprecated Accessing the session from the element is deprecated as of 1.6 and will be impossible in 2.0.
-     */
-    public function getSession()
+    public function __construct(DriverInterface $driver, ElementFinder $elementFinder)
     {
-        @trigger_error(sprintf('The method %s is deprecated as of 1.6 and will be removed in 2.0', __METHOD__), E_USER_DEPRECATED);
-
-        return $this->session;
+        $this->driver = $driver;
+        $this->elementFinder = $elementFinder;
     }
 
     /**
@@ -76,20 +47,6 @@ protected function getDriver()
         return $this->driver;
     }
 
-    /**
-     * Returns selectors handler.
-     *
-     * @return SelectorsHandler
-     *
-     * @deprecated Accessing the selectors handler in the element is deprecated as of 1.7 and will be impossible in 2.0.
-     */
-    protected function getSelectorsHandler()
-    {
-        @trigger_error(sprintf('The method %s is deprecated as of 1.7 and will be removed in 2.0', __METHOD__), E_USER_DEPRECATED);
-
-        return $this->session->getSelectorsHandler();
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -138,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;
     }
 
     /**
@@ -174,22 +131,4 @@ public function getOuterHtml()
     {
         return $this->getDriver()->getOuterHtml($this->getXpath());
     }
-
-    /**
-     * Builds an ElementNotFoundException.
-     *
-     * @param string      $type
-     * @param string|null $selector
-     * @param string|null $locator
-     *
-     * @return ElementNotFoundException
-     *
-     * @deprecated as of 1.7, to be removed in 2.0
-     */
-    protected function elementNotFound($type, $selector = null, $locator = null)
-    {
-        @trigger_error(sprintf('The method %s is deprecated as of 1.7 and will be removed in 2.0', __METHOD__), E_USER_DEPRECATED);
-
-        return new ElementNotFoundException($this->driver, $type, $selector, $locator);
-    }
 }

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;
     }
 }

src/Element/ElementInterface.php

@@ -10,8 +10,6 @@
 
 namespace Behat\Mink\Element;
 
-use Behat\Mink\Session;
-
 /**
  * Element interface.
  *
@@ -26,15 +24,6 @@ interface ElementInterface
      */
     public function getXpath();
 
-    /**
-     * Returns element's session.
-     *
-     * @return Session
-     *
-     * @deprecated Accessing the session from the element is deprecated as of 1.6 and will be impossible in 2.0.
-     */
-    public function getSession();
-
     /**
      * Checks whether element with specified selector exists inside the current element.
      *

src/Element/NodeElement.php

@@ -12,7 +12,7 @@
 
 use Behat\Mink\Exception\DriverException;
 use Behat\Mink\KeyModifier;
-use Behat\Mink\Session;
+use Behat\Mink\Driver\DriverInterface;
 use Behat\Mink\Exception\ElementNotFoundException;
 
 /**
@@ -30,14 +30,15 @@ class NodeElement extends TraversableElement
     /**
      * Initializes node element.
      *
-     * @param string  $xpath   element xpath
-     * @param Session $session session instance
+     * @param string          $xpath         element xpath
+     * @param DriverInterface $driver
+     * @param ElementFinder   $elementFinder
      */
-    public function __construct($xpath, Session $session)
+    public function __construct($xpath, DriverInterface $driver, ElementFinder $elementFinder)
     {
         $this->xpath = $xpath;
 
-        parent::__construct($session);
+        parent::__construct($driver, $elementFinder);
     }
 
     /**

src/Exception/ElementHtmlException.php

@@ -12,7 +12,6 @@
 
 use Behat\Mink\Driver\DriverInterface;
 use Behat\Mink\Element\Element;
-use Behat\Mink\Session;
 
 /**
  * Exception thrown when an expectation on the HTML of an element fails.
@@ -31,12 +30,12 @@ class ElementHtmlException extends ExpectationException
     /**
      * Initializes exception.
      *
-     * @param string                  $message   optional message
-     * @param DriverInterface|Session $driver    driver instance
-     * @param Element                 $element   element
+     * @param string          $message   optional message
+     * @param DriverInterface $driver    driver instance
+     * @param Element         $element   element
      * @param \Exception|null         $exception expectation exception
      */
-    public function __construct($message, $driver, Element $element, \Exception $exception = null)
+    public function __construct($message, DriverInterface $driver, Element $element, \Exception $exception = null)
     {
         $this->element = $element;