Merge pull request #392 from kenjis/php81

kenjis · web-flow · commit 295d0c8369ef · 2022-03-17T16:49:56.000+09:00
Update for PHP 8.1
diff --git a/.travis.yml b/.travis.yml
@@ -1,9 +1,12 @@
 language: php
 
+dist: bionic
+
 php:
   - 7.3
   - 7.4.22
   - 8.0
+  - 8.1.0
 
 env:
   global:
diff --git a/application/tests/_ci_phpunit_test/CIPHPUnitTestDouble.php b/application/tests/_ci_phpunit_test/CIPHPUnitTestDouble.php
@@ -88,6 +88,8 @@ public function getDouble($classname, $params, $constructor_params = false)
 			} elseif (is_object($return) && $return instanceof Closure) {
 				$mock->expects($this->testCase->any())->method($method)
 					->willReturnCallback($return);
+			} elseif ($return === ':void') {
+				$mock->expects($this->testCase->any())->method($method);
 			} else {
 				$mock->expects($this->testCase->any())->method($method)
 					->willReturn($return);
diff --git a/application/tests/_ci_phpunit_test/CIPHPUnitTestFileCache.php b/application/tests/_ci_phpunit_test/CIPHPUnitTestFileCache.php
@@ -21,6 +21,11 @@ public function __construct($file)
 		if (file_exists($this->file))
 		{
 			$this->map = unserialize(file_get_contents($this->file));
+
+			if (! is_array($this->map)) {
+				$this->map = [];
+			}
+
 			return;
 		}
 
@@ -50,7 +55,7 @@ public function __destruct()
 
 	/**
 	 * Dump cache data (sorted by key)
-	 * 
+	 *
 	 * @return array
 	 */
 	public function dump()
@@ -60,12 +65,14 @@ public function dump()
 		return $map;
 	}
 
+	#[\ReturnTypeWillChange]
 	public function offsetSet($key, $value)
 	{
 		$this->map[$key] = $value;
 		$this->updated = true;
 	}
 
+	#[\ReturnTypeWillChange]
 	public function offsetGet($key)
 	{
 		if ($this->offsetExists($key))
@@ -78,11 +85,13 @@ public function offsetGet($key)
 		}
 	}
 
+	#[\ReturnTypeWillChange]
 	public function offsetExists($key)
 	{
 		return isset($this->map[$key]);
 	}
 
