Merge 37ba1f5 into 3408978

chubbyphp · Sep 20, 2020 · 58b6049 · 58b6049
2 parents 3408978 + 37ba1f5
commit 58b6049
Show file tree

Hide file tree

Showing 108 changed files with 720 additions and 3,514 deletions.
diff --git a/README.md b/README.md
@@ -14,25 +14,25 @@ A simple serialization.
 ## Requirements
 
  * php: ^7.2
- * doctrine/inflector: ^1.0
+ * doctrine/inflector: ^1.0|^2.0
  * psr/http-message: ^1.0.1
  * psr/link: ^1.0
- * psr/log: ^1.1
+ * psr/log: ^1.1.3
 
 ## Suggest
 
- * chubbyphp/chubbyphp-container: ^1.0
- * pimple/pimple: ^3.2.3
+ * chubbyphp/chubbyphp-container: ^1.1
+ * pimple/pimple: ^3.3
  * psr/container: ^1.0
- * symfony/dependency-injection: ^2.8.50|^3.4.26|^4.2.7|^5.0 (symfony integration)
- * symfony/yaml: ^2.8.50|^3.4.26|^4.2.7|^5.0 (application/x-yaml support)
+ * symfony/dependency-injection: ^3.4.42|^4.4.10|^5.0.10 (symfony integration)
+ * symfony/yaml: ^3.4.42|^4.4.10|^5.0.10 (application/x-yaml support)
 
 ## Installation
 
 Through [Composer](http://getcomposer.org) as [chubbyphp/chubbyphp-serialization][1].
 
 ```sh
-composer require chubbyphp/chubbyphp-serialization "^2.15"
+composer require chubbyphp/chubbyphp-serialization "^3.0"
 ```
 
 ## Usage
@@ -111,11 +111,20 @@ composer require chubbyphp/chubbyphp-serialization "^2.15"
  * [CallableNormalizationObjectMapping][30]
  * [LazyNormalizationObjectMapping][31]
 
+### Policy
+
+* [AndPolicy][32]
+* [CallbackPolicy][33]
+* [GroupPolicy][34]
+* [NotPolicy][35]
+* [NullPolicy][36]
+* [OrPolicy][37]
+
 ### ServiceFactory
 
 #### chubbyphp-container
 
- * [SerializationServiceFactory][32]
+ * [SerializationServiceFactory][38]
 
 #### chubbyphp-laminas-config-factory
 
@@ -126,7 +135,7 @@ composer require chubbyphp/chubbyphp-serialization "^2.15"
 
 ### ServiceProvider
 
-* [SerializationServiceProvider][33]
+* [SerializationServiceProvider][39]
 
 ### Serializer
 
@@ -188,7 +197,7 @@ print_r($data);
 print_r($serializer->getContentTypes());
 //[
 //    'application/json',
-//    'application/x-jsonx',
+//    'application/jsonx+xml',
 //    'application/x-www-form-urlencoded',
 //    'application/xml',
 //    'application/x-yaml'
@@ -252,9 +261,16 @@ Dominik Zogg 2020
 [30]: doc/Mapping/CallableNormalizationObjectMapping.md
 [31]: doc/Mapping/LazyNormalizationObjectMapping.md
 
-[32]: doc/ServiceFactory/SerializationServiceFactory.md
+[32]: doc/Policy/AndPolicy.md
+[33]: doc/Policy/CallbackPolicy.md
+[34]: doc/Policy/GroupPolicy.md
+[35]: doc/Policy/NotPolicy.md
+[36]: doc/Policy/NullPolicy.md
+[37]: doc/Policy/OrPolicy.md
+
+[38]: doc/ServiceFactory/SerializationServiceFactory.md
 
-[33]: doc/ServiceProvider/SerializationServiceProvider.md
+[39]: doc/ServiceProvider/SerializationServiceProvider.md
 
 [40]: doc/ServiceFactory/EncoderFactory.md
 [41]: doc/ServiceFactory/NormalizerFactory.md

diff --git a/composer.json b/composer.json
@@ -11,29 +11,29 @@
     ],
     "require": {
         "php": "^7.2",
-        "doctrine/inflector": "^1.0",
+        "doctrine/inflector": "^1.0|^2.0",
         "psr/http-message": "^1.0.1",
         "psr/link": "^1.0",
-        "psr/log": "^1.1"
+        "psr/log": "^1.1.3"
     },
     "require-dev": {
-        "chubbyphp/chubbyphp-container": "^1.0",
+        "chubbyphp/chubbyphp-container": "^1.1",
         "chubbyphp/chubbyphp-dev-helper": "dev-master",
         "chubbyphp/chubbyphp-laminas-config-factory": "^1.0",
-        "chubbyphp/chubbyphp-mock": "^1.4.2",
+        "chubbyphp/chubbyphp-mock": "^1.4.5",
         "doctrine/persistence": "^1.3|^2.0",
-        "infection/infection": "^0.15",
+        "infection/infection": "^0.15.3|^0.16.4",
         "mavimo/phpstan-junit": "^0.3",
         "php-coveralls/php-coveralls": "^2.2",
-        "phploc/phploc": "^5.0",
-        "phpstan/extension-installer": "^1.0.3",
-        "phpstan/phpstan": "^0.12.3",
-        "phpunit/phpunit": "^8.5.1",
-        "pimple/pimple": "^3.2.3",
+        "phploc/phploc": "^5.0|^6.0.2",
+        "phpstan/extension-installer": "^1.0.4",
+        "phpstan/phpstan": "^0.12.32",
+        "phpunit/phpunit": "^8.5.8|^9.2.5",
+        "pimple/pimple": "^3.3",
         "psr/container": "^1.0",
-        "symfony/config": "^2.8.50|^3.4.26|^4.2.7|^5.0",
-        "symfony/dependency-injection": "^2.8.50|^3.4.26|^4.2.7|^5.0",
-        "symfony/yaml": "^2.8.50|^3.4.26|^4.2.7|^5.0"
+        "symfony/config": "^3.4.42|^4.4.10|^5.0.10",
+        "symfony/dependency-injection": "^3.4.42|^4.4.10|^5.0.10",
+        "symfony/yaml": "^3.4.42|^4.4.10|^5.0.10"
     },
     "autoload": {
         "psr-4": { "Chubbyphp\\Serialization\\": "src/" }
@@ -46,7 +46,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "2.15-dev"
+            "dev-master": "3.0-dev"
         }
     },
     "scripts": {
@@ -63,7 +63,7 @@
         ],
         "test:cs": "mkdir -p build && vendor/bin/php-cs-fixer fix --dry-run --stop-on-violation --cache-file=build/phpcs.cache",
         "test:infection": "vendor/bin/infection --threads=$(nproc) --min-msi=87 --verbose --coverage=build/phpunit",
