diff --git a/docs/custom_theme_builders.md b/docs/custom_theme_builders.md index b75240e0..b38146b6 100644 --- a/docs/custom_theme_builders.md +++ b/docs/custom_theme_builders.md @@ -208,6 +208,8 @@ After these steps, your custom ThemeBuilder will be available and integrated wit 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. +`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ä). + ```php public function detect(string $themePath): bool { diff --git a/src/Service/Hyva/HyvaThemeDetector.php b/src/Service/Hyva/HyvaThemeDetector.php new file mode 100644 index 00000000..0e23a7e2 --- /dev/null +++ b/src/Service/Hyva/HyvaThemeDetector.php @@ -0,0 +1,53 @@ +fileDriver->isExists($themePath . '/theme.xml')) { + $themeXmlContent = $this->fileDriver->fileGetContents($themePath . '/theme.xml'); + if (stripos($themeXmlContent, 'hyva') !== false) { + return true; + } + } + + if ($this->fileDriver->isExists($themePath . '/composer.json')) { + $composerContent = $this->fileDriver->fileGetContents($themePath . '/composer.json'); + $composerJson = json_decode($composerContent, true); + $packageName = is_array($composerJson) ? $composerJson['name'] ?? null : null; + if (is_string($packageName) && str_contains($packageName, 'hyva')) { + return true; + } + } + + return false; + } +} diff --git a/src/Service/ThemeBuilder/HyvaThemes/Builder.php b/src/Service/ThemeBuilder/HyvaThemes/Builder.php index 53bd43dd..d8f23dae 100644 --- a/src/Service/ThemeBuilder/HyvaThemes/Builder.php +++ b/src/Service/ThemeBuilder/HyvaThemes/Builder.php @@ -7,6 +7,7 @@ use Magento\Framework\Filesystem\Driver\File; use Magento\Framework\Shell; use OpenForgeProject\MageForge\Service\CacheCleaner; +use OpenForgeProject\MageForge\Service\Hyva\HyvaThemeDetector; use OpenForgeProject\MageForge\Service\NodePackageManager; use OpenForgeProject\MageForge\Service\StaticContentCleaner; use OpenForgeProject\MageForge\Service\StaticContentDeployer; @@ -28,6 +29,7 @@ class Builder implements BuilderInterface * @param CacheCleaner $cacheCleaner * @param SymlinkCleaner $symlinkCleaner * @param NodePackageManager $nodePackageManager + * @param HyvaThemeDetector $hyvaThemeDetector */ public function __construct( private readonly Shell $shell, @@ -37,6 +39,7 @@ public function __construct( private readonly CacheCleaner $cacheCleaner, private readonly SymlinkCleaner $symlinkCleaner, private readonly NodePackageManager $nodePackageManager, + private readonly HyvaThemeDetector $hyvaThemeDetector, ) { } @@ -56,25 +59,7 @@ public function detect(string $themePath): bool return false; } - // Check theme.xml for Hyva theme declaration - if ($this->fileDriver->isExists($themePath . '/theme.xml')) { - $themeXmlContent = $this->fileDriver->fileGetContents($themePath . '/theme.xml'); - if (stripos($themeXmlContent, 'hyva') !== false) { - return true; - } - } - - // Check composer.json for Hyva module dependency - if ($this->fileDriver->isExists($themePath . '/composer.json')) { - $composerContent = $this->fileDriver->fileGetContents($themePath . '/composer.json'); - $composerJson = json_decode($composerContent, true); - $packageName = is_array($composerJson) ? $composerJson['name'] ?? null : null; - if (is_string($packageName) && str_contains($packageName, 'hyva')) { - return true; - } - } - - return false; + return $this->hyvaThemeDetector->isHyvaTheme($themePath); } /** diff --git a/src/Service/ThemeBuilder/TailwindCSS/Builder.php b/src/Service/ThemeBuilder/TailwindCSS/Builder.php index 34cb8638..afb3ac26 100644 --- a/src/Service/ThemeBuilder/TailwindCSS/Builder.php +++ b/src/Service/ThemeBuilder/TailwindCSS/Builder.php @@ -7,6 +7,7 @@ use Magento\Framework\Filesystem\Driver\File; use Magento\Framework\Shell; use OpenForgeProject\MageForge\Service\CacheCleaner; +use OpenForgeProject\MageForge\Service\Hyva\HyvaThemeDetector; use OpenForgeProject\MageForge\Service\NodePackageManager; use OpenForgeProject\MageForge\Service\StaticContentCleaner; use OpenForgeProject\MageForge\Service\StaticContentDeployer; @@ -28,6 +29,7 @@ class Builder implements BuilderInterface * @param CacheCleaner $cacheCleaner * @param SymlinkCleaner $symlinkCleaner * @param NodePackageManager $nodePackageManager + * @param HyvaThemeDetector $hyvaThemeDetector */ public function __construct( private readonly Shell $shell, @@ -37,6 +39,7 @@ public function __construct( private readonly CacheCleaner $cacheCleaner, private readonly SymlinkCleaner $symlinkCleaner, private readonly NodePackageManager $nodePackageManager, + private readonly HyvaThemeDetector $hyvaThemeDetector, ) { } @@ -56,25 +59,12 @@ public function detect(string $themePath): bool return false; } - // Check for theme.xml file in theme folder and ensure it's not a Hyva theme - if ($this->fileDriver->isExists($themePath . '/theme.xml')) { - $themeXmlContent = $this->fileDriver->fileGetContents($themePath . '/theme.xml'); - if (stripos($themeXmlContent, 'hyva') === false) { - return true; - } - } - - // Check for composer.json file in theme folder and ensure it's not a Hyva theme - if ($this->fileDriver->isExists($themePath . '/composer.json')) { - $composerContent = $this->fileDriver->fileGetContents($themePath . '/composer.json'); - $composerJson = json_decode($composerContent, true); - $packageName = \is_array($composerJson) ? $composerJson['name'] ?? null : null; - if (\is_string($packageName) && !str_contains($packageName, 'hyva')) { - return true; - } - } + // Must be a theme at all, and must not be claimed by the Hyva builder + $hasThemeFile = + $this->fileDriver->isExists($themePath . '/theme.xml') + || $this->fileDriver->isExists($themePath . '/composer.json'); - return false; + return $hasThemeFile && !$this->hyvaThemeDetector->isHyvaTheme($themePath); } /** diff --git a/tests/Unit/Model/TemplateEngine/Decorator/InspectorHintsTest.php b/tests/Unit/Model/TemplateEngine/Decorator/InspectorHintsTest.php index 5a4a8602..fc0cf1a9 100644 --- a/tests/Unit/Model/TemplateEngine/Decorator/InspectorHintsTest.php +++ b/tests/Unit/Model/TemplateEngine/Decorator/InspectorHintsTest.php @@ -224,16 +224,10 @@ public function testRenderExtractsModuleNameFromRealBlockClassName(): void public function testRenderDetectsParentBlockAndAlias(): void { - $parentBlock = $this->getStubBuilder(AbstractBlock::class) - ->disableOriginalConstructor() - ->onlyMethods(['getNameInLayout']) - ->getStub(); + $parentBlock = $this->createStub(AbstractBlock::class); $parentBlock->method('getNameInLayout')->willReturn('parent.block'); - $block = $this->getStubBuilder(AbstractBlock::class) - ->disableOriginalConstructor() - ->onlyMethods(['getParentBlock', 'getNameInLayout']) - ->getStub(); + $block = $this->createStub(AbstractBlock::class); $block->method('getParentBlock')->willReturn($parentBlock); $block->method('getNameInLayout')->willReturn('child.block'); diff --git a/tests/Unit/Service/Hyva/HyvaThemeDetectorTest.php b/tests/Unit/Service/Hyva/HyvaThemeDetectorTest.php new file mode 100644 index 00000000..0fe97cfb --- /dev/null +++ b/tests/Unit/Service/Hyva/HyvaThemeDetectorTest.php @@ -0,0 +1,61 @@ +|null, 2: bool}> + */ + public static function themeFilesProvider(): array + { + return [ + 'hyva in theme.xml' => ['Hyva/default', null, true], + 'hyva in theme.xml, other composer name' => [ + 'Hyva/default', + ['name' => 'vendor/custom-theme'], + true, + ], + 'neutral theme.xml, hyva composer name' => [ + 'Custom', + ['name' => 'hyva-themes/theme-default'], + true, + ], + 'neutral theme.xml and composer name' => [ + 'Custom', + ['name' => 'vendor/custom-theme'], + false, + ], + 'composer json without name' => [null, ['require' => []], false], + 'no theme files' => [null, null, false], + ]; + } + + /** + * @param string|null $themeXml + * @param array|null $composerJson + * @param bool $expected + */ + #[DataProvider('themeFilesProvider')] + public function testIsHyvaTheme(?string $themeXml, ?array $composerJson, bool $expected): void + { + $fileDriver = $this->createStub(File::class); + $fileDriver->method('isExists')->willReturnMap([ + ['/theme/theme.xml', $themeXml !== null], + ['/theme/composer.json', $composerJson !== null], + ]); + $fileDriver->method('fileGetContents')->willReturnMap([ + ['/theme/theme.xml', null, null, (string) $themeXml], + ['/theme/composer.json', null, null, json_encode($composerJson)], + ]); + + $this->assertSame($expected, (new HyvaThemeDetector($fileDriver))->isHyvaTheme('/theme/')); + } +} diff --git a/tests/Unit/Service/Inspector/Cache/BlockCacheCollectorTest.php b/tests/Unit/Service/Inspector/Cache/BlockCacheCollectorTest.php index b007866d..ae85ad91 100644 --- a/tests/Unit/Service/Inspector/Cache/BlockCacheCollectorTest.php +++ b/tests/Unit/Service/Inspector/Cache/BlockCacheCollectorTest.php @@ -35,10 +35,10 @@ protected function setUp(): void */ private function createBlock(): AbstractBlock&Stub { - return $this->getStubBuilder(AbstractBlock::class) + return $this->getMockBuilder(AbstractBlock::class) ->disableOriginalConstructor() ->onlyMethods(['isScopePrivate', 'getCacheKey']) - ->getStub(); + ->getMock(); } public function testGetCacheInfoReturnsNotCacheableWhenLifetimeIsFalse(): void diff --git a/tests/Unit/Service/TemplateOverride/TemplateFallbackResolverTest.php b/tests/Unit/Service/TemplateOverride/TemplateFallbackResolverTest.php index 0844a888..21f20b05 100644 --- a/tests/Unit/Service/TemplateOverride/TemplateFallbackResolverTest.php +++ b/tests/Unit/Service/TemplateOverride/TemplateFallbackResolverTest.php @@ -340,7 +340,8 @@ public function testFindDirectoryFilesUsesDirectoryRootWithoutSubPathAndSkipsMis ->method('isFile') ->willReturnCallback(static fn(string $path): bool => str_ends_with($path, '.phtml')); - $files = $this->createResolver(fileDriver: $fileDriver)->findDirectoryFiles(['/missing', '/module/templates'], ''); + $files = $this->createResolver(fileDriver: $fileDriver) + ->findDirectoryFiles(['/missing', '/module/templates'], ''); $this->assertSame( ['b.phtml' => '/module/templates/b.phtml', 'z.phtml' => '/module/templates/z.phtml'], diff --git a/tests/Unit/Service/ThemeBuilder/HyvaThemes/BuilderTest.php b/tests/Unit/Service/ThemeBuilder/HyvaThemes/BuilderTest.php index 12a39500..4bbe4f42 100644 --- a/tests/Unit/Service/ThemeBuilder/HyvaThemes/BuilderTest.php +++ b/tests/Unit/Service/ThemeBuilder/HyvaThemes/BuilderTest.php @@ -7,6 +7,7 @@ use Magento\Framework\Filesystem\Driver\File; use Magento\Framework\Shell; use OpenForgeProject\MageForge\Service\CacheCleaner; +use OpenForgeProject\MageForge\Service\Hyva\HyvaThemeDetector; use OpenForgeProject\MageForge\Service\NodePackageManager; use OpenForgeProject\MageForge\Service\StaticContentCleaner; use OpenForgeProject\MageForge\Service\StaticContentDeployer; @@ -97,6 +98,7 @@ private function createBuilder( $cacheCleaner ?? $this->cacheCleaner, $symlinkCleaner ?? $this->symlinkCleaner, $nodePackageManager ?? $this->nodePackageManager, + new HyvaThemeDetector($fileDriver ?? $this->fileDriver), ); } diff --git a/tests/Unit/Service/ThemeBuilder/TailwindCSS/BuilderTest.php b/tests/Unit/Service/ThemeBuilder/TailwindCSS/BuilderTest.php index c21e89aa..6c82d9d8 100644 --- a/tests/Unit/Service/ThemeBuilder/TailwindCSS/BuilderTest.php +++ b/tests/Unit/Service/ThemeBuilder/TailwindCSS/BuilderTest.php @@ -7,6 +7,7 @@ use Magento\Framework\Filesystem\Driver\File; use Magento\Framework\Shell; use OpenForgeProject\MageForge\Service\CacheCleaner; +use OpenForgeProject\MageForge\Service\Hyva\HyvaThemeDetector; use OpenForgeProject\MageForge\Service\NodePackageManager; use OpenForgeProject\MageForge\Service\StaticContentCleaner; use OpenForgeProject\MageForge\Service\StaticContentDeployer; @@ -162,6 +163,40 @@ public function testDetectReturnsFalseWhenNeitherFilePresent(): void $this->assertFalse($this->builder->detect('app/design/frontend/Vendor/theme')); } + public function testDetectReturnsFalseForHyvaComposerNameWithNeutralThemeXml(): void + { + $fileDriver = $this->createStub(File::class); + $fileDriver->method('isExists')->willReturn(true); + $fileDriver->method('fileGetContents')->willReturnMap([ + ['app/design/frontend/Vendor/theme/theme.xml', null, null, 'Custom'], + [ + 'app/design/frontend/Vendor/theme/composer.json', + null, + null, + json_encode(['name' => 'hyva-themes/theme-default']), + ], + ]); + + $this->assertFalse($this->createBuilder(fileDriver: $fileDriver)->detect('app/design/frontend/Vendor/theme')); + } + + public function testDetectReturnsFalseForHyvaThemeXmlWithNeutralComposerName(): void + { + $fileDriver = $this->createStub(File::class); + $fileDriver->method('isExists')->willReturn(true); + $fileDriver->method('fileGetContents')->willReturnMap([ + ['app/design/frontend/Vendor/theme/theme.xml', null, null, 'Hyva/default'], + [ + 'app/design/frontend/Vendor/theme/composer.json', + null, + null, + json_encode(['name' => 'vendor/custom-theme']), + ], + ]); + + $this->assertFalse($this->createBuilder(fileDriver: $fileDriver)->detect('app/design/frontend/Vendor/theme')); + } + private function createBuilder( ?Shell $shell = null, ?File $fileDriver = null, @@ -179,6 +214,7 @@ private function createBuilder( $cacheCleaner ?? $this->cacheCleaner, $symlinkCleaner ?? $this->symlinkCleaner, $nodePackageManager ?? $this->nodePackageManager, + new HyvaThemeDetector($fileDriver ?? $this->fileDriver), ); }