open-code-modeling/json-schema-to-php-ast

Provides factories to create PhpParser node visitors from JSON schema e. g. value objects

0.5.4 2021-07-27 14:32 UTC

Requires

• php: ^7.4 || ^8.0
• open-code-modeling/json-schema-to-php: ^0.3.0 || 0.4.x-dev
• open-code-modeling/php-code-ast: ^0.12.0 || 0.13.x-dev

Requires (Dev)

• laminas/laminas-filter: ^2.9
• open-code-modeling/php-filter: ^0.1.1
• phpspec/prophecy-phpunit: ^2.0
• phpunit/phpunit: ^9.5.0
• prooph/php-cs-fixer-config: ^v0.4.0
• psalm/plugin-phpunit: ^0.15.0
• roave/security-advisories: dev-master
• vimeo/psalm: ^4.4

Suggests

• open-code-modeling/php-filter: For pre-configured filters for proper class / method / property names etc.

MIT

• Sandro Keil

• php
• json
• schema
• code
• generation

README

Compiles a JSON schema to PHP classes / value objects via PHP AST.

Installation

$ composer require open-code-modeling/json-schema-to-php-ast --dev

Usage

See unit tests in tests folder for comprehensive examples.

You can use each value object factory to compose your value object with PHP AST node visitors or high level builder API. The easiest way to use this library is the ValueObjectFactory.

Assume you have the following JSON schema

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "definitions": {
        "address": {
            "type": "object",
            "properties": {
                "street_address": {
                    "type": "string"
                },
                "city": {
                    "type": ["string", "null"]
                },
                "federal_state": {
                    "$ref": "#/definitions/state"
                }
            },
            "required": [
                "street_address",
                "city",
                "federal_state"
            ]
        },
        "state": {
            "type": "string",
            "enum": ["NY", "DC"]
        }
    },
    "type": "object",
    "properties": {
        "billing_address": {
            "$ref": "#/definitions/address"
        },
        "shipping_addresses": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/address"
            }
        }
    },
    "required": [
        "billing_address"
    ]
}

Then you can use the ValueObjectFactory to generate PHP code for the following classes:

• Order
• ShippingAddresses
• Address
• StreetAddress
• City
• State

<?php

use OpenCodeModeling\CodeAst\Builder\FileCollection;
use OpenCodeModeling\CodeAst\Package\ClassInfoList;
use OpenCodeModeling\CodeAst\Package\Psr4Info;
use OpenCodeModeling\Filter\FilterFactory;
use OpenCodeModeling\JsonSchemaToPhp\Type\Type;
use OpenCodeModeling\JsonSchemaToPhpAst\ValueObjectFactory;

$parser = (new PhpParser\ParserFactory())->create(PhpParser\ParserFactory::ONLY_PHP7);
$printer = new PhpParser\PrettyPrinter\Standard(['shortArraySyntax' => true]);

// configure your Composer info
// FilterFactory of library open-code-modeling/php-filter is used for sake of brevity
$classInfoList = new ClassInfoList(
    ...Psr4Info::fromComposer(
        'src/',
        file_get_contents('composer.json'),
        FilterFactory::directoryToNamespaceFilter(),
        FilterFactory::namespaceToDirectoryFilter(),
    )
);

$valueObjectFactory = new ValueObjectFactory(
    $classInfoList,
    $parser,
    $printer,
    true,
    FilterFactory::classNameFilter(),
    FilterFactory::propertyNameFilter(),
    FilterFactory::methodNameFilter(),
    FilterFactory::constantNameFilter(),
    FilterFactory::constantValueFilter()
);

// $json contains the json string from above
$decodedJson = \json_decode($json, true, 512, \JSON_BIGINT_AS_STRING | \JSON_THROW_ON_ERROR);

$typeSet = Type::fromDefinition($decodedJson);
$srcFolder = 'tmp/';

$fileCollection = FileCollection::emptyList();
$classBuilder = ClassBuilder::fromScratch('Order', 'YourNamespaceFromComposer')->setFinal(true);

$valueObjectFactory->generateClasses($classBuilder, $fileCollection, $typeSet, $srcFolder);

// $fileCollection contains 6 classes

// now let's add constants and getter methods of properties for non value objects
$valueObjectFactory->addGetterMethodsForProperties($fileCollection, true);
$valueObjectFactory->addClassConstantsForProperties($fileCollection);

// generate PHP code
$files = $valueObjectFactory->generateFiles($fileCollection);

foreach ($files as $filename => $code) {
    // store PHP code to filesystem
}