Added support for chunked finder.

Author: Robert Pustułka

src/Model/Behavior/ChunkBehavior.php

@@ -26,6 +26,7 @@
 
 use Cake\ORM\Behavior;
 use Cake\ORM\Query;
+use Robotusers\Chunk\ORM\Query as ChunkedQuery;
 use Robotusers\Chunk\ORM\ResultSet;
 
 class ChunkBehavior extends Behavior
@@ -42,4 +43,19 @@ public function chunk(Query $query, array $config = [])
     {
         return new ResultSet($query, $config);
     }
+
+    /**
+     * Chunked result finder.
+     *
+     * @param Query $query Query instance.
+     * @param array $config Config.
+     * @return ChunkedQuery
+     */
+    public function findChunked(Query $query, array $config = [])
+    {
+        $chunkedQuery = new ChunkedQuery($query);
+        $chunkedQuery->applyOptions($config);
+
+        return $chunkedQuery;
+    }
 }

src/ORM/Query.php

@@ -0,0 +1,100 @@
+<?php
+/*
+ * The MIT License
+ *
+ * Copyright 2017 Robert Pustułka <[email protected]>.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+namespace Robotusers\Chunk\ORM;
+
+use Cake\ORM\Query as BaseQuery;
+
+/**
+ * Description of Query
+ *
+ * @author Robert Pustułka <[email protected]>
+ */
+class Query extends BaseQuery
+{
+
+    /**
+     * Constructor. Takes a query and feeds this object with its properties.
+     *
+     * @param BaseQuery $query Query instance.
+     */
+    public function __construct(BaseQuery $query)
+    {
+        parent::__construct($query->getConnection(), $query->repository());
+
+        $this->load($query);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function applyOptions(array $options)
+    {
+        if (isset($options['chunkSize'])) {
+            $this->_options['chunkSize'] = $options['chunkSize'];
+        }
+
+        return parent::applyOptions($options);
+    }
+
+    /**
+     * Returns chunked reuslt set.
+     *
+     * @return \Robotusers\Chunk\ORM\ResultSet
+     */
+    public function all()
+    {
+        $config = [];
+        if (isset($this->_options['chunkSize'])) {
+            $config['size'] = $this->_options['chunkSize'];
+        }
+
+        return new ResultSet($this, $config);
+    }
+
+    /**
+     * Returns default ResultSet.
+     *
+     * {@inheritDoc}
+     */
+    public function defaultAll()
+    {
+        return parent::all();
+    }
+
+    /**
+     * Feeds this object with query properties.
+     *
+     * @param BaseQuery $query Query instance.
+     * @return void
+     */
+    protected function load(BaseQuery $query)
+    {
+        $vars = get_object_vars($query);
+        foreach ($vars as $key => $value) {
+            $this->$key = $value;
+        }
+    }
+}

tests/TestCase/Model/Behavior/ChunkBehaviorTest.php

@@ -27,6 +27,7 @@
 use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
 use Robotusers\Chunk\Model\Behavior\ChunkBehavior;
+use Robotusers\Chunk\ORM\Query;
 use Robotusers\Chunk\ORM\ResultSet;
 
 /**
@@ -53,4 +54,16 @@ public function testChunk()
         $this->assertInstanceOf(ResultSet::class, $chunk);
         $this->assertEquals(100, $chunk->getConfig('size'));
     }
+
+    public function testFinder()
+    {
+        $table = TableRegistry::get('Authors');
+        $table->addBehavior('Robotusers/Chunk.Chunk');
+        $query = $table->find('chunked', [
+            'chunkSize' => 1
+        ]);
+
+        $this->assertInstanceOf(Query::class, $query);
+        $this->assertEquals(1, $query->getOptions()['chunkSize']);
+    }
 }

tests/TestCase/ORM/QueryTest.php

@@ -0,0 +1,88 @@
+<?php
+/*
+ * The MIT License
+ *
+ * Copyright 2017 Robert Pustułka <[email protected]>.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+namespace Robotusers\Chunk\Test\TestCase\ORM;
+
+use Cake\ORM\ResultSet as CoreResultSet;
+use Cake\ORM\TableRegistry;
+use Cake\TestSuite\TestCase;
+use Robotusers\Chunk\ORM\Query;
+use Robotusers\Chunk\ORM\ResultSet;
+
+/**
+ * Description of QueryTest
+ *
+ * @author Robert Pustułka <[email protected]>
+ */
+class QueryTest extends TestCase
+{
+    public $fixtures = [
+        'core.authors'
+    ];
+
+    public function testLoad()
+    {
+        $table = TableRegistry::get('Authors');
+        $query = $table->find();
+
+        $chunkedQuery = new Query($query);
+
+        $this->assertSame($query->repository(), $chunkedQuery->repository());
+        $this->assertSame($query->getConnection(), $chunkedQuery->getConnection());
+        $this->assertSame($query->getOptions(), $chunkedQuery->getOptions());
+    }
+
+    public function testApplyOptions()
+    {
+        $table = TableRegistry::get('Authors');
+        $query = $table->find();
+
+        $chunkedQuery = new Query($query);
+        $chunkedQuery->applyOptions(['chunkSize' => 100]);
+        $this->assertEquals(100, $chunkedQuery->getOptions()['chunkSize']);
+    }
+
+    public function testAll()
+    {
+        $table = TableRegistry::get('Authors');
+        $query = $table->find();
+
+        $chunkedQuery = new Query($query);
+        $chunkedQuery->applyOptions(['chunkSize' => 100]);
+        $results = $chunkedQuery->all();
+        $this->assertInstanceOf(ResultSet::class, $results);
+        $this->assertEquals(100, $results->getConfig('size'));
+    }
+
+    public function testDefaultAll()
+    {
+        $table = TableRegistry::get('Authors');
+        $query = $table->find();
+
+        $chunkedQuery = new Query($query);
+        $results = $chunkedQuery->defaultAll();
+        $this->assertInstanceOf(CoreResultSet::class, $results);
+    }
+}

tests/TestCase/ORM/ResultSetTest.php

@@ -23,7 +23,7 @@
  * THE SOFTWARE.
  */
 
-namespace Robotusers\Chunk\Test\TestCase\Model;
+namespace Robotusers\Chunk\Test\TestCase\ORM;
 
 use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;