Merge pull request #271 from RonasIT/add-lazy-each

feat: add lazyEach to EntityControlTrait

Author: DenTray

src/Traits/EntityControlTrait.php

@@ -370,6 +370,16 @@ public function chunk(int $limit, Closure $callback, array $where = []): void
         $this->postQueryHook();
     }
 
+    public function lazyEach(Closure $callback, array $where = [], int $chunkSize = 500): void
+    {
+        $this
+            ->getQuery($where)
+            ->lazyById($chunkSize)
+            ->each($callback);
+
+        $this->postQueryHook();
+    }
+
     /**
      * Delete rows by list of values a particular field or primary key
      *

tests/EntityControlTraitTest.php

@@ -920,6 +920,51 @@ public function testChunkEmptyResult()
         $this->assertSettablePropertiesReset(self::$testRepositoryClass);
     }
 
+    public function testLazyEach()
+    {
+        $mockResult = $this->getJsonFixture('lazy_each_query_result');
+
+        $this->mockLazyEach($mockResult);
+
+        $counter = 0;
+
+        self::$testRepositoryClass
+            ->withTrashed()
+            ->onlyTrashed()
+            ->force()
+            ->with('relation')
+            ->withCount('relation')
+            ->lazyEach(function () use (&$counter) {
+                $counter++;
+            }, chunkSize: 1);
+
+        $this->assertEquals(2, $counter);
+
+        $this->assertSettablePropertiesReset(self::$testRepositoryClass);
+    }
+
+    public function testLazyEachEmptyResult()
+    {
+        $nullCondition = $this->lazyByIdInitialNullCondition();
+
+        $this->mockSelect(
+            'select * from "test_models"'
+            . ($nullCondition ? ' where "id" is not null' : '')
+            . ' order by "id" asc limit 500',
+        );
+
+        $counter = 0;
+
+        // TODO: remove withTrashed() after increase min Laravel version up to 13
+        self::$testRepositoryClass
+            ->withTrashed()
+            ->lazyEach(function () use (&$counter) {
+                $counter++;
+            });
+
+        $this->assertEquals(0, $counter);
+    }
+
     public function testForceDeleteByList()
     {
         $this->mockDelete(

tests/MockTraitTest.php

@@ -3,6 +3,7 @@
 namespace RonasIT\Support\Tests;
 
 use PHPUnit\Framework\ExpectationFailedException;
+use PHPUnit\Runner\Version as PhpUnitVersion;
 use ReflectionClass;
 use ReflectionProperty;
 use RonasIT\Support\Tests\Support\Mock\TestMockClass;
@@ -219,12 +220,18 @@ protected function clearMockAssertionFailures(): void
             $class = $class->getParentClass();
         }
 
-        foreach ($class->getProperty('mockObjects')->getValue($this) as $entry) {
-            $handler = $entry['mockObject']->__phpunit_getInvocationHandler();
-
-            $assertionFailureProp = new ReflectionProperty($handler, 'assertionFailure');
+        // TODO: Remove after increase min PHPUnit version up to 11
+        $isNewPhpunit = version_compare(PhpUnitVersion::id(), '11.0.0', '>=');
 
-            $assertionFailureProp->setValue($handler, null);
+        foreach ($class->getProperty('mockObjects')->getValue($this) as $entry) {
+            if ($isNewPhpunit) {
+                $handler = $entry['mockObject']->__phpunit_getInvocationHandler();
+                (new ReflectionProperty($handler, 'matchers'))->setValue($handler, []);
+                (new ReflectionProperty($handler, 'assertionFailure'))->setValue($handler, null);
+            } else {
+                $handler = $entry->__phpunit_getInvocationHandler();
+                (new ReflectionProperty($handler, 'matchers'))->setValue($handler, []);
+            }
         }
     }
 }

tests/fixtures/EntityControlTraitTest/lazy_each_query_result.json

@@ -0,0 +1,16 @@
+[
+  {
+    "id": 1,
+    "name": "John",
+    "email": "john@example.com",
+    "created_at": "2020-01-01 00:00:00",
+    "updated_at": "2020-01-01 00:00:00"
+  },
+  {
+    "id": 2,
+    "name": "Jane",
+    "email": "jane@example.com",
+    "created_at": "2020-01-01 00:00:00",
+    "updated_at": "2020-01-01 00:00:00"
+  }
+]

tests/support/Traits/SqlMockTrait.php

@@ -142,6 +142,33 @@ protected function mockChunk(array $selectResult): void
         );
     }
 
+    // TODO: remove after increase min Laravel version up to 13
+    protected function lazyByIdInitialNullCondition(): string
+    {
+        return version_compare(app()->version(), '12.4.0', '>=') ? ' and "id" is not null' : '';
+    }
+
+    protected function mockLazyEach(array $selectResult): void
+    {
+        $mainQuery = 'select "test_models".*, (select count(*) from "relation_models" '
+            . 'where "test_models"."id" = "relation_models"."test_model_id") as "relation_count" '
+            . 'from "test_models" where "test_models"."deleted_at" is not null';
+
+        $firstRow = array_shift($selectResult);
+        $lastId = $firstRow['id'];
+
+        $this->mockSelect("{$mainQuery}{$this->lazyByIdInitialNullCondition()} order by \"id\" asc limit 1", [$firstRow]);
+        $this->mockSelect("select * from \"relation_models\" where \"relation_models\".\"test_model_id\" in ({$lastId})");
+
+        foreach ($selectResult as $row) {
+            $this->mockSelect("{$mainQuery} and \"id\" > ? order by \"id\" asc limit 1", [$row], [$lastId]);
+            $this->mockSelect("select * from \"relation_models\" where \"relation_models\".\"test_model_id\" in ({$row['id']})");
+            $lastId = $row['id'];
+        }
+
+        $this->mockSelect("{$mainQuery} and \"id\" > ? order by \"id\" asc limit 1", [], [$lastId]);
+    }
+
     protected function mockCreate(array $selectResult, $notFillableValue): void
     {
         $this->mockInsert(