Merge branch 'release/1.7.0'

readme.md

@@ -34,6 +34,7 @@ should not force your code to fit in patterns. It should come out naturally. Fir
     state
     * [Observer](src/Behavioral/Observer) - Define one to many dependency between objects so that when one changes state,
     all its dependents are notified and updated automatically
+    * [State][src/Behavioral/State] - allow object to alter its behavior depending on current internal state change.
     * [Strategy](src/Behavioral/Strategy) - Define a family of algorithms and make them interchangable. 
 3. Creational
     * [Factory](src/Creational/Factory) - Define an interface for creating an object but let the subclasses decide
@@ -57,6 +58,5 @@ should not force your code to fit in patterns. It should come out naturally. Fir
 * Interpreter
 * Iterator
 * Mediator
-* State
 * Visitor
 

src/Antipatterns/Singleton/Singleton.php

@@ -13,7 +13,7 @@ class Singleton
     private static $instance;
 
     /**
-     * @return bool
+     * @return $this
      */
     final public static function getInstance()
     {
@@ -28,12 +28,10 @@ final private function __construct()
         //default construct should not have public access
     }
 
-    final private function __wakeup()
-    {
-    }
 
     final private function __clone()
     {
+        return static::$instance;
     }
 
     public function doSomething()

src/Antipatterns/Singleton/SingletonTrait.php

@@ -22,12 +22,4 @@ final private function __construct()
     {
     }
 
-    final private function __wakeup()
-    {
-    }
-
-    final private function __clone()
-    {
-    }
-
 }

src/Behavioral/State/ConnectionClosed.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: robertpodwikamac
+ * Date: 15.07.15
+ * Time: 00:31
+ */
+
+namespace Rpodwika\Designpatterns\Behavioral\State;
+
+
+class ConnectionClosed implements ConnectionState
+{
+    public function open()
+    {
+        return 'Opening connection';
+    }
+
+    public function close()
+    {
+        return 'Connection already closed';
+    }
+
+    public function reconnect()
+    {
+        return 'Reconnecting';
+    }
+
+}

src/Behavioral/State/ConnectionEstablished.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: robertpodwikamac
+ * Date: 15.07.15
+ * Time: 00:26
+ */
+
+namespace Rpodwika\Designpatterns\Behavioral\State;
+
+
+class ConnectionEstablished implements ConnectionState
+{
+    public function open()
+    {
+        return 'Cannot open already opened connection';
+    }
+
+    public function close()
+    {
+        return 'Freeing resources';
+    }
+
+    public function reconnect()
+    {
+        return "Waiting for reconnection";
+    }
+
+}

src/Behavioral/State/ConnectionState.php

@@ -0,0 +1,17 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: robertpodwikamac
+ * Date: 15.07.15
+ * Time: 00:25
+ */
+
+namespace Rpodwika\Designpatterns\Behavioral\State;
+
+
+interface ConnectionState
+{
+    public function open();
+    public function close();
+    public function reconnect();
+}

src/Behavioral/State/DbConnection.php

