Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions everblocklight.php
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,8 @@ private function getCustomHooks(): array
['displayAfterLocatorStore', 'display after store content on store locator', 'This hook triggers after store content on store locator'],
['displayBeforeProductMiniature', 'display before product miniature', 'This hook triggers before product miniature is rendered'],
['displayAfterProductMiniature', 'display after product miniature', 'This hook triggers after product miniature is rendered'],
['actionBeforeEverblocklightShortcodeDocumentation', 'Before Ever Block Light shortcode documentation', 'Lets modules add shortcode documentation groups displayed before the module ones (params: translator, domain, &docs)'],
['actionAfterEverblocklightShortcodeDocumentation', 'After Ever Block Light shortcode documentation', 'Lets modules add or alter shortcode documentation groups after the module ones (params: translator, domain, &docs)'],
];
}

Expand Down
20 changes: 19 additions & 1 deletion src/Service/ShortcodeDocumentationProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,16 @@ public static function getDocumentation(Module $module): array
$translator = $context->getTranslator();
$domain = 'Modules.Everblocklight.Shortcodes';

$docs = [
// Groupes ajoutés par d'autres modules, affichés avant ceux d'Ever Block Light
$docs = [];

\Hook::exec('actionBeforeEverblocklightShortcodeDocumentation', [
'translator' => $translator,
'domain' => $domain,
'docs' => &$docs,
]);

$docsCore = [
[
'title' => $translator->trans('Catalog & merchandising', [], $domain),
'entries' => [
Expand Down Expand Up @@ -861,7 +870,16 @@ public static function getDocumentation(Module $module): array
],
],
];
$docs = array_merge($docs, $docsCore);

// Derniers ajouts / modifications par d'autres modules (groupes affichés après ceux du module)
\Hook::exec('actionAfterEverblocklightShortcodeDocumentation', [
'translator' => $translator,
'domain' => $domain,
'docs' => &$docs,
]);

// Mise en cache après les deux hooks : les appels suivants renvoient la même documentation
static::$cache[$idLang] = $docs;

return $docs;
Expand Down
80 changes: 80 additions & 0 deletions tests/Unit/ShortcodeDocumentationTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<?php

declare(strict_types=1);

namespace Everblocklight\Tests\Unit;

use Everblocklight\Tools\Service\ShortcodeDocumentationProvider;
use ReflectionProperty;

final class ShortcodeDocumentationTest extends TestCase
{
protected function setUp(): void
{
parent::setUp();
(new ReflectionProperty(ShortcodeDocumentationProvider::class, 'cache'))->setValue(null, []);
\Context::getContext()->language = (object) ['id' => 1];
}

/**
* @return array<int, string>
*/
private static function codes(array $docs): array
{
$codes = [];
foreach ($docs as $group) {
foreach ($group['entries'] ?? [] as $entry) {
$codes[] = (string) ($entry['code'] ?? '');
}
}

return $codes;
}

private static function titles(array $docs): array
{
return array_map(static fn (array $group): string => (string) ($group['title'] ?? ''), $docs);
}

public function testCoreDocumentationListsModuleShortcodes(): void
{
$codes = self::codes(ShortcodeDocumentationProvider::getDocumentation(new \Module()));

self::assertContains('[cart_total]', $codes);
self::assertContains('[alert type="success"]Content[/alert]', $codes);
foreach ($codes as $code) {
self::assertDoesNotMatchRegularExpression('/everinstagram|wordpress-posts|everfaq|everorderform/', $code, 'Shortcode retiré documenté');
}
}

public function testExternalModulesCanAddGroupsBeforeAndAfter(): void
{
\Hook::$listeners['actionBeforeEverblocklightShortcodeDocumentation'][] = static function (array $params): void {
$params['docs'][] = ['title' => 'Avant', 'entries' => [['code' => '[before_sc]']]];
};
\Hook::$listeners['actionAfterEverblocklightShortcodeDocumentation'][] = static function (array $params): void {
$params['docs'][] = ['title' => 'Après ' . $params['domain'], 'entries' => [['code' => '[after_sc]']]];
};

$titles = self::titles(ShortcodeDocumentationProvider::getDocumentation(new \Module()));

self::assertSame('Avant', $titles[0], 'Le hook Before ajoute ses groupes avant ceux du module');
self::assertSame('Après Modules.Everblocklight.Shortcodes', end($titles), 'Le hook After ajoute ses groupes à la fin');
}

public function testCachedDocumentationKeepsHookAdditions(): void
{
$calls = 0;
\Hook::$listeners['actionAfterEverblocklightShortcodeDocumentation'][] = static function (array $params) use (&$calls): void {
++$calls;
$params['docs'][] = ['title' => 'Externe', 'entries' => [['code' => '[external_sc]']]];
};

$first = ShortcodeDocumentationProvider::getDocumentation(new \Module());
$second = ShortcodeDocumentationProvider::getDocumentation(new \Module());

self::assertSame(1, $calls, 'Deuxième appel servi depuis le cache');
self::assertContains('[external_sc]', self::codes($second), 'Le cache contient les ajouts du hook After');
self::assertSame($first, $second);
}
}
1 change: 1 addition & 0 deletions tests/Unit/TestCase.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ protected function setUp(): void
\Configuration::reset();
\Cache::reset();
\Context::reset();
\Hook::reset();
}

/**
Expand Down
40 changes: 40 additions & 0 deletions tests/stubs/prestashop.php
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,11 @@ class Context
public $language;
public $shop;

public function getTranslator(): TranslatorStub
{
return new TranslatorStub();
}

private static ?Context $instance = null;

public static function getContext(): Context
Expand All @@ -105,3 +110,38 @@ public static function reset(): void
self::$instance = null;
}
}

class Module
{
}

class Hook
{
/** @var array<string, array<int, callable>> */
public static array $listeners = [];

/**
* Les paramètres passés par référence (ex. 'docs' => &$docs) restent liés, comme dans le cœur.
*/
public static function exec($hookName, $hookArgs = [], $idModule = null, $arrayReturn = false)
{
foreach (self::$listeners[$hookName] ?? [] as $listener) {
$listener($hookArgs);
}

return '';
}

public static function reset(): void
{
self::$listeners = [];
}
}

class TranslatorStub
{
public function trans($id, array $parameters = [], $domain = null, $locale = null): string
{
return strtr((string) $id, $parameters);
}
}
Loading