Merge pull request zendframework/zendframework#5470 from stefanotorre…

…si/add/mail-transport-factory

Add Zend\Mail\Transport\Factory

src/Transport/Exception/DomainException.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Mail\Transport\Exception;
+
+use Zend\Mail\Exception;
+
+/**
+ * Exception for Zend\Mail\Transport component.
+ */
+class DomainException extends Exception\DomainException implements ExceptionInterface
+{
+}

src/Transport/Factory.php

@@ -0,0 +1,83 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Mail\Transport;
+
+use Traversable;
+use Zend\Stdlib\ArrayUtils;
+
+abstract class Factory
+{
+    /**
+     * @var array Known transport types
+     */
+    protected static $classMap = array(
+        'file'      => 'Zend\Mail\Transport\File',
+        'null'      => 'Zend\Mail\Transport\Null',
+        'sendmail'  => 'Zend\Mail\Transport\Sendmail',
+        'smtp'      => 'Zend\Mail\Transport\Smtp',
+    );
+
+    /**
+     * @param array $spec
+     * @return TransportInterface
+     * @throws Exception\InvalidArgumentException
+     * @throws Exception\DomainException
+     */
+    public static function create($spec = array())
+    {
+        if ($spec instanceof Traversable) {
+            $spec = ArrayUtils::iteratorToArray($spec);
+        }
+
+        if (! is_array($spec)) {
+            throw new Exception\InvalidArgumentException(sprintf(
+                '%s expects an array or Traversable argument; received "%s"',
+                __METHOD__,
+                (is_object($spec) ? get_class($spec) : gettype($spec))
+            ));
+        }
+
+        $type = isset($spec['type']) ? $spec['type'] : 'sendmail';
+
+        $normalizedType = strtolower($type);
+
+        if (isset(static::$classMap[$normalizedType])) {
+            $type = static::$classMap[$normalizedType];
+        }
+
+        if (! class_exists($type)) {
+            throw new Exception\DomainException(sprintf(
+                '%s expects the "type" attribute to resolve to an existing class; received "%s"',
+                __METHOD__,
+                $type
+            ));
+        }
+
+        $transport = new $type;
+
+        if (! $transport instanceof TransportInterface) {
+            throw new Exception\DomainException(sprintf(
+                '%s expects the "type" attribute to resolve to a valid Zend\Mail\Transport\TransportInterface instance; received "%s"',
+                __METHOD__,
+                $type
+            ));
+        }
+
+        if ($transport instanceof Smtp && isset($spec['options'])) {
+            $transport->setOptions(new SmtpOptions($spec['options']));
+        }
+
+        if ($transport instanceof File && isset($spec['options'])) {
+            $transport->setOptions(new FileOptions($spec['options']));
+        }
+
+        return $transport;
+    }
+}

src/Transport/File.php

@@ -43,6 +43,14 @@ public function __construct(FileOptions $options = null)
         $this->setOptions($options);
     }
 
+    /**
+     * @return FileOptions
+     */
+    public function getOptions()
+    {
+        return $this->options;
+    }
+
     /**
      * Sets options
      *

test/Transport/FactoryTest.php

@@ -0,0 +1,161 @@
+<?php
+/**
+ * @author Stefano Torresi (http://stefanotorresi.it)
+ * @license See the file LICENSE.txt for copying permission.
+ * ************************************************
+ */
+
+namespace ZendTest\Mail\Transport;
+
+use PHPUnit_Framework_TestCase;
+use Zend\Mail\Transport\Factory;
+use Zend\Stdlib\ArrayObject;
+
+class FactoryTest extends PHPUnit_Framework_TestCase
+{
+    /**
+     * @dataProvider invalidSpecTypeProvider
+     * @expectedException \Zend\Mail\Transport\Exception\InvalidArgumentException
+     * @param $spec
+     */
+    public function testInvalidSpecThrowsInvalidArgumentException($spec)
+    {
+        Factory::create($spec);
+    }
+
+    public function invalidSpecTypeProvider()
+    {
+        return array(
+            array('spec'),
+            array(new \stdClass()),
+        );
+    }
+
+    /**
+     *
+     */
+    public function testDefaultTypeIsSendmail()
+    {
+        $transport = Factory::create();
+
+        $this->assertInstanceOf('Zend\Mail\Transport\Sendmail', $transport);
+    }
+
+    /**
+     * @dataProvider typeProvider
+     * @param $type
+     */
+    public function testCanCreateClassUsingTypeKey($type)
+    {
+        $transport = Factory::create(array(
+            'type' => $type,
+        ));
+
+        $this->assertInstanceOf($type, $transport);
+    }
+
+    public function typeProvider()
+    {
+        return array(
+            array('Zend\Mail\Transport\File'),
+            array('Zend\Mail\Transport\Null'),
+            array('Zend\Mail\Transport\Sendmail'),
+            array('Zend\Mail\Transport\Smtp'),
+        );
+    }
+
+    /**
+     * @dataProvider typeAliasProvider
+     * @param $type
+     * @param $expectedClass
+     */
+    public function testCanCreateClassFromTypeAlias($type, $expectedClass)
+    {
+        $transport = Factory::create(array(
+            'type' => $type,
+        ));
+
+        $this->assertInstanceOf($expectedClass, $transport);
+    }
+
+    public function typeAliasProvider()
+    {
+        return array(
+            array('file', 'Zend\Mail\Transport\File'),
+            array('null', 'Zend\Mail\Transport\Null'),
+            array('sendmail', 'Zend\Mail\Transport\Sendmail'),
+            array('smtp', 'Zend\Mail\Transport\Smtp'),
+            array('File', 'Zend\Mail\Transport\File'),
+            array('Null', 'Zend\Mail\Transport\Null'),
+            array('NULL', 'Zend\Mail\Transport\Null'),
+            array('Sendmail', 'Zend\Mail\Transport\Sendmail'),
+            array('SendMail', 'Zend\Mail\Transport\Sendmail'),
+            array('Smtp', 'Zend\Mail\Transport\Smtp'),
+            array('SMTP', 'Zend\Mail\Transport\Smtp'),
+        );
+    }
+
+    /**
+     *
+     */
+    public function testCanUseTraversableAsSpec()
+    {
+        $spec = new ArrayObject(array(
+            'type' => 'null'
+        ));
+
+        $transport = Factory::create($spec);
+
+        $this->assertInstanceOf('Zend\Mail\Transport\Null', $transport);
+    }
+
+    /**
+     * @dataProvider invalidClassProvider
+     * @expectedException \Zend\Mail\Transport\Exception\DomainException
+     * @param $class
+     */
+    public function testInvalidClassThrowsDomainException($class)
+    {
+        Factory::create(array(
+            'type' => $class
+        ));
+    }
+
+    public function invalidClassProvider()
+    {
+        return array(
+            array('stdClass'),
+            array('non-existent-class'),
+        );
+    }
+
+    /**
+     *
+     */
+    public function testCanCreateSmtpTransportWithOptions()
+    {
+        $transport = Factory::create(array(
+            'type' => 'smtp',
+            'options' => array(
+                'host' => 'somehost',
+            )
+        ));
+
+        $this->assertEquals($transport->getOptions()->getHost(), 'somehost');
+    }
+
+    /**
+     *
+     */
+    public function testCanCreateFileTransportWithOptions()
+    {
+        $transport = Factory::create(array(
+            'type' => 'file',
+            'options' => array(
+                'path' => __DIR__,
+            )
+        ));
+
+        $this->assertEquals($transport->getOptions()->getPath(), __DIR__);
+    }
+}