Merge branch 'feature/34-json-pretty-debug' into release-1.0.0

Close #34

Author: weierophinney

CHANGELOG.md

@@ -50,6 +50,12 @@ Versions 0.3.0 and prior were released as "weierophinney/problem-details".
   modifies the constructor of `Zend\ProblemDetails\ProblemDetailsNotFoundHandler`;
   the `$responseFactory` argument is now required.
 
+- [#34](https://github.com/zendframework/zend-problem-details/pull/34) updates
+  the behavior when passing null as the `$jsonFlag` parameter to the
+  `Zend\ProblemDetails\ProblemDetailsResponseFactory` constructor; in such
+  situations, the default `json_encode()` flags will include `JSON_PRETTY_PRINT`
+  only when the `$isDebug` argument is boolean `true`.
+
 ### Deprecated
 
 - Nothing.
@@ -67,7 +73,7 @@ Versions 0.3.0 and prior were released as "weierophinney/problem-details".
 ### Added
 
 - [#30](https://github.com/zendframework/zend-problem-details/pull/30)
-  adds PSR-15 support. 
+  adds PSR-15 support.
 
 ### Changed
 

docs/book/response.md

@@ -116,8 +116,11 @@ where:
 - `int $jsonFlags` is an integer bitmask of [JSON encoding
   constants](http://php.net/manual/en/json.constants.php) to use with
   `json_encode()` when generating JSON problem details. If you pass a `null`
-  value, `JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE |
-  JSON_PRESERVE_ZERO_FRACTION` will be used.
+  value, and the `$isDebug` flag is true,
+  `JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION`
+  will be used; otherwise,
+  `JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION`
+  will be used.
 - `bool $exceptionDetailsInResponse` is a flag indicating whether or not to
   include exception details (in particular, the message) when creating the
   problem details response. By default, for non-`ProblemDetailsExceptionInterface`

src/ProblemDetailsResponseFactory.php

@@ -146,7 +146,10 @@ class ProblemDetailsResponseFactory
     /**
      * JSON flags to use when generating JSON response payload.
      *
-     * Defaults to JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION
+     * On non-debug mode:
+     * defaults to JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION
+     * On debug mode:
+     * defaults to JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION
      *
      * @var int
      */
@@ -191,8 +194,13 @@ public function __construct(
             return $responseFactory();
         };
         $this->isDebug = $isDebug;
-        $this->jsonFlags = $jsonFlags
-            ?: JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION;
+        if (! $jsonFlags) {
+            $jsonFlags = JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION;
+            if ($isDebug) {
+                $jsonFlags = JSON_PRETTY_PRINT | $jsonFlags;
+            }
+        }
+        $this->jsonFlags = $jsonFlags;
         $this->exceptionDetailsInResponse = $exceptionDetailsInResponse;
         $this->defaultDetailMessage = $defaultDetailMessage;
     }

test/ProblemDetailsResponseFactoryFactoryTest.php

@@ -77,7 +77,7 @@ public function testLackOfConfigServiceResultsInFactoryUsingDefaults() : void
         $this->assertInstanceOf(ProblemDetailsResponseFactory::class, $factory);
         $this->assertAttributeSame(ProblemDetailsResponseFactory::EXCLUDE_THROWABLE_DETAILS, 'isDebug', $factory);
         $this->assertAttributeSame(
-            JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION,
+            JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION,
             'jsonFlags',
             $factory
         );
@@ -86,6 +86,25 @@ public function testLackOfConfigServiceResultsInFactoryUsingDefaults() : void
         $this->assertResponseFactoryReturns($response, $factory);
     }
 
+    public function testUsesPrettyPrintFlagOnEnabledDebugMode() : void
+    {
+        $this->container->has('config')->willReturn(true);
+        $this->container->get('config')->willReturn([
+            'debug' => true,
+        ]);
+        $this->container->get(ResponseInterface::class)->willReturn(function () {
+        });
+
+        $factoryFactory = new ProblemDetailsResponseFactoryFactory();
+        $factory = $factoryFactory($this->container->reveal());
+
+        $this->assertAttributeSame(
+            JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION,
+            'jsonFlags',
+            $factory
+        );
+    }
+
     public function testUsesDebugSettingFromConfigWhenPresent() : void
     {
         $this->container->has('config')->willReturn(true);