From cc765bde41a46b62a4166ecb8ace521defd003e9 Mon Sep 17 00:00:00 2001
From: Trismegiste <florent.g@allopneus.com>
Date: Fri, 10 May 2013 21:09:55 +0200
Subject: [PATCH] the REAL factory method pattern

---
 FactoryMethod/Bicycle.php                 | 20 +++++++++
 FactoryMethod/FactoryMethod.php           | 45 ++++++++++++++++++++
 FactoryMethod/Ferrari.php                 | 20 +++++++++
 FactoryMethod/GermanFactory.php           | 32 +++++++++++++++
 FactoryMethod/ItalianFactory.php          | 32 +++++++++++++++
 FactoryMethod/Porsche.php                 | 20 +++++++++
 FactoryMethod/Vehicle.php                 | 16 ++++++++
 Tests/FactoryMethod/FactoryMethodTest.php | 50 +++++++++++++++++++++++
 8 files changed, 235 insertions(+)
 create mode 100644 FactoryMethod/Bicycle.php
 create mode 100644 FactoryMethod/FactoryMethod.php
 create mode 100644 FactoryMethod/Ferrari.php
 create mode 100644 FactoryMethod/GermanFactory.php
 create mode 100644 FactoryMethod/ItalianFactory.php
 create mode 100644 FactoryMethod/Porsche.php
 create mode 100644 FactoryMethod/Vehicle.php
 create mode 100644 Tests/FactoryMethod/FactoryMethodTest.php

