Merge branch 'feature/config-provider' into develop

Close #80

Author: weierophinney

CHANGELOG.md

@@ -8,6 +8,12 @@ All notable changes to this project will be documented in this file, in reverse
 
 - [#41](https://github.com/zendframework/zend-mail/pull/41) adds support for
   IMAP delimiters in the IMAP storage adapter.
+- [#80](https://github.com/zendframework/zend-mail/pull/80) adds:
+  - `Zend\Mail\Protocol\SmtpPluginManagerFactory`, for creating and returning an
+    `SmtpPluginManagerFactory` instance.
+  - `Zend\Mail\ConfigProvider`, which maps the `SmtpPluginManager` to the above
+    factory.
+  - `Zend\Mail\Module`, which does the same, for zend-mvc contexts.
 
 ### Deprecated
 

composer.json

@@ -36,6 +36,10 @@
         "branch-alias": {
             "dev-master": "2.6-dev",
             "dev-develop": "2.7-dev"
+        },
+        "zf": {
+            "component": "Zend\\Mail",
+            "config-provider": "Zend\\Mail\\ConfigProvider"
         }
     },
     "autoload-dev": {

src/ConfigProvider.php

@@ -0,0 +1,37 @@
+<?php
+/**
+ * @link      http://github.com/zendframework/zend-mail for the canonical source repository
+ * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Mail;
+
+class ConfigProvider
+{
+    /**
+     * Retrieve configuration for zend-mail package.
+     *
+     * @return array
+     */
+    public function __invoke()
+    {
+        return [
+            'dependencies' => $this->getDependencyConfig(),
+        ];
+    }
+
+    /**
+     * Retrieve dependency settings for zend-mail package.
+     *
+     * @return array
+     */
+    public function getDependencyConfig()
+    {
+        return [
+            'factories' => [
+                Protocol\SmtpPluginManager::class => Protocol\SmtpPluginManagerFactory::class,
+            ],
+        ];
+    }
+}

src/Module.php

@@ -0,0 +1,24 @@
+<?php
+/**
+ * @link      http://github.com/zendframework/zend-mail for the canonical source repository
+ * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Mail;
+
+class Module
+{
+    /**
+     * Retrieve zend-mail package configuration for zend-mvc context.
+     *
+     * @return array
+     */
+    public function getConfig()
+    {
+        $provider = new ConfigProvider();
+        return [
+            'service_manager' => $provider->getDependencyConfig(),
+        ];
+    }
+}

src/Protocol/SmtpPluginManager.php

@@ -55,7 +55,7 @@ class SmtpPluginManager extends AbstractPluginManager
         'zendmailprotocolsmtpauthcrammd5' => InvokableFactory::class,
         'zendmailprotocolsmtpauthlogin'   => InvokableFactory::class,
         'zendmailprotocolsmtpauthplain'   => InvokableFactory::class,
-        'zendmailprotocolsmtp'              => InvokableFactory::class,
+        'zendmailprotocolsmtp'            => InvokableFactory::class,
     ];
 
     /**

src/Protocol/SmtpPluginManagerFactory.php

@@ -0,0 +1,53 @@
+<?php
+/**
+ * @link      http://github.com/zendframework/zend-mail for the canonical source repository
+ * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Mail\Protocol;
+
+use Interop\Container\ContainerInterface;
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+class SmtpPluginManagerFactory implements FactoryInterface
+{
+    /**
+     * zend-servicemanager v2 support for invocation options.
+     *
+     * @param array
+     */
+    protected $creationOptions;
+
+    /**
+     * {@inheritDoc}
+     *
+     * @return SmtpPluginManager
+     */
+    public function __invoke(ContainerInterface $container, $name, array $options = null)
+    {
+        return new SmtpPluginManager($container, $options ?: []);
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @return SmtpPluginManager
+     */
+    public function createService(ServiceLocatorInterface $container, $name = null, $requestedName = null)
+    {
+        return $this($container, $requestedName ?: SmtpPluginManager::class, $this->creationOptions);
+    }
+
+    /**
+     * zend-servicemanager v2 support for invocation options.
+     *
+     * @param array $options
+     * @return void
+     */
+    public function setCreationOptions(array $options)
+    {
+        $this->creationOptions = $options;
+    }
+}

test/Protocol/SmtpPluginManagerFactoryTest.php

@@ -0,0 +1,73 @@
+<?php
+/**
+ * @link      http://github.com/zendframework/zend-mail for the canonical source repository
+ * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace ZendTest\Mail\Protocol;
+
+use Interop\Container\ContainerInterface;
+use PHPUnit_Framework_TestCase as TestCase;
+use Zend\Mail\Protocol\Smtp;
+use Zend\Mail\Protocol\SmtpPluginManager;
+use Zend\Mail\Protocol\SmtpPluginManagerFactory;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+class SmtpPluginManagerFactoryTest extends TestCase
+{
+    public function testFactoryReturnsPluginManager()
+    {
+        $container = $this->prophesize(ContainerInterface::class)->reveal();
+        $factory = new SmtpPluginManagerFactory();
+
+        $plugins = $factory($container, SmtpPluginManager::class);
+        $this->assertInstanceOf(SmtpPluginManager::class, $plugins);
+
+        if (method_exists($plugins, 'configure')) {
+            // zend-servicemanager v3
+            $this->assertAttributeSame($container, 'creationContext', $plugins);
+        } else {
+            // zend-servicemanager v2
+            $this->assertSame($container, $plugins->getServiceLocator());
+        }
+    }
+
+    /**
+     * @depends testFactoryReturnsPluginManager
+     */
+    public function testFactoryConfiguresPluginManagerUnderContainerInterop()
+    {
+        $container = $this->prophesize(ContainerInterface::class)->reveal();
+        $smtp = $this->prophesize(Smtp::class)->reveal();
+
+        $factory = new SmtpPluginManagerFactory();
+        $plugins = $factory($container, SmtpPluginManager::class, [
+            'services' => [
+                'test' => $smtp,
+            ],
+        ]);
+        $this->assertSame($smtp, $plugins->get('test'));
+    }
+
+    /**
+     * @depends testFactoryReturnsPluginManager
+     */
+    public function testFactoryConfiguresPluginManagerUnderServiceManagerV2()
+    {
+        $container = $this->prophesize(ServiceLocatorInterface::class);
+        $container->willImplement(ContainerInterface::class);
+
+        $smtp = $this->prophesize(Smtp::class)->reveal();
+
+        $factory = new SmtpPluginManagerFactory();
+        $factory->setCreationOptions([
+            'services' => [
+                'test' => $smtp,
+            ],
+        ]);
+
+        $plugins = $factory->createService($container->reveal());
+        $this->assertSame($smtp, $plugins->get('test'));
+    }
+}