Merge pull request #1 from event-engine/feature/simplify-connections

Support sync of nodes

Author: sandrokeil

.php-cs-fixer.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+$config = new Prooph\CS\Config\Prooph();
+$finder = $config->getFinder();
+
+$finder->exclude('vendor');
+$finder->in(__DIR__);
+$finder->append(['.php_cs']);
+
+$cacheDir = \getenv('TRAVIS') ? \getenv('HOME') . '/.php-cs-fixer' : __DIR__;
+
+$config->setCacheFile($cacheDir . '/.php_cs.cache');
+
+return $config;

.php_cs

@@ -1,18 +1,18 @@
 # Event Engine - PHP InspectIO Cody
 
-This is the repository of the Cody server. [InspectIO](https://github.com/event-engine/inspectio "InspectIO") can 
-connect to a coding bot called [Cody](https://github.com/event-engine/inspectio/wiki/PHP-Cody-Tutorial "PHP Cody Tutorial"). 
+This is the repository of the Cody server. [prooph board](https://prooph-board.com/ "prooph board") can 
+connect to a coding bot called [Cody](https://wiki.prooph-board.com/cody/php-cody-tutorial.html "PHP Cody Tutorial"). 
 With its help you can generate working code from an event map.
 
 Cody server runs at [http://localhost:3311](http://localhost:3311)
 
 ## Installation
 
+> There is also an [Event Engine Cody Skeleton](https://github.com/proophboard/php-cody-engine-skeleton) available.
+
 Please make sure you have installed [Docker](https://docs.docker.com/install/ "Install Docker")
 and [Docker Compose](https://docs.docker.com/compose/install/ "Install Docker Compose").
 
-> An example usage / implementation of this library exists for [Event Engine](https://github.com/event-engine/php-code-generator-cody "Cody Bot for Event Engine").
-
 It is recommended to create a new application for code generation which installs this library via Composer. This allows
 independence of your application code and avoids running in Composer dependency conflicts.
 
@@ -36,7 +36,7 @@ cp vendor/event-engine/php-inspectio-cody/php-watcher.yml.dist .
 ```
 
 To mount our business application folder to the Cody server you have to update the `docker-compose.yml` file. Please
-take a look at the [Cody](https://github.com/event-engine/inspectio/wiki/PHP-Cody-Tutorial "PHP Cody Tutorial") for more
+take a look at the [Cody](https://wiki.prooph-board.com/cody/php-cody-tutorial.html "PHP Cody Tutorial") for more
 details.
 
 ## Start Cody Server

README.md

@@ -10,7 +10,18 @@
 
 use EventEngine\InspectioCody\CodyConfig;
 
-$context = new stdClass(); // replace it with your own context class
+$context = new class() implements \EventEngine\InspectioCody\CodyContext {
+    public function isFullSyncRequired(): bool
+    {
+        // TODO: Implement isFullSyncRequired() method.
+        return false;
+    }
+
+    public function clearGraph(): void
+    {
+        // TODO: Implement clearGraph() method.
+    }
+}; // replace it with your own context class
 
 return new CodyConfig(
     $context,
@@ -20,5 +31,14 @@
 //        CodyConfig::HOOK_ON_EVENT => new EventHook(),
 //        CodyConfig::HOOK_ON_POLICY => new PolicyHook(),
 //        CodyConfig::HOOK_ON_DOCUMENT => new DocumentHook(),
+//        CodyConfig::HOOK_ON_EXTERNAL_SYSTEM => new ExternalSystemHook(),
+//        CodyConfig::HOOK_ON_HOT_SPOT => new HotSpotHook(),
+//        CodyConfig::HOOK_ON_ROLE => new RoleHook(),
+//        CodyConfig::HOOK_ON_UI => new UiHook(),
+//        CodyConfig::HOOK_ON_FEATURE => new FeatureHook(),
+//        CodyConfig::HOOK_ON_BOUNDED_CONTEXT => new BoundedContextHook(),
+//        CodyConfig::HOOK_ON_SYNC => new SyncHook(),
+//        CodyConfig::HOOK_ON_SYNC_UPDATED => new SyncHook(),
+//        CodyConfig::HOOK_ON_SYNC_DELETED => new SyncDeletedHook(),
     ]
 );

codyconfig.php

@@ -33,7 +33,7 @@
         "php": "^7.4 || ^8.0",
         "ext-json": "*",
         "christoph-kluge/reactphp-http-cors-middleware": "^2.0.0",
-        "event-engine/php-inspectio-graph-cody": "dev-master",
+        "event-engine/php-inspectio-graph-cody": "^0.1.0",
         "fig/http-message-util": "^1.1",
         "open-code-modeling/php-code-generator-transformator": "^0.1.0",
         "psr/http-message": "^1.0",
@@ -46,8 +46,8 @@
         "phpstan/phpstan": "^0.12.33",
         "phpstan/phpstan-strict-rules": "^0.12.4",
         "phpunit/phpunit": "^9.2.6",
-        "prooph/php-cs-fixer-config": "^0.4",
-        "roave/security-advisories": "dev-master"
+        "prooph/php-cs-fixer-config": "^0.5.0",
+        "roave/security-advisories": "dev-latest"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,

composer.json

@@ -13,22 +13,45 @@
 final class CodyConfig
 {
     public const HOOK_ON_COMMAND = 'onCommand';
+
     public const HOOK_ON_AGGREGATE = 'onAggregate';
+
     public const HOOK_ON_EVENT = 'onEvent';
+
     public const HOOK_ON_POLICY = 'onPolicy';
+
     public const HOOK_ON_DOCUMENT = 'onDocument';
+
+    public const HOOK_ON_EXTERNAL_SYSTEM = 'onExternalSystem';
+
+    public const HOOK_ON_HOT_SPOT = 'onHotSpot';
+
+    public const HOOK_ON_ROLE = 'onRole';
+
     public const HOOK_ON_UI = 'onUi';
+
     public const HOOK_ON_FEATURE = 'onFeature';
+
     public const HOOK_ON_BOUNDED_CONTEXT = 'onBoundedContext';
 
+    public const HOOK_ON_SYNC = 'onSync';
+
+    public const HOOK_ON_SYNC_UPDATED = 'onSyncUpdated';
+
+    public const HOOK_ON_SYNC_DELETED = 'onSyncDeleted';
+
     /**
      * @var array
      **/
     private $hooks;
 
-    private $context;
+    private CodyContext $context;
 
-    public function __construct($context, array $hooks)
+    /**
+     * @param CodyContext $context Context which is provided to each hook
+     * @param array $hooks List of implemented hooks
+     */
+    public function __construct(CodyContext $context, array $hooks)
     {
         $this->context = $context;
         $this->hooks = $hooks;
@@ -44,10 +67,7 @@ public function hook(string $hookName)
         return $this->hooks[$hookName];
     }
 
-    /**
-     * @return mixed
-     */
-    public function context()
+    public function context(): CodyContext
     {
         return $this->context;
     }

src/CodyConfig.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * @see       https://github.com/event-engine/php-inspectio-cody for the canonical source repository
+ * @copyright https://github.com/event-engine/php-inspectio-cody/blob/master/COPYRIGHT.md
+ * @license   https://github.com/event-engine/php-inspectio-cody/blob/master/LICENSE.md MIT License
+ */
+
+declare(strict_types=1);
+
+namespace EventEngine\InspectioCody;
+
+interface CodyContext
+{
+    /**
+     * Whether or not context has nodes e.g. to decide to trigger full sync
+     *
+     * @return bool
+     */
+    public function isFullSyncRequired(): bool;
+
+    /**
+     * Clear the graph because it's out of sync and needs complete new sync
+     *
+     * @return void
+     */
+    public function clearGraph(): void;
+}

src/CodyContext.php

@@ -23,6 +23,7 @@ public static function greeting(string $user): CodyResponse
                 'If you need guidance just ask me with: %c/help',
                 'background-color: rgba(251, 159, 75, 0.2)',
             ],
+            CodyResponse::SYNC_REQUIRED
         );
     }
 

src/General/Greetings.php

@@ -15,10 +15,17 @@
 interface CodyResponse extends ResponseInterface
 {
     public const INFO = 'Info';
+
     public const ERROR = 'Error';
+
     public const WARNING = 'Warning';
+
     public const QUESTION = 'Question';
 
+    public const EMPTY = 'Empty';
+
+    public const SYNC_REQUIRED = 'SyncRequired';
+
     /**
      * @return string|string[]
      */

src/Http/Message/CodyResponse.php

@@ -86,6 +86,24 @@ public static function error(string $error, array $details = []): CodyResponse
         );
     }
 
+    public static function empty(): CodyResponse
+    {
+        return self::fromCody(
+            '',
+            [],
+            self::EMPTY
+        );
+    }
+
+    public static function syncRequired(): CodyResponse
+    {
+        return self::fromCody(
+            'I need to sync all elements first.',
+            ["Lean back for a moment. I'll let you know when I'm done."],
+            self::SYNC_REQUIRED
+        );
+    }
+
     public static function noJsonRequest(): CodyResponse
     {
         return self::fromCody(