diff --git a/FactoryMethod/Bicycle.php b/FactoryMethod/Bicycle.php
new file mode 100644
index 0000000..772dcdf
--- /dev/null
+++ b/FactoryMethod/Bicycle.php
@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * DesignPatternPHP
+ */
+
+namespace DesignPatterns\FactoryMethod;
+
+/**
+ * Bicycle is a bicycle
+ */
+class Bicycle implements Vehicle
+{
+
+    public function setColor($rgb)
+    {
+        
+    }
+
+}
\ No newline at end of file
diff --git a/FactoryMethod/FactoryMethod.php b/FactoryMethod/FactoryMethod.php
new file mode 100644
index 0000000..439965b
--- /dev/null
+++ b/FactoryMethod/FactoryMethod.php
@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * DesignPatternPHP
+ */
+
+namespace DesignPatterns\FactoryMethod;
+
+/**
+ * FactoryMethod is a factory method. The good point on the SimpleFactory
+ * is you can subclass it to implement different way to create vehicle for
+ * each country.
+ * 
+ * For simple case, this abstracct class could be just an interface
+ */
+abstract class FactoryMethod
+{
+
+    /**
+     * The children of the class must implement this method
+     * 
+     * Sometimes this method can be public to get "raw" object
+     * 
+     * @param string $type a generic type
+     * 
+     * @return Vehicle a new vehicle
+     */
+    abstract protected function createVehicle($type);
+
+    /**
+     * Creates a new vehicle
+     * 
+     * @param string $type
+     * 
+     * @return Vehicle a new vehicle
+     */
+    public function create($type)
+    {
+        $obj = $this->createVehicle($type);
+        $obj->setColor("#f00");
+
+        return $obj;
+    }
+
+}
\ No newline at end of file
diff --git a/FactoryMethod/Ferrari.php b/FactoryMethod/Ferrari.php
new file mode 100644
index 0000000..f57d728
--- /dev/null
+++ b/FactoryMethod/Ferrari.php
@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * DesignPatternPHP
+ */
+
+namespace DesignPatterns\FactoryMethod;
+
+/**
+ * Ferrari is a italian car
+ */
+class Ferrari implements Vehicle
+{
+
+    public function setColor($rgb)
+    {
+        
+    }
+
+}
\ No newline at end of file
diff --git a/FactoryMethod/GermanFactory.php b/FactoryMethod/GermanFactory.php
new file mode 100644
index 0000000..a7fb6f1
--- /dev/null
+++ b/FactoryMethod/GermanFactory.php
@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * DesignPatternPHP
+ */
+
+namespace DesignPatterns\FactoryMethod;
+
+/**
+ * GermanFactory is vehicle factory in Germany
+ */
+class GermanFactory extends FactoryMethod
+{
+
+    /**
+     * @inheritdoc
+     */
+    protected function createVehicle($type)
+    {
+        switch ($type) {
+            case 'cheap' :
+                return new Bicycle();
+                break;
+            case 'fast' :
+                return new Porsche();
+                break;
+            default :
+                throw new \InvalidArgumentException("$type is not a valid vehicle");
+        }
+    }
+
+}
\ No newline at end of file
diff --git a/FactoryMethod/ItalianFactory.php b/FactoryMethod/ItalianFactory.php
new file mode 100644
index 0000000..873c91d
--- /dev/null
+++ b/FactoryMethod/ItalianFactory.php
@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * DesignPatternPHP
+ */
+
+namespace DesignPatterns\FactoryMethod;
+
+/**
+ * ItalianFactory is vehicle factory in Italy
+ */
+class ItalianFactory extends FactoryMethod
+{
+
+    /**
+     * @inheritdoc
+     */
+    protected function createVehicle($type)
+    {
+        switch ($type) {
+            case 'cheap' :
+                return new Bicycle();
+                break;
+            case 'fast' :
+                return new Ferrari();
+                break;
+            default :
+                throw new \InvalidArgumentException("$type is not a valid vehicle");
+        }
+    }
+
+}
\ No newline at end of file
diff --git a/FactoryMethod/Porsche.php b/FactoryMethod/Porsche.php
new file mode 100644
index 0000000..8ecf3ec
--- /dev/null
+++ b/FactoryMethod/Porsche.php
@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * DesignPatternPHP
+ */
+
+namespace DesignPatterns\FactoryMethod;
+
+/**
+ * Porsche is a german car
+ */
+class Porsche implements Vehicle
+{
+
+    public function setColor($rgb)
+    {
+        
+    }
+
+}
\ No newline at end of file
diff --git a/FactoryMethod/Vehicle.php b/FactoryMethod/Vehicle.php
new file mode 100644
index 0000000..180a349
--- /dev/null
+++ b/FactoryMethod/Vehicle.php
@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * DesignPatternPHP
+ */
+
+namespace DesignPatterns\FactoryMethod;
+
+/**
+ * Vehicle is a contract for a vehicle
+ */
+interface Vehicle
+{
+
+    function setColor($rgb);
+}
\ No newline at end of file
diff --git a/Tests/FactoryMethod/FactoryMethodTest.php b/Tests/FactoryMethod/FactoryMethodTest.php
new file mode 100644
index 0000000..ec7b652
--- /dev/null
+++ b/Tests/FactoryMethod/FactoryMethodTest.php
@@ -0,0 +1,50 @@
+<?php
+
+/*
+ * DesignPatternPHP
+ */
+
+namespace DesignPatterns\Tests\FactoryMethod;
+
+use DesignPatterns\FactoryMethod;
+
+/**
+ * FactoryMethodTest tests the factory method pattern
+ */
+class FactoryMethodTest extends \PHPUnit_Framework_TestCase
+{
+
+    protected $type = array('cheap', 'fast');
+
+    public function getShop()
+    {
+        return array(
+            array(new FactoryMethod\GermanFactory()),
+            array(new FactoryMethod\ItalianFactory())
+        );
+    }
+
+    /**
+     * @dataProvider getShop
+     */
+    public function testCreation(FactoryMethod\FactoryMethod $shop)
+    {
+        // this test method acts as a client for the factory. We don't care
+        // about the factory, all we know is it can produce vehicle
+        foreach ($this->type as $oneType) {
+            $vehicle = $shop->create($oneType);
+            $this->assertInstanceOf('DesignPatterns\FactoryMethod\Vehicle', $vehicle);
+        }
+    }
+
+    /**
+     * @dataProvider getShop
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage spaceship is not a valid vehicle
+     */
+    public function testUnknownType(FactoryMethod\FactoryMethod $shop)
+    {
+        $shop->create('spaceship');
+    }
+
+}
\ No newline at end of file