Merge pull request martin-helmich#9 from martin-helmich/feature/phpunit-6-compat

PHPUnit 6 compatibility

Author: martin-helmich

.travis.yml

@@ -3,10 +3,6 @@ sudo: false
 php:
   - 7.1
   - 7.0
-  - 5.6
-  - 5.5
-  - 5.4
-  - hhvm
 install:
   - composer install --prefer-dist
 script:

README.md

@@ -14,6 +14,11 @@ This library is [MIT-licensed](LICENSE.txt).
 
     $ composer require --dev helmich/phpunit-json-assert
 
+**Compatibility notice**: [Version 1](https://github.com/martin-helmich/phpunit-json-assert/tree/v1)
+(the `v1` branch) of this library is compatible with PHPUnit 4.8 to 5. [Version 2](https://github.com/martin-helmich/phpunit-json-assert/tree/master)
+(the `master` branch) is compatible with PHPUnit 6 and later. When using `composer require`, Composer should automatically
+pick the correct version for you.
+
 ## Usage
 
 Simply use the trait `Helmich\JsonAssert\JsonAssertions` in your test case. This
@@ -23,8 +28,9 @@ cases:
 ```php
 <?php
 use Helmich\JsonAssert\JsonAssertions;
+use PHPUnit\Framework\TestCase;
 
-class MyTestCase extends PHPUnit_Framework_TestCase
+class MyTestCase extends TestCase
 {
   use JsonAssertions;
 
@@ -58,10 +64,11 @@ Alternatively, you can use the functional interface by including the file
 ```php
 <?php
 use Helmich\JsonAssert\JsonAssertions;
+use PHPUnit\Framework\TestCase;
 
 require_once('path/to/Functions.php');
 
-class MyTestCase extends PHPUnit_Framework_TestCase
+class MyTestCase extends TestCase
 {
   use JsonAssertions;
 

composer.json

@@ -10,8 +10,9 @@
     ],
     "require": {
         "flow/jsonpath": "^0.3.1",
-        "phpunit/phpunit": ">=4.8,<6.0",
-        "justinrainbow/json-schema": "^2.0"
+        "phpunit/phpunit": ">=6.0",
+        "justinrainbow/json-schema": "^2.0",
+        "php": ">=7.0"
     },
     "require-dev": {
         "codeclimate/php-test-reporter": "dev-master"

src/Constraint/JsonValueMatches.php

@@ -2,7 +2,7 @@
 namespace Helmich\JsonAssert\Constraint;
 
 use Flow\JSONPath\JSONPath;
-use PHPUnit_Framework_Constraint as Constraint;
+use PHPUnit\Framework\Constraint\Constraint;
 
 /**
  * A simple constraints that asserts that a single value of a JSON document
@@ -39,7 +39,7 @@ class JsonValueMatches extends Constraint
      *                               _all_ found values must match the
      *                               constraint.
      */
-    public function __construct($jsonPath, Constraint $constraint, $matchAll = false)
+    public function __construct(string $jsonPath, Constraint $constraint, bool $matchAll = false)
     {
         parent::__construct();
 
@@ -53,15 +53,15 @@ public function __construct($jsonPath, Constraint $constraint, $matchAll = false
      *
      * @return string
      */
-    public function toString()
+    public function toString(): string
     {
         return "matches " . $this->constraint->toString() . " at JSON path '{$this->jsonPath}'";
     }
 
     /**
      * @inheritdoc
      */
-    protected function matches($other)
+    protected function matches($other): bool
     {
         if (is_string($other)) {
             $other = json_decode($other);
@@ -88,9 +88,9 @@ protected function matches($other)
     }
 
     /**
-     * @return \Closure
+     * @return callable
      */
-    protected function buildCombinationFunction()
+    protected function buildCombinationFunction(): callable
     {
         if ($this->matchAll) {
             return function ($first, $second) {

src/Constraint/JsonValueMatchesMany.php

@@ -1,7 +1,8 @@
 <?php
 namespace Helmich\JsonAssert\Constraint;
 
-use PHPUnit_Framework_Constraint as Constraint;
+use PHPUnit\Framework\Constraint\Constraint;
+use PHPUnit\Framework\Constraint\IsEqual;
 
 /**
  * Constraint that asserts that a JSON document matches an entire set of JSON
@@ -30,7 +31,7 @@ public function __construct(array $constraints)
 
         foreach ($constraints as $key => $constraint) {
             if (!$constraint instanceof Constraint) {
-                $constraint = new \PHPUnit_Framework_Constraint_IsEqual($constraint);
+                $constraint = new IsEqual($constraint);
             }
 
             $this->constraints[] = new JsonValueMatches($key, $constraint);
@@ -42,7 +43,7 @@ public function __construct(array $constraints)
      *
      * @return string
      */
-    public function toString()
+    public function toString(): string
     {
         return implode(
             ' and ',
@@ -58,7 +59,7 @@ function (Constraint $constraint) {
     /**
      * @inheritdoc
      */
-    protected function matches($other)
+    protected function matches($other): bool
     {
         foreach ($this->constraints as $constraint) {
             if (!$constraint->evaluate($other, '', true)) {

src/Constraint/JsonValueMatchesSchema.php

@@ -2,7 +2,7 @@
 namespace Helmich\JsonAssert\Constraint;
 
 use JsonSchema\Validator;
-use PHPUnit_Framework_Constraint as Constraint;
+use PHPUnit\Framework\Constraint\Constraint;
 use stdClass;
 
 /**
@@ -37,7 +37,7 @@ public function __construct($schema)
      * @param array|stdClass $jsonDocument
      * @return stdClass
      */
-    private function forceToObject($jsonDocument)
+    private function forceToObject($jsonDocument): stdClass
     {
         if (is_string($jsonDocument)) {
             return json_decode($jsonDocument);
@@ -49,7 +49,7 @@ private function forceToObject($jsonDocument)
     /**
      * @inheritdoc
      */
-    protected function matches($other)
+    protected function matches($other): bool
     {
         $other = $this->forceToObject($other);
 
@@ -62,7 +62,7 @@ protected function matches($other)
     /**
      * @inheritdoc
      */
-    protected function additionalFailureDescription($other)
+    protected function additionalFailureDescription($other): string
     {
         $other = $this->forceToObject($other);
 
@@ -79,7 +79,7 @@ protected function additionalFailureDescription($other)
      *
      * @return string
      */
-    public function toString()
+    public function toString(): string
     {
         return 'matches JSON schema';
     }

src/Functions.php

@@ -1,20 +1,26 @@
 <?php
 
-function containsJsonValue($path, $constraint)
+use Helmich\JsonAssert\Constraint\JsonValueMatches;
+use Helmich\JsonAssert\Constraint\JsonValueMatchesMany;
+use Helmich\JsonAssert\Constraint\JsonValueMatchesSchema;
+use PHPUnit\Framework\Constraint\Constraint;
+use PHPUnit\Framework\Constraint\IsEqual;
+
+function containsJsonValue(string $path, $constraint): JsonValueMatches
 {
-    if (!$constraint instanceof PHPUnit_Framework_Constraint) {
-        $constraint = new PHPUnit_Framework_Constraint_IsEqual($constraint);
+    if (!$constraint instanceof Constraint) {
+        $constraint = new IsEqual($constraint);
     }
 
-    return new \Helmich\JsonAssert\Constraint\JsonValueMatches($path, $constraint);
+    return new JsonValueMatches($path, $constraint);
 }
 
-function matchesJsonConstraints(array $constraints)
+function matchesJsonConstraints(array $constraints): JsonValueMatchesMany
 {
-    return new \Helmich\JsonAssert\Constraint\JsonValueMatchesMany($constraints);
+    return new JsonValueMatchesMany($constraints);
 }
 
-function matchesJsonSchema(array $schema)
+function matchesJsonSchema(array $schema): JsonValueMatchesSchema
 {
-    return new \Helmich\JsonAssert\Constraint\JsonValueMatchesSchema($schema);
+    return new JsonValueMatchesSchema($schema);
 }

src/JsonAssertions.php

@@ -4,8 +4,9 @@
 use Helmich\JsonAssert\Constraint\JsonValueMatches;
 use Helmich\JsonAssert\Constraint\JsonValueMatchesMany;
 use Helmich\JsonAssert\Constraint\JsonValueMatchesSchema;
-use PHPUnit_Framework_Assert as Assert;
-use PHPUnit_Framework_Constraint as Constraint;
+use PHPUnit\Framework\Assert;
+use PHPUnit\Framework\Constraint\Constraint;
+use PHPUnit\Framework\Constraint\IsEqual;
 
 /**
  * A trait that can be used in test classes for easy use of JSON assertions
@@ -28,7 +29,7 @@ trait JsonAssertions
      *                                 must match
      * @return void
      */
-    public static function assertJsonValueMatches($jsonDocument, $jsonPath, Constraint $constraint)
+    public static function assertJsonValueMatches($jsonDocument, string $jsonPath, Constraint $constraint)
     {
         Assert::assertThat($jsonDocument, new JsonValueMatches($jsonPath, $constraint));
     }
@@ -46,7 +47,7 @@ public static function assertJsonValueMatches($jsonDocument, $jsonPath, Constrai
      *                                 must match
      * @return void
      */
-    public static function assertAllJsonValuesMatch($jsonDocument, $jsonPath, Constraint $constraint)
+    public static function assertAllJsonValuesMatch($jsonDocument, string $jsonPath, Constraint $constraint)
     {
         Assert::assertThat($jsonDocument, new JsonValueMatches($jsonPath, $constraint, true));
     }
@@ -63,12 +64,12 @@ public static function assertAllJsonValuesMatch($jsonDocument, $jsonPath, Constr
      *                              equal to.
      * @return void
      */
-    public static function assertJsonValueEquals($jsonDocument, $jsonPath, $expectedValue)
+    public static function assertJsonValueEquals($jsonDocument, string $jsonPath, $expectedValue)
     {
         static::assertJsonValueMatches(
             $jsonDocument,
             $jsonPath,
-            new \PHPUnit_Framework_Constraint_IsEqual($expectedValue)
+            new IsEqual($expectedValue)
         );
     }
 
@@ -85,12 +86,12 @@ public static function assertJsonValueEquals($jsonDocument, $jsonPath, $expected
      *                              equal to.
      * @return void
      */
-    public static function assertAllJsonValuesEqual($jsonDocument, $jsonPath, $expectedValue)
+    public static function assertAllJsonValuesEqual($jsonDocument, string $jsonPath, $expectedValue)
     {
         static::assertAllJsonValuesMatch(
             $jsonDocument,
             $jsonPath,
-            new \PHPUnit_Framework_Constraint_IsEqual($expectedValue)
+            new IsEqual($expectedValue)
         );
     }
 

tests/Functional/JsonValueMatchesFluentTest.php

@@ -1,7 +1,7 @@
 <?php
 namespace Helmich\JsonAssert\Tests\Functional;
 
-use PHPUnit_Framework_TestCase as TestCase;
+use PHPUnit\Framework\TestCase;
 
 class JsonValueMatchesFluentTest extends TestCase
 {

tests/Functional/JsonValueMatchesSchemaFluentTest.php

@@ -2,7 +2,7 @@
 namespace Helmich\JsonAssert\Tests\Functional;
 
 use Helmich\JsonAssert\JsonAssertions;
-use PHPUnit_Framework_TestCase as TestCase;
+use PHPUnit\Framework\TestCase;
 
 class JsonValueMatchesSchemaFluentTest extends TestCase
 {
@@ -60,7 +60,7 @@ public function testJsonDocumentMatchesSchema()
     }
 
     /**
-     * @expectedException \PHPUnit_Framework_AssertionFailedError
+     * @expectedException \PHPUnit\Framework\AssertionFailedError
      */
     public function testJsonDocumentDoesNotMatchSchema()
     {