Skip to content

Fixed PHPUnit integration section in README.md #138

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 1 commit into from
Apr 20, 2019
Merged

Fixed PHPUnit integration section in README.md #138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# PHP Matcher

Library created for testing all kinds of JSON/XML/TXT/Scalar values against patterns.
Library created for testing all kinds of JSON/XML/TXT/Scalar values against patterns.

```php
PHPMatcher::match($value = '{"foo": "bar"}', $pattern = '{"foo": "@string@"}');
```

It was built to simplify API's functional testing.
It was built to simplify API's functional testing.

* [![Build Status](https://travis-ci.org/coduo/php-matcher.svg)](https://travis-ci.org/coduo/php-matcher) - master (3.2.*)
* [![Build Status](https://travis-ci.org/coduo/php-matcher.svg?branch=3.1)](https://travis-ci.org/coduo/php-matcher) - 3.1.*

[Readme for master (3.2) version](https://github.com/coduo/php-matcher/tree/master/README.md)
[Readme for 3.1 version](https://github.com/coduo/php-matcher/tree/3.1/README.md)
[Readme for 3.1 version](https://github.com/coduo/php-matcher/tree/3.1/README.md)


## Installation
Expand All @@ -32,7 +32,7 @@ composer require --dev "coduo/php-matcher"

use Coduo\PHPMatcher\PHPMatcher;

if (!PHPMatcher::match("lorem ipsum dolor", "@string@", $error)) {
if (!PHPMatcher::match("lorem ipsum dolor", "@string@", $error)) {
echo $error; // in case of error message is set on $error variable via reference
}

Expand Down Expand Up @@ -198,7 +198,7 @@ $matcher->match(array("bar"), "@wildcard@");
$matcher->match(new \stdClass, "@wildcard@");
```

### Expression matching
### Expression matching

```php
<?php
Expand All @@ -225,7 +225,7 @@ $matcher = $factory->createMatcher();
$matcher->match('9f4db639-0e87-4367-9beb-d64e3f42ae18', '@uuid@');
```

### Array matching
### Array matching

```php
<?php
Expand Down Expand Up @@ -280,11 +280,11 @@ $matcher->match(
),
'@boolean@',
'@double@'
)
)
);
```

### Json matching
### Json matching

```php
<?php
Expand Down Expand Up @@ -378,7 +378,7 @@ Feature: Listing user toys
Scenario: Listing toys
Given the following users exist:
| firstName | lastName |
| Chuck | Norris |
| Chuck | Norris |

And the following toys user "Chuck Norris" exist:
| name |
Expand Down Expand Up @@ -409,7 +409,7 @@ Feature: Listing user toys
}
]
"""
```
```

## PHPUnit integration

Expand All @@ -421,8 +421,9 @@ or extend the `Coduo\PHPMatcher\PHPUnit\PHPMatcherTestCase`:
namespace Coduo\PHPMatcher\Tests\PHPUnit;

use Coduo\PHPMatcher\PHPUnit\PHPMatcherAssertions;
use PHPUnit\Framework\TestCase;

class PHPMatcherAssertionsTest extends \PHPUnit_Framework_TestCase
class PHPMatcherAssertionsTest extends TestCase
{
use PHPMatcherAssertions;

Expand All @@ -436,7 +437,7 @@ class PHPMatcherAssertionsTest extends \PHPUnit_Framework_TestCase
The `matchesPattern()` method can be used in PHPUnit stubs or mocks:

```php
$mock = $this->getMock(Foo::class);
$mock = $this->createMock(Foo::class);
$mock->method('bar')
->with($this->matchesPattern('@string@'))
->willReturn('foo');
Expand All @@ -450,4 +451,3 @@ This library is distributed under the MIT license. Please see the LICENSE file.

This lib was inspired by [JSON Expressions gem](https://github.com/chancancode/json_expressions) &&
[Behat RestExtension ](https://github.com/jakzal/RestExtension)