Allow default with null value to be applied (#108)

Author: vearutop

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.12.31] - 2020-09-21
+
+### Fixed
+- Missing support for `null` `default` values, [#107](https://github.com/swaggest/php-json-schema/issues/107). 
+
 ## [0.12.30] - 2020-09-09
 
 ### Added
@@ -63,6 +68,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Export `null` value instead of skipping it for properties having `null` type.
 
+[0.12.31]: https://github.com/swaggest/php-json-schema/compare/v0.12.30...v0.12.31
 [0.12.30]: https://github.com/swaggest/php-json-schema/compare/v0.12.29...v0.12.30
 [0.12.29]: https://github.com/swaggest/php-json-schema/compare/v0.12.28...v0.12.29
 [0.12.28]: https://github.com/swaggest/php-json-schema/compare/v0.12.27...v0.12.28

Makefile

@@ -1,4 +1,4 @@
-PHPSTAN_VERSION ?= 0.11.15
+PHPSTAN_VERSION ?= 0.12.43
 PHPBENCH_VERSION ?= 0.16.10
 
 deps:

phpstan.neon

@@ -1,8 +1,15 @@
 parameters:
 	inferPrivatePropertyTypeFromConstructor: true
+	checkMissingIterableValueType: false
+	checkGenericClassInNonGenericObjectType: false
 	ignoreErrors:
 		- '#Access to an undefined property static\(Swaggest\\JsonSchema\\JsonSchema\)\|Swaggest\\JsonSchema\\Constraint\\Properties::#'
 		- '#Access to an undefined property .+Swaggest\\JsonSchema\\NameMirror::.+#'
 		- '#should be compatible with parameter \$properties#'
 		- '#PHPDoc tag @param references unknown parameter: \$schema#'
-		- '#should return array<string>|null but returns array<int, int|string>#'
+		- '#Property .+ \(array<string>\|null\) does not accept array<int, string\|false>.#'
+		- '#should return array<string> but returns array<int, int\|string>#'
+		- '#has no return typehint specified#'
+		- '#with no typehint specified#'
+		- '#has no typehint specified#'
+		- '#Unsafe usage of new static\(\).#'

src/Constraint/Content.php

@@ -32,7 +32,7 @@ public static function process(Context $options, $encoding, $mediaType, $data, $
                             throw new ContentException('Invalid base64 string');
                         }
                         $data = base64_decode($data);
-                        if ($data === false && !$options->skipValidation) {
+                        if ($data === false && !$options->skipValidation) { // @phpstan-ignore-line
                             throw new ContentException('Unable to decode base64');
                         }
                         break;

src/HasDefault.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Swaggest\JsonSchema;
+
+
+interface HasDefault
+{
+    public function hasDefault();
+}

src/JsonSchema.php

@@ -18,6 +18,8 @@
  *
  * // draft6
  * @property mixed $const
+ *
+ * @property mixed $default
  */
 class JsonSchema extends ClassStructure
 {
@@ -47,8 +49,6 @@ class JsonSchema extends ClassStructure
     /** @var string */
     public $description;
 
-    public $default;
-
     /** @var float|null */
     public $multipleOf;
 

src/Schema.php

@@ -31,10 +31,11 @@
  * Class Schema
  * @package Swaggest\JsonSchema
  */
-class Schema extends JsonSchema implements MetaHolder, SchemaContract
+class Schema extends JsonSchema implements MetaHolder, SchemaContract, HasDefault
 {
     const ENUM_NAMES_PROPERTY = 'x-enum-names';
     const CONST_PROPERTY = 'const';
+    const DEFAULT_PROPERTY = 'default';
 
     const DEFAULT_MAPPING = 'default';
 
@@ -423,7 +424,7 @@ private function processOneOf($data, Context $options, $path)
             try {
                 $result = self::unboolSchema($item)->process($data, $options, $path . '->oneOf[' . $index . ']');
                 $successes++;
-                if ($successes > 1 || $options->skipValidation) {
+                if ($successes > 1 || $options->skipValidation) { // @phpstan-ignore-line
                     break;
                 }
             } catch (InvalidValue $exception) {
@@ -795,9 +796,23 @@ private function processObject($data, Context $options, $path, $result = null)
             && $properties !== null
         ) {
             foreach ($properties as $key => $property) {
+                $allowNull = false;
+                if ($property instanceof HasDefault) {
+                    if (!$property->hasDefault()) {
+                        continue;
+                    }
+
+                    $allowNull = true;
+                }
+
                 // todo check when property is \stdClass `{}` here (RefTest)
-                if ($property instanceof SchemaContract && null !== $default = $property->getDefault()) {
+                if ($property instanceof SchemaContract) {
                     if (!array_key_exists($key, $array)) {
+                        $default = $property->getDefault();
+                        if (null === $default && !$allowNull) { // @phpstan-ignore-line
+                            continue;
+                        }
+
                         $defaultApplied[$key] = true;
                         $array[$key] = $default;
                     }
@@ -961,6 +976,9 @@ private function processArray($data, Context $options, $path, $result)
         $this->items = self::unboolSchema($this->items);
         if ($this->items instanceof SchemaContract) {
             $items = array();
+            /**
+             * @var null|bool|Schema $additionalItems
+             */
             $additionalItems = $this->items;
         } elseif ($this->items === null) { // items defaults to empty schema so everything is valid
             $items = array();
@@ -973,7 +991,6 @@ private function processArray($data, Context $options, $path, $result)
 
         /**
          * @var Schema|Schema[] $items
-         * @var null|bool|Schema $additionalItems
          */
         $itemsLen = is_array($items) ? count($items) : 0;
         $index = 0;
@@ -1407,6 +1424,14 @@ public function getDefault()
         return $this->default;
     }
 
+    /**
+     * @return bool
+     */
+    public function hasDefault()
+    {
+        return array_key_exists(self::DEFAULT_PROPERTY, $this->__arrayOfData);
+    }
+
     /**
      * @nolint
      */

tests/src/PHPUnit/Constraint/DefaultTest.php

@@ -2,7 +2,6 @@
 
 namespace Swaggest\JsonSchema\Tests\PHPUnit\Constraint;
 
-use Swaggest\JsonSchema\Constraint\Type;
 use Swaggest\JsonSchema\Schema;
 
 class DefaultTest extends \PHPUnit_Framework_TestCase
@@ -30,4 +29,27 @@ public function testValidDefault()
         $this->assertSame([], $data->foo);
     }
 
+    /**
+     * @throws \Exception
+     * @throws \Swaggest\JsonSchema\Exception
+     * @throws \Swaggest\JsonSchema\InvalidValue
+     */
+    public function testNullDefault()
+    {
+        $schema = Schema::import(json_decode(<<<'JSON'
+{
+    "properties": {
+        "foo": {
+            "type": ["null", "integer"],
+            "default": null
+        }
+    }
+}
+
+JSON
+        ));
+        $data = $schema->in(new \stdClass());
+        $this->assertSame('{"foo":null}', json_encode($data));
+    }
+
 }