Added Flyweight Design Pattern

Author: Hyunk3l

Structural/Flyweight/AccessoryFlyweightInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace PhpDesignPatterns\Structural\Flyweight;
+
+/**
+ * Interface AccessoryFlyweightInterface
+ * @package PhpDesignPatterns\Structural\Flyweight
+ */
+interface AccessoryFlyweightInterface
+{
+    /**
+     * Get item price.
+     *
+     * @return mixed
+     */
+    public function getPrice();
+}

Structural/Flyweight/HeadphonesFlyweight.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace PhpDesignPatterns\Structural\Flyweight;
+
+/**
+ * Class HeadphonesFlyweight
+ * @package PhpDesignPatterns\Structural\Flyweight
+ */
+class HeadphonesFlyweight implements AccessoryFlyweightInterface
+{
+    /**
+     * Get item price.
+     *
+     * @return float
+     */
+    public function getPrice()
+    {
+        return 29.99;
+    }
+}

Structural/Flyweight/PhoneInterface.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace PhpDesignPatterns\Structural\Flyweight;
+
+/**
+ * Interface PhoneInterface
+ * @package PhpDesignPatterns\Structural\Flyweight
+ */
+interface PhoneInterface
+{
+    /**
+     * Get the basic item price.
+     *
+     * @return mixed
+     */
+    public function getBasicPrice();
+
+    /**
+     * Get total item + accessories price.
+     *
+     * @return mixed
+     */
+    public function getTotalPrice();
+
+    /**
+     * Add an accessory.
+     *
+     * @param AccessoryFlyweightInterface $accessory
+     * @return PhoneInterface
+     */
+    public function addAccessory(AccessoryFlyweightInterface $accessory);
+
+    /**
+     * Get accessories price.
+     *
+     * @return mixed
+     */
+    public function getAccessoriesPrice();
+}

Structural/Flyweight/README.md

@@ -0,0 +1,7 @@
+# Flyweight Design Pattern
+
+## Intent
+
+“Use sharing to support large numbers of fine-grained objects efficiently.”
+
+Excerpt From: Erich Gamma. “Design Patterns: Elements of Reusable Object-Oriented Software.”

Structural/Flyweight/SecondaryBatteryFlyweight.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace PhpDesignPatterns\Structural\Flyweight;
+
+/**
+ * Class SecondaryBatteryFlyweight
+ * @package PhpDesignPatterns\Structural\Flyweight
+ */
+class SecondaryBatteryFlyweight implements AccessoryFlyweightInterface
+{
+    /**
+     * Get item price.
+     *
+     * @return float
+     */
+    public function getPrice()
+    {
+        return 14.99;
+    }
+}

Structural/Flyweight/Smartphone.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace PhpDesignPatterns\Structural\Flyweight;
+
+/**
+ * Class Smartphone
+ * @package PhpDesignPatterns\Structural\Flyweight
+ */
+class Smartphone implements PhoneInterface
+{
+    /**
+     * Phone price.
+     *
+     * @var float
+     */
+    const PHONE_PRICE = 399.90;
+
+    /**
+     * Accessories default price.
+     *
+     * @var float
+     */
+    const NO_ACCESSORIES_PRICE = 0.0;
+
+    /**
+     * List of accessories.
+     *
+     * @var array
+     */
+    private $accessories;
+
+    /**
+     * Get phone basic price.
+     *
+     * @return float
+     */
+    public function getBasicPrice()
+    {
+        return static::PHONE_PRICE;
+    }
+
+    /**
+     * Get accessories price.
+     *
+     * @return float
+     */
+    public function getAccessoriesPrice()
+    {
+        $accessories_price = static::NO_ACCESSORIES_PRICE;
+        if(empty($this->accessories)) {
+            return $accessories_price;
+        }
+        foreach($this->accessories as $accessory) {
+            $accessories_price += $accessory->getPrice();
+        }
+        return $accessories_price;
+    }
+
+    /**
+     * Add accessory.
+     *
+     * @param AccessoryFlyweightInterface $accessory
+     * @return PhoneInterface
+     */
+    public function addAccessory(AccessoryFlyweightInterface $accessory)
+    {
+        $this->accessories[] = $accessory;
+        return $this;
+    }
+
+    /**
+     * Get total phone price.
+     *
+     * @return float
+     */
+    public function getTotalPrice()
+    {
+        return $this->getBasicPrice() + $this->getAccessoriesPrice();
+    }
+}

