Merge branch 'feature/10' into develop

Close #10

Author: weierophinney

.travis.yml

@@ -17,13 +17,25 @@ matrix:
     - php: 5.5
       env:
         - EXECUTE_CS_CHECK=true
+    - php: 5.5
+      env:
+        - SERVICE_MANAGER_VERSION='^2.7.5'
     - php: 5.6
       env:
         - EXECUTE_TEST_COVERALLS=true
+    - php: 5.6
+      env:
+        - SERVICE_MANAGER_VERSION='^2.7.5'
     - php: 7
-    - php: hhvm 
-  allow_failures:
     - php: 7
+      env:
+        - SERVICE_MANAGER_VERSION='^2.7.5'
+    - php: hhvm
+    - php: hhvm
+      env:
+        - SERVICE_MANAGER_VERSION='^2.7.5'
+  allow_failures:
+    - php: hhvm
 
 notifications:
   irc: "irc.freenode.org#zftalk.dev"
@@ -33,6 +45,8 @@ before_install:
   - if [[ $EXECUTE_TEST_COVERALLS != 'true' ]]; then phpenv config-rm xdebug.ini || return 0 ; fi
   - composer self-update
   - if [[ $EXECUTE_TEST_COVERALLS == 'true' ]]; then composer require --dev --no-update satooshi/php-coveralls ; fi
+  - if [[ $SERVICE_MANAGER_VERSION != '' ]]; then composer require --dev --no-update "zendframework/zend-servicemanager:$SERVICE_MANAGER_VERSION" ; fi
+  - if [[ $SERVICE_MANAGER_VERSION == '' ]]; then composer require --dev --no-update "zendframework/zend-servicemanager:^3.0.3" ; fi
 
 install:
   - travis_retry composer install --no-interaction --ignore-platform-reqs

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
-## 3.0.0 - TBD
+## 2.6.0 - 2016-02-03
 
 ### Added
 
@@ -18,5 +18,6 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Fixed
 
-- [#3](https://github.com/zendframework/zend-tag/pull/3) updates the component
-  to use zend-servicemanager v3.
+- [#3](https://github.com/zendframework/zend-tag/pull/3) and
+  [#10](https://github.com/zendframework/zend-tag/pull/10) update the component
+  to be forward-compatible with zend-servicemanager v3.

composer.json

@@ -13,13 +13,12 @@
         }
     },
     "require": {
-        "php": ">=5.5",
-        "zendframework/zend-escaper": "~2.5",
-        "zendframework/zend-stdlib": "~2.5"
+        "php": "^5.5 || ^7.0",
+        "zendframework/zend-escaper": "^2.5",
+        "zendframework/zend-stdlib": "^3.0"
     },
     "require-dev": {
-        "zendframework/zend-config": "~2.5",
-        "zendframework/zend-servicemanager": "dev-develop as 2.7.0",
+        "zendframework/zend-servicemanager": "^2.7.5 || ^3.0.3",
         "fabpot/php-cs-fixer": "1.7.*",
         "phpunit/PHPUnit": "~4.0"
     },
@@ -31,7 +30,7 @@
     "extra": {
         "branch-alias": {
             "dev-master": "2.5-dev",
-            "dev-develop": "3.0-dev"
+            "dev-develop": "2.6-dev"
         }
     },
     "autoload-dev": {

src/Cloud/DecoratorPluginManager.php

@@ -9,8 +9,10 @@
 
 namespace Zend\Tag\Cloud;
 
+use RuntimeException;
 use Zend\ServiceManager\AbstractPluginManager;
 use Zend\ServiceManager\Factory\InvokableFactory;
+use Zend\ServiceManager\Exception\InvalidServiceException;
 
 /**
  * Plugin manager implementation for decorators.
@@ -37,7 +39,49 @@ class DecoratorPluginManager extends AbstractPluginManager
     protected $factories = [
         Decorator\HtmlCloud::class => InvokableFactory::class,
         Decorator\HtmlTag::class   => InvokableFactory::class,
+        // Legacy (v2) due to alias resolution; canonical form of resolved
+        // alias is used to look up the factory, while the non-normalized
+        // resolved alias is used as the requested name passed to the factory.
+        'zendtagclouddecoratorhtmlcloud' => InvokableFactory::class,
+        'zendtagclouddecoratorhtmltag'   => InvokableFactory::class
     ];
 
     protected $instanceOf = Decorator\DecoratorInterface::class;
+
+    /**
+     * Validate the plugin is of the expected type (v3).
+     *
+     * Validates against `$instanceOf`.
+     *
+     * @param mixed $instance
+     * @throws InvalidServiceException
+     */
+    public function validate($instance)
+    {
+        if (! $instance instanceof $this->instanceOf) {
+            throw new InvalidServiceException(sprintf(
+                '%s can only create instances of %s; %s is invalid',
+                get_class($this),
+                $this->instanceOf,
+                (is_object($instance) ? get_class($instance) : gettype($instance))
+            ));
+        }
+    }
+
+    /**
+     * Validate the plugin is of the expected type (v2).
+     *
+     * Proxies to `validate()`.
+     *
+     * @param mixed $instance
+     * @throws InvalidServiceException
+     */
+     public function validatePlugin($instance)
+     {
+         try {
+             $this->validate($instance);
+         } catch (InvalidServiceException $e) {
+             throw new RuntimeException($e->getMessage(), $e->getCode(), $e);
+         }
+     }
 }

test/Cloud/CloudTest.php

@@ -9,8 +9,10 @@
 
 namespace ZendTest\Tag\Cloud;
 
+use ArrayObject;
 use stdClass;
 use Zend\ServiceManager\ServiceManager;
+use Zend\ServiceManager\Config as SMConfig;
 use Zend\Tag;
 use Zend\Tag\Cloud;
 use Zend\Tag\Cloud\Decorator\HtmlCloud;
@@ -228,9 +230,14 @@ public function testConstructorWithArray()
         $this->assertEquals('foo', $list[0]->getTitle());
     }
 
