Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juampi92/test-seo
https://github.com/juampi92/test-seo
php8 phpunit seo testing
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/juampi92/test-seo
- Owner: juampi92
- License: mit
- Created: 2022-08-26T23:34:54.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-16T21:16:33.000Z (5 months ago)
- Last Synced: 2024-10-14T06:27:52.632Z (25 days ago)
- Topics: php8, phpunit, seo, testing
- Language: PHP
- Homepage:
- Size: 54.7 KB
- Stars: 23
- Watchers: 1
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Test SEO
[](https://packagist.org/packages/juampi92/test-seo)
[](https://github.com/juampi92/test-seo/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/juampi92/test-seo/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/juampi92/test-seo)
An easy-to-use package for testing SEO. The package allows you to extract SEO tags from a given HTML and verify that the SEO structure is correct.
- [Installation](#instalation)
- [Usage](#usage)
- [PHPUnit](#phpunit)
- [Laravel](#laravel)
- [Pest](#pest)
- [API](#seo-data)
- [SEO Data](#seo-data)
- [Assertions](#sssertions)
- [Snapshot testing](#snapshots)
----
## Installation
You can install the package via composer:
```bash
composer require juampi92/test-seo --dev
```
## Usage
```php
// Create TestSEO instance using the response:
$seo = new TestSEO($htmlResponse);
// Perform assertions:
$seo->assertTitleEndsWith(' - My Website');
// Assert the data yourself:
$this->assertEquals(
'My title - My Website',
$seo->data->title()
);
```
Look at the following examples using **PHPUnit**, **Laravel**, and **Pest**.
### PHPUnit
```php
public function testLandingPageSEO()
{
// Arrange
// ...
// Act
$response = $client->get('/')->send();
// Assert
$this->assertEquals(200, $response->getStatusCode());
$html = json_decode($response->getBody(true), true);
$seo = new TestSEO($html);
// Assert
$seo
->assertTitleEndsWith(' - My Website')
->assertCanonicalIs('https://www.mywebsite.com/');
}
```
### Laravel
```php
public function test_landing_page_SEO()
{
// Arrange
// ...
// Act
$response = $this->get('/');
// Assert
$response->assertStatus(200);
$seo = new TestSEO($response->getContent());
$seo
->assertTitleEndsWith(' - My Website')
->assertCanonicalIs('https://www.mywebsite.com/');
}
```
### Pest
```php
test('landing page SEO tags', function () {
// Arrange
// ...
// Act
$response = get('/')->assertStatus(200);
$seo = new TestSEO($response->getContent());
// Assert
expect($seo->data)
->title()->toEndWith(' - My Website')
->description()->toBe('This is my description')
->canonical()->not()->toBeNull()
->robots()->index()->toBeTrue()
->robots()->nofollow()->toBeTrue();
});
```
## SEO Data
You can access the SEO Data yourself by accessing the public property `TestSEO->data`.
Here are the available methods:
| Method | Returns | Description |
|-----------------------|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| `title()` | `?string` | `{this}` |
| `description()` | `?string` | `` |
| `image()` | `?Url` [🔍](https://github.com/spatie/url) | `` |
| `robots()` | `Robots` [🔍](https://github.com/juampi92/test-seo/blob/main/src/Tags/Robots.php) | `` |
| `canonical()` | `?Url` [🔍](https://github.com/spatie/url) | `` |
| `prev()` | `?Url` [🔍](https://github.com/spatie/url) | `` |
| `next()` | `?Url` [🔍](https://github.com/spatie/url) | `` |
| `openGraph()` | `TagCollection` [🔍](https://github.com/juampi92/test-seo/blob/main/src/Tags/TagCollection.php) | `` |
| `twitter()` | `TagCollection` [🔍](https://github.com/juampi92/test-seo/blob/main/src/Tags/TagCollection.php) | `` |
| `alternateHrefLang()` | `AlternateHrefLangCollection` [🔍](https://github.com/juampi92/test-seo/blob/main/src/Tags/AlternateHrefLangCollection.php) | `` |
| `images()` | `array` | All images in the page. `
` |
| `h1s()` | `array` | All H1 in the page. `
{this}
` |
| `h2s()` | `array` | All H2 in the page. `{this}
` |
| `charset()` | `?string` | `` |
The SEOData class is **Macroable**, so feel free to extend it yourself.
## Assertions
| Method | Notes |
|-----------------------------------------|-----------------------------------------------------------------------------------------------------------|
| `assertCanonicalIs(string $expected)` | |
| `assertCanonicalIsEmpty()` | |
| `assertRobotsIsEmpty()` | |
| `assertRobotsIsNoIndexNoFollow()` | Checks that the robots are `noindex, nofollo` or `none` |
| `assertPaginationIsEmpty()` | `prev` and `next` are both missing. |
| `assertAlternateHrefLangIsEmpty()` | |
| `assertTitleIs(string $expected)` | |
| `assertTitleContains(string $expected)` | |
| `assertTitleEndsWith(string $expected)` | |
| `assertDescriptionIs(string $expected)` | |
| `assertThereIsOnlyOneH1()` | Make sure there is only one H1 in the entire website. |
| `assertAllImagesHaveAltText()` | Make sure all images have an `alt="..."` |
| Suggest your own! | These assertions can help devs to follow the best SEO practices. Make a PR if you think some are missing! |
## Snapshots
When it comes to SEO, a snapshot test is a great way to ensure nothing has been changed by accident.
Here is an example:
```php
$seo = new TestSEO($response->getContent(), snapshotSerializer: null);
$json = json_encode($seo);
```
By default, the SEO tags are serialized using the `SimpleSerializer`.
Make your own serializer by implementing the `SnapshotSerializer` interface:
```php
$seo = new TestSEO($response->getContent(), new MyCustomSerializer());
$json = json_encode($seo);
```
### Pest Example
```php
use function Spatie\Snapshots\{assertMatchesSnapshot, assertMatchesJsonSnapshot};
use Juampi92\TestSEO\TestSEO;
test('landing page SEO', function () {
$response = $this->get('/');
$response->assertStatus(200);
$seo = new TestSEO($response->getContent());
assertMatchesJsonSnapshot(json_encode($seo));
});
```
**Note:** this example requires `spatie/pest-plugin-snapshots`.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Credits
- [Juan Pablo Barreto](https://github.com/juampi92)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.