Merge pull request #139 from wandersonwhcr/hotfix/87

Deprecate Attribs and Proxy to Attributes

Author: weierophinney

composer.json

@@ -70,6 +70,9 @@
         }
     },
     "autoload-dev": {
+        "files": [
+            "test/autoload.php"
+        ],
         "psr-4": {
             "ZendTest\\View\\": "test/"
         }

phpunit.xml.dist

@@ -23,6 +23,8 @@
 
     <php>
         <ini name="date.timezone" value="UTC"/>
+        <ini name="error_reporting" value="E_ALL"/>
+        <ini name="max_execution_time" value="360"/>
 
         <!-- OB_ENABLED should be enabled for some tests to check if all
              functionality works as expected. Such tests include those for

src/Helper/Gravatar.php

@@ -47,7 +47,7 @@ class Gravatar extends AbstractHtmlElement
      *
      * @var array
      */
-    protected $attribs;
+    protected $attributes;
 
     /**
      * Email Address
@@ -86,21 +86,21 @@ class Gravatar extends AbstractHtmlElement
      *
      * @see    http://pl.gravatar.com/site/implement/url
      * @see    http://pl.gravatar.com/site/implement/url More information about gravatar's service.
-     * @param  string|null $email   Email address.
-     * @param  null|array  $options Options
-     * @param  array       $attribs Attributes for image tag (title, alt etc.)
+     * @param  string|null $email      Email address.
+     * @param  null|array  $options    Options
+     * @param  array       $attributes Attributes for image tag (title, alt etc.)
      * @return Gravatar
      */
-    public function __invoke($email = "", $options = [], $attribs = [])
+    public function __invoke($email = "", $options = [], $attributes = [])
     {
         if (! empty($email)) {
             $this->setEmail($email);
         }
         if (! empty($options)) {
             $this->setOptions($options);
         }
-        if (! empty($attribs)) {
-            $this->setAttribs($attribs);
+        if (! empty($attributes)) {
+            $this->setAttributes($attributes);
         }
 
         return $this;
@@ -168,28 +168,63 @@ public function getImgTag()
     {
         $this->setSrcAttribForImg();
         $html = '<img'
-            . $this->htmlAttribs($this->getAttribs())
+            . $this->htmlAttribs($this->getAttributes())
             . $this->getClosingBracket();
 
         return $html;
     }
 
     /**
-     * Set attribs for image tag
+     * Set attributes for image tag
      *
-     * Warning! You shouldn't set src attrib for image tag.
-     * This attrib is overwritten in protected method setSrcAttribForImg().
+     * Warning! You shouldn't set src attribute for image tag.
+     * This attribute is overwritten in protected method setSrcAttribForImg().
      * This method(_setSrcAttribForImg) is called in public method getImgTag().
      *
+     * @param  array $attributes
+     * @return Gravatar
+     */
+    public function setAttributes(array $attributes)
+    {
+        $this->attributes = $attributes;
+        return $this;
+    }
+
+    /**
+     * Set attribs for image tag
+     *
      * @param  array $attribs
      * @return Gravatar
+     *
+     * @deprecated Please use Zend\View\Helper\Gravatar::setAttributes
      */
     public function setAttribs(array $attribs)
     {
-        $this->attribs = $attribs;
+        trigger_error(sprintf(
+            '%s is deprecated; please use %s::setAttributes',
+            __METHOD__,
+            __CLASS__
+        ), E_USER_DEPRECATED);
+
+        $this->setAttributes($attribs);
         return $this;
     }
 
+    /**
+     * Get attributes of image
+     *
+     * Warning!
+     * If you set src attribute, you get it, but this value will be overwritten in
+     * protected method setSrcAttribForImg(). And finally your get other src
+     * value!
+     *
+     * @return array
+     */
+    public function getAttributes()
+    {
+        return $this->attributes;
+    }
+
     /**
      * Get attribs of image
      *
@@ -199,10 +234,18 @@ public function setAttribs(array $attribs)
      * value!
      *
      * @return array
+     *
+     * @deprecated Please use Zend\View\Helper\Gravatar::getAttributes
      */
     public function getAttribs()
     {
-        return $this->attribs;
+        trigger_error(sprintf(
+            '%s is deprecated; please use %s::getAttributes',
+            __METHOD__,
+            __CLASS__
+        ), E_USER_DEPRECATED);
+
+        return $this->getAttributes();
     }
 
     /**
@@ -352,8 +395,8 @@ public function getSecure()
      */
     protected function setSrcAttribForImg()
     {
-        $attribs        = $this->getAttribs();
-        $attribs['src'] = $this->getAvatarUrl();
-        $this->setAttribs($attribs);
+        $attributes        = $this->getAttributes();
+        $attributes['src'] = $this->getAvatarUrl();
+        $this->setAttributes($attributes);
     }
 }

test/Helper/GravatarTest.php

@@ -9,10 +9,12 @@
 
 namespace ZendTest\View\Helper;
 
+use PHPUnit\Framework\Error\Deprecated as DeprecatedError;
 use PHPUnit\Framework\TestCase;
+use ReflectionMethod;
 use Zend\View\Exception;
-use Zend\View\Renderer\PhpRenderer as View;
 use Zend\View\Helper\Gravatar;
+use Zend\View\Renderer\PhpRenderer as View;
 
 /**
  * @group      Zendview
@@ -85,17 +87,17 @@ public function testGravatarHtmlDoctype()
      */
     public function testGetAndSetMethods()
     {
-        $attribs = ['class' => 'gravatar', 'title' => 'avatar', 'id' => 'gravatar-1'];
+        $attributes = ['class' => 'gravatar', 'title' => 'avatar', 'id' => 'gravatar-1'];
         $this->helper->setDefaultImg('monsterid')
                      ->setImgSize(150)
                      ->setSecure(true)
                      ->setEmail("[email protected]")
-                     ->setAttribs($attribs)
+                     ->setAttributes($attributes)
                      ->setRating('pg');
         $this->assertEquals("monsterid", $this->helper->getDefaultImg());
         $this->assertEquals("pg", $this->helper->getRating());
         $this->assertEquals("[email protected]", $this->helper->getEmail());
-        $this->assertEquals($attribs, $this->helper->getAttribs());
+        $this->assertEquals($attributes, $this->helper->getAttributes());
         $this->assertEquals(150, $this->helper->getImgSize());
         $this->assertTrue($this->helper->getSecure());
     }
@@ -164,9 +166,9 @@ public function testHttpsSource()
     }
 
     /**
-     * Test HTML attribs
+     * Test HTML attributes
      */
-    public function testImgAttribs()
+    public function testImgAttributes()
     {
         $this->assertRegExp(
             '/class="gravatar" title="Gravatar"/',
@@ -233,11 +235,11 @@ public function testAutoDetectLocationOnIis()
         );
     }
 
-    public function testSetAttribsWithSrcKey()
+    public function testSetAttributesWithSrcKey()
     {
         $email = '[email protected]';
         $this->helper->setEmail($email);
-        $this->helper->setAttribs([
+        $this->helper->setAttributes([
             'class' => 'gravatar',
             'src'   => 'http://example.com',
             'id'    => 'gravatarID',
@@ -285,4 +287,34 @@ public function testEmailIsProperlyNormalized()
             $this->helper->__invoke('[email protected] ')->getEmail()
         );
     }
+
+    public function testSetAttribsIsDeprecated()
+    {
+        $this->expectException(DeprecatedError::class);
+
+        $this->helper->setAttribs([]);
+    }
+
+    public function testSetAttribsDocCommentHasDeprecated()
+    {
+        $method  = new ReflectionMethod($this->helper, 'setAttribs');
+        $comment = $method->getDocComment();
+
+        $this->assertContains('@deprecated', $comment);
+    }
+
+    public function testGetAttribsIsDeprecated()
+    {
+        $this->expectException(DeprecatedError::class);
+
+        $this->helper->getAttribs();
+    }
+
+    public function testGetAttribsDocCommentHasDeprecated()
+    {
+        $method  = new ReflectionMethod($this->helper, 'getAttribs');
+        $comment = $method->getDocComment();
+
+        $this->assertContains('@deprecated', $comment);
+    }
 }

test/autoload.php

@@ -0,0 +1,11 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-view for the canonical source repository
+ * @copyright Copyright (c) 2017 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   https://github.com/zendframework/zend-view/blob/master/LICENSE.md New BSD License
+ */
+
+if (class_exists(PHPUnit_Framework_Error_Deprecated::class)
+    && ! class_exists(PHPUnit\Framework\Error\Deprecated::class)) {
+    class_alias(PHPUnit_Framework_Error_Deprecated::class, PHPUnit\Framework\Error\Deprecated::class);
+}