feature #60955 [BrowserKit] Add PHPUnit constraints: BrowserHistoryIsOnFirstPage and BrowserHistoryIsOnLastPage (santysisi)

This PR was merged into the 7.4 branch.

Discussion
----------

[BrowserKit] Add PHPUnit constraints: `BrowserHistoryIsOnFirstPage` and `BrowserHistoryIsOnLastPage`

| Q             | A
| ------------- | ---
| Branch?       | 7.4
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Issues        | no
| License       | MIT

This PR introduces two new PHPUnit constraints to improve testing of browser navigation history state:

- `BrowserHistoryIsOnFirstPage`
- `BrowserHistoryIsOnLastPage`

These constraints allow asserting the current state of the `AbstractBrowser` history using the following new assertion methods:

```php
$this->assertBrowserHistoryIsOnFirstPage();
$this->assertBrowserHistoryIsNotOnFirstPage();
$this->assertBrowserHistoryIsOnLastPage();
$this->assertBrowserHistoryIsNotOnLastPage();
```

Commits
-------

76e80c17237 [BrowserKit] Add PHPUnit constraints: `BrowserHistoryIsOnFirstPage` and `BrowserHistoryIsOnLastPage`

Author: fabpot

CHANGELOG.md

@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add `isFirstPage()` and `isLastPage()` methods to the History class for checking navigation boundaries
+ * Add PHPUnit constraints: `BrowserHistoryIsOnFirstPage` and `BrowserHistoryIsOnLastPage`
 
 6.4
 ---

Test/Constraint/BrowserHistoryIsOnFirstPage.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\BrowserKit\Test\Constraint;
+
+use PHPUnit\Framework\Constraint\Constraint;
+use Symfony\Component\BrowserKit\AbstractBrowser;
+
+final class BrowserHistoryIsOnFirstPage extends Constraint
+{
+    public function toString(): string
+    {
+        return 'is on the first page';
+    }
+
+    protected function matches($other): bool
+    {
+        if (!$other instanceof AbstractBrowser) {
+            throw new \LogicException('Can only test on an AbstractBrowser instance.');
+        }
+
+        return $other->getHistory()->isFirstPage();
+    }
+
+    protected function failureDescription($other): string
+    {
+        return 'the Browser history '.$this->toString();
+    }
+}

Test/Constraint/BrowserHistoryIsOnLastPage.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\BrowserKit\Test\Constraint;
+
+use PHPUnit\Framework\Constraint\Constraint;
+use Symfony\Component\BrowserKit\AbstractBrowser;
+
+final class BrowserHistoryIsOnLastPage extends Constraint
+{
+    public function toString(): string
+    {
+        return 'is on the last page';
+    }
+
+    protected function matches($other): bool
+    {
+        if (!$other instanceof AbstractBrowser) {
+            throw new \LogicException('Can only test on an AbstractBrowser instance.');
+        }
+
+        return $other->getHistory()->isLastPage();
+    }
+
+    protected function failureDescription($other): string
+    {
+        return 'the Browser history '.$this->toString();
+    }
+}