-        "test:insights": "mkdir -p build && bash -c 'vendor/bin/phpinsights analyse -v --no-interaction --min-quality=88 --disable-security-check | tee build/phpinsights.log; if [ ${PIPESTATUS[0]} -ne \"0\" ]; then exit 1; fi'",
+        "test:insights": "mkdir -p build && bash -c 'vendor/bin/phpinsights analyse -v --no-interaction --min-quality=94 --disable-security-check | tee build/phpinsights.log; if [ ${PIPESTATUS[0]} -ne \"0\" ]; then exit 1; fi'",
         "test:integration": "vendor/bin/phpunit --testsuite=Integration --cache-result-file=build/phpunit/result.cache",
         "test:lint": "mkdir -p build && find src tests -name '*.php' -print0 | xargs -0 -n1 -P$(nproc) php -l | tee build/phplint.log",
         "test:loc": "mkdir -p build && vendor/bin/phploc src --verbose | tee build/phploc.log",

diff --git a/doc/Encoder/Encoder.md b/doc/Encoder/Encoder.md
@@ -3,14 +3,16 @@
 ```php
 <?php
 
-use Chubbyphp\Deserialization\Encoder\Encoder;
-use Chubbyphp\Deserialization\Encoder\JsonTypeEncoder;
-use Chubbyphp\Deserialization\Encoder\UrlEncodedTypeEncoder;
-use Chubbyphp\Deserialization\Encoder\XmlTypeEncoder;
-use Chubbyphp\Deserialization\Encoder\YamlTypeEncoder;
+use Chubbyphp\Serialization\Encoder\Encoder;
+use Chubbyphp\Serialization\Encoder\JsonTypeEncoder;
+use Chubbyphp\Serialization\Encoder\JsonxTypeEncoder;
+use Chubbyphp\Serialization\Encoder\UrlEncodedTypeEncoder;
+use Chubbyphp\Serialization\Encoder\XmlTypeEncoder;
+use Chubbyphp\Serialization\Encoder\YamlTypeEncoder;
 
 $encoder = new Encoder([
     new JsonTypeEncoder(),
+    new JsonxTypeEncoder(),
     new UrlEncodedTypeEncoder(),
     new XmlTypeEncoder(),
     new YamlTypeEncoder()
@@ -19,6 +21,7 @@ $encoder = new Encoder([
 print_r($encoder->getContentTypes());
 //[
 //    'application/json',
+//    'application/jsonx+xml',
 //    'application/x-www-form-urlencoded',
 //    'application/xml',
 //    'application/x-yaml'
@@ -29,4 +32,4 @@ echo $encoder->encode(
     'application/json'
 );
 // '{"name": "php"}'
-```
+```
diff --git a/doc/Encoder/JsonxTypeEncoder.md b/doc/Encoder/JsonxTypeEncoder.md
@@ -8,7 +8,7 @@ use Chubbyphp\Serialization\Encoder\JsonxTypeEncoder;
 $encoderType = new JsonxTypeEncoder();
 
 echo $encoderType->getContentType();
-// 'application/x-jsonx'
+// 'application/jsonx+xml'
 
 echo $encoderType->encode(['name' => 'php']);
 // '<json:object><json:string name="name">php</json:string></json:object>'

diff --git a/doc/Encoder/XmlTypeEncoder.md b/doc/Encoder/XmlTypeEncoder.md
@@ -1,4 +1,4 @@
-# XmlTypeEncoder
+# XmlTypeEncoder  (alias for Jsonx)
 
 ```php
 <?php
