Registered all namespaces in ModuleTemplateLoader class #9173
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| module1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| module2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| List from module 3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| module3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| <?php | ||
| /** | ||
| * 2007-2018 PrestaShop | ||
| * | ||
| * NOTICE OF LICENSE | ||
| * | ||
| * This source file is subject to the Open Software License (OSL 3.0) | ||
| * that is bundled with this package in the file LICENSE.txt. | ||
| * It is also available through the world-wide-web at this URL: | ||
| * https://opensource.org/licenses/OSL-3.0 | ||
| * If you did not receive a copy of the license and are unable to | ||
| * obtain it through the world-wide-web, please send an email | ||
| * to license@prestashop.com so we can send you a copy immediately. | ||
| * | ||
| * DISCLAIMER | ||
| * | ||
| * Do not edit or add to this file if you wish to upgrade PrestaShop to newer | ||
| * versions in the future. If you wish to customize PrestaShop for your | ||
| * needs please refer to http://www.prestashop.com for more information. | ||
| * | ||
| * @author PrestaShop SA <contact@prestashop.com> | ||
| * @copyright 2007-2018 PrestaShop SA | ||
| * @license https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0) | ||
| * International Registered Trademark & Property of PrestaShop SA | ||
| */ | ||
|
|
||
| namespace Tests\PrestaShopBundle\Twig\Locator; | ||
|
|
||
| use PrestaShopBundle\Twig\Locator\ModuleTemplateLoader; | ||
| use PHPUnit\Framework\TestCase; | ||
|
|
||
| /** | ||
| * @group sf | ||
| */ | ||
| class ModuleTemplateLoaderTest extends TestCase | ||
| { | ||
| /** | ||
| * @var TemplateModuleLoader | ||
| */ | ||
| private $loader; | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function setUp() | ||
| { | ||
| $namespaces = [ | ||
| 'Product' => 'Admin/Product', | ||
| 'PrestaShop' => '', | ||
| ]; | ||
|
|
||
| $paths = [ | ||
| __DIR__.'/../Fixtures/module1', | ||
| __DIR__.'/../Fixtures/module2', | ||
| __DIR__.'/../Fixtures/module3', | ||
| ]; | ||
|
|
||
| $rootPath = null; | ||
|
|
||
| $this->loader = new ModuleTemplateLoader($namespaces, $paths, $rootPath); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function tearDown() | ||
| { | ||
| $this->loader = null; | ||
| } | ||
|
|
||
| public function testGetPaths() | ||
| { | ||
| self::assertCount( | ||
| 2, | ||
| $this->loader->getPaths('Product'), | ||
| 'Two templates for the namespace "Product" should be found.' | ||
| ); | ||
|
|
||
| self::assertCount( | ||
| 3, | ||
| $this->loader->getPaths('PrestaShop'), | ||
| 'One templates should be found.'); | ||
| } | ||
|
|
||
| /** | ||
| * @dataProvider getSourceContextsProvider | ||
| * @param string $sourceContent The template file content. | ||
| * @param string $twigPathAsked The Twig path asked during Twig template rendering. | ||
| * @param string $successMessage In case of failure, describe what is expected. | ||
| */ | ||
| public function testGetSourceContext($sourceContent, $twigPathAsked, $successMessage) | ||
| { | ||
| self::assertEquals( | ||
| $sourceContent . PHP_EOL, | ||
| $this->loader->getSourceContext($twigPathAsked)->getCode(), | ||
| $successMessage | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * @return array | ||
| */ | ||
| public function getSourceContextsProvider() | ||
| { | ||
| return [ | ||
| ['module1', '@Product/test.html.twig', 'Module 1 wins as Module 3 is loaded after.'], | ||
| ['module1', '@PrestaShop/Admin/Product/test.html.twig', 'PrestaShop is the main namespace.'], | ||
| ['List from module 3', '@Product/ProductPage/Lists/list.html.twig', 'Module 3 templates are available.'], | ||
| ['module2', '@PrestaShop/test.html.twig', 'Module 2 templates are availables.'], | ||
| ]; | ||
| } | ||
|
|
||
| public function testEmptyConstructor() | ||
| { | ||
| $loader = new ModuleTemplateLoader([]); | ||
|
|
||
| self::assertEquals(array(), $loader->getPaths()); | ||
| } | ||
|
|
||
| /** | ||
| * @throws \Twig_Error_Loader | ||
| */ | ||
| public function testGetNamespaces() | ||
| { | ||
| $loader = new ModuleTemplateLoader([]); | ||
|
|
||
| self::assertEquals([], $loader->getNamespaces()); | ||
|
|
||
| $loader->addPath(sys_get_temp_dir(), 'named'); | ||
|
|
||
| self::assertEquals(['named'], $loader->getNamespaces()); | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not store this list elsewhere, like in a config or something?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's used just once, not sure it's necessary
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
because this won't be re-used.
At start, I wanted to re-use the paths used in framework configuration, but thinking about it it's not a good idea. The 'array' look like the same but they have really different purposes.
If we have another place/service when we want to re-use it, of course I'm also in favor of extracting it into a parameter.
Note you can access to all registered Twig paths and namespaces using
php bin/console debug:twigbut not us, cause of weird call of Legacy Context in a Twig extension. This is a really minor issue we should try to fix asap.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But we'll need to add new namespaces as we migrate new sections, won't we?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, so we will append new namespaces here.
But before I need to document which namespaces should be added as there is no real consistency actually: some templates use them, others don't, some namespace refers to a page, others to sections or even categories...
Once we will have consistency, I'm pretty sure we won't even need to configure an Array, but maybe loop into actual folders and declare namespaces dynamically ^^
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As long as it isn't done in runtime...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nope, it's converted in PHP function in container cache: I don't think we can make the process faster 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes everything setting in yml files are automatically converted in string / array in the cache file =)