event-engine/php-inspectio-graph-cody

PHP Graph Cody for InspectIO

0.1.0 2022-02-22 16:23 UTC

Requires

• php: ^7.4 || ^8.0
• ext-json: *
• event-engine/php-inspectio-graph: ^0.4.0

Requires (Dev)

• open-code-modeling/php-code-generator: ^0.2.0
• phpspec/prophecy-phpunit: ^2.0
• phpstan/phpstan: ^0.12.33
• phpstan/phpstan-strict-rules: ^0.12.4
• phpunit/phpunit: ^9.2.6
• prooph/php-cs-fixer-config: ^0.5.0
• roave/security-advisories: dev-latest

Suggests

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

Conflicts

• open-code-modeling/php-code-generator: ^0.1.0

MIT

• Alexander Miertsch
• Sandro Keil

README

Implementation of the InspectIO Graph specification for Cody Bot to generate PHP code based on the InspectIO Event Map.

Installation

$ composer require event-engine/php-inspectio-graph-cody

Usage

See unit tests (EventSourcingAnalyzerTest) in tests folder for comprehensive examples and how a Cody JSON looks like.

The following example gives a quick overview how to retrieve information from the EventSourcingAnalyzer.

<?php

declare(strict_types=1);

use EventEngine\InspectioGraph\VertexConnectionMap;
use EventEngine\InspectioGraph\VertexType;
use EventEngine\InspectioGraphCody\EventSourcingAnalyzer;
use EventEngine\InspectioGraphCody\EventSourcingGraph;
use EventEngine\InspectioGraphCody\JsonNode;

// assume $filter is a callable to filter sticky / node names
$filter = static function (string $value) {
    return \trim($value);
};

// assume $json is a JSON string in Cody format
$node = JsonNode::fromJson($json);

$analyzer = new EventSourcingAnalyzer(new EventSourcingGraph($filter));
$connection = $analyzer->analyse($node); // analyze the Cody JSON node
// call $analyzer->analyse($anotherNode) again with other nodes to build up the graph

$identity = $connection->identity();

if ($identity->type() === VertexType::TYPE_AGGREGATE) {
    // get connected commands of connection, in this case the aggregate
    $commands = $connection->from()->filterByType(VertexType::TYPE_COMMAND);

    // get connected events of connection, in this case the aggregate
    $events = $connection->to()->filterByType(VertexType::TYPE_EVENT);

    // get parent of identity, could be a feature or bounded context
    $parent = $connection->parent();

    if ($parent->type() === VertexType::TYPE_FEATURE) {
        // get parent connection to get connected vertices
        $parentConnection = $analyzer->connection($parent->id());

        // cycle through all children (vertices e.g. commands, events, etc) of this parent
        foreach ($parentConnection->children() as $child) {
            if ($child->type() === VertexType::TYPE_COMMAND) {
                // ...
            }
        }
    }
}

// search in graph for first document in forwarding mode (a "to" connection)
$documentConnection = $analyzer->graph()->findInGraph(
    $identity->id(),
    static function (VertexType $vertex): bool {
        return $vertex->type() === VertexType::TYPE_DOCUMENT;
    },
    VertexConnectionMap::WALK_FORWARD
);