@@ -11,5 +11,5 @@ echo $encoderType->getContentType();
 // 'application/xml'
 
 echo $encoderType->encode(['name' => 'php']);
-// '<name type="string">php</name>'
+// '<json:object><json:string name="name">php</json:string></json:object>'
 ```
diff --git a/doc/Mapping/AdvancedNormalizationObjectMapping.md b/doc/Mapping/AdvancedNormalizationObjectMapping.md
@@ -11,14 +11,15 @@ namespace MyProject\Serialization;
 
 use Chubbyphp\Serialization\Accessor\PropertyAccessor;
 use Chubbyphp\Serialization\Link\LinkBuilder;
+use Chubbyphp\Serialization\Mapping\NormalizationFieldMappingBuilder;
+use Chubbyphp\Serialization\Mapping\NormalizationFieldMappingInterface;
 use Chubbyphp\Serialization\Mapping\NormalizationLinkMapping;
 use Chubbyphp\Serialization\Mapping\NormalizationLinkMappingInterface;
+use Chubbyphp\Serialization\Mapping\NormalizationObjectMappingInterface;
 use Chubbyphp\Serialization\Normalizer\CallbackLinkNormalizer;
 use Chubbyphp\Serialization\Normalizer\Relation\EmbedManyFieldNormalizer;
-use Chubbyphp\Serialization\Mapping\NormalizationFieldMappingBuilder;
-use Chubbyphp\Serialization\Mapping\NormalizationFieldMappingInterface;
-use Chubbyphp\Serialization\Mapping\NormalizationObjectMappingInterface;
 use Chubbyphp\Serialization\Normalizer\Relation\EmbedOneFieldNormalizer;
+use Chubbyphp\Serialization\Policy\GroupPolicy;
 use MyProject\Model\Model;
 
 final class ModelMapping implements NormalizationObjectMappingInterface
@@ -48,8 +49,12 @@ final class ModelMapping implements NormalizationObjectMappingInterface
     public function getNormalizationFieldMappings(string $path, string $type = null): array
     {
         return [
-            NormalizationFieldMappingBuilder::create('id')->setGroups(['baseInformation'])->getMapping(),
-            NormalizationFieldMappingBuilder::create('name')->setGroups(['baseInformation'])->getMapping(),
+            NormalizationFieldMappingBuilder::create('id')
+                ->setPolicy(new GroupPolicy(['baseInformation']))
+                ->getMapping(),
+            NormalizationFieldMappingBuilder::create('name')
+                ->setPolicy(new GroupPolicy(['baseInformation']))
+                ->getMapping(),
             NormalizationFieldMappingBuilder::createEmbedOne('one')->getMapping(),
             NormalizationFieldMappingBuilder::createEmbedMany('manies')->getMapping(),
         ];

diff --git a/doc/Mapping/NormalizationFieldMappingBuilder.md b/doc/Mapping/NormalizationFieldMappingBuilder.md
@@ -8,7 +8,6 @@ use Chubbyphp\Serialization\Normalizer\FieldNormalizer;
 use Chubbyphp\Serialization\Mapping\NormalizationFieldMappingBuilder;
 
 $fieldMapping = NormalizationFieldMappingBuilder::create('name')
-    ->setGroups(['group1'])
     ->setFieldNormalizer(
         new FieldNormalizer(
             new PropertyAccessor('name')

diff --git a/doc/Mapping/NormalizationLinkMappingBuilder.md b/doc/Mapping/NormalizationLinkMappingBuilder.md
@@ -9,19 +9,18 @@ use Chubbyphp\Serialization\Normalizer\CallbackLinkNormalizer;
 use Chubbyphp\Serialization\Normalizer\NormalizerContextInterface;
 
 $fieldMapping = NormalizationLinkMappingBuilder::create(
-        'name',
-        new CallbackLinkNormalizer(
-            function (
-                string $path,
-                $object,
-                NormalizerContextInterface $context
-            ) {
-                return new Link('/api/model');
-            }
-        )
+    'name',
+    new CallbackLinkNormalizer(
+        function (
+            string $path,
+            $object,
+            NormalizerContextInterface $context
+        ) {
+            return new Link('/api/model');
+        }
     )
-    ->setGroups(['group1'])
-    ->getMapping();
+)
+->getMapping();
 
 echo $fieldMapping->getName();
 // 'name'

diff --git a/doc/Normalizer/CallbackFieldNormalizer.md b/doc/Normalizer/CallbackFieldNormalizer.md
@@ -14,7 +14,7 @@ $context = ...;
 $fieldNormalizer = new CallbackFieldNormalizer(
     function (
         string $path,
-        $object,
+        object $object,
         NormalizerContextInterface $context,
         NormalizerInterface $normalizer = null
     ) {

diff --git a/doc/Normalizer/CallbackLinkNormalizer.md b/doc/Normalizer/CallbackLinkNormalizer.md
@@ -14,7 +14,7 @@ $context = ...;
 $fieldNormalizer = new CallbackLinkNormalizer(
     function (
         string $path,
-        $object,
+        object $object,
         NormalizerContextInterface $context
     ) {
         return new Link('/api/model');

diff --git a/doc/Normalizer/NormalizerContext.md b/doc/Normalizer/NormalizerContext.md
@@ -8,10 +8,10 @@ use Psr\Http\Message\ServerRequestInterface;
 
 $request = ...;
 
-$context = new NormalizerContext(['group1'], $request);
-
-print_r($context->getGroups());
-// ['group1']
+$context = new NormalizerContext($request, ['key' => 'value']);
 
 $request = $context->getRequest();
+
+print_r($context->getAttributes());
+// ['key' => 'value']
 ```
