Merge branch '1-0-0' into 'main'

1-0-0

See merge request fluxlabs/flux-eco/json-schema-instance!2

CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## [1.0.0]
+provides for a given value a json schema instance of
+* array
+* boolen
+* number
+* object
+* string
+
 ## [0.0.2]
 * added flux-publish-utils
 

README.md

@@ -9,13 +9,66 @@ https://json-schema.org/specification.html
 The following example application demonstrates the usage:
 https://github.com/flux-caps/todo-app
 
+## Usage
+
+account.yaml
+```
+title: account
+type: object
+aggregateRootNames:
+    - account
+properties:
+  personId:
+    type: number
+  firstname:
+    type: string
+  lastname:
+    type: string
+  email:
+    type: string
+  type:
+    type: string
+  lastChanged:
+    type: string
+```
+
+getAndPrintSchemaInstance.php
+
+```
+$schema = yaml_parse(file_get_contents('account.yaml'));
+
+$schemaInstance = fluxJsonSchemaInstance\getSchemaInstance('Emmett', $schema['properties']['firstname']);
+print_r($schemaInstance);
+
+$schemaInstance = fluxJsonSchemaInstance\getSchemaInstance('123', $schema['properties']['personId']);
+print_r($schemaInstance);
+```
+
+outputs
+```
+Array
+(
+    [value] => Emmett
+    [describedBy] => {"type":"string"}
+)
+Array
+(
+    [value] => 123
+    [describedBy] => {"type":"number"}
+)
+```
+
 ## Contributing :purple_heart:
+
 Please ...
+
 1. ... register an account at https://git.fluxlabs.ch
 2. ... create pull requests :fire:
 
 ## Adjustment suggestions / bug reporting :feet:
+
 Please ...
+
 1. ... register an account at https://git.fluxlabs.ch
 2. ... ask us for a Service Level Agreement: [email protected] :kissing_heart:
 3. ... read and create issues

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "flux-eco/json-schema-instance",
   "description": "Makes a json schema instance for the transmitted values and schema",
-  "version": "0.0.2",
+  "version": "1.0.0",
   "type": "flux-app",
   "keywords": [
     "flux-eco",
@@ -23,25 +23,19 @@
   },
   "require": {
     "php": ">=8.0",
-    "ext-curl": "*",
     "ext-json": "*",
-    "ext-yaml": "*",
-    "composer-runtime-api": ">=2.1",
-    "psr/http-factory": ">=1.0",
-    "psr/http-message": ">=1.0",
-    "psr/http-server-handler": ">=1.0",
-    "psr/http-server-middleware": ">=1.0"
-  },
-  "require-dev": {
-    "phpunit/phpunit": ">=9.5",
-    "composer/composer": ">=2.0",
-    "swoole/ide-helper": ">=4.6",
-    "symfony/console": ">=5.2"
+    "ext-yaml": "*"
   },
   "autoload": {
+    "files": [
+      "fn/getSchemaInstance.php"
+    ],
     "psr-4": {
       "FluxEco\\JsonSchemaInstance\\": [
         "src/"
+      ],
+      "fluxJsonSchemaInstance\\": [
+        "fn/"
       ]
     }
   },

examples/account.yaml

@@ -0,0 +1,19 @@
+---
+title: account
+type: object
+aggregateRootNames:
+    - account
+properties:
+  personId:
+    type: number
+  firstname:
+    type: string
+  lastname:
+    type: string
+  email:
+    type: string
+  type:
+    type: string
+  lastChanged:
+    type: string
+...

examples/getAndPrintSchemaInstance.php

@@ -0,0 +1,12 @@
+<?php
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+
+$schema = yaml_parse(file_get_contents('account.yaml'));
+
+$schemaInstance = fluxJsonSchemaInstance\getSchemaInstance('Emmett', $schema['properties']['firstname']);
+print_r($schemaInstance);
+
+$schemaInstance = fluxJsonSchemaInstance\getSchemaInstance('123', $schema['properties']['personId']);
+print_r($schemaInstance);

fn/getSchemaInstance.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace fluxJsonSchemaInstance;
+
+use FluxEco\JsonSchemaInstance;
+
+function getSchemaInstance(string $value, array $jsonSchema) : array
+{
+    return JsonSchemaInstance\Api::new()->getSchemaInstance($value, $jsonSchema);
+}

