Avoid having pre-instantiated objects with connected/attached ports/sockets on second run

Author: Marc Aschmann

Flow/AbstractNetworkBuilder.php

@@ -0,0 +1,59 @@
+<?php
+/*
+ * This file is part of the phpflo\phpflo-bundle package.
+ *
+ * (c) Marc Aschmann <maschmann@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PhpFlo\PhpFloBundle\Flow;
+
+use PhpFlo\Graph;
+use PhpFlo\Network;
+
+/**
+ * Class AbstractNetworkBuilder
+ *
+ * @package PhpFlo\PhpFloBundle\Flow
+ * @author Marc Aschmann <maschmann@gmail.com>
+ */
+abstract class AbstractNetworkBuilder
+{
+    /**
+     * @param string $fileName
+     * @return Network
+     */
+    public function fromFile($fileName)
+    {
+        $fileUri = $this->root . '/' . ltrim($fileName, '/');
+
+        if (file_exists($fileUri)) {
+            $graph = file_get_contents($fileUri);
+        } else {
+            throw new \InvalidArgumentException('Could not find file ' . $fileUri);
+        }
+
+        return $this->fromString($graph);
+    }
+
+    /**
+     * @param string $graph
+     * @return Network
+     */
+    public function fromString($graph)
+    {
+        $graph = Graph::loadString($graph);
+
+        return $this->fromGraph($graph);
+    }
+
+    /**
+     * @param Graph $graph
+     * @return Network
+     */
+    public function fromGraph(Graph $graph)
+    {
+        return Network::create($graph, $this->builder);
+    }
+}

Flow/DiNetworkBuilder.php

@@ -0,0 +1,46 @@
+<?php
+/*
+ * This file is part of the phpflo\phpflo-bundle package.
+ *
+ * (c) Marc Aschmann <maschmann@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PhpFlo\PhpFloBundle\Flow;
+
+use PhpFlo\Builder\ComponentDiFinder;
+use PhpFlo\PhpFloBundle\Common\BuilderInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+
+/**
+ * Class DiNetworkBuilder
+ *
+ * @package PhpFlo\PhpFloBundle\Flow
+ * @author Marc Aschmann <maschmann@gmail.com>
+ */
+class DiNetworkBuilder extends AbstractNetworkBuilder implements BuilderInterface
+{
+    /**
+     * @var string
+     */
+    protected $root;
+
+    /**
+     * @var ComponentBuilderInterface
+     */
+    protected $builder;
+
+    /**
+     * Builder constructor.
+     *
+     * @param ComponentRegistryInterface $registry
+     * @param string $rootDir
+     */
+    public function __construct(ContainerInterface $container, $rootDir)
+    {
+        $this->builder = new ComponentDiFinder($container);
+        $this->root = $rootDir . '/../app/config';
+    }
+}

Flow/NetworkBuilder.php

@@ -23,17 +23,17 @@
  * @package PhpFlo\PhpFloBundle\Flow
  * @author Marc Aschmann <maschmann@gmail.com>
  */
-class NetworkBuilder implements BuilderInterface
+class NetworkBuilder extends AbstractNetworkBuilder implements BuilderInterface
 {
     /**
      * @var string
      */
-    private $root;
+    protected $root;
 
     /**
      * @var ComponentBuilderInterface
      */
-    private $builder;
+    protected $builder;
 
     /**
      * Builder constructor.
@@ -46,44 +46,4 @@ public function __construct(ComponentRegistryInterface $registry, $rootDir)
         $this->builder = new ComponentDiFinder($registry);
         $this->root = $rootDir . '/../app/config';
     }
-
-    /**
-     * @Todo maybe find a cached solution for that?
-     *
-     * @param string $fileName
-     * @return Network
-     * @throws \InvalidArgumentException
-     */
-    public function fromFile($fileName)
-    {
-        $fileUri = $this->root . '/' . ltrim($fileName, '/');
-
-        if (file_exists($fileUri)) {
-            $graph = file_get_contents($fileUri);
-        } else {
-            throw new \InvalidArgumentException('Could not find file ' . $fileUri);
-        }
-
-        return $this->fromString($graph);
-    }
-
-    /**
-     * @param string $graph
-     * @return Network
-     */
-    public function fromString($graph)
-    {
-        $graph = Graph::loadString($graph);
-
-        return $this->fromGraph($graph);
-    }
-
-    /**
-     * @param Graph $graph
-     * @return Network
-     */
-    public function fromGraph(Graph $graph)
-    {
-        return Network::create($graph, $this->builder);
-    }
 }

README.md

@@ -31,7 +31,10 @@ Configuration
         ];
     // ...
 ```
-After adding the bundle, you have a new factory service **phpflo** which uses a registry of all your accordingly tagged services.
+After adding the bundle, you have a new factory service **phpflo.network** which uses a registry of all your accordingly tagged services.
+Another possibility is to use **phpflo.network_di** service.
+The difference between these services is: network uses a registry and components are registered **only once** and collected during compile time. This is useful when using the network within on request cycle and build it only once.
+If you are working e.g. with a long running process, you should us the network_di where every component will be fetched as a fresh object from DIC for every network build.
 You can add components using following steps:
 
 **Component class**
@@ -61,9 +64,9 @@ class ReadFile extends Component
     }
 }
 ```
-Keep in mind to exend the PhpFlo\Component or implement PhpFlo\ComponentInterface!
+Keep in mind to extend the PhpFlo\Component or implement PhpFlo\ComponentInterface!
 
-**service definition**
+**service definition (phpflo.network)**
 ```yaml
 # app/config/services.yml
 
@@ -77,6 +80,21 @@ services:
 ```
 You can name the service whatever you want: The only two important things are the tags. It needs name "phpflo.component" to be found in compiler pass and the alias will be used as component name for the graph file.
 
+**service definition (phpflo.network_di)**
+
+```yaml
+# app/config/services.yml
+
+services:
+  app.read_file:
+    lazy: true
+    shared: false # force instantiation 
+    class: AppBundle\Component\ReadFile
+    tags: # optional
+      - {name: phpflo.component, alias: read_file}
+
+```
+
 **graph file** (app/config/my_graph.json)
 ```json
 {
@@ -143,6 +161,29 @@ You can name the service whatever you want: The only two important things are th
 ```
 The builder will automatically search for the provided graph file in '''app/config''' - if you need subdirectories, you can provide the filename in the formate '''subdir/graph.json'''
 
+**processes definition (network_di)**
+```json
+{
+  ...
+  "processes": {
+    "ReadFile": {
+      "component": "app.read_file"
+    },
+    "SplitbyLines": {
+      "component": "split_str"
+    },
+    "CountLines": {
+      "component": "counter"
+    },
+    "Display": {
+      "component": "output"
+    }
+  },
+  ...
+}
+```
+Add the service name as component name! 
+
 Example
 ----
 Within a symfony controller with access to the DIC, you can simply create a graph like this:

Resources/config/services.yml

@@ -1,7 +1,14 @@
 parameters:
 
 services:
-  phpflo:
+  phpflo.network_di:
+    class: PhpFlo\PhpFloBundle\Flow\DiNetworkBuilder
+    lazy: true
+    arguments:
+      - '@service_container' # not nice, but necessary
+      - '%kernel.root_dir%'
+
+  phpflo.network:
     class: PhpFlo\PhpFloBundle\Flow\NetworkBuilder
     lazy: true
     arguments: