Make graphaware/neo4j-php-ogm optional (#8)

* Make graphaware/neo4j-php-ogm optional

* code style

* Moved ogm to suggest

* typo

Author: Nyholm

DependencyInjection/Neo4jExtension.php

@@ -6,6 +6,7 @@
 
 use GraphAware\Bolt\Driver as BoltDriver;
 use GraphAware\Neo4j\Client\Connection\Connection;
+use GraphAware\Neo4j\OGM\EntityManager;
 use GraphAware\Neo4j\Client\HttpDriver\Driver as HttpDriver;
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 use Symfony\Component\Config\FileLocator;
@@ -34,7 +35,10 @@ public function load(array $configs, ContainerBuilder $container)
 
         $this->handleConnections($config, $container);
         $clientServiceIds = $this->handleClients($config, $container);
-        $this->handleEntityMangers($config, $container, $clientServiceIds);
+        if ($this->validateEntityManagers($config)) {
+            $loader->load('entity_manager.xml');
+            $this->handleEntityMangers($config, $container, $clientServiceIds);
+        }
 
         // add aliases for the default services
         $container->setAlias('neo4j.connection', 'neo4j.connection.default');
@@ -114,11 +118,6 @@ private function handleClients(array &$config, ContainerBuilder $container): arr
      */
     private function handleEntityMangers(array &$config, ContainerBuilder $container, array $clientServiceIds): array
     {
-        if (empty($config['entity_managers'])) {
-            // Add default entity manager if none set.
-            $config['entity_managers']['default'] = ['client' => 'default'];
-        }
-
         $serviceIds = [];
         foreach ($config['entity_managers'] as $name => $data) {
             $serviceIds[] = $serviceId = sprintf('neo4j.entity_manager.%s', $name);
@@ -204,4 +203,30 @@ private function getPort(array $config)
 
         return 'http' == $config['schema'] ? HttpDriver::DEFAULT_HTTP_PORT : BoltDriver::DEFAULT_TCP_PORT;
     }
+
+    /**
+     * Make sure the EntityManager is installed if we have configured it.
+     *
+     * @param array &$config
+     *
+     * @return bool true if "graphaware/neo4j-php-ogm" is installed
+     *
+     * @thorws \LogicException if EntityManagers os not installed but they are configured.
+     */
+    private function validateEntityManagers(array &$config): bool
+    {
+        $dependenciesInstalled = class_exists(EntityManager::class);
+        $entityManagersConfigured = !empty($config['entity_managers']);
+
+        if ($dependenciesInstalled && !$entityManagersConfigured) {
+            // Add default entity manager if none set.
+            $config['entity_managers']['default'] = ['client' => 'default'];
+        } elseif (!$dependenciesInstalled && $entityManagersConfigured) {
+            throw new \LogicException(
+                'You need to install "graphaware/neo4j-php-ogm" to be able to use the EntityManager'
+            );
+        }
+
+        return $dependenciesInstalled;
+    }
 }

README.md

@@ -15,7 +15,7 @@ Via Composer
 $ composer require neo4j/neo4j-bundle
 ```
 
-At the moment we have a hard dependency on GraphAware OGM. You need to install that as well
+If you want to use the an `EntityManager` you need to install a [GraphAware OGM](https://github.com/graphaware/neo4j-php-ogm)
 
 ```bash
 $ composer require graphaware/neo4j-php-ogm:@beta
@@ -43,7 +43,7 @@ The bundle is a convenient way of registering services. We register `Connections
 
  * neo4j.connection
  * neo4j.client
- * neo4j.entity_manager
+ * neo4j.entity_manager*
 
 
 ### Minimal configuration
@@ -57,7 +57,7 @@ neo4j:
 With the minimal configuration we have services named:
  * neo4j.connection.default
  * neo4j.client.default
- * neo4j.entity_manager.default
+ * neo4j.entity_manager.default*
 
 ### Full configuration
 
@@ -92,9 +92,11 @@ With the configuration above we would have services named:
  * neo4j.client.default
  * neo4j.client.other_client
  * neo4j.client.other_foobar
- * neo4j.entity_manager.default
+ * neo4j.entity_manager.default*
 
 
+\* Note: EntityManagers will only be available if `graphaware/neo4j-php-ogm` is installed. 
+
 ## Testing
 
 ``` bash

Resources/config/entity_manager.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+        <service id="neo4j.entity_manager.abstract" class="GraphAware\Neo4j\OGM\EntityManager" abstract="true">
+        </service>
+    </services>
+</container>

Resources/config/services.xml

@@ -11,7 +11,5 @@
         <service id="neo4j.client.abstract" class="GraphAware\Neo4j\Client\Client" abstract="true">
             <factory service="neo4j.factory.client" method="create" />
         </service>
-        <service id="neo4j.entity_manager.abstract" class="GraphAware\Neo4j\OGM\EntityManager" abstract="true">
-        </service>
     </services>
 </container>

composer.json

@@ -16,16 +16,19 @@
     ],
     "require": {
         "php": "^7.0",
-        "graphaware/neo4j-php-ogm": "^1.0",
         "graphaware/neo4j-php-client": "^4.6.4",
         "symfony/framework-bundle": "^3.0",
         "graphaware/neo4j-bolt": "^1.6"
     },
     "require-dev": {
         "phpunit/phpunit": "^5.4",
         "symfony/symfony": "^3.0",
+        "graphaware/neo4j-php-ogm": "^1.0",
         "matthiasnoback/symfony-dependency-injection-test": "^1.0"
     },
+    "suggest": {
+        "graphaware/neo4j-php-ogm": "To have EntityManager support"
+    },
     "autoload": {
         "psr-4": {
             "Neo4j\\Neo4jBundle\\": ""