src/Api.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace FluxEco\JsonSchemaInstance;
+
+class Api
+{
+
+    private Core\Ports\SchemaInstanceService $service;
+
+    private function __construct(Core\Ports\SchemaInstanceService $service)
+    {
+        $this->service = $service;
+    }
+
+    public static function new() : self
+    {
+        $service = Core\Ports\SchemaInstanceService::new();
+        return new self($service);
+    }
+
+    final public function getSchemaInstance(string $value, array $jsonSchema) : array
+    {
+        $schemaInstance = $this->service->getSchemaInstance($value, $jsonSchema);
+        return SchemaInstance::fromDomain($schemaInstance)->toArray();
+    }
+}

src/Core/Application/Commands/ProvideArraySchemaInstanceHandler.php

@@ -24,7 +24,7 @@ public function handle(ProvideSchemaInstanceCommand $command): Domain\Models\Str
         //ToDo special string validation
         //@see https://json-schema.org/draft/2020-12/json-schema-validation.html
 
-        return Domain\Models\StringSchemaInstance::new($value);
+        return Domain\Models\StringSchemaInstance::new($value, json_encode($schema));
     }
 }
 

src/Core/Application/Commands/ProvideBooleanSchemaInstanceHandler.php

@@ -24,7 +24,7 @@ public function handle(ProvideSchemaInstanceCommand $command): Domain\Models\Str
         //ToDo special string validation
         //@see https://json-schema.org/draft/2020-12/json-schema-validation.html
 
-        return Domain\Models\StringSchemaInstance::new($value);
+        return Domain\Models\StringSchemaInstance::new($value, json_encode($schema));
     }
 }
 

src/Core/Application/Commands/ProvideNumberSchemaInstanceHandler.php

@@ -18,12 +18,10 @@ public static function new(): self
 
     public function handle(ProvideSchemaInstanceCommand $command): Domain\Models\NumberSchemaInstance
     {
+        $schema =  $command->getSchema();
         $value = $command->getValue();
 
-        //ToDo special string validation
-        //@see https://json-schema.org/draft/2020-12/json-schema-validation.html
-
-        return Domain\Models\NumberSchemaInstance::new($value);
+        return Domain\Models\NumberSchemaInstance::new($value, json_encode($schema));
     }
 }
 

src/Core/Application/Commands/ProvideObjectSchemaInstanceHandler.php

@@ -61,7 +61,7 @@ public function handle(ProvideSchemaInstanceCommand $command): Domain\Models\Obj
         }
 
 
-        return Domain\Models\ObjectSchemaInstance::new($properties);
+        return Domain\Models\ObjectSchemaInstance::new($properties, json_encode($subSchema));
     }
 
     private function process(ProvideSchemaInstanceCommand $command, ProvideSchemaInterfaceHandler $handler): Domain\Models\SchemaInstance

src/Core/Application/Commands/ProvideStringSchemaInstanceHandler.php

@@ -24,7 +24,7 @@ public function handle(ProvideSchemaInstanceCommand $command): Domain\Models\Str
         //ToDo special string validation
         //@see https://json-schema.org/draft/2020-12/json-schema-validation.html
 
-        return Domain\Models\StringSchemaInstance::new($value);
+        return Domain\Models\StringSchemaInstance::new($value, json_encode($schema));
     }
 }
 

src/Core/Ports/SchemaInstanceService.php

@@ -31,7 +31,7 @@ public function __construct(array $handlerMapping)
         $this->handlerMapping = $handlerMapping;
     }
 
-    public static function new(): self
+    public static function new() : self
     {
         $handlerMapping = [
             'boolean' => Commands\ProvideNumberSchemaInstanceHandler::new(),
@@ -43,9 +43,10 @@ public static function new(): self
         return new self($handlerMapping);
     }
 
-
-    final public function provideSchemaInstance(string $value, array $schema): Domain\Models\ObjectSchemaInstance|Domain\Models\SchemaInstance
-    {
+    final public function getSchemaInstance(
+        string $value,
+        array $schema
+    ) : Domain\Models\ObjectSchemaInstance|Domain\Models\SchemaInstance {
         $process = Processes\ProvideSchemaInstanceProcess::new();
         $command = Commands\ProvideSchemaInstanceCommand::new($value, $schema, $this->handlerMapping);
 

src/SchemaInstance.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace FluxEco\JsonSchemaInstance;
+
+class SchemaInstance
+{
+    private Core\Domain\Models\SchemaInstance $schemaInstance;
+
+    private function __construct(Core\Domain\Models\SchemaInstance $schemaInstance)
+    {
+        $this->schemaInstance = $schemaInstance;
+    }
+
+    public static function fromDomain(Core\Domain\Models\SchemaInstance $schemaInstance) : self
+    {
+        return new self($schemaInstance);
+    }
+
+    public function toArray() : array
+    {
+        return $this->schemaInstance->toArray();
+    }
+}