Added once architecture for mock functions

Author: diloabininyeri

README.md

@@ -515,4 +515,60 @@ $mockFunction = new MockFunction();
  $mockFunction->getCalledCountOutScope('time'); //3
 
  $mockFunction->getTotalCount('time'); //5
+```
+### The restore mock function
+You can convert a mock function to php's original function, that is, restore it.
+```php
+$mockFunction = new MockFunction();
+
+
+$mockFunction->addIfNotDefined('date', '2010-01-01');
+
+
+$mockFunction->scope();
+
+echo $date->now(); //2010-01-01,its return the mock function value
+$mockFunction->restoreOriginalFunction('date');
+echo $date->now();  //2025-02-28, its return the real value of date function
+
+
+$mockFunction->endScope();
+```
+or
+```php
+$mockFunction = new MockFunction();
+$mockFunction->addIfNotDefined('date', '2010-01-01');
+
+$mockFunction->runWithMock(new Date(), function (Date $date) use ($mockFunction) {
+    echo $date->now(); //2010-01-01
+    $mockFunction->restoreOriginalFunction('date');
+    echo $date->now(); // it will return current date not the mock function
+});
+```
+
+### the once for the mock functions
+You may want mock functions to run only once.
+Here is the simple usage
+```php
+$mockFunction = new MockFunction();
+
+$mockFunction->once(function (MockFunction $function){
+    $function->add('date', '2022-01-01');
+    $function->add('time', 100);
+});
+
+$mockFunction->scope();
+echo date('y-m-d'); //it will work and will return the 2010-01-01
+echo date('y-m-d');//it will throw exception, because it will work just once 
+
+echo time(); //it will work and will return the 100
+echo time(); ////it will throw exception, because it will work just once 
+/// 
+$mockFunction->endScope();
+
+echo date('y-m-d'); //2025-02-28, it will work,because it's out of the scope
+echo date('y-m-d'); //2025-02-28, it will work,because it's out of the scope
+echo date('y-m-d'); //2025-02-28, it will work,because it's out of the scope
+echo time(); //it will work and will return the real time
+
 ```

src/MockFunction.php

@@ -15,6 +15,11 @@ class MockFunction
      * @var array<string,Closure>
      */
     private array $functions = [];
+
+    /**
+     * @var array<string, Closure> $originalFunctions
+     */
+    private array $originalFunctions = [];
     /**
      * @var bool
      */
@@ -33,6 +38,15 @@ class MockFunction
      */
     private static array $createdFunctions = [];
 
+
+    private array $onceFunctions = [];
+
+
+    /**
+     * @var bool $onceMode
+     */
+    private bool $onceMode = false;
+
     /**
      * @var array<string, array{in_scope: int, out_scope: int}> $calledCount
      */
@@ -46,19 +60,40 @@ public function __construct()
         static::$instances = $this;
     }
 
+
     /**
      * @param string $name
      * @param Closure $returnValue
      * @return void
      */
     public function add(string $name, mixed $returnValue): void
     {
+        if ($this->onceMode && !in_array($name, $this->onceFunctions, true)) {
+             $this->onceFunctions[] = $name;
+        }
+        if (!isset($this->originalFunctions[$name]) && function_exists($name)) {
+            $this->originalFunctions[$name] = $name(...);
+        }
+
         if (!($returnValue instanceof Closure)) {
             $returnValue = static fn() => $returnValue;
         }
+
         $this->functions[$name] = $returnValue;
     }
 
+    /***
+     * @noinspection PhpUnused
+     * @param string $name
+     * @return void
+     */
+    public function restoreOriginalFunction(string $name): void
+    {
+        if (isset($this->originalFunctions[$name])) {
+            $this->functions[$name] = $this->originalFunctions[$name];
+        }
+    }
+
     /**
      * @noinspection PhpUnused
      * @param string $name
@@ -88,6 +123,12 @@ public function has(string $name): bool
      */
     private function call(string $name, array $args): mixed
     {
+        if (in_array($name, $this->onceFunctions, true)) {
+            $calledCount = $this->getCalledCountInScope($name);
+            if ($calledCount !== 0) {
+                throw new OnceMockFunction("$name cant be called more than once ");
+            }
+        }
         return $this->executeWithEffect(
             call_user_func($this->functions[$name], ...$args),
             fn() => $this->incrementCount($name)
@@ -265,6 +306,13 @@ public function runWithMock(object $object, Closure $closure): mixed
         return $result;
     }
 
+
+    public function once(Closure $closure):void
+    {
+        $this->onceMode = true;
+        $closure($this);
+        $this->onceMode = false;
+    }
     /**
      * @param string $method
      * @param array $arguments

src/OnceMockFunction.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Zeus\Mock;
+
+use RuntimeException;
+
+class OnceMockFunction extends RuntimeException
+{}

tests/stubs/Date.php

@@ -8,6 +8,6 @@ class Date
 
     public function now():string
     {
-        return date('y-m-d');
+        return date('Y-m-d');
     }
 }

tests/unit/OnceMockTest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Zeus\Mock\Tests\unit;
+
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Zeus\Mock\MockFunction;
+use Zeus\Mock\OnceMockFunction;
+
+class OnceMockTest extends TestCase
+{
+
+
+    #[Test]
+    public function onceMock(): void
+    {
+
+        $mockFunction = new MockFunction();
+        $mockFunction->once(function (MockFunction $function) {
+            $function->add('time', function () {
+                return 100;
+            });
+        });
+
+        $mockFunction->scope();
+        $this->assertEquals(100, time());
+        $this->expectException(OnceMockFunction::class);
+        time();
+        $mockFunction->endScope();
+        $this->assertNotEquals(100, time());
+    }
+}