Skip to content

Commit fa8ea08

Browse files
dermatzCopilot
andauthored
fix(theme-builder): make Hyva and TailwindCSS detection mutually exclusive (#289)
* fix(theme-builder): make Hyva and TailwindCSS detection mutually exclusive Both builders decided independently in detect(), so a theme with mixed Hyva signals (theme.xml vs. composer name) matched both and the result depended on the order in di.xml. Share the decision through a new HyvaThemeDetector and make TailwindCSS reject Hyva themes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(tests): avoid getStubBuilder and fix line length for CI Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * style(theme-builder): apply mago formatting to TailwindCSS builder Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 31d46be commit fa8ea08

7 files changed

Lines changed: 166 additions & 37 deletions

File tree

‎docs/custom_theme_builders.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,8 @@ After these steps, your custom ThemeBuilder will be available and integrated wit
208208

209209
This method is crucial as it determines whether your builder is responsible for a specific theme. Implement logic here that uniquely identifies your theme type.
210210

211+
`BuilderPool` uses the first builder whose `detect()` returns `true`, so detection must be mutually exclusive. If your builder overlaps with a built-in one, exclude its themes explicitly (the TailwindCSS builder, for example, rejects themes that `HyvaThemeDetector` identifies as Hyvä).
212+
211213
```php
212214
public function detect(string $themePath): bool
213215
{
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace OpenForgeProject\MageForge\Service\Hyva;
6+
7+
use Magento\Framework\Filesystem\Driver\File;
8+
9+
/**
10+
* Decides whether a theme directory belongs to a Hyvä theme
11+
*
12+
* Shared by the Hyvä and TailwindCSS builders so that their detection is mutually exclusive
13+
* regardless of the order they are registered in the builder pool.
14+
*/
15+
class HyvaThemeDetector
16+
{
17+
/**
18+
* @param File $fileDriver
19+
*/
20+
public function __construct(
21+
private readonly File $fileDriver,
22+
) {
23+
}
24+
25+
/**
26+
* Check theme.xml and composer.json for a Hyvä declaration
27+
*
28+
* @param string $themePath
29+
* @return bool
30+
*/
31+
public function isHyvaTheme(string $themePath): bool
32+
{
33+
$themePath = rtrim($themePath, '/');
34+
35+
if ($this->fileDriver->isExists($themePath . '/theme.xml')) {
36+
$themeXmlContent = $this->fileDriver->fileGetContents($themePath . '/theme.xml');
37+
if (stripos($themeXmlContent, 'hyva') !== false) {
38+
return true;
39+
}
40+
}
41+
42+
if ($this->fileDriver->isExists($themePath . '/composer.json')) {
43+
$composerContent = $this->fileDriver->fileGetContents($themePath . '/composer.json');
44+
$composerJson = json_decode($composerContent, true);
45+
$packageName = is_array($composerJson) ? $composerJson['name'] ?? null : null;
46+
if (is_string($packageName) && str_contains($packageName, 'hyva')) {
47+
return true;
48+
}
49+
}
50+
51+
return false;
52+
}
53+
}

‎src/Service/ThemeBuilder/HyvaThemes/Builder.php‎

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
use Magento\Framework\Filesystem\Driver\File;
88
use Magento\Framework\Shell;
99
use OpenForgeProject\MageForge\Service\CacheCleaner;
10+
use OpenForgeProject\MageForge\Service\Hyva\HyvaThemeDetector;
1011
use OpenForgeProject\MageForge\Service\NodePackageManager;
1112
use OpenForgeProject\MageForge\Service\StaticContentCleaner;
1213
use OpenForgeProject\MageForge\Service\StaticContentDeployer;
@@ -28,6 +29,7 @@ class Builder implements BuilderInterface
2829
* @param CacheCleaner $cacheCleaner
2930
* @param SymlinkCleaner $symlinkCleaner
3031
* @param NodePackageManager $nodePackageManager
32+
* @param HyvaThemeDetector $hyvaThemeDetector
3133
*/
3234
public function __construct(
3335
private readonly Shell $shell,
@@ -37,6 +39,7 @@ public function __construct(
3739
private readonly CacheCleaner $cacheCleaner,
3840
private readonly SymlinkCleaner $symlinkCleaner,
3941
private readonly NodePackageManager $nodePackageManager,
42+
private readonly HyvaThemeDetector $hyvaThemeDetector,
4043
) {
4144
}
4245

@@ -56,25 +59,7 @@ public function detect(string $themePath): bool
5659
return false;
5760
}
5861

59-
// Check theme.xml for Hyva theme declaration
60-
if ($this->fileDriver->isExists($themePath . '/theme.xml')) {
61-
$themeXmlContent = $this->fileDriver->fileGetContents($themePath . '/theme.xml');
62-
if (stripos($themeXmlContent, 'hyva') !== false) {
63-
return true;
64-
}
65-
}
66-
67-
// Check composer.json for Hyva module dependency
68-
if ($this->fileDriver->isExists($themePath . '/composer.json')) {
69-
$composerContent = $this->fileDriver->fileGetContents($themePath . '/composer.json');
70-
$composerJson = json_decode($composerContent, true);
71-
$packageName = is_array($composerJson) ? $composerJson['name'] ?? null : null;
72-
if (is_string($packageName) && str_contains($packageName, 'hyva')) {
73-
return true;
74-
}
75-
}
76-
77-
return false;
62+
return $this->hyvaThemeDetector->isHyvaTheme($themePath);
7863
}
7964

8065
/**

‎src/Service/ThemeBuilder/TailwindCSS/Builder.php‎

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
use Magento\Framework\Filesystem\Driver\File;
88
use Magento\Framework\Shell;
99
use OpenForgeProject\MageForge\Service\CacheCleaner;
10+
use OpenForgeProject\MageForge\Service\Hyva\HyvaThemeDetector;
1011
use OpenForgeProject\MageForge\Service\NodePackageManager;
1112
use OpenForgeProject\MageForge\Service\StaticContentCleaner;
1213
use OpenForgeProject\MageForge\Service\StaticContentDeployer;
@@ -28,6 +29,7 @@ class Builder implements BuilderInterface
2829
* @param CacheCleaner $cacheCleaner
2930
* @param SymlinkCleaner $symlinkCleaner
3031
* @param NodePackageManager $nodePackageManager
32+
* @param HyvaThemeDetector $hyvaThemeDetector
3133
*/
3234
public function __construct(
3335
private readonly Shell $shell,
@@ -37,6 +39,7 @@ public function __construct(
3739
private readonly CacheCleaner $cacheCleaner,
3840
private readonly SymlinkCleaner $symlinkCleaner,
3941
private readonly NodePackageManager $nodePackageManager,
42+
private readonly HyvaThemeDetector $hyvaThemeDetector,
4043
) {
4144
}
4245

@@ -56,25 +59,12 @@ public function detect(string $themePath): bool
5659
return false;
5760
}
5861

59-
// Check for theme.xml file in theme folder and ensure it's not a Hyva theme
60-
if ($this->fileDriver->isExists($themePath . '/theme.xml')) {
61-
$themeXmlContent = $this->fileDriver->fileGetContents($themePath . '/theme.xml');
62-
if (stripos($themeXmlContent, 'hyva') === false) {
63-
return true;
64-
}
65-
}
66-
67-
// Check for composer.json file in theme folder and ensure it's not a Hyva theme
68-
if ($this->fileDriver->isExists($themePath . '/composer.json')) {
69-
$composerContent = $this->fileDriver->fileGetContents($themePath . '/composer.json');
70-
$composerJson = json_decode($composerContent, true);
71-
$packageName = \is_array($composerJson) ? $composerJson['name'] ?? null : null;
72-
if (\is_string($packageName) && !str_contains($packageName, 'hyva')) {
73-
return true;
74-
}
75-
}
62+
// Must be a theme at all, and must not be claimed by the Hyva builder
63+
$hasThemeFile =
64+
$this->fileDriver->isExists($themePath . '/theme.xml')
65+
|| $this->fileDriver->isExists($themePath . '/composer.json');
7666

77-
return false;
67+
return $hasThemeFile && !$this->hyvaThemeDetector->isHyvaTheme($themePath);
7868
}
7969

8070
/**
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace OpenForgeProject\MageForge\Test\Unit\Service\Hyva;
6+
7+
use Magento\Framework\Filesystem\Driver\File;
8+
use OpenForgeProject\MageForge\Service\Hyva\HyvaThemeDetector;
9+
use PHPUnit\Framework\Attributes\DataProvider;
10+
use PHPUnit\Framework\TestCase;
11+
12+
class HyvaThemeDetectorTest extends TestCase
13+
{
14+
/**
15+
* @return array<string, array{0: string|null, 1: array<string, mixed>|null, 2: bool}>
16+
*/
17+
public static function themeFilesProvider(): array
18+
{
19+
return [
20+
'hyva in theme.xml' => ['<theme><parent>Hyva/default</parent></theme>', null, true],
21+
'hyva in theme.xml, other composer name' => [
22+
'<theme><parent>Hyva/default</parent></theme>',
23+
['name' => 'vendor/custom-theme'],
24+
true,
25+
],
26+
'neutral theme.xml, hyva composer name' => [
27+
'<theme><title>Custom</title></theme>',
28+
['name' => 'hyva-themes/theme-default'],
29+
true,
30+
],
31+
'neutral theme.xml and composer name' => [
32+
'<theme><title>Custom</title></theme>',
33+
['name' => 'vendor/custom-theme'],
34+
false,
35+
],
36+
'composer json without name' => [null, ['require' => []], false],
37+
'no theme files' => [null, null, false],
38+
];
39+
}
40+
41+
/**
42+
* @param string|null $themeXml
43+
* @param array<string, mixed>|null $composerJson
44+
* @param bool $expected
45+
*/
46+
#[DataProvider('themeFilesProvider')]
47+
public function testIsHyvaTheme(?string $themeXml, ?array $composerJson, bool $expected): void
48+
{
49+
$fileDriver = $this->createStub(File::class);
50+
$fileDriver->method('isExists')->willReturnMap([
51+
['/theme/theme.xml', $themeXml !== null],
52+
['/theme/composer.json', $composerJson !== null],
53+
]);
54+
$fileDriver->method('fileGetContents')->willReturnMap([
55+
['/theme/theme.xml', null, null, (string) $themeXml],
56+
['/theme/composer.json', null, null, json_encode($composerJson)],
57+
]);
58+
59+
$this->assertSame($expected, (new HyvaThemeDetector($fileDriver))->isHyvaTheme('/theme/'));
60+
}
61+
}

‎tests/Unit/Service/ThemeBuilder/HyvaThemes/BuilderTest.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
use Magento\Framework\Filesystem\Driver\File;
88
use Magento\Framework\Shell;
99
use OpenForgeProject\MageForge\Service\CacheCleaner;
10+
use OpenForgeProject\MageForge\Service\Hyva\HyvaThemeDetector;
1011
use OpenForgeProject\MageForge\Service\NodePackageManager;
1112
use OpenForgeProject\MageForge\Service\StaticContentCleaner;
1213
use OpenForgeProject\MageForge\Service\StaticContentDeployer;
@@ -97,6 +98,7 @@ private function createBuilder(
9798
$cacheCleaner ?? $this->cacheCleaner,
9899
$symlinkCleaner ?? $this->symlinkCleaner,
99100
$nodePackageManager ?? $this->nodePackageManager,
101+
new HyvaThemeDetector($fileDriver ?? $this->fileDriver),
100102
);
101103
}
102104

‎tests/Unit/Service/ThemeBuilder/TailwindCSS/BuilderTest.php‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
use Magento\Framework\Filesystem\Driver\File;
88
use Magento\Framework\Shell;
99
use OpenForgeProject\MageForge\Service\CacheCleaner;
10+
use OpenForgeProject\MageForge\Service\Hyva\HyvaThemeDetector;
1011
use OpenForgeProject\MageForge\Service\NodePackageManager;
1112
use OpenForgeProject\MageForge\Service\StaticContentCleaner;
1213
use OpenForgeProject\MageForge\Service\StaticContentDeployer;
@@ -162,6 +163,40 @@ public function testDetectReturnsFalseWhenNeitherFilePresent(): void
162163
$this->assertFalse($this->builder->detect('app/design/frontend/Vendor/theme'));
163164
}
164165

166+
public function testDetectReturnsFalseForHyvaComposerNameWithNeutralThemeXml(): void
167+
{
168+
$fileDriver = $this->createStub(File::class);
169+
$fileDriver->method('isExists')->willReturn(true);
170+
$fileDriver->method('fileGetContents')->willReturnMap([
171+
['app/design/frontend/Vendor/theme/theme.xml', null, null, '<theme><title>Custom</title></theme>'],
172+
[
173+
'app/design/frontend/Vendor/theme/composer.json',
174+
null,
175+
null,
176+
json_encode(['name' => 'hyva-themes/theme-default']),
177+
],
178+
]);
179+
180+
$this->assertFalse($this->createBuilder(fileDriver: $fileDriver)->detect('app/design/frontend/Vendor/theme'));
181+
}
182+
183+
public function testDetectReturnsFalseForHyvaThemeXmlWithNeutralComposerName(): void
184+
{
185+
$fileDriver = $this->createStub(File::class);
186+
$fileDriver->method('isExists')->willReturn(true);
187+
$fileDriver->method('fileGetContents')->willReturnMap([
188+
['app/design/frontend/Vendor/theme/theme.xml', null, null, '<theme><parent>Hyva/default</parent></theme>'],
189+
[
190+
'app/design/frontend/Vendor/theme/composer.json',
191+
null,
192+
null,
193+
json_encode(['name' => 'vendor/custom-theme']),
194+
],
195+
]);
196+
197+
$this->assertFalse($this->createBuilder(fileDriver: $fileDriver)->detect('app/design/frontend/Vendor/theme'));
198+
}
199+
165200
private function createBuilder(
166201
?Shell $shell = null,
167202
?File $fileDriver = null,
@@ -179,6 +214,7 @@ private function createBuilder(
179214
$cacheCleaner ?? $this->cacheCleaner,
180215
$symlinkCleaner ?? $this->symlinkCleaner,
181216
$nodePackageManager ?? $this->nodePackageManager,
217+
new HyvaThemeDetector($fileDriver ?? $this->fileDriver),
182218
);
183219
}
184220

0 commit comments

Comments
 (0)