renamed setTempDirectory() to setCacheDirectory() for consistency with Latte

Author: dg

readme.md

@@ -75,7 +75,7 @@ $loader->addDirectory(__DIR__ . '/app');
 $loader->addDirectory(__DIR__ . '/libs');
 
 // Set caching to the 'temp' directory
-$loader->setTempDirectory(__DIR__ . '/temp');
+$loader->setCacheDirectory(__DIR__ . '/temp');
 $loader->register(); // Activate RobotLoader
 ```
 
@@ -112,7 +112,7 @@ $loader = new Nette\Loaders\RobotLoader;
 $loader->addDirectory(__DIR__ . '/app');
 
 // Set caching to the 'temp' directory
-$loader->setTempDirectory(__DIR__ . '/temp');
+$loader->setCacheDirectory(__DIR__ . '/temp');
 
 // Scans directories using cache
 $loader->refresh();

src/RobotLoader/RobotLoader.php

@@ -21,7 +21,7 @@
  * $loader = new Nette\Loaders\RobotLoader;
  * $loader->addDirectory('app');
  * $loader->excludeDirectory('app/exclude');
- * $loader->setTempDirectory('temp');
+ * $loader->setCacheDirectory('temp');
  * $loader->register();
  * </code>
  */
@@ -53,7 +53,7 @@ class RobotLoader
 
 	/** @var array<string, int>  file => mtime */
 	private array $emptyFiles = [];
-	private ?string $tempDirectory = null;
+	private ?string $cacheDirectory = null;
 	private bool $needSave = false;
 
 
@@ -175,7 +175,7 @@ public function rebuild(): void
 		$this->cacheLoaded = true;
 		$this->classes = $this->missingClasses = $this->emptyFiles = [];
 		$this->refreshClasses();
-		if ($this->tempDirectory) {
+		if ($this->cacheDirectory) {
 			$this->saveCache();
 		}
 	}
@@ -390,19 +390,26 @@ public function setAutoRefresh(bool $state = true): static
 
 
 	/**
-	 * Sets path to temporary directory.
+	 * Sets the directory for storing cache.
 	 */
-	public function setTempDirectory(string $dir): static
+	public function setCacheDirectory(string $dir): static
 	{
 		if (!FileSystem::isAbsolute($dir)) {
-			throw new Nette\InvalidArgumentException("Temporary directory must be absolute, '$dir' given.");
+			throw new Nette\InvalidArgumentException("Cache directory must be absolute, '$dir' given.");
 		}
 		FileSystem::createDir($dir);
-		$this->tempDirectory = $dir;
+		$this->cacheDirectory = $dir;
 		return $this;
 	}
 
 
+	/** @deprecated  use setCacheDirectory() */
+	public function setTempDirectory(string $dir): static
+	{
+		return $this->setCacheDirectory($dir);
+	}
+
+
 	/**
 	 * Loads class list from cache.
 	 */
@@ -499,11 +506,11 @@ private function acquireLock(string $file, int $mode)
 
 	private function generateCacheFileName(): string
 	{
-		if (!$this->tempDirectory) {
-			throw new \LogicException('Set path to temporary directory using setTempDirectory().');
+		if (!$this->cacheDirectory) {
+			throw new \LogicException('Set path to temporary directory using setCacheDirectory().');
 		}
 
-		return $this->tempDirectory . '/' . hash('xxh128', serialize($this->generateCacheKey())) . '.php';
+		return $this->cacheDirectory . '/' . hash('xxh128', serialize($this->generateCacheKey())) . '.php';
 	}
 
 

tests/Loaders/RobotLoader.caseSensitivity.phpt

@@ -12,7 +12,7 @@ require __DIR__ . '/../bootstrap.php';
 
 
 $loader = new RobotLoader;
-$loader->setTempDirectory(getTempDir());
+$loader->setCacheDirectory(getTempDir());
 $loader->addDirectory(__DIR__ . '/files');
 $loader->register();
 

tests/Loaders/RobotLoader.emptyArrayVariadicArgument.phpt

@@ -11,7 +11,7 @@ use Tester\Assert;
 require __DIR__ . '/../bootstrap.php';
 
 $loader = new RobotLoader;
-$loader->setTempDirectory(getTempDir());
+$loader->setCacheDirectory(getTempDir());
 
 Assert::noError(
 	function () use ($loader) {

tests/Loaders/RobotLoader.phar.phpt

@@ -28,7 +28,7 @@ Phar::loadPhar($pharFile, 'test.phar');
 
 
 $loader = new RobotLoader;
-$loader->setTempDirectory(getTempDir());
+$loader->setCacheDirectory(getTempDir());
 $loader->addDirectory("phar://$pharFile/sub");
 $loader->addDirectory("PHAR://$pharFile/class.B.php");
 $loader->addDirectory('phar://test.phar/class.C.php');
@@ -41,7 +41,7 @@ Assert::true(class_exists('D'));
 
 
 $loader = new RobotLoader;
-$loader->setTempDirectory(getTempDir());
+$loader->setCacheDirectory(getTempDir());
 $loader->addDirectory("phar://$pharFile/non-dir");
 Assert::exception(
 	fn() => $loader->rebuild(),
@@ -51,7 +51,7 @@ Assert::exception(
 
 
 $loader = new RobotLoader;
-$loader->setTempDirectory(getTempDir());
+$loader->setCacheDirectory(getTempDir());
 $loader->addDirectory("phar://$pharFile/non-file.php");
 Assert::exception(
 	fn() => $loader->rebuild(),

tests/Loaders/RobotLoader.phpt

@@ -12,7 +12,7 @@ require __DIR__ . '/../bootstrap.php';
 
 
 $loader = new RobotLoader;
-$loader->setTempDirectory(getTempDir());
+$loader->setCacheDirectory(getTempDir());
 $loader->addDirectory(__DIR__ . '/files');
 $loader->addDirectory(__DIR__ . '/files/'); // purposely doubled
 $loader->addDirectory(__DIR__ . '/file/interface.php'); // as file

tests/Loaders/RobotLoader.rebuild.phpt

@@ -17,7 +17,7 @@ file_put_contents($dir . '/file1.php', '<?php class A {}');
 file_put_contents($dir . '/file2.php', '<?php class B {}');
 
 $loader = new RobotLoader;
-$loader->setTempDirectory(getTempDir());
+$loader->setCacheDirectory(getTempDir());
 $loader->addDirectory($dir);
 $loader->register();
 class_exists('x'); // rebuilds cache
@@ -28,7 +28,7 @@ Assert::false(class_exists('A'));
 
 
 $loader2 = new RobotLoader;
-$loader2->setTempDirectory(getTempDir());
+$loader2->setCacheDirectory(getTempDir());
 $loader2->addDirectory($dir);
 $loader2->register();
 

tests/Loaders/RobotLoader.relative.phpt

@@ -12,7 +12,7 @@ require __DIR__ . '/../bootstrap.php';
 
 
 $loader = new RobotLoader;
-$loader->setTempDirectory(getTempDir());
+$loader->setCacheDirectory(getTempDir());
 $loader->addDirectory(__DIR__ . '/../Loaders/files');
 $loader->excludeDirectory(__DIR__ . '/../Loaders/files/exclude');
 $loader->excludeDirectory(__DIR__ . '/../Loaders/files/exclude2/excluded.php');

tests/Loaders/RobotLoader.renamed.phpt

@@ -15,7 +15,7 @@ $dir = realpath(getTempDir()) . DIRECTORY_SEPARATOR . 'fixtures' . DIRECTORY_SEP
 mkdir($dir);
 
 $loader = new RobotLoader;
-$loader->setTempDirectory(getTempDir());
+$loader->setCacheDirectory(getTempDir());
 $loader->addDirectory($dir);
 
 file_put_contents($dir . 'file1.php', '<?php class A {}');

tests/Loaders/RobotLoader.stress.phpt

@@ -8,7 +8,7 @@ require __DIR__ . '/../../vendor/autoload.php';
 
 $loader = new Nette\Loaders\RobotLoader;
 $loader->setAutoRefresh(true);
-$loader->setTempDirectory(__DIR__ . '/../tmp');
+$loader->setCacheDirectory(__DIR__ . '/../tmp');
 $loader->addDirectory(__DIR__);
 $loader->register();