Merge pull request #174 from gacela-project/feature/custom-caching-dir

Allow defining custom cache directory name

CHANGELOG.md

@@ -5,6 +5,7 @@
 
 - Group gacela cache files inside a `cache/` directory.
 - Allow enabling/disabling cache files from the project config files. 
+- Added `setCacheDirectory()` to `GacelaConfig`.
 - Added `vendor/bin/gacela` script.
 - Add `.editorconfig` & `.gitattributes` files.
 - Ignore `composer.lock`.

src/Framework/Bootstrap/GacelaConfig.php

@@ -23,6 +23,8 @@ final class GacelaConfig
 
     private bool $cacheEnabled = true;
 
+    private string $cacheDirectory = 'cache';
+
     /**
      * @param array<string,class-string|object|callable> $externalServices
      */
@@ -120,13 +122,21 @@ public function setCacheEnabled(bool $flag): self
         return $this;
     }
 
+    public function setCacheDirectory(string $dir): self
+    {
+        $this->cacheDirectory = $dir;
+
+        return $this;
+    }
+
     /**
      * @return array{
      *     external-services:array<string,class-string|object|callable>,
      *     config-builder:ConfigBuilder,
      *     suffix-types-builder:SuffixTypesBuilder,
      *     mapping-interfaces-builder:MappingInterfacesBuilder,
      *     cache-enabled:bool,
+     *     cache-directory:string,
      * }
      *
      * @internal
@@ -139,6 +149,7 @@ public function build(): array
             'suffix-types-builder' => $this->suffixTypesBuilder,
             'mapping-interfaces-builder' => $this->mappingInterfacesBuilder,
             'cache-enabled' => $this->cacheEnabled,
+            'cache-directory' => $this->cacheDirectory,
         ];
     }
 }

src/Framework/Bootstrap/SetupGacela.php

@@ -31,6 +31,8 @@ final class SetupGacela extends AbstractSetupGacela
 
     private bool $cacheEnabled = true;
 
+    private string $cacheDirectory = 'cache';
+
     public function __construct()
     {
         $this->configFn = static function (): void {
@@ -61,7 +63,8 @@ public static function fromGacelaConfig(GacelaConfig $gacelaConfig): self
             ->setSuffixTypesBuilder($build['suffix-types-builder'])
             ->setMappingInterfacesBuilder($build['mapping-interfaces-builder'])
             ->setExternalServices($build['external-services'])
-            ->setCacheEnabled($build['cache-enabled']);
+            ->setCacheEnabled($build['cache-enabled'])
+            ->setCacheDirectory($build['cache-directory']);
     }
 
     public function setMappingInterfacesBuilder(MappingInterfacesBuilder $builder): self
@@ -190,4 +193,16 @@ public function isCacheEnabled(): bool
     {
         return $this->cacheEnabled;
     }
+
+    public function setCacheDirectory(string $dir): self
+    {
+        $this->cacheDirectory = $dir;
+
+        return $this;
+    }
+
+    public function getCacheDirectory(): string
+    {
+        return $this->cacheDirectory;
+    }
 }

src/Framework/Bootstrap/SetupGacelaInterface.php

@@ -34,5 +34,7 @@ public function buildSuffixTypes(SuffixTypesBuilder $suffixTypesBuilder): Suffix
      */
     public function externalServices(): array;
 
+    public function getCacheDirectory(): string;
+
     public function isCacheEnabled(): bool;
 }

src/Framework/Config/Config.php

@@ -99,7 +99,7 @@ public function getAppRootDir(): string
 
     public function getCacheDir(): string
     {
-        return $this->getAppRootDir() . '/cache/';
+        return $this->getAppRootDir() . '/' . $this->getSetupGacela()->getCacheDirectory();
     }
 
     public function setSetup(SetupGacelaInterface $setup): self
