Added support for matches() and closest() in Crawler (#524)

pkruithof · web-flow · commit aeda2f11ac9a · 2022-01-04T18:23:55.000+01:00
* Added support for `matches()` and `closest()` in Crawler

* cs
diff --git a/src/DomCrawler/Crawler.php b/src/DomCrawler/Crawler.php
@@ -13,6 +13,7 @@
 
 namespace Symfony\Component\Panther\DomCrawler;
 
+use function array_merge;
 use Facebook\WebDriver\Exception\NoSuchElementException;
 use Facebook\WebDriver\WebDriver;
 use Facebook\WebDriver\WebDriverBy;
@@ -132,6 +133,33 @@ public function siblings(): static
         return $this->createSubCrawlerFromXpath('(preceding-sibling::* | following-sibling::*)');
     }
 
+    public function matches(string $selector): bool
+    {
+        $converter = $this->createCssSelectorConverter();
+        $xpath = $converter->toXPath($selector, 'self::');
+
+        return $this->filterXPath($xpath)->count() > 0;
+    }
+
+    public function closest(string $selector): ?self
+    {
+        $converter = $this->createCssSelectorConverter();
+        $xpath = WebDriverBy::xpath($converter->toXPath($selector, 'self::'));
+
+        /** @var WebDriverElement[] $elements */
+        $elements = [...$this->elements, ...$this->ancestors()->elements];
+        foreach ($elements as $element) {
+            try {
+                $element->findElement($xpath);
+
+                return $this->createSubCrawler([$element]);
+            } catch (NoSuchElementException) {
+            }
+        }
+
+        return null;
+    }
+
     public function nextAll(): static
     {
         return $this->createSubCrawlerFromXpath('following-sibling::*');
diff --git a/tests/DomCrawler/CrawlerTest.php b/tests/DomCrawler/CrawlerTest.php
@@ -156,6 +156,50 @@ public function testSiblings(callable $clientFactory): void
         $this->assertSame(['Main', 'Sibling 2', 'Sibling 3'], $texts);
     }
 
+    /**
+     * @dataProvider clientFactoryProvider
+     */
+    public function testMatches(callable $clientFactory): void
+    {
+        $crawler = $this->request($clientFactory, '/basic.html');
+        $p = $crawler->filter('#a-sibling');
+
+        $this->assertTrue($p->matches('#a-sibling'));
+        $this->assertTrue($p->matches('p'));
+        $this->assertTrue($p->matches('.foo'));
+        $this->assertFalse($p->matches('#other-id'));
+        $this->assertFalse($p->matches('div'));
+        $this->assertFalse($p->matches('.bar'));
+    }
+
+    /**
+     * @dataProvider clientFactoryProvider
+     */
+    public function testClosest(callable $clientFactory): void
+    {
+        $crawler = $this->request($clientFactory, '/closest.html');
+
+        $foo = $crawler->filter('#foo');
+
+        $newFoo = $foo->closest('#foo');
+        $this->assertNotNull($newFoo);
+        $this->assertSame('newFoo ok', $newFoo->attr('class'));
+
+        $lorem1 = $foo->closest('.lorem1');
+        $this->assertNotNull($lorem1);
+        $this->assertSame('lorem1 ok', $lorem1->attr('class'));
+
+        $lorem2 = $foo->closest('.lorem2');
+        $this->assertNotNull($lorem2);
+        $this->assertSame('lorem2 ok', $lorem2->attr('class'));
+
+        $lorem3 = $foo->closest('.lorem3');
+        $this->assertNull($lorem3);
+
+        $notFound = $foo->closest('.not-found');
+        $this->assertNull($notFound);
+    }
+
     /**
      * @dataProvider clientFactoryProvider
      */
diff --git a/tests/fixtures/closest.html b/tests/fixtures/closest.html
@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+<body>
+<div class="lorem2 ok">
+    <div>
+        <div class="lorem3 ko"></div>
+    </div>
+    <div class="lorem1 ok">
+        <div id="foo" class="newFoo ok">
+            <div class="lorem1 ko"></div>
+        </div>
+    </div>
+</div>
+<div class="lorem2 ko">
+</div>
+</body>
+</html>
