eliseuamaro/gnu-social
1
0
Fork 0
forked from GNUsocial/gnu-social
Code Issues Pull Requests Releases Wiki Activity

[TWIG] Moves the SVG custom function to an extension and change the test regex

Browse Source
This commit is contained in:
Angelo D. Moura
2020-12-02 14:44:04 +00:00
committed by Hugo Sales
parent d2208d15d8
commit d53fef09a8
2 changed files with 3 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
src/Twig/IconsExtension.php
View File

@@ -1,78 +0,0 @@
<?php
// {{{ License
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
// }}}
/**
* GNU social Twig extensions
*
* @package GNUsocial
* @category Twig
*
* @author Ângelo D. Moura <up201303828@fe.up.pt>
* @copyright 2020 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
namespace App\Twig;
use Twig\Environment;
use Twig\Error\LoaderError;
use Twig\Error\RuntimeError;
use Twig\Error\SyntaxError;
use Twig\Extension\AbstractExtension;
use Twig\TwigFunction;
class IconsExtension extends AbstractExtension
{
public function getFunctions()
{
return [
new TwigFunction('icon',
[$this, 'embedSvgIcon'],
['needs_environment' => true]
),
];
}
/**
* Renders the Svg Icon template and returns it.
*
* @param Environment $twig
* @param string $icon_name
* @param string $icon_css_class
*
* @return string
*
* @author Ângelo D. Moura <up201303828@fe.up.pt>
*/
public function embedSvgIcon(Environment $twig, string $icon_name = '', string $icon_css_class = '')
{
try {
return $twig->render('@public_path/assets/icons/' . $icon_name . '.svg.twig', ['iconClass' => $icon_css_class]);
} catch (LoaderError $e) {
//return an empty string (a missing icon is not that important of an error)
return '';
} catch (RuntimeError $e) {
//return an empty string (a missing icon is not that important of an error)
return '';
} catch (SyntaxError $e) {
//return an empty string (a missing icon is not that important of an error)
return '';
}
}
}

6
tests/Twig/IconsExtensionTest.php → tests/Twig/ExtensionTest.php
View File

@@ -36,7 +36,7 @@ use App\Twig\Runtime;
use DirectoryIterator; use DirectoryIterator;
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase; use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
class IconsExtensionTest extends KernelTestCase class ExtensionTest extends KernelTestCase
{ {
public function testIconsExtension() public function testIconsExtension()
{ {
@@ -51,7 +51,7 @@ class IconsExtensionTest extends KernelTestCase
//Check if every icon file as a ".svg.twig" extension //Check if every icon file as a ".svg.twig" extension
foreach ($icon_file_names as $icon_file_name) { foreach ($icon_file_names as $icon_file_name) {
static::assertRegExp('#([a-zA-Z0-9\s_\\.\-\(\):])+(.svg.twig)$#', $icon_file_name); static::assertRegExp('/.svg.twig/', $icon_file_name);
} }
//Check if the function gives a valid HTML with a class attribute equal to the one passed //Check if the function gives a valid HTML with a class attribute equal to the one passed
@@ -63,7 +63,7 @@ class IconsExtensionTest extends KernelTestCase
$icon_template_render = $twig->render('@public_path/assets/icons/' . $icon_file_name, ['iconClass' => 'icon icon-' . $icon_name]); $icon_template_render = $twig->render('@public_path/assets/icons/' . $icon_file_name, ['iconClass' => 'icon icon-' . $icon_name]);
$icons_extension = new IconsExtension(); $icons_extension = new Extension();
$icon_extension_render = $icons_extension->embedSvgIcon($twig, $icon_name, 'icon icon-' . $icon_name); $icon_extension_render = $icons_extension->embedSvgIcon($twig, $icon_name, 'icon icon-' . $icon_name);
static::assertSame($icon_template_render, $icon_extension_render); static::assertSame($icon_template_render, $icon_extension_render);