Merge pull request #194 from Brindster/feature-add-attributes

Allow additions to view helper valid attributes

Conflicts:
	src/View/Helper/AbstractHelper.php

Author: weierophinney

src/View/Helper/AbstractHelper.php

@@ -9,6 +9,7 @@
 
 use Zend\Escaper\Exception\RuntimeException as EscaperException;
 use Zend\Form\ElementInterface;
+use Zend\Form\Exception\InvalidArgumentException;
 use Zend\I18n\View\Helper\AbstractTranslatorHelper as BaseAbstractHelper;
 use Zend\View\Helper\Doctype;
 use Zend\View\Helper\EscapeHtml;
@@ -160,6 +161,17 @@ abstract class AbstractHelper extends BaseAbstractHelper
         'xml:space'          => true,
     ];
 
+    /**
+     * Attribute prefixes valid for all tags
+     *
+     * @var array
+     */
+    protected $validTagAttributePrefixes = [
+        'data-',
+        'aria-',
+        'x-',
+    ];
+
     /**
      * Attributes valid for the tag represented by this helper
      *
@@ -375,11 +387,8 @@ protected function prepareAttributes(array $attributes)
 
             if (! isset($this->validGlobalAttributes[$attribute])
                 && ! isset($this->validTagAttributes[$attribute])
-                && 0 !== strpos($attribute, 'data-')
-                && 0 !== strpos($attribute, 'aria-')
-                && 0 !== strpos($attribute, 'x-')
+                && ! $this->hasAllowedPrefix($attribute)
             ) {
-                // Invalid attribute for the current tag
                 unset($attributes[$key]);
                 continue;
             }
@@ -455,6 +464,40 @@ protected function translateHtmlAttributeValue($key, $value)
         return $value;
     }
 
+    /**
+     * Adds an HTML attribute to the list of valid attributes
+     *
+     * @param string $attribute
+     *
+     * @return AbstractHelper
+     */
+    public function addValidAttribute($attribute)
+    {
+        if (! $this->isValidAttributeName($attribute)) {
+            throw new InvalidArgumentException(sprintf('%s is not a valid attribute name', $attribute));
+        }
+
+        $this->validTagAttributes[$attribute] = true;
+        return $this;
+    }
+
+    /**
+     * Adds a prefix to the list of valid attribute prefixes
+     *
+     * @param string $prefix
+     *
+     * @return AbstractHelper
+     */
+    public function addValidAttributePrefix($prefix)
+    {
+        if (! $this->isValidAttributeName($prefix)) {
+            throw new InvalidArgumentException(sprintf('%s is not a valid attribute prefix', $prefix));
+        }
+
+        $this->validTagAttributePrefixes[] = $prefix;
+        return $this;
+    }
+
     /**
      * Adds an HTML attribute to the list of translatable attributes
      *
@@ -502,4 +545,34 @@ public static function addDefaultTranslatableAttributePrefix($prefix)
     {
         self::$defaultTranslatableHtmlAttributePrefixes[] = $prefix;
     }
+
+    /**
+     * Whether the passed attribute is valid or not
+     *
+     * @see https://html.spec.whatwg.org/multipage/syntax.html#attributes-2  Description of valid attributes
+     *
+     * @param  string  $attribute
+     *
+     * @return bool
+     */
+    protected function isValidAttributeName($attribute)
+    {
+        return preg_match('/^[^\t\n\f \/>"\'=]+$/', $attribute);
+    }
+
+    /**
+     * Whether the passed attribute has a valid prefix or not
+     * @param  string  $attribute
+     * @return bool
+     */
+    protected function hasAllowedPrefix($attribute)
+    {
+        foreach ($this->validTagAttributePrefixes as $prefix) {
+            if (substr($attribute, 0, strlen($prefix)) === $prefix) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }

test/View/Helper/AbstractHelperTest.php

@@ -10,6 +10,7 @@
 namespace ZendTest\Form\View\Helper;
 
 use Zend\Escaper\Escaper;
+use Zend\Form\Exception\InvalidArgumentException;
 use Zend\Form\View\Helper\AbstractHelper;
 use Zend\I18n\Translator\Translator;
 
@@ -60,6 +61,77 @@ public function testWillNotEncodeValueAttributeValuesCorrectly()
         );
     }
 
+    public function addAttributesData()
+    {
+        return [
+            [ 'valid', 'valid="value"' ],
+            [ 'px-custom', 'px-custom="value"' ],
+            [ 'xlink:custom', 'xlink:custom="value"' ],
+            [ 'attr/', null, true ],
+            [ 'attr"', null, true ],
+            [ 'attr\'', null, true ],
+            [ 'attr>', null, true ],
+            [ 'attr=value', null, true ],
+            [ 'at tr', null, true ],
+            [ "at\ntr", null, true ],
+            [ "at\ttr", null, true ],
+            [ "at\ftr", null, true ],
+        ];
+    }
+
+    /**
+     * @dataProvider addAttributesData
+     */
+    public function testWillIncludeAdditionalAttributes($attribute, $expected = null, $exception = null)
+    {
+        if ($exception) {
+            $this->expectException(InvalidArgumentException::class);
+        }
+
+        $this->helper->addValidAttribute($attribute);
+
+        $this->assertSame(
+            $expected,
+            $this->helper->createAttributesString([$attribute => 'value'])
+        );
+    }
+
+    public function addAttributesPrefixData()
+    {
+        return [
+            [ 'v-', 'v-attr="value"' ],
+            [ 'custom-', 'custom-attr="value"' ],
+            [ 'xlink:', 'xlink:attr="value"' ],
+            [ 'abc', 'abcattr="value"' ],
+            [ 'custom/', null, true ],
+            [ 'custom"', null, true ],
+            [ 'custom\'', null, true ],
+            [ 'custom>', null, true ],
+            [ 'custom=', null, true ],
+            [ 'custom ', null, true ],
+            [ "cus\ntom", null, true ],
+            [ "cus\ttom", null, true ],
+            [ "cus\ftom", null, true ],
+        ];
+    }
+
+    /**
+     * @dataProvider addAttributesPrefixData
+     */
+    public function testWillIncludeAdditionalAttributesByPrefix($prefix, $expected = null, $exception = null)
+    {
+        if ($exception) {
+            $this->expectException(InvalidArgumentException::class);
+        }
+
+        $this->helper->addValidAttributePrefix($prefix);
+
+        $this->assertSame(
+            $expected,
+            $this->helper->createAttributesString([$prefix . 'attr' => 'value'])
+        );
+    }
+
     public function testWillTranslateAttributeValuesCorrectly()
     {
         $translator = self::getMockBuilder(Translator::class)