@@ -117,13 +117,18 @@ public function getFactory(): ConfigFactory
         if ($this->configFactory === null) {
             $this->configFactory = new ConfigFactory(
                 $this->getAppRootDir(),
-                $this->setup ?? new SetupGacela()
+                $this->getSetupGacela()
             );
         }
 
         return $this->configFactory;
     }
 
+    private function getSetupGacela(): SetupGacelaInterface
+    {
+        return $this->setup ?? new SetupGacela();
+    }
+
     private function hasValue(string $key): bool
     {
         return array_key_exists($key, $this->config);

tests/Feature/CodeGenerator/MakeFileCommandTest.php

@@ -4,7 +4,7 @@
 
 namespace GacelaTest\Feature\CodeGenerator;
 
-use GacelaTest\Feature\CodeGenerator\Util\DirectoryUtil;
+use GacelaTest\Feature\Util\DirectoryUtil;
 use PHPUnit\Framework\TestCase;
 
 final class MakeFileCommandTest extends TestCase

tests/Feature/CodeGenerator/MakeModuleCommandTest.php

@@ -4,7 +4,7 @@
 
 namespace GacelaTest\Feature\CodeGenerator;
 
-use GacelaTest\Feature\CodeGenerator\Util\DirectoryUtil;
+use GacelaTest\Feature\Util\DirectoryUtil;
 use PHPUnit\Framework\TestCase;
 
 final class MakeModuleCommandTest extends TestCase

tests/Feature/Framework/CustomCacheDirectory/FeatureTest.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GacelaTest\Feature\Framework\CustomCacheDirectory;
+
+use Gacela\Framework\Bootstrap\GacelaConfig;
+use Gacela\Framework\ClassResolver\ClassNameCache;
+use Gacela\Framework\ClassResolver\DocBlockService\CustomServicesCache;
+use Gacela\Framework\Gacela;
+use GacelaTest\Feature\Util\DirectoryUtil;
+use PHPUnit\Framework\TestCase;
+
+final class FeatureTest extends TestCase
+{
+    public function setUp(): void
+    {
+        Gacela::bootstrap(__DIR__, static function (GacelaConfig $config): void {
+            $config->addAppConfig('config/*.php');
+            $config->setCacheDirectory('custom-caching-dir');
+        });
+    }
+
+    public function tearDown(): void
+    {
+        DirectoryUtil::removeDir(__DIR__ . '/custom-caching-dir');
+    }
+
+    public function test_custom_caching_dir(): void
+    {
+        $facade = new Module\Facade();
+        self::assertSame('name', $facade->getName());
+
+        self::assertFileExists(__DIR__ . '/custom-caching-dir/' . ClassNameCache::CACHE_FILENAME);
+        self::assertFileExists(__DIR__ . '/custom-caching-dir/' . CustomServicesCache::CACHE_FILENAME);
+    }
+}

tests/Feature/Framework/CustomCacheDirectory/Module/Facade.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GacelaTest\Feature\Framework\CustomCacheDirectory\Module;
+
+use Gacela\Framework\AbstractFacade;
+use Gacela\Framework\DocBlockResolverAwareTrait;
+use GacelaTest\Feature\Framework\CustomCacheDirectory\Module\Persistence\FakeRepository;
+
+/**
+ * @method FakeRepository getRepository()
+ */
+final class Facade extends AbstractFacade
+{
+    use DocBlockResolverAwareTrait;
+
+    public function getName(): string
+    {
+        return $this->getRepository()->findName();
+    }
+}

tests/Feature/Framework/CustomCacheDirectory/Module/Persistence/FakeRepository.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GacelaTest\Feature\Framework\CustomCacheDirectory\Module\Persistence;
+
+final class FakeRepository
+{
+    public function findName(): string
+    {
+        return 'name';
+    }
+}

tests/Feature/CodeGenerator/Util/DirectoryUtil.php → tests/Feature/Util/DirectoryUtil.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace GacelaTest\Feature\CodeGenerator\Util;
+namespace GacelaTest\Feature\Util;
 
 use FilesystemIterator;
 use RecursiveDirectoryIterator;