Addidng additional examples to step definitons

src/Context/DebugContext.php

@@ -9,13 +9,16 @@ class DebugContext extends BaseContext
 {
     private $screenshotDir;
 
-    public function __construct($screenshotDir = '.')
+    public function __construct($screenshotDir = './screenshots')
     {
         $this->screenshotDir = $screenshotDir;
     }
 
     /**
      * Pauses the scenario until the user presses a key. Useful when debugging a scenario.
+     * Example: When I put a breakpoint
+     * Example: Then I put a breakpoint
+     * Example: And I put a breakpoint
      *
      * @Then (I )put a breakpoint
      */
@@ -30,6 +33,9 @@ public function iPutABreakpoint()
 
     /**
      * Saving a screenshot
+     * Example: When I save a screenshot in "logInView"
+     * Example: Then I save a screenshot in "logInView"
+     * Example: And I save a screenshot in "logInView"
      *
      * @When I save a screenshot in :filename
      */

src/Context/JsonContext.php

@@ -23,6 +23,8 @@ public function __construct(HttpCallResultPool $httpCallResultPool, $evaluationM
 
     /**
      * Checks, that the response is correct JSON
+     * Example: Then the response should be in JSON
+     * Example: And the response should be in JSON
      *
      * @Then the response should be in JSON
      */
@@ -33,6 +35,8 @@ public function theResponseShouldBeInJson()
 
     /**
      * Checks, that the response is not correct JSON
+     * Example: Then the response should not be in JSON
+     * Example: And the response should not be in JSON
      *
      * @Then the response should not be in JSON
      */
@@ -46,6 +50,8 @@ public function theResponseShouldNotBeInJson()
 
     /**
      * Checks, that given JSON node is equal to given value
+     * Example: Then the JSON node "isBatman"should be equal to "true"
+     * Example: And the JSON node "isBatman" should be equal to "true"
      *
      * @Then the JSON node :node should be equal to :text
      */
@@ -64,6 +70,8 @@ public function theJsonNodeShouldBeEqualTo($node, $text)
 
     /**
      * Checks, that given JSON node has N element(s)
+     * Example: Then the JSON node "bio" should have 5 elements
+     * Example: And the JSON node "bio" should have 5 elements
      *
      * @Then the JSON node :node should have :count element(s)
      */
@@ -78,6 +86,8 @@ public function theJsonNodeShouldHaveElements($node, $count)
 
     /**
      * Checks, that given JSON node contains given value
+     * Example: Then the JSON node "trueIdentity" should contain "Bruce Wayne"
+     * Example: And the JSON node "trueIdentity" should contain "Bruce Wayne"
      *
      * @Then the JSON node :node should contain :text
      */
@@ -92,6 +102,8 @@ public function theJsonNodeShouldContain($node, $text)
 
     /**
      * Checks, that given JSON node does not contain given value
+     * Example: Then the JSON node "isRobin" should not contain "true"
+     * Example: And the JSON node "isRobin" should not contain "true"
      *
      * @Then the JSON node :node should not contain :text
      */
@@ -106,6 +118,8 @@ public function theJsonNodeShouldNotContain($node, $text)
 
     /**
      * Checks, that given JSON node exist
+     * Example: Then the JSON node "id" should exist
+     * Example: And the JSON node "id" should exist
      *
      * @Given the JSON node :name should exist
      */
@@ -124,6 +138,8 @@ public function theJsonNodeShouldExist($name)
 
     /**
      * Checks, that given JSON node does not exist
+     * Example: Then the JSON node "Robin" should not exist
+     * Example: And the JSON node "Robin" should not exist
      *
      * @Given the JSON node :name should not exist
      */
@@ -135,6 +151,56 @@ public function theJsonNodeShouldNotExist($name)
     }
 
     /**
+     * Checks provided JSON against a JSON schema
+     * Example: Then the JSON should be valid according to this schema:
+     *          """
+     *          {
+     *              "$schema": "http://json-schema.org/draft-04/schema#",
+     *              "title": "Heroes",
+     *              "description": "A list of heroes from the known universe",
+     *              "type": "object",
+     *              "properties": {
+     *                   "id": {
+     *                        "description": "The unique identifier for a hero",
+     *                        "type": "integer"
+     *                   },
+     *                   "name": {
+     *                        "description": "Name of the hero",
+     *                        "type": "string"
+     *                   },
+     *                   "alterEgo": {
+     *                        "description": "Alter ego for hero",
+     *                        "type": "string"
+     *                   }
+     *              },
+     *              "required": ["id", "name", "alterEgo"]
+     *          }
+     *          """
+     * Example: And the JSON should be valid according to this schema:
+     *          """
+     *          {
+     *              "$schema": "http://json-schema.org/draft-04/schema#",
+     *              "title": "Heroes",
+     *              "description": "A list of heroes from the known universe",
+     *              "type": "object",
+     *              "properties": {
+     *                   "id": {
+     *                        "description": "The unique identifier for a hero",
+     *                        "type": "integer"
+     *                   },
+     *                   "name": {
+     *                        "description": "Name of the hero",
+     *                        "type": "string"
+     *                   },
+     *                   "alterEgo": {
+     *                        "description": "Alter ego for hero",
+     *                        "type": "string"
+     *                   }
+     *              },
+     *              "required": ["id", "name", "alterEgo"]
+     *          }
+     *          """
+     *
      * @Then the JSON should be valid according to this schema:
      */
     public function theJsonShouldBeValidAccordingToThisSchema(PyStringNode $schema)
@@ -146,6 +212,10 @@ public function theJsonShouldBeValidAccordingToThisSchema(PyStringNode $schema)
     }
 
     /**
+     * Checks provided JSON against a provided JSON schema
+     * Example: Then the JSON should be valid according to the schema "http://batman.com/secret-schema"
+     * Example: And the JSON should be valid according to the schema "http://batman.com/secret-schema"
+     *
      * @Then the JSON should be valid according to the schema :filename
      */
     public function theJsonShouldBeValidAccordingToTheSchema($filename)
@@ -166,6 +236,24 @@ public function theJsonShouldBeValidAccordingToTheSchema($filename)
     }
 
     /**
+     * Checks that the JSON response is equal to value
+     * Example: Then the JSON should be equal to:
+     *           """
+     *           {
+     *               "id": 1,
+     *               "name": "Batman",
+     *               "alterEgo": "Bruce Wayne"
+     *           }
+     *           """
+     * Example: And the JSON should be equal to:
+     *           """
+     *           {
+     *               "id": 1,
+     *               "name": "Batman",
+     *               "alterEgo": "Bruce Wayne"
+     *           }
+     *           """
+     *
      * @Then the JSON should be equal to:
      */
     public function theJsonShouldBeEqualTo(PyStringNode $content)
@@ -187,6 +275,10 @@ public function theJsonShouldBeEqualTo(PyStringNode $content)
     }
 
     /**
+     * Prints last JSON response
+     * Example: Then print last JSON response
+     * Example: And print last JSON response
+     *
      * @Then print last JSON response
      */
     public function printLastJsonResponse()