atMost method has been created for limiting calls

Author: diloabininyeri

README.md

@@ -643,4 +643,24 @@ function test(Date $date):void
 
 test($date);
 
+```
+***Limiting calls***
+You can specify the maximum number of times the methods are called. For example, let's write a method that runs at most three times.
+```php
+$mockFactory = new MockFactory();
+
+// Set the method to be called at most 3 times
+$mockFactory->atMost(3, 'now', function () {
+    return '2012-2-2';
+});
+
+$dateInstance = $mockFactory->createMock(Date::class);
+
+echo $dateInstance->now(); // Outputs '2012-2-2'
+echo $dateInstance->now(); // Outputs '2012-2-2'
+echo $dateInstance->now(); // Outputs '2012-2-2'
+
+// This will throw an exception after the third call
+echo $dateInstance->now(); // AtMostMethodException: Method now can be called only 3 times.
+
 ```

src/AtMostMethodException.php

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

src/MockFactory.php

@@ -139,4 +139,24 @@ public function never(string $methodName): void
             $methodName, fn() => throw new NeverMethodException("Unexpected method call: $methodName. This method should never be invoked.")
         );
     }
+
+    /**
+     * @param string $methodName
+     * @return void
+     */
+    public function atMost(int $count, string $methodName, mixed $response): void
+    {
+        $this->mockMethod->add($methodName, function (...$args) use ($count, $response, $methodName) {
+            static $callCount = 0;
+            if ($callCount >= $count) {
+                throw new AtMostMethodException("Method $methodName must be called at most $count times.");
+            }
+            if ($response instanceof Closure) {
+                $callCount++;
+                return $response(...$args);
+            }
+            $callCount++;
+            return $response;
+        });
+    }
 }

src/MockMethodInterface.php

@@ -30,7 +30,7 @@ public function invokeMockedMethod(string $methodName, array $arguments): mixed;
      * @param Closure $response
      * @return $this
      */
-    public function mockMethod(string $methodName, Closure $response): MockMethod;
+    public function mockMethod(string $methodName, mixed $response): MockMethod;
 
     /**
      * @param string $methodName

tests/unit/AtMostMethodTest.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Zeus\Mock\Tests\unit;
+
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Zeus\Mock\AtMostMethodException;
+use Zeus\Mock\MockFactory;
+use Zeus\Mock\Tests\stubs\Date;
+
+class AtMostMethodTest extends TestCase
+{
+
+
+    #[Test]
+    public function atMostTest():void
+    {
+
+        $mockFactory = new MockFactory();
+        $mockFactory->atMost(3, 'now','2012');
+        $dateInstance=$mockFactory->createMock(Date::class);
+
+        $this->assertEquals('2012', $dateInstance->now());
+        $this->assertEquals('2012', $dateInstance->now());
+        $this->assertEquals('2012', $dateInstance->now());
+
+        $this->expectException(AtMostMethodException::class);
+        $dateInstance->now();
+    }
+}