Merge pull request #2 from Syndesi/feature/upgrade-to-cypher-datastructures-0.2.0

Feature/upgrade to cypher datastructures 0.2.0

Author: Syndesi

.github/workflows/ci-unit-test.yml

@@ -13,8 +13,8 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                php-version: ['8.1']
-                neo4j-version: ['4.4', '5.1.0']
+                php-version: ['8.1', '8.2-rc']
+                neo4j-version: ['4.4', '5.1.0', '5.2.0']
         env:
             ENABLE_FEATURE_TEST: true
             NEO4J_VERSION: ${{ matrix.neo4j-version }}
@@ -38,7 +38,7 @@ jobs:
               with:
                   php-version: ${{ matrix.php-version }}
                   tools: composer:v2
-            - run: composer install
+            - run: composer install --ignore-platform-reqs
               shell: bash
             - run: composer test
               shell: bash

.gitignore

@@ -7,4 +7,6 @@
 .phpunit.result.cache
 composer.lock
 coverage.xml
-infection.html
+infection.html
+/docs/.npm
+/docs/.config

Readme.md

@@ -17,10 +17,53 @@
 
 # Syndesi's Cypher Entity Manager
 
-This library provides an entity manager for Cypher data types.
-
-Links:
+This library provides an entity manager for Cypher data types.  
+This basically means, that you do not have to write create/merge/delete statements for your nodes, relations etc. per
+hand. Instead, you just call `$em->create($node)`, `$em->merge($node)`, `$em->delete($node)` and at the end
+`$em->flush()`.
 
 - [Documentation](https://neo4j-php.github.io/cypher-entity-manager)
 - [Packagist](https://packagist.org/packages/syndesi/cypher-entity-manager)
-- [Neo4j PHP Community](https://github.com/neo4j-php)
+
+## Installation
+
+To install this library, run the following code:
+
+```bash
+composer require syndesi/cypher-entity-manager
+```
+
+This is all, now you can use the library :D
+
+## Using the library
+
+```php
+use Syndesi\CypherDataStructures\Type\Node;
+use Syndesi\CypherEntityManager\Type\EntityManager;
+
+/**
+ * note: the container should be provided by your framework. manual configuration is possible, see documentation
+ * @var EntityManagerInterface $em 
+ */
+$em = $container->get(EntityManager::class);
+
+$node = new Node();
+$node
+    ->addLabel('NodeLabel')
+    ->addIdentifier('id', 123)
+    ->addProperty('someProperty', 'someValue')
+    ->addIdentifier('id');
+
+// create a node:
+$em->create($node);
+$em->flush();
+
+// update a node:
+$node->addProperty('newProperty', 'Hello world :D');
+$em->merge($node);
+$em->flush();
+
+// delete a node:
+$em->delete($node);
+$em->flush();
+```

composer.json

@@ -19,8 +19,8 @@
     ],
     "require": {
         "php": "^8.1",
-        "syndesi/cypher-data-structures": "^0.1.3",
-        "laudis/neo4j-php-client": "^2.7",
+        "syndesi/cypher-data-structures": "^0.2.0",
+        "laudis/neo4j-php-client": "^2.8",
         "psr/log": "^3.0",
         "psr/event-dispatcher": "^1.0"
     },
@@ -53,6 +53,7 @@
     },
     "scripts": {
         "test": "export ENABLE_FEATURE_TEST=true && echo -n \"\" > ./tests/test.log && php vendor/phpunit/phpunit/phpunit",
+        "test:current": "export ENABLE_FEATURE_TEST=true && echo -n \"\" > ./tests/test.log && php vendor/phpunit/phpunit/phpunit --group current",
         "test:coverage:xml": "export XDEBUG_MODE=coverage && php ./vendor/phpunit/phpunit/phpunit --coverage-clover coverage.xml",
         "test:coverage:html": "export XDEBUG_MODE=coverage && php ./vendor/phpunit/phpunit/phpunit --coverage-html ./tmp",
         "test:mutant": "export XDEBUG_MODE=coverage && php vendor/infection/infection/bin/infection --threads=4",

docs/README.md

@@ -17,10 +17,53 @@
 
 # Syndesi's Cypher Entity Manager
 
-This library provides an entity manager for Cypher data types.
-
-Links:
+This library provides an entity manager for Cypher data types.  
+This basically means, that you do not have to write create/merge/delete statements for your nodes, relations etc. per
+hand. Instead, you just call `$em->create($node)`, `$em->merge($node)`, `$em->delete($node)` and at the end
+`$em->flush()`.
 
 - [Documentation](https://neo4j-php.github.io/cypher-entity-manager)
 - [Packagist](https://packagist.org/packages/syndesi/cypher-entity-manager)
-- [Neo4j PHP Community](https://github.com/neo4j-php)
+
+## Installation
+
+To install this library, run the following code:
+
+```bash
+composer require syndesi/cypher-entity-manager
+```
+
+This is all, now you can use the library :D
+
+## Using the library
+
+```php
+use Syndesi\CypherDataStructures\Type\Node;
+use Syndesi\CypherEntityManager\Type\EntityManager;
+
+/**
+ * note: the container should be provided by your framework. manual configuration is possible, see documentation
+ * @var EntityManagerInterface $em 
+ */
+$em = $container->get(EntityManager::class);
+
+$node = new Node();
+$node
+    ->addLabel('NodeLabel')
+    ->addIdentifier('id', 123)
+    ->addProperty('someProperty', 'someValue')
+    ->addIdentifier('id');
+
+// create a node:
+$em->create($node);
+$em->flush();
+
+// update a node:
+$node->addProperty('newProperty', 'Hello world :D');
+$em->merge($node);
+$em->flush();
+
+// delete a node:
+$em->delete($node);
+$em->flush();
+```

docs/_navbar.md

@@ -1,2 +1,2 @@
-- [GitHub](https://github.com/Syndesi/cypher-entity-manager)
+- [GitHub](https://github.com/neo4j-php/cypher-entity-manager)
 - [Packagist](https://packagist.org/packages/syndesi/cypher-entity-manager)

docs/_sidebar.md

@@ -1,5 +1,4 @@
 - [Home](/)
-- [Getting Started](/getting_started.md)
 - [Usage](/usage.md)
 - [Todo](/todo.md)
 - [Credits & License](/credits_and_license.md)

docs/credits_and_license.md

@@ -11,6 +11,8 @@ for helping to refine this library! :D
 - The favicon is a modified form of the icons `chart-bubble` and `cog` from
   [Material Design Icons](https://materialdesignicons.com/), published under the Apache 2.0 license.
 - This documentation uses the same blue as Neo4j's logo, which was not vetoed by Neo4j.
+- Core aspects of this library are inspired by [Doctrine](https://www.doctrine-project.org/), an entity manager for SQL
+  databases.
 
 ## Dedication
 

docs/getting_started.md

@@ -7,14 +7,12 @@
 - Create framework bridges:
   - Symfony
   - Laravel
-- Add support for other graph databases:
-  - Memgraph
 
 ## Other
 
 - Add trigger/notification for newly released Neo4j versions?
-- Test with PHP 8.2 once it is released
 
 ## Possible bugs
 
 - merge relations with no properties beside identifiers: does it work?
+- support cypher data structure elements with bad practice properties/labels/types