Merge pull request #76 from johnikx/pool

add object pool pattern

Pool/Pool.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace DesignPatterns\Pool;
+
+class Pool
+{
+
+    private $instances = array();
+    private $class;
+    
+    public function __construct($class)
+    {
+        $this->class = $class;
+    }
+
+    public function get()
+    {
+        if (count($this->instances) > 0) {
+            return array_pop($this->instances);
+        }
+
+        return new $this->class();
+    }
+
+    public function dispose($instance)
+    {
+        $this->instances[] = $instance;
+    }
+
+}

Pool/Processor.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace DesignPatterns\Pool;
+
+class Processor
+{
+
+    private $pool;
+    private $processing = 0;
+    private $maxProcesses = 3;
+    private $waitingQueue = [];
+
+    public function __construct(Pool $pool)
+    {
+        $this->pool = $pool;
+    }
+
+    public function process($image)
+    {
+        if ($this->processing++ < $this->maxProcesses) {
+            $this->createWorker($image);
+        } else {
+            $this->pushToWaitingQueue($worker);
+        }
+    }
+
+    private function createWorker($image)
+    {
+        $worker = $this->pool->get();
+        $worker->run($image, array($this, 'processDone'));
+    }
+
+    public function processDone($worker)
+    {
+        $this->processing--;
+        $this->pool->dispose($worker);
+
+        if (count($this->waitingQueue) > 0) {
+            $this->createWorker($this->popFromWaitingQueue());
+        }
+    }
+
+    private function pushToWaitingQueue($image)
+    {
+        $this->waitingQueue[] = $image;
+    }
+
+    private function popFromWaitingQueue()
+    {
+        return array_pop($this->waitingQueue);
+    }
+
+}

Pool/README.md

@@ -0,0 +1,8 @@
+Pool
+====
+
+The **object pool pattern** is a software creational design pattern that uses a set of initialized objects kept ready to use – a "pool" – rather than allocating and destroying them on demand. A client of the pool will request an object from the pool and perform operations on the returned object. When the client has finished, it returns the object, which is a specific type of factory object, to the pool rather than destroying it.
+
+Object pooling can offer a significant performance boost in situations where the cost of initializing a class instance is high, the rate of instantiation of a class is high, and the number of instances in use at any one time is low. The pooled object is obtained in predictable time when creation of the new objects (especially over network) may take variable time.
+
+However these benefits are mostly true for objects that are expensive with respect to time, such as database connections, socket connections, threads and large graphic objects like fonts or bitmaps. In certain situations, simple object pooling (that hold no external resources, but only occupy memory) may not be efficient and could decrease performance.

Pool/Worker.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace DesignPatterns\Pool;
+
+class Worker
+{
+
+    public function __construct()
+    {
+        // let's say that constuctor does really expensive work...
+        // for example creates "thread"
+    }
+
+    public function run($image, array $callback)
+    {
+        // do something with $image...
+        // and when it's done, execute callback
+        call_user_func($callback, $this);
+    }
+
+}

Pool/index.php

@@ -0,0 +1,16 @@
+<?php
+
+use DesignPatterns\Pool\Pool;
+use DesignPatterns\Pool\Processor;
+
+$pool = new Pool('DesignPatterns\Pool\Worker');
+$processor = new Processor($pool);
+
+$processor->process('image1.jpg');
+$processor->process('image2.jpg');
+$processor->process('image3.jpg');
+$processor->process('image4.jpg');
+$processor->process('image5.jpg');
+$processor->process('image6.jpg');
+$processor->process('image7.jpg');
+$processor->process('image8.jpg');

README.md

@@ -18,6 +18,7 @@ The patterns can be structured in roughly three different categories. Please cli
 * [FactoryMethod](FactoryMethod) [:notebook:](http://en.wikipedia.org/wiki/Factory_method_pattern)
 * [StaticFactory](StaticFactory)
 * [Prototype](Prototype) [:notebook:](http://en.wikipedia.org/wiki/Prototype_pattern)
+* [Pool](Prototype) [:notebook:](http://en.wikipedia.org/wiki/Object_pool_pattern)
 * [Singleton](Singleton) [:notebook:](http://en.wikipedia.org/wiki/Singleton_pattern) (is considered an anti-pattern! :no_entry:)
 * [Multiton](Multiton) (is considered an anti-pattern! :no_entry:)
 

Tests/Pool/PoolTest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace DesignPatterns\Tests\Pool;
+
+use DesignPatterns\Pool\Pool;
+
+class TestWorker
+{
+
+    public $id = 1;
+
+}
+
+class PoolTest extends \PHPUnit_Framework_TestCase
+{
+
+    public function testPool()
+    {
+        $pool = new Pool('DesignPatterns\Tests\Pool\TestWorker');
+        $worker = $pool->get();
+
+        $this->assertEquals(1, $worker->id);
+
+        $worker->id = 5;
+        $pool->dispose($worker);
+
+        $this->assertEquals(5, $pool->get()->id);
+        $this->assertEquals(1, $pool->get()->id);
+    }
+
+}
+