+    /**
+     * This test uses ArrayObject, which will have essentially the
+     * same behavior as Zend\Config\Config; the code is looking only
+     * for a Traversable.
+     */
     public function testConstructorWithConfig()
     {
-        $cloud = $this->getCloud(new \Zend\Config\Config([
+        $cloud = $this->getCloud(new ArrayObject([
             'tags' => [
                 [
                     'title'  => 'foo',
@@ -320,12 +327,21 @@ protected function getCloud($options = null, $setDecoratorPluginManager = true)
 
         if ($setDecoratorPluginManager) {
             $decorators = $cloud->getDecoratorPluginManager();
+            /*
             $decorators->configure([
                 'invokables' => [
                     'CloudDummy' => CloudDummy::class,
                     'TagDummy'   => TagDummy::class
                 ]
             ]);
+            */
+            $smConfig = new SMConfig([
+              'invokables' => [
+                  'CloudDummy' => CloudDummy::class,
+                  'TagDummy'   => TagDummy::class
+              ]
+            ]);
+            $smConfig->configureServiceManager($decorators);
         }
 
         return $cloud;

test/Cloud/Decorator/DecoratorPluginManagerCompatibilityTest.php

@@ -0,0 +1,38 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2016 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+namespace ZendTest\ServiceManager;
+
+use PHPUnit_Framework_TestCase as TestCase;
+use Zend\ServiceManager\ServiceManager;
+use Zend\Tag\Cloud\DecoratorPluginManager;
+use Zend\Tag\Cloud\Decorator\DecoratorInterface;
+use Zend\ServiceManager\Test\CommonPluginManagerTrait;
+
+/**
+ * Example test of using CommonPluginManagerTrait
+ */
+class DecoratorPluginManagerCompatibilityTest extends TestCase
+{
+    use CommonPluginManagerTrait;
+
+    protected function getPluginManager()
+    {
+        return new DecoratorPluginManager(new ServiceManager());
+    }
+
+    protected function getV2InvalidPluginException()
+    {
+        return \RuntimeException::class;
+    }
+
+    protected function getInstanceOf()
+    {
+        return DecoratorInterface::class;
+    }
+}

test/Cloud/Decorator/HtmlCloudTest.php

@@ -9,6 +9,7 @@
 
 namespace ZendTest\Tag\Cloud\Decorator;
 
+use ArrayObject;
 use Zend\Tag\Cloud\Decorator;
 
 /**
@@ -72,58 +73,54 @@ public function testSeparator()
     public function testConstructorWithArray()
     {
         $decorator = new Decorator\HtmlCloud([
-                                                  'htmlTags'  => ['div'],
-                                                  'separator' => ' '
-                                             ]);
+            'htmlTags'  => ['div'],
+            'separator' => ' ',
+        ]);
 
         $this->assertEquals(
-            '<div>foo bar</div>', $decorator->render(
-                [
-                     'foo',
-                     'bar'
-                ]
-            )
+            '<div>foo bar</div>',
+            $decorator->render([
+                'foo',
+                'bar'
+            ])
         );
     }
 
+    /**
+     * This test uses ArrayObject, which will have essentially the
+     * same behavior as Zend\Config\Config; the code is looking only
+     * for a Traversable.
+     */
     public function testConstructorWithConfig()
     {
-        $decorator = new Decorator\HtmlCloud(
-            new \Zend\Config\Config(
-                [
-                     'htmlTags'  => ['div'],
-                     'separator' => ' '
-                ]
-            )
-        );
+        $decorator = new Decorator\HtmlCloud(new ArrayObject([
+            'htmlTags'  => ['div'],
+            'separator' => ' '
+        ]));
 
         $this->assertEquals(
-            '<div>foo bar</div>', $decorator->render(
-                [
-                     'foo',
-                     'bar'
-                ]
-            )
+            '<div>foo bar</div>',
+            $decorator->render([
+                'foo',
+                'bar'
+            ])
         );
     }
 
     public function testSetOptions()
     {
         $decorator = new Decorator\HtmlCloud();
-        $decorator->setOptions(
-            [
-                 'htmlTags'  => ['div'],
-                 'separator' => ' '
-            ]
-        );
+        $decorator->setOptions([
+            'htmlTags'  => ['div'],
+            'separator' => ' '
+        ]);
 
         $this->assertEquals(
-            '<div>foo bar</div>', $decorator->render(
-                [
-                     'foo',
-                     'bar'
-                ]
-            )
+            '<div>foo bar</div>',
+            $decorator->render([
+                'foo',
+                'bar'
+            ])
         );
     }
 

test/Cloud/Decorator/HtmlTagTest.php

@@ -9,6 +9,7 @@
 
 namespace ZendTest\Tag\Cloud\Decorator;
 
+use ArrayObject;
 use Zend\Tag;
 use Zend\Tag\Cloud\Decorator;
 
@@ -114,9 +115,18 @@ public function testConstructorWithArray()
         $this->assertEquals('pt', $decorator->getFontSizeUnit());
     }
 
+    /**
+     * This test uses ArrayObject, which will have essentially the
+     * same behavior as Zend\Config\Config; the code is looking only
+     * for a Traversable.
+     */
     public function testConstructorWithConfig()
     {
-        $decorator = new Decorator\HtmlTag(new \Zend\Config\Config(['minFontSize' => 5, 'maxFontSize' => 10, 'fontSizeUnit' => 'pt']));
+        $decorator = new Decorator\HtmlTag(new ArrayObject([
+            'minFontSize' => 5,
+            'maxFontSize' => 10,
+            'fontSizeUnit' => 'pt',
+        ]));
 
         $this->assertEquals(5, $decorator->getMinFontSize());
         $this->assertEquals(10, $decorator->getMaxFontSize());

test/ItemTest.php

@@ -9,6 +9,7 @@
 
 namespace ZendTest\Tag;
 
+use ArrayObject;
 use Zend\Tag;
 
 /**
@@ -108,9 +109,14 @@ public function testMissingWeight()
         $tag = new Tag\Item(['title' => 'foo']);
     }
 
+    /**
+     * This test uses ArrayObject, which will have essentially the
+     * same behavior as Zend\Config\Config; the code is looking only
+     * for a Traversable.
+     */
     public function testConfigOptions()
     {
-        $tag = new Tag\Item(new \Zend\Config\Config(['title' => 'foo', 'weight' => 1]));
+        $tag = new Tag\Item(new ArrayObject(['title' => 'foo', 'weight' => 1]));
 
         $this->assertEquals($tag->getTitle(), 'foo');
         $this->assertEquals($tag->getWeight(), 1);