Merge pull request #11 from jdeniau/jd-feat-jsonDxSoyuka

increase JSON context DX

Author: soyuka

src/Context/JsonContext.php

@@ -3,13 +3,11 @@
 namespace Behatch\Context;
 
 use Behat\Gherkin\Node\PyStringNode;
-
 use Behat\Gherkin\Node\TableNode;
-use Behat\Mink\Exception\ExpectationException;
+use Behatch\HttpCall\HttpCallResultPool;
 use Behatch\Json\Json;
-use Behatch\Json\JsonSchema;
 use Behatch\Json\JsonInspector;
-use Behatch\HttpCall\HttpCallResultPool;
+use Behatch\Json\JsonSchema;
 
 class JsonContext extends BaseContext
 {
@@ -49,17 +47,19 @@ public function theResponseShouldNotBeInJson()
     /**
      * Checks, that given JSON node is equal to given value
      *
-     * @Then the JSON node :node should be equal to :text
+     * @Then the JSON node :node should be equal to :expected
      */
-    public function theJsonNodeShouldBeEqualTo($node, $text)
+    public function theJsonNodeShouldBeEqualTo($node, $expected)
     {
         $json = $this->getJson();
 
+        $expected = self::reespaceSpecialGherkinValue($expected);
+
         $actual = $this->inspector->evaluate($json, $node);
 
-        if ($actual != $text) {
+        if ($actual != $expected) {
             throw new \Exception(
-                sprintf("The node value is '%s'", json_encode($actual))
+                sprintf("The node '%s' value is '%s', '%s' expected", $node, json_encode($actual), $expected)
             );
         }
     }
@@ -71,8 +71,21 @@ public function theJsonNodeShouldBeEqualTo($node, $text)
      */
     public function theJsonNodesShouldBeEqualTo(TableNode $nodes)
     {
-        foreach ($nodes->getRowsHash() as $node => $text) {
-            $this->theJsonNodeShouldBeEqualTo($node, $text);
+        $json = $this->getJson();
+
+        $errors = [];
+        foreach ($nodes->getRowsHash() as $node => $expected) {
+            $actual = $this->inspector->evaluate($json, $node);
+
+            $expected = self::reespaceSpecialGherkinValue($expected);
+
+            if ($actual != $expected) {
+                $errors[] = sprintf("The node '%s' value is '%s', '%s' expected", $node, json_encode($actual), $expected);
+            }
+        }
+
+        if (!empty($errors)) {
+            throw new \Exception(implode("\n", $errors));
         }
     }
 
@@ -89,7 +102,7 @@ public function theJsonNodeShouldMatch($node, $pattern)
 
         if (preg_match($pattern, $actual) === 0) {
             throw new \Exception(
-                sprintf("The node value is '%s'", json_encode($actual))
+                sprintf("The node '%s' value is '%s', '%s' pattern expected", $node, json_encode($actual), $pattern)
             );
         }
     }
@@ -107,7 +120,7 @@ public function theJsonNodeShouldBeNull($node)
 
         if (null !== $actual) {
             throw new \Exception(
-                sprintf('The node value is `%s`', json_encode($actual))
+                sprintf("The node '%s' value is '%s', null expected", $node, json_encode($actual))
             );
         }
     }
@@ -119,9 +132,15 @@ public function theJsonNodeShouldBeNull($node)
      */
     public function theJsonNodeShouldNotBeNull($node)
     {
-        $this->not(function () use ($node) {
-            return $this->theJsonNodeShouldBeNull($node);
-        }, sprintf('The node %s should not be null', $node));
+        $json = $this->getJson();
+
+        $actual = $this->inspector->evaluate($json, $node);
+
+        if (null === $actual) {
+            throw new \Exception(
+                sprintf("The node '%s' value is null, non-null value expected", $node)
+            );
+        }
     }
 
     /**
@@ -137,7 +156,7 @@ public function theJsonNodeShouldBeTrue($node)
 
         if (true !== $actual) {
             throw new \Exception(
-                sprintf('The node value is `%s`', json_encode($actual))
+                sprintf("The node '%s' value is '%s', 'true' expected", $node, json_encode($actual))
             );
         }
     }
@@ -155,25 +174,25 @@ public function theJsonNodeShouldBeFalse($node)
 
         if (false !== $actual) {
             throw new \Exception(
-                sprintf('The node value is `%s`', json_encode($actual))
+                sprintf("The node '%s' value is '%s', 'false' expected", $node, json_encode($actual))
             );
         }
     }
 
     /**
      * Checks, that given JSON node is equal to the given string
      *
-     * @Then the JSON node :node should be equal to the string :text
+     * @Then the JSON node :node should be equal to the string :expected
      */
-    public function theJsonNodeShouldBeEqualToTheString($node, $text)
+    public function theJsonNodeShouldBeEqualToTheString($node, $expected)
     {
         $json = $this->getJson();
 
         $actual = $this->inspector->evaluate($json, $node);
 
-        if ($actual !== $text) {
+        if ($actual !== $expected) {
             throw new \Exception(
-                sprintf('The node value is `%s`', json_encode($actual))
+                sprintf("The node '%s' value is '%s', string '%s' expected", $node, json_encode($actual), $expected)
             );
         }
     }
@@ -191,7 +210,7 @@ public function theJsonNodeShouldBeEqualToTheNumber($node, $number)
 
         if ($actual !== (float) $number && $actual !== (int) $number) {
             throw new \Exception(
-                sprintf('The node value is `%s`', json_encode($actual))
+                sprintf("The node '%s' value is '%s', number '%s' expected", $node, json_encode($actual), (string) $number)
             );
         }
     }
@@ -207,7 +226,7 @@ public function theJsonNodeShouldHaveElements($node, $count)
 
         $actual = $this->inspector->evaluate($json, $node);
 
-        $this->assertSame($count, sizeof((array) $actual));
+        $this->assertSame($count, count((array) $actual));
     }
 
     /**
@@ -276,6 +295,7 @@ public function theJsonNodeShouldExist($name)
         } catch (\Exception $e) {
             throw new \Exception("The node '$name' does not exist.");
         }
+
         return $node;
     }
 
@@ -337,7 +357,7 @@ public function theJsonShouldBeInvalidAccordingToTheSchema($filename)
 
         $this->not(function () use ($filename) {
             return $this->theJsonShouldBeValidAccordingToTheSchema($filename);
-        }, "The schema was valid");
+        }, 'The schema was valid');
     }
 
     /**
@@ -356,7 +376,7 @@ public function theJsonShouldBeEqualTo(PyStringNode $content)
         $this->assertSame(
             (string) $expected,
             (string) $actual,
-            "The json is equal to:\n". $actual->encode()
+            "The json is equal to:\n" . $actual->encode()
         );
     }
 
@@ -390,8 +410,8 @@ public function theJsonShouldBeValidAccordingToTheSwaggerSchema($dumpPath, $sche
             )
         );
     }
+
     /**
-     *
      * Checks, that response JSON not matches with a swagger dump
      *
      * @Then the JSON should not be valid according to swagger :dumpPath dump schema :schemaName
@@ -403,8 +423,6 @@ public function theJsonShouldNotBeValidAccordingToTheSwaggerSchema($dumpPath, $s
         }, 'JSON Schema matches but it should not');
     }
 
-
-
     protected function getJson()
     {
         return new Json($this->httpCallResultPool->getResult()->getValue());
@@ -418,4 +436,9 @@ private function checkSchemaFile($filename)
             );
         }
     }
+
+    public static function reespaceSpecialGherkinValue(string $value): string
+    {
+        return str_replace("\\n", "\n", $value);
+    }
 }