@@ -0,0 +1,119 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: robertpodwikamac
+ * Date: 15.07.15
+ * Time: 00:33
+ */
+
+namespace Rpodwika\Designpatterns\Behavioral\State;
+
+
+class DbConnection
+{
+    /**
+     * @var ConnectionState $state
+     */
+    private $state;
+    private $port;
+    private $uri;
+
+    public function __construct($port, $uri)
+    {
+        $this->port = $port;
+        $this->uri = $uri;
+    }
+
+
+    /**
+     * @return mixed
+     */
+    public function getState()
+    {
+        return $this->state;
+    }
+
+    /**
+     * @param mixed $state
+     * @return $this
+     */
+    public function setState(ConnectionState $state)
+    {
+        $this->state = $state;
+
+        return $this;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getUri()
+    {
+        return $this->uri;
+    }
+
+    /**
+     * @param mixed $uri
+     * @return $this
+     */
+    public function setUri($uri)
+    {
+        $this->uri = $uri;
+
+        return $this;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getPort()
+    {
+        return $this->port;
+    }
+
+    /**
+     * @param mixed $port
+     * @return $this
+     */
+    public function setPort($port)
+    {
+        $this->port = $port;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function connect()
+    {
+        $this->state = new ConnectionEstablished();
+        $this->state->open();
+
+        return sprintf('Opening connection %s:%d', $this->getUri(), $this->getPort());
+    }
+
+    /**
+     * @return string
+     */
+    public function close()
+    {
+        $this->state = new ConnectionClosed();
+        $this->state->close();
+
+        return 'Closing connection';
+    }
+
+    /**
+     * @return string
+     */
+    public function reconnect()
+    {
+        $this->close();
+        $this->connect();
+
+        return 'Reconnecting';
+    }
+
+
+}

src/Behavioral/State/readme.md

@@ -0,0 +1,8 @@
+#State
+
+State allows oject to later its behavior when its internal state changes. 
+The key idea in this pattern is to create State object that represents current state of an object.
+
+#When to use
+
+* When object behavior depends on state and it must change behavior at runtime depending on that state

tests/Antipatterns/Singleton/SingletonTest.php

@@ -44,4 +44,13 @@ public function testSingletonTrait()
         $this->assertEquals('I do something', $object->doSomething());
 
     }
+
+    /**
+     * @covers \Rpodwika\Designpatterns\Antipatterns\Singleton\SingletonSample
+     */
+    public function testSingletonSample()
+    {
+        $this->assertEquals('I do something', SingletonSample::getInstance()->doSomething());
+    }
+
 }

tests/Behavioral/State/ConnectionClosedTest.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: robertpodwikamac
+ * Date: 15.07.15
+ * Time: 00:41
+ */
+
+namespace Rpodwika\Designpatterns\Tests\Behavioral\State;
+
+use Rpodwika\Designpatterns\Behavioral\State\ConnectionClosed;
+
+class ConnectionClosedTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @covers \Rpodwika\Designpatterns\Behavioral\State\ConnectionClosed::open
+     */
+    public function testOpen()
+    {
+        $connection = new ConnectionClosed();
+        $this->assertEquals('Opening connection', $connection->open());
+    }
+
+    /**
+     * @covers \Rpodwika\Designpatterns\Behavioral\State\ConnectionClosed::close
+     */
+    public function testClose()
+    {
+        $connection = new ConnectionClosed();
+        $this->assertEquals('Connection already closed', $connection->close());
+    }
+
+    /**
+     * @covers \Rpodwika\Designpatterns\Behavioral\State\ConnectionClosed::reconnect
+     */
+    public function testReconnect()
+    {
+        $connection = new ConnectionClosed();
+        $this->assertEquals('Reconnecting', $connection->reconnect());
+    }
+}

tests/Behavioral/State/ConnectionEstablishedTest.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: robertpodwikamac
+ * Date: 15.07.15
+ * Time: 00:41
+ */
+
+namespace Rpodwika\Designpatterns\Tests\Behavioral\State;
+
+use Rpodwika\Designpatterns\Behavioral\State\ConnectionEstablished;
+
+class ConnectionEstablishedTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @covers \Rpodwika\Designpatterns\Behavioral\State\ConnectionEstablished::open
+     */
+    public function testOpen()
+    {
+        $connection = new ConnectionEstablished();
+        $this->assertEquals('Cannot open already opened connection', $connection->open());
+    }
+
+    /**
+     * @covers \Rpodwika\Designpatterns\Behavioral\State\ConnectionEstablished::close
+     */
+    public function testClose()
+    {
+        $connection = new ConnectionEstablished();
+        $this->assertEquals('Freeing resources', $connection->close());
+    }
+
+    /**
+     * @covers \Rpodwika\Designpatterns\Behavioral\State\ConnectionEstablished::reconnect
+     */
+    public function testReconnect()
+    {
+        $connection = new ConnectionEstablished();
+        $this->assertEquals('Waiting for reconnection', $connection->reconnect());
+    }
+}