Merge branch 'weierophinney-hotfix/json-default-flags' into develop

Author: ezimuel

CHANGELOG.md

@@ -48,6 +48,10 @@ All notable changes to this project will be documented in this file, in reverse
 - [#96](https://github.com/zendframework/zend-diactoros/pull/96) updates
   `withPort()` to allow `null` port values (indicating usage of default for
   the given scheme).
+- [#98](https://github.com/zendframework/zend-diactoros/pull/98) updates
+  the default JSON flags used by `JsonResponse` to include
+  `JSON_UNESCAPED_SLASHES`, which still conforms with RFC 4627, and is a more
+  sane default.
 
 ## 1.1.3 - 2015-08-10
 

src/Response/JsonResponse.php

@@ -24,6 +24,17 @@ class JsonResponse extends Response
 {
     use InjectContentTypeTrait;
 
+    /**
+     * Default flags for json_encode; value of:
+     *
+     * <code>
+     * JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_SLASHES
+     * </code>
+     *
+     * @const int
+     */
+    const DEFAULT_JSON_FLAGS = 79;
+
     /**
      * Create a JSON response with the given data.
      *
@@ -34,15 +45,20 @@ class JsonResponse extends Response
      * - JSON_HEX_APOS
      * - JSON_HEX_AMP
      * - JSON_HEX_QUOT
+     * - JSON_UNESCAPED_SLASHES
      *
      * @param mixed $data Data to convert to JSON.
      * @param int $status Integer status code for the response; 200 by default.
      * @param array $headers Array of headers to use at initialization.
      * @param int $encodingOptions JSON encoding options to use.
      * @throws InvalidArgumentException if unable to encode the $data to JSON.
      */
-    public function __construct($data, $status = 200, array $headers = [], $encodingOptions = 15)
-    {
+    public function __construct(
+        $data,
+        $status = 200,
+        array $headers = [],
+        $encodingOptions = self::DEFAULT_JSON_FLAGS
+    ) {
         $body = new Stream('php://temp', 'wb+');
         $body->write($this->jsonEncode($data, $encodingOptions));
 

test/Response/JsonResponseTest.php

@@ -98,4 +98,32 @@ public function testJsonErrorHandlingOfBadEmbeddedData()
         $this->setExpectedException('InvalidArgumentException', 'Unable to encode');
         new JsonResponse($data);
     }
+
+    public function valuesToJsonEncode()
+    {
+        return [
+            'uri'    => ['https://example.com/foo?bar=baz&baz=bat', 'uri'],
+            'html'   => ['<p class="test">content</p>', 'html'],
+            'string' => ["Don't quote!", 'string'],
+        ];
+    }
+
+    /**
+     * @dataProvider valuesToJsonEncode
+     */
+    public function testUsesSaneDefaultJsonEncodingFlags($value, $key)
+    {
+        $defaultFlags = JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP | JSON_UNESCAPED_SLASHES;
+
+        $response = new JsonResponse([$key => $value]);
+        $stream   = $response->getBody();
+        $contents = (string) $stream;
+
+        $expected = json_encode($value, $defaultFlags);
+        $this->assertContains(
+            $expected,
+            $contents,
+            sprintf('Did not encode %s properly; expected (%s), received (%s)', $key, $expected, $contents)
+        );
+    }
 }