diff --git a/doc/Normalizer/NormalizerContextBuilder.md b/doc/Normalizer/NormalizerContextBuilder.md
@@ -9,12 +9,12 @@ use Psr\Http\Message\ServerRequestInterface;
 $request = ...;
 
 $context = NormalizerContextBuilder::create()
-    ->setGroups(['group1'])
     ->setRequest($request)
+    ->setAttributes(['key' => 'value'])
     ->getContext();
 
-print_r($context->getGroups());
-// ['group1']
+print_r($context->getAttributes());
+// ['key' => 'value']
 
 $request = $context->getRequest();
 ```
diff --git a/doc/Policy/AndPolicy.md b/doc/Policy/AndPolicy.md
@@ -0,0 +1,24 @@
+# AndPolicy
+
+```php
+<?php
+
+use Chubbyphp\Serialization\Normalizer\NormalizerContextInterface;
+use Chubbyphp\Serialization\Policy\AndPolicy;
+use MyProject\Model\Model;
+use MyProject\Policy\AnotherPolicy;
+use MyProject\Policy\SomePolicy;
+
+$model = new Model();
+
+/** @var NormalizerContextInterface $context */
+$context = ...;
+
+$policy = new AndPolicy([
+    new SomePolicy(),
+    new AnotherPolicy(),
+]);
+
+echo $policy->isCompliant('path', $model, $context);
+// 1
+```
diff --git a/doc/Policy/CallbackPolicy.md b/doc/Policy/CallbackPolicy.md
@@ -0,0 +1,21 @@
+# CallbackPolicy
+
+```php
+<?php
+
+use Chubbyphp\Serialization\Normalizer\NormalizerContextInterface;
+use Chubbyphp\Serialization\Policy\CallbackPolicy;
+use MyProject\Model\Model;
+
+$model = new Model();
+
+/** @var NormalizerContextInterface $context */
+$context = ...;
+
+$policy = new CallbackPolicy(function (string $path, object $object, NormalizerContextInterface $context) {
+    return true;
+});
+
+echo $policy->isCompliant('path', $model, $context);
+// 1
+```