+	#[\ReturnTypeWillChange]
 	public function offsetUnset($key)
 	{
 		unset($this->map[$key]);
diff --git a/application/tests/_ci_phpunit_test/ChangeLog.md b/application/tests/_ci_phpunit_test/ChangeLog.md
@@ -1,5 +1,23 @@
 # Change Log for ci-phpunit-test
 
+## v3.0.4 (Not Released)
+
+### Added
+
+* You can set return value type `void` as `':void'` when you use `$this->getDouble()`.
+
+```php
+$mock = $this->getDouble(
+    'SplFileObject',
+    ['next' => ':void'],
+    ['php://memory']
+);
+```
+
+### Others
+
+* Compatible with PHP 8.1
+
 ## v3.0.3 (2022/03/17)
 
 ### Others
diff --git a/application/tests/_ci_phpunit_test/exceptions/CIPHPUnitTestExitException.php b/application/tests/_ci_phpunit_test/exceptions/CIPHPUnitTestExitException.php
@@ -10,9 +10,17 @@
 
 class CIPHPUnitTestExitException extends RuntimeException
 {
-	public $file;
-	public $line;
 	public $class;
 	public $method;
 	public $exit_status;
+
+	public function setFile($file)
+	{
+		$this->file = $file;
+	}
+
+	public function setLine($line)
+	{
+		$this->line = $line;
+	}
 }
diff --git a/application/tests/_ci_phpunit_test/patcher/2.x/Exception/ExitException.php b/application/tests/_ci_phpunit_test/patcher/2.x/Exception/ExitException.php
@@ -14,9 +14,17 @@
 
 class ExitException extends RuntimeException
 {
-	public $file;
-	public $line;
 	public $class;
 	public $method;
 	public $exit_status;
+
+	public function setFile($file)
+	{
+		$this->file = $file;
+	}
+
+	public function setLine($line)
+	{
+		$this->line = $line;
+	}
 }
diff --git a/application/tests/_ci_phpunit_test/patcher/2.x/Patcher/ConstantPatcher/Proxy.php b/application/tests/_ci_phpunit_test/patcher/2.x/Patcher/ConstantPatcher/Proxy.php
@@ -73,8 +73,8 @@ protected static function checkCalledMethod($constant)
 		$trace = debug_backtrace();
 		$info = Backtrace::getInfo('ConstantPatcher', $trace);
 
-		$class = strtolower($info['class']);
-		$class_method = strtolower($info['class_method']);
+		$class = strtolower((string) $info['class']);
+		$class_method = strtolower((string) $info['class_method']);
 
 		// Patches the constants only in the class
 		if (strpos(self::$patches_to_apply[$constant], '::') === false)
diff --git a/application/tests/_ci_phpunit_test/patcher/3.x/Exception/ExitException.php b/application/tests/_ci_phpunit_test/patcher/3.x/Exception/ExitException.php
@@ -14,9 +14,17 @@
 
 class ExitException extends RuntimeException
 {
-	public $file;
-	public $line;
 	public $class;
 	public $method;
 	public $exit_status;
+
+	public function setFile($file)
+	{
+		$this->file = $file;
+	}
+
+	public function setLine($line)
+	{
+		$this->line = $line;
+	}
 }
diff --git a/application/tests/_ci_phpunit_test/patcher/3.x/Patcher/ConstantPatcher/Proxy.php b/application/tests/_ci_phpunit_test/patcher/3.x/Patcher/ConstantPatcher/Proxy.php
@@ -73,8 +73,8 @@ protected static function checkCalledMethod($constant)
 		$trace = debug_backtrace();
 		$info = Backtrace::getInfo('ConstantPatcher', $trace);
 
-		$class = strtolower($info['class']);
-		$class_method = strtolower($info['class_method']);
+		$class = strtolower((string) $info['class']);
+		$class_method = strtolower((string) $info['class_method']);
 
 		// Patches the constants only in the class
 		if (strpos(self::$patches_to_apply[$constant], '::') === false)
diff --git a/application/tests/_ci_phpunit_test/patcher/4.5/Exception/ExitException.php b/application/tests/_ci_phpunit_test/patcher/4.5/Exception/ExitException.php
@@ -14,9 +14,17 @@
 
 class ExitException extends RuntimeException
 {
-	public $file;
-	public $line;
 	public $class;
 	public $method;
 	public $exit_status;
+
+	public function setFile($file)
+	{
+		$this->file = $file;
+	}
+
+	public function setLine($line)
+	{
+		$this->line = $line;
+	}
 }
diff --git a/application/tests/_ci_phpunit_test/patcher/4.5/Patcher/ConstantPatcher/Proxy.php b/application/tests/_ci_phpunit_test/patcher/4.5/Patcher/ConstantPatcher/Proxy.php
@@ -73,8 +73,8 @@ protected static function checkCalledMethod($constant)
 		$trace = debug_backtrace();
 		$info = Backtrace::getInfo('ConstantPatcher', $trace);
 
-		$class = strtolower($info['class']);
-		$class_method = strtolower($info['class_method']);
+		$class = strtolower((string) $info['class']);
+		$class_method = strtolower((string) $info['class_method']);
 
 		// Patches the constants only in the class
 		if (strpos(self::$patches_to_apply[$constant], '::') === false)
diff --git a/application/tests/_ci_phpunit_test/patcher/4.x/Exception/ExitException.php b/application/tests/_ci_phpunit_test/patcher/4.x/Exception/ExitException.php
@@ -14,9 +14,17 @@
 
 class ExitException extends RuntimeException
 {
-	public $file;
-	public $line;
 	public $class;
 	public $method;
 	public $exit_status;
+
+	public function setFile($file)
+	{
+		$this->file = $file;
+	}
+
+	public function setLine($line)
+	{
+		$this->line = $line;
+	}
 }
diff --git a/application/tests/_ci_phpunit_test/patcher/4.x/Patcher/ConstantPatcher/Proxy.php b/application/tests/_ci_phpunit_test/patcher/4.x/Patcher/ConstantPatcher/Proxy.php
@@ -38,6 +38,10 @@ class Proxy
 	 */
 	public static function patch($constant, $value, $class_method = null)
 	{
+		if ($class_method === null) {
+			$class_method = '';
+		}
+
 		self::$patches[$constant] = $value;
 		self::$patches_to_apply[$constant] = strtolower($class_method);
 	}
@@ -73,8 +77,8 @@ protected static function checkCalledMethod($constant)
 		$trace = debug_backtrace();
 		$info = Backtrace::getInfo('ConstantPatcher', $trace);
 
-		$class = strtolower($info['class']);
-		$class_method = strtolower($info['class_method']);
+		$class = strtolower((string) $info['class']);
+		$class_method = strtolower((string) $info['class_method']);
 
 		// Patches the constants only in the class
 		if (strpos(self::$patches_to_apply[$constant], '::') === false)
diff --git a/application/tests/_ci_phpunit_test/patcher/Cache.php b/application/tests/_ci_phpunit_test/patcher/Cache.php
@@ -40,22 +40,22 @@ public static function setCacheDir($dir)
 	{
 		self::createDir($dir);
 		self::$cache_dir = realpath($dir);
-		
+
 		if (self::$cache_dir === false)
 		{
 			throw new LogicException("No such directory: $dir");
 		}
-		
+
 		self::$src_cache_dir = self::$cache_dir . '/src';
-		self::$tmp_function_whitelist_file = 
+		self::$tmp_function_whitelist_file =
 			self::$cache_dir . '/conf/func_whiltelist.php';
-		self::$tmp_function_blacklist_file = 
+		self::$tmp_function_blacklist_file =
 			self::$cache_dir . '/conf/func_blacklist.php';
-		self::$tmp_patcher_list_file = 
+		self::$tmp_patcher_list_file =
 			self::$cache_dir . '/conf/patcher_list.php';
-		self::$tmp_include_paths_file = 
+		self::$tmp_include_paths_file =
 			self::$cache_dir . '/conf/include_paths.php';
-		self::$tmp_exclude_paths_file = 
+		self::$tmp_exclude_paths_file =
 			self::$cache_dir . '/conf/exclude_paths.php';
 	}
 
@@ -79,6 +79,11 @@ public static function getSrcCacheFilePath($path)
 
 	protected static function createDir($dir)
 	{
+		if ($dir === null)
+		{
+			throw new RuntimeException('Failed to create folder: ' . $dir);
+		}
+
 		if (! is_dir($dir))
 		{
 			if (! @mkdir($dir, 0777, true))
@@ -108,7 +113,7 @@ public static function getValidSrcCachePath($path)
 
 	/**
 	 * Write to src cache file
-	 * 
+	 *
 	 * @param string $path   original source file path
 	 * @param string $source source code
 	 */
@@ -123,7 +128,7 @@ public static function writeSrcCacheFile($path, $source)
 
 	/**
 	 * Write to cache file
-	 * 
+	 *
 	 * @param string $path   file path
 	 * @param string $contents file contents
 	 */
@@ -252,10 +257,10 @@ public static function clearCache()
 	}
 
 	/**
-	* Recursive Unlink
-	*
-	* @param string $dir
-	*/
+	 * Recursive Unlink
+	 *
+	 * @param string $dir
+	 */
 	protected static function recursiveUnlink($dir)
 	{
 		if (! is_dir($dir))
diff --git a/application/tests/_ci_phpunit_test/patcher/functions/exit__.php b/application/tests/_ci_phpunit_test/patcher/functions/exit__.php
@@ -27,8 +27,8 @@ function exit__($status = null)
 
 	$exception_name = Kenjis\MonkeyPatch\MonkeyPatchManager::getExitExceptionClassname();
 	$exception = new $exception_name($message);
-	$exception->file = $file;
-	$exception->line = $line;
+	$exception->setFile($file);
+	$exception->setLine($line);
 	$exception->class = $class;
 	$exception->method = $method;
 	$exception->exit_status = $status;
diff --git a/application/tests/_ci_phpunit_test/replacing/helpers/url_helper.php b/application/tests/_ci_phpunit_test/replacing/helpers/url_helper.php
@@ -76,6 +76,11 @@ function redirect($uri = '', $method = 'auto', $code = NULL)
 				ob_end_clean();
 			}
 
+			if ($code === NULL)
+			{
+				$code = 200;
+			}
+
 			throw new CIPHPUnitTestRedirectException('Redirect to ' . $uri, $code);
 		}
 	}