Tests/Structural/Flyweight/HeadphonesFlyweightTest.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace PhpDesignPatterns\Tests\Structural\Flyweight;
+
+use PhpDesignPatterns\Structural\Flyweight\HeadphonesFlyweight;
+
+/**
+ * Class HeadphonesFlyweightTest
+ * @package PhpDesignPatterns\Tests\Structural\Flyweight
+ */
+class HeadphonesFlyweightTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * Testing getPrice.
+     */
+    public function testGetPrice()
+    {
+        $expected   = 29.99;
+        $flyweight  = new HeadphonesFlyweight;
+        $this->assertEquals($expected, $flyweight->getPrice());
+    }
+}

Tests/Structural/Flyweight/SecondaryBatteryFlyweightTest.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace PhpDesignPatterns\Tests\Structural\Flyweight;
+
+use PhpDesignPatterns\Structural\Flyweight\SecondaryBatteryFlyweight;
+
+/**
+ * Class SecondaryBatteryFlyweightTest
+ * @package PhpDesignPatterns\Tests\Structural\Flyweight
+ */
+class SecondaryBatteryFlyweightTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * Testing getPrice.
+     */
+    public function testGetPrice()
+    {
+        $expected   = 14.99;
+        $flyweight  = new SecondaryBatteryFlyweight;
+        $this->assertEquals($expected, $flyweight->getPrice());
+    }
+}

Tests/Structural/Flyweight/SmartphoneTest.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace PhpDesignPatterns\Tests\Structural\Flyweight;
+
+use PhpDesignPatterns\Structural\Flyweight\Smartphone;
+
+class SmartphoneTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * Instance of Smartphone.
+     *
+     * @var PhoneInterface
+     */
+    private $phone;
+
+    /**
+     * Setup each test case basic variables.
+     */
+    public function setUp()
+    {
+        $this->phone = new Smartphone;
+    }
+
+    /**
+     * Destroy variables after each test case.
+     */
+    public function tearDown()
+    {
+        $this->phone = null;
+    }
+
+    /**
+     * Test get basic phone price.
+     */
+    public function testGetBasicPrice()
+    {
+        $this->assertEquals(Smartphone::PHONE_PRICE, $this->phone->getBasicPrice());
+    }
+
+    /**
+     * Test get accessories price when no accessories.
+     */
+    public function testGetAccessoriesPriceWhenNoAccessories()
+    {
+        $this->assertEquals(0.0, $this->phone->getAccessoriesPrice());
+    }
+
+    /**
+     * Test get accessories price.
+     */
+    public function testGetAccessoriesPrice()
+    {
+        $mock_accessory = $this->getMock('\\PhpDesignPatterns\\Structural\\Flyweight\\AccessoryFlyweightInterface', array('getPrice'));
+        $mock_accessory
+            ->expects($this->exactly(2))
+            ->method('getPrice')
+            ->will($this->onConsecutiveCalls(20.00, 10.00))
+        ;
+        $this->phone->addAccessory($mock_accessory);
+        $this->phone->addAccessory($mock_accessory);
+        $this->assertEquals(30.0, $this->phone->getAccessoriesPrice());
+    }
+
+    /**
+     * Test get total phone price.
+     */
+    public function testGetTotalPrice()
+    {
+        $mock_accessory = $this->getMock('\\PhpDesignPatterns\\Structural\\Flyweight\\AccessoryFlyweightInterface', array('getPrice'));
+        $mock_accessory
+            ->expects($this->exactly(2))
+            ->method('getPrice')
+            ->will($this->onConsecutiveCalls(20.00, 10.00))
+        ;
+        $this->phone->addAccessory($mock_accessory);
+        $this->phone->addAccessory($mock_accessory);
+        $this->assertEquals(Smartphone::PHONE_PRICE+30.0, $this->phone->getTotalPrice());
+    }
+}