Update travis, bootstrap test and fix injection in easy-icon from master.

Holt59 · Holt59 · commit 526c72b80a22 · 2019-04-01T21:52:50.000+02:00
diff --git a/.travis.yml b/.travis.yml
@@ -9,7 +9,7 @@ php:
 dist: trusty
 
 env:
-  - CAKEPHP_VERSION=3.7.* DEFAULT=1
+  - CAKEPHP_VERSION=3.7.*
 
 matrix:
   include:
@@ -57,11 +57,11 @@ before_install:
 install: composer update --prefer-dist --no-interaction
 
 script:
-  - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION = 7.0 ]]; then export CODECOVERAGE=1; vendor/bin/phpunit --coverage-clover=clover.xml; fi
-  - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION != 7.0 ]]; then vendor/bin/phpunit; fi
+  - if [[ $TRAVIS_PHP_VERSION = 7.0 ]]; then export CODECOVERAGE=1; vendor/bin/phpunit --coverage-clover=clover.xml; fi
+  - if [[ $TRAVIS_PHP_VERSION != 7.0 ]]; then vendor/bin/phpunit; fi
 
 after_success:
-  - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION = 7.0 ]]; then bash <(curl -s https://codecov.io/bash); fi
+  - if [[ $TRAVIS_PHP_VERSION = 7.0 ]]; then bash <(curl -s https://codecov.io/bash); fi
 
 notifications:
   email: true
diff --git a/src/View/Helper/EasyIconTrait.php b/src/View/Helper/EasyIconTrait.php
@@ -27,6 +27,24 @@ trait EasyIconTrait {
      */
     public $easyIcon = true;
 
+    /**
+     * Remove the `easyIcon` option from the given array and return it together with
+     * the array.
+     * 
+     * @param array $options Array of options from which the easy-icon option should
+     * be extracted.
+     * 
+     * @return array An array containing the options and the easy-icon option.
+     */
+    protected function _easyIconOption(array $options) {
+        $options += [
+            'easyIcon' => $this->easyIcon
+        ];
+        $easyIcon = $options['easyIcon'];
+        unset($options['easyIcon']);
+        return [$options, $easyIcon];
+    }
+
     /**
      * Try to convert the specified string to a bootstrap icon. The string is converted if
      * it matches a format `i:icon-name` (leading and trailing spaces or ignored) and if
@@ -41,7 +59,7 @@ trait EasyIconTrait {
      *
      * @return string The text after conversion.
      */
-    protected function _makeIcon($text, &$converted = false, $options = []) {
+    protected function _makeIcon($text, &$converted = false) {
         $converted = false;
 
         // If easyIcon mode is disable.
@@ -64,43 +82,26 @@ protected function _makeIcon($text, &$converted = false, $options = []) {
 
         // Replace occurences.
         $text = preg_replace_callback(
-            '#(^|\s+)i:([a-zA-Z0-9\\-_]+)(\s+|$)#', function ($matches) use ($ficon, $options) {
-                return $matches[1].call_user_func($ficon, $matches[2], $options).$matches[3];
+            '#(^|[>\s]\s*)i:([a-zA-Z0-9\\-_]+)(\s*[\s<]|$)#', function ($matches) use ($ficon) {
+                return $matches[1].call_user_func($ficon, $matches[2]).$matches[3];
             }, $text, -1, $count);
         $converted = (bool)$count;
         return $text;
     }
 
     /**
-     * This method calls the given callback with the given list of parameters after
-     * applying an easy-icon filter on them.
-     *
-     * Note: For compatibility issue, this function can still be called with a callback,
-     * a string (title) and an array of options.
-     *
-     * @param callable $callback The callback.
-     * @param int $indexTitle Index of the title to which the easy-icon processing
-     * will be applied.
-     * @param int $indexOptions Index of the options in the $args array.
-     * @param array $args Arguments for the callback.
-     *
-     * @return mixed Whatever might be returned by $callback.
+     * Inject icon into the given string.
+     * 
+     * @param string $input Input string where icon should be injected following the
+     * easy-icon process.
+     * @param bool $easyIcon Boolean indicating if the easy-icon process should be
+     * applied.
      */
-    protected function _easyIcon(callable $callback, $indexTitle, $indexOptions, $args = null) {
-        if ($args === null) {
-            $args = [$indexTitle, $indexOptions];
-            $indexTitle = 0;
-            $indexOptions = 1;
-        }
-        $title = &$args[$indexTitle];
-        $options = &$args[$indexOptions];
-        $title = $this->_makeIcon($title, $converted);
-        if ($converted) {
-            $options += [
-                'escape' => false
-            ];
+    protected function _injectIcon($title, $easyIcon) {
+        if (!$easyIcon) {
+            return $title;
         }
-        return call_user_func_array($callback, $args);
+        return $this->_makeIcon($title);
     }
 
 }
diff --git a/src/View/Helper/FormHelper.php b/src/View/Helper/FormHelper.php
@@ -592,8 +592,8 @@ public function file($fieldName, array $options = []) {
      * @link http://book.cakephp.org/3.0/en/views/helpers/form.html#creating-button-elements
      */
     public function button($title, array $options = []) {
-        return $this->_easyIcon('parent::button', $title,
-                                $this->_addButtonClasses($options));
+        list($options, $easyIcon) = $this->_easyIconOption($options);
+        return $this->_injectIcon(parent::button($title, $this->_addButtonClasses($options)), $easyIcon);
     }
 
     /**
diff --git a/src/View/Helper/HtmlHelper.php b/src/View/Helper/HtmlHelper.php
@@ -139,7 +139,8 @@ public function icon($icon, array $options = []) {
      * {@inheritDoc}
      */
     public function link($title, $url = null, array $options = []) {
-        return $this->_easyIcon('parent::link', 0, 2, [$title, $url, $options]);
+        list($options, $easyIcon) = $this->_easyIconOption($options);
+        return $this->_injectIcon(parent::link($title, $url, $options), $easyIcon);
     }
 
     /**
diff --git a/src/View/Helper/PaginatorHelper.php b/src/View/Helper/PaginatorHelper.php
@@ -275,7 +275,8 @@ public function numbers(array $options = []) {
      * @link http://book.cakephp.org/3.0/en/views/helpers/paginator.html#creating-jump-links
      */
     public function prev($title = '<< Previous', array $options = []) {
-        return $this->_easyIcon('parent::prev', $title, $options);
+        list($options, $easyIcon) = $this->_easyIconOption($options);
+        return $this->_injectIcon(parent::prev($title, $options), $easyIcon);
     }
 
     /**
@@ -301,7 +302,8 @@ public function prev($title = '<< Previous', array $options = []) {
      * @link http://book.cakephp.org/3.0/en/views/helpers/paginator.html#creating-jump-links
      */
     public function next($title = 'Next >>', array $options = []) {
-        return $this->_easyIcon('parent::next', $title, $options);
+        list($options, $easyIcon) = $this->_easyIconOption($options);
+        return $this->_injectIcon(parent::next($title, $options), $easyIcon);
     }
 
     /**
@@ -336,7 +338,8 @@ public function next($title = 'Next >>', array $options = []) {
      * @link http://book.cakephp.org/3.0/en/views/helpers/paginator.html#creating-jump-links
      */
     public function first($first = '<< first', array $options = []) {
-        return $this->_easyIcon('parent::first', $first, $options);
+        list($options, $easyIcon) = $this->_easyIconOption($options);
+        return $this->_injectIcon(parent::first($first, $options), $easyIcon);
     }
 
     /**
@@ -371,7 +374,8 @@ public function first($first = '<< first', array $options = []) {
      * @link http://book.cakephp.org/3.0/en/views/helpers/paginator.html#creating-jump-links
      */
     public function last($last = 'last >>', array $options = []) {
-        return $this->_easyIcon('parent::last', $last, $options);
+        list($options, $easyIcon) = $this->_easyIconOption($options);
+        return $this->_injectIcon(parent::last($last, $options), $easyIcon);
     }
 
 }
diff --git a/tests/TestCase/View/Helper/EasyIconTraitTest.php b/tests/TestCase/View/Helper/EasyIconTraitTest.php
@@ -17,8 +17,8 @@ public function __construct($view) {
         $this->Html = new HtmlHelper($view);
     }
 
-    public function publicEasyIcon($callback, $title, $options) {
-        return $this->_easyIcon($callback, $title, $options);
+    public function publicMakeIcon($title, &$converted) {
+        return $this->_makeIcon($title, $converted);
     }
 
 };
@@ -71,58 +71,33 @@ public function setUp() {
     }
 
     public function testEasyIcon() {
+        $converted = false;
 
-        $that = $this;
-        $callback = function($text, $options) use($that) {
-            $that->assertEquals(isset($options['escape']) ? $options['escape'] : true,
-                                $options['expected']['escape']);
-            $that->assertHtml($options['expected']['result'], $text);
-        };
-
-        $this->trait->publicEasyIcon($callback, 'i:plus', [
-            'expected' => [
-                'escape' => false,
-                'result' => [['i' => [
-                    'class' => 'fa fa-plus',
-                    'aria-hidden' => 'true'
-                ]], '/i']
-            ]
-        ]);
+        $this->assertHtml(
+            [['i' => [
+                'class' => 'fa fa-plus',
+                'aria-hidden' => 'true'
+            ]], '/i'], $this->trait->publicMakeIcon('i:plus', $converted));
+        $this->assertTrue($converted);
 
-        $this->trait->publicEasyIcon($callback, 'Click Me!', [
-            'expected' => [
-                'escape' => true,
-                'result' => 'Click Me!'
-            ]
-        ]);
+        $this->assertHtml(['Click Me!'], $this->trait->publicMakeIcon('Click Me!', $converted));
+        $this->assertFalse($converted);
 
-        $this->trait->publicEasyIcon($callback, 'i:plus Add', [
-            'expected' => [
-                'escape' => false,
-                'result' => [['i' => [
-                    'class' => 'fa fa-plus',
-                    'aria-hidden' => 'true'
-                ]], '/i', ' Add']
-            ]
-        ]);
+        $this->assertHtml([['i' => [
+                'class' => 'fa fa-plus',
+                'aria-hidden' => 'true'
+            ]], '/i', ' Add'], $this->trait->publicMakeIcon('i:plus Add', $converted));
+        $this->assertTrue($converted);
 
-        $this->trait->publicEasyIcon($callback, 'Add i:plus', [
-            'expected' => [
-                'escape' => false,
-                'result' => ['Add ', ['i' => [
-                    'class' => 'fa fa-plus',
-                    'aria-hidden' => 'true'
-                ]], '/i']
-            ]
-        ]);
+        $this->assertHtml(['Add ', ['i' => [
+            'class' => 'fa fa-plus',
+            'aria-hidden' => 'true'
+        ]], '/i'], $this->trait->publicMakeIcon('Add i:plus', $converted));
+        $this->assertTrue($converted);
 
         $this->trait->easyIcon = false;
-        $this->trait->publicEasyIcon($callback, 'i:plus', [
-            'expected' => [
-                'escape' => true,
-                'result' => 'i:plus'
-            ]
-        ]);
+        $this->assertHtml(['Add i:plus'], $this->trait->publicMakeIcon('Add i:plus', $converted));
+        $this->assertFalse($converted);
     }
 
     public function testHtmlHelperMethods() {
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -64,5 +64,3 @@
 Configure::write('debug', true);
 
 ini_set('intl.default_locale', 'en_US');
-
-Plugin::load('Search', ['path' => ROOT]);

Original file line number	Diff line number	Diff line change
`@@ -139,7 +139,8 @@ public function icon($icon, array $options = []) {`
`139`	`139`	`* {@inheritDoc}`
`140`	`140`	`*/`
`141`	`141`	`public function link($title, $url = null, array $options = []) {`
`142`		`- return $this->_easyIcon('parent::link', 0, 2, [$title, $url, $options]);`
	`142`	`+ list($options, $easyIcon) = $this->_easyIconOption($options);`
	`143`	`+ return $this->_injectIcon(parent::link($title, $url, $options), $easyIcon);`
`143`	`144`	`}`
`144`	`145`
`145`	`146`	`/**`