diff --git a/docs/FunctionAndClassReference.md b/docs/FunctionAndClassReference.md
@@ -1,6 +1,6 @@
 # ci-phpunit-test for CodeIgniter 3.x
 
-version: **v3.0.1** |
+version: **v3.0.4** |
 [v2.x](https://github.com/kenjis/ci-phpunit-test/blob/2.x/docs/FunctionAndClassReference.md) |
 [v1.x](https://github.com/kenjis/ci-phpunit-test/blob/master/docs/FunctionAndClassReference.md)
 
@@ -415,6 +415,15 @@ You could write code above like below:
 $email = $this->getDouble('CI_Email', ['send' => TRUE]);
 ~~~
 
+If the return value of a method is `void`, you specify `':void'`:
+~~~php
+$mock = $this->getDouble(
+	'SplFileObject',
+	['next' => ':void'],
+	['php://memory']
+);
+~~~
+
 You can set Closure as the return value of a mocked method.
 
 ~~~php

-Original file line number
+Diff line change
@@ @@ -1,9 +1,12 @@ @@
 language: php
 +dist: bionic
++
 php:
   - 7.3
   - 7.4.22
   - 8.0
 +  - 8.1.0
 env:
   global:
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,11 @@ public function __construct($file)`
`21`	`21`	`if (file_exists($this->file))`
`22`	`22`	`{`
`23`	`23`	`$this->map = unserialize(file_get_contents($this->file));`
	`24`	`+`
	`25`	`+ if (! is_array($this->map)) {`
	`26`	`+ $this->map = [];`
	`27`	`+ }`
	`28`	`+`
`24`	`29`	`return;`
`25`	`30`	`}`
`26`	`31`
`@@ -50,7 +55,7 @@ public function __destruct()`
`50`	`55`
`51`	`56`	`/**`
`52`	`57`	`* Dump cache data (sorted by key)`
`53`		`- *`
	`58`	`+ *`
`54`	`59`	`* @return array`
`55`	`60`	`*/`
`56`	`61`	`public function dump()`
`@@ -60,12 +65,14 @@ public function dump()`
`60`	`65`	`return $map;`
`61`	`66`	`}`
`62`	`67`
	`68`	`+ #[\ReturnTypeWillChange]`
`63`	`69`	`public function offsetSet($key, $value)`
`64`	`70`	`{`
`65`	`71`	`$this->map[$key] = $value;`
`66`	`72`	`$this->updated = true;`
`67`	`73`	`}`
`68`	`74`
	`75`	`+ #[\ReturnTypeWillChange]`
`69`	`76`	`public function offsetGet($key)`
`70`	`77`	`{`
`71`	`78`	`if ($this->offsetExists($key))`
`@@ -78,11 +85,13 @@ public function offsetGet($key)`
`78`	`85`	`}`
`79`	`86`	`}`
`80`	`87`
	`88`	`+ #[\ReturnTypeWillChange]`
`81`	`89`	`public function offsetExists($key)`
`82`	`90`	`{`
`83`	`91`	`return isset($this->map[$key]);`
`84`	`92`	`}`
`85`	`93`
	`94`	`+ #[\ReturnTypeWillChange]`
`86`	`95`	`public function offsetUnset($key)`
`87`	`96`	`{`
`88`	`97`	`unset($this->map[$key]);`