Add transformation compound return types and add valuable unit tests

tbolier · marcgeurts · commit e132aa6bec11 · 2018-02-22T14:52:38.000+01:00
diff --git a/src/Query/Aggregation/AbstractAggregation.php b/src/Query/Aggregation/AbstractAggregation.php
@@ -19,31 +19,31 @@ public function count(): QueryInterface
     /**
      * @inheritdoc
      */
-    public function sum($key): QueryInterface
+    public function sum(string $key): QueryInterface
     {
         return new Sum($this->rethink, $this->message, $this, $key);
     }
 
     /**
      * @inheritdoc
      */
-    public function avg($key): QueryInterface
+    public function avg(string $key): QueryInterface
     {
         return new Avg($this->rethink, $this->message, $this, $key);
     }
 
     /**
      * @inheritdoc
      */
-    public function min($key): AggregationInterface
+    public function min(string $key): AggregationInterface
     {
         return new Min($this->rethink, $this->message, $this, $key);
     }
 
     /**
      * @inheritdoc
      */
-    public function max($key): AggregationInterface
+    public function max(string $key): AggregationInterface
     {
         return new Max($this->rethink, $this->message, $this, $key);
     }
diff --git a/src/Query/Aggregation/AggregationInterface.php b/src/Query/Aggregation/AggregationInterface.php
@@ -17,25 +17,25 @@ public function count(): QueryInterface;
      * @param string $key
      * @return QueryInterface
      */
-    public function sum($key): QueryInterface;
+    public function sum(string $key): QueryInterface;
 
     /**
      * @param string $key
      * @return QueryInterface
      */
-    public function avg($key): QueryInterface;
+    public function avg(string $key): QueryInterface;
 
     /**
      * @param string $key
      * @return AggregationInterface
      */
-    public function min($key): AggregationInterface;
+    public function min(string $key): AggregationInterface;
 
     /**
      * @param string $key
      * @return AggregationInterface
      */
-    public function max($key): AggregationInterface;
+    public function max(string $key): AggregationInterface;
 
     /**
      * @return Iterable|ResponseInterface
diff --git a/src/Query/Operation/AbstractOperation.php b/src/Query/Operation/AbstractOperation.php
@@ -4,6 +4,7 @@
 namespace TBolier\RethinkQL\Query\Operation;
 
 use TBolier\RethinkQL\Query\Aggregation\AbstractAggregation;
+use TBolier\RethinkQL\Query\Transformation\TransformationCompoundInterface;
 use TBolier\RethinkQL\Query\QueryInterface;
 
 abstract class AbstractOperation extends AbstractAggregation implements OperationInterface
@@ -19,15 +20,15 @@ public function delete(): QueryInterface
     /**
      * @inheritdoc
      */
-    public function filter(array $predicate): OperationInterface
+    public function filter(array $predicate): TransformationCompoundInterface
     {
         return new Filter($this->rethink, $this->message, $this, $predicate);
     }
 
     /**
      * @inheritdoc
      */
-    public function getAll(...$keys): OperationInterface
+    public function getAll(...$keys): TransformationCompoundInterface
     {
         return new GetAll($this->rethink, $this->message, $this, $keys);
     }
diff --git a/src/Query/Operation/GetAll.php b/src/Query/Operation/GetAll.php
@@ -5,10 +5,11 @@
 
 use TBolier\RethinkQL\Message\MessageInterface;
 use TBolier\RethinkQL\Query\QueryInterface;
+use TBolier\RethinkQL\Query\Transformation\AbstractTransformationCompound;
 use TBolier\RethinkQL\RethinkInterface;
 use TBolier\RethinkQL\Types\Term\TermType;
 
-class GetAll extends AbstractOperation
+class GetAll extends AbstractTransformationCompound
 {
     /**
      * @var array
diff --git a/src/Query/Operation/OperationInterface.php b/src/Query/Operation/OperationInterface.php
@@ -5,6 +5,7 @@
 
 use TBolier\RethinkQL\Query\Aggregation\AggregationInterface;
 use TBolier\RethinkQL\Query\QueryInterface;
+use TBolier\RethinkQL\Query\Transformation\TransformationCompoundInterface;
 use TBolier\RethinkQL\Response\ResponseInterface;
 
 interface OperationInterface extends AggregationInterface
@@ -16,15 +17,15 @@ public function delete(): QueryInterface;
 
     /**
      * @param array $predicate
-     * @return OperationInterface
+     * @return TransformationCompoundInterface
      */
-    public function filter(array $predicate): OperationInterface;
+    public function filter(array $predicate): TransformationCompoundInterface;
 
     /**
      * @param int|string|array $keys
-     * @return OperationInterface
+     * @return TransformationCompoundInterface
      */
-    public function getAll(...$keys): OperationInterface;
+    public function getAll(...$keys): TransformationCompoundInterface;
 
     /**
      * @param array $elements
diff --git a/src/Query/Transformation/AbstractTransformation.php b/src/Query/Transformation/AbstractTransformation.php
@@ -19,23 +19,23 @@ public function isEmpty(): QueryInterface
     /**
      * @inheritdoc
      */
-    public function limit($value): TransformationInterface
+    public function limit($value): TransformationCompoundInterface
     {
         return new Limit($this->rethink, $this->message, $this, $value);
     }
 
     /**
      * @inheritdoc
      */
-    public function skip($value): TransformationInterface
+    public function skip($value): TransformationCompoundInterface
     {
         return new Skip($this->rethink, $this->message, $this, $value);
     }
 
     /**
      * @inheritdoc
      */
-    public function orderBy($key): TransformationInterface
+    public function orderBy($key): TransformationCompoundInterface
     {
         return new OrderBy($this->rethink, $this->message, $this, $key);
     }
diff --git a/src/Query/Transformation/AbstractTransformationCompound.php b/src/Query/Transformation/AbstractTransformationCompound.php
@@ -6,7 +6,7 @@
 use TBolier\RethinkQL\Query\Operation\AbstractOperation;
 use TBolier\RethinkQL\Query\QueryInterface;
 
-abstract class AbstractTransformationCompound extends AbstractOperation implements TransformationInterface
+abstract class AbstractTransformationCompound extends AbstractOperation implements TransformationCompoundInterface
 {
     /**
      * @inheritdoc
@@ -19,23 +19,23 @@ public function isEmpty(): QueryInterface
     /**
      * @inheritdoc
      */
-    public function limit($value): TransformationInterface
+    public function limit($value): TransformationCompoundInterface
     {
         return new Limit($this->rethink, $this->message, $this, $value);
     }
 
     /**
      * @inheritdoc
      */
-    public function skip($value): TransformationInterface
+    public function skip($value): TransformationCompoundInterface
     {
         return new Skip($this->rethink, $this->message, $this, $value);
     }
 
     /**
      * @inheritdoc
      */
-    public function orderBy($key): TransformationInterface
+    public function orderBy($key): TransformationCompoundInterface
     {
         return new OrderBy($this->rethink, $this->message, $this, $key);
     }
diff --git a/src/Query/Transformation/Limit.php b/src/Query/Transformation/Limit.php
@@ -8,7 +8,7 @@
 use TBolier\RethinkQL\RethinkInterface;
 use TBolier\RethinkQL\Types\Term\TermType;
 
-class Limit extends AbstractTransformation
+class Limit extends AbstractTransformationCompound
 {
     /**
      * @var int
diff --git a/src/Query/Transformation/OrderBy.php b/src/Query/Transformation/OrderBy.php
@@ -8,7 +8,7 @@
 use TBolier\RethinkQL\RethinkInterface;
 use TBolier\RethinkQL\Types\Term\TermType;
 
-class OrderBy extends AbstractTransformation
+class OrderBy extends AbstractTransformationCompound
 {
     /**
      * @var mixed|QueryInterface
diff --git a/src/Query/Transformation/Skip.php b/src/Query/Transformation/Skip.php
@@ -8,7 +8,7 @@
 use TBolier\RethinkQL\RethinkInterface;
 use TBolier\RethinkQL\Types\Term\TermType;
 
-class Skip extends AbstractTransformation
+class Skip extends AbstractTransformationCompound
 {
     /**
      * @var int
diff --git a/src/Query/Transformation/TransformationCompoundInterface.php b/src/Query/Transformation/TransformationCompoundInterface.php
@@ -0,0 +1,39 @@
+<?php
+declare(strict_types = 1);
+
+namespace TBolier\RethinkQL\Query\Transformation;
+
+use TBolier\RethinkQL\Query\Operation\OperationInterface;
+use TBolier\RethinkQL\Query\QueryInterface;
+use TBolier\RethinkQL\Response\ResponseInterface;
+
+interface TransformationCompoundInterface extends OperationInterface
+{
+    /**
+     * @return QueryInterface
+     */
+    public function isEmpty(): QueryInterface;
+
+    /**
+     * @param int $n
+     * @return TransformationCompoundInterface
+     */
+    public function limit($n): TransformationCompoundInterface;
+
+    /**
+     * @param int $n
+     * @return TransformationCompoundInterface
+     */
+    public function skip($n): TransformationCompoundInterface;
+
+    /**
+     * @param mixed|QueryInterface $key
+     * @return TransformationCompoundInterface
+     */
+    public function orderBy($key): TransformationCompoundInterface;
+
+    /**
+     * @return Iterable|ResponseInterface
+     */
+    public function run();
+}
diff --git a/src/Query/Transformation/TransformationInterface.php b/src/Query/Transformation/TransformationInterface.php
@@ -15,21 +15,21 @@ public function isEmpty(): QueryInterface;
 
     /**
      * @param int $n
-     * @return TransformationInterface
+     * @return TransformationCompoundInterface
      */
-    public function limit($n): TransformationInterface;
+    public function limit($n): TransformationCompoundInterface;
 
     /**
      * @param int $n
-     * @return TransformationInterface
+     * @return TransformationCompoundInterface
      */
-    public function skip($n): TransformationInterface;
+    public function skip($n): TransformationCompoundInterface;
 
     /**
      * @param mixed|QueryInterface $key
-     * @return TransformationInterface
+     * @return TransformationCompoundInterface
      */
-    public function orderBy($key): TransformationInterface;
+    public function orderBy($key): TransformationCompoundInterface;
 
     /**
      * @return Iterable|ResponseInterface
diff --git a/test/integration/Aggregation/MaxTest.php b/test/integration/Aggregation/MaxTest.php
@@ -14,11 +14,11 @@ class MaxTest extends AbstractTableTest
      */
     public function testMax(): void
     {
-        $this->insertDocument(5);
-        $this->insertDocument(4);
-        $this->insertDocument(3);
-        $this->insertDocument(2);
-        $this->insertDocument(1);
+        $this->insertDocumentWithNumber(5, 99);
+        $this->insertDocumentWithNumber(4, 77);
+        $this->insertDocumentWithNumber(3, 1045);
+        $this->insertDocumentWithNumber(2,4);
+        $this->insertDocumentWithNumber(1, 43534);
 
         /** @var ResponseInterface $res */
         $res = $this->r()
@@ -29,6 +29,6 @@ public function testMax(): void
         /** @var array $array */
         $array = $res->getData();
 
-        $this->assertArraySubset(['description' => 'A document description.'], $array);
+        $this->assertArraySubset(['number' => 43534], $array);
     }
 }
diff --git a/test/integration/Aggregation/MinTest.php b/test/integration/Aggregation/MinTest.php
@@ -14,11 +14,11 @@ class MinTest extends AbstractTableTest
      */
     public function testMin(): void
     {
-        $this->insertDocument(5);
-        $this->insertDocument(4);
-        $this->insertDocument(3);
-        $this->insertDocument(2);
-        $this->insertDocument(1);
+        $this->insertDocumentWithNumber(5, 99);
+        $this->insertDocumentWithNumber(4, 77);
+        $this->insertDocumentWithNumber(3, 1045);
+        $this->insertDocumentWithNumber(2,4);
+        $this->insertDocumentWithNumber(1, 43534);
 
         /** @var ResponseInterface $res */
         $res = $this->r()
@@ -29,6 +29,6 @@ public function testMin(): void
         /** @var array $array */
         $array = $res->getData();
 
-        $this->assertArraySubset(['description' => 'A document description.'], $array);
+        $this->assertArraySubset(['number' => 4], $array);
     }
 }
diff --git a/test/integration/Query/AbstractTableTest.php b/test/integration/Query/AbstractTableTest.php
@@ -28,7 +28,6 @@ public function tearDown()
         parent::tearDown();
     }
 
-
     /**
      * @param int|string $id
      * @return ResponseInterface
@@ -40,7 +39,26 @@ protected function insertDocument($id): ResponseInterface
             ->insert([
                 'id' => $id,
                 'title' => 'Test document '.$id,
-                'number' => rand(15, 60),
+                'description' => 'A document description.',
+            ])
+            ->run();
+
+        return $res;
+    }
+
+    /**
+     * @param int|string $id
+     * @param int $number
+     * @return ResponseInterface
+     */
+    protected function insertDocumentWithNumber($id, int $number): ResponseInterface
+    {
+        $res = $this->r()
+            ->table('tabletest')
+            ->insert([
+                'id' => $id,
+                'title' => 'Test document '.$id,
+                'number' => $number,
                 'description' => 'A document description.',
             ])
             ->run();
diff --git a/test/integration/Query/FilterTest.php b/test/integration/Query/FilterTest.php
diff --git a/test/integration/Query/GetAllTest.php b/test/integration/Query/GetAllTest.php
diff --git a/test/integration/Transformation/LimitTest.php b/test/integration/Transformation/LimitTest.php

Original file line number	Diff line number	Diff line change
`@@ -19,31 +19,31 @@ public function count(): QueryInterface`
`19`	`19`	`/**`
`20`	`20`	`* @inheritdoc`
`21`	`21`	`*/`
`22`		`- public function sum($key): QueryInterface`
	`22`	`+ public function sum(string $key): QueryInterface`
`23`	`23`	`{`
`24`	`24`	`return new Sum($this->rethink, $this->message, $this, $key);`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`/**`
`28`	`28`	`* @inheritdoc`
`29`	`29`	`*/`
`30`		`- public function avg($key): QueryInterface`
	`30`	`+ public function avg(string $key): QueryInterface`
`31`	`31`	`{`
`32`	`32`	`return new Avg($this->rethink, $this->message, $this, $key);`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`/**`
`36`	`36`	`* @inheritdoc`
`37`	`37`	`*/`
`38`		`- public function min($key): AggregationInterface`
	`38`	`+ public function min(string $key): AggregationInterface`
`39`	`39`	`{`
`40`	`40`	`return new Min($this->rethink, $this->message, $this, $key);`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`/**`
`44`	`44`	`* @inheritdoc`
`45`	`45`	`*/`
`46`		`- public function max($key): AggregationInterface`
	`46`	`+ public function max(string $key): AggregationInterface`
`47`	`47`	`{`
`48`	`48`	`return new Max($this->rethink, $this->message, $this, $key);`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`namespace TBolier\RethinkQL\Query\Operation;`
`5`	`5`
`6`	`6`	`use TBolier\RethinkQL\Query\Aggregation\AbstractAggregation;`
	`7`	`+use TBolier\RethinkQL\Query\Transformation\TransformationCompoundInterface;`
`7`	`8`	`use TBolier\RethinkQL\Query\QueryInterface;`
`8`	`9`
`9`	`10`	`abstract class AbstractOperation extends AbstractAggregation implements OperationInterface`
`@@ -19,15 +20,15 @@ public function delete(): QueryInterface`
`19`	`20`	`/**`
`20`	`21`	`* @inheritdoc`
`21`	`22`	`*/`
`22`		`- public function filter(array $predicate): OperationInterface`
	`23`	`+ public function filter(array $predicate): TransformationCompoundInterface`
`23`	`24`	`{`
`24`	`25`	`return new Filter($this->rethink, $this->message, $this, $predicate);`
`25`	`26`	`}`
`26`	`27`
`27`	`28`	`/**`
`28`	`29`	`* @inheritdoc`
`29`	`30`	`*/`
`30`		`- public function getAll(...$keys): OperationInterface`
	`31`	`+ public function getAll(...$keys): TransformationCompoundInterface`
`31`	`32`	`{`
`32`	`33`	`return new GetAll($this->rethink, $this->message, $this, $keys);`
`33`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,23 +19,23 @@ public function isEmpty(): QueryInterface`
`19`	`19`	`/**`
`20`	`20`	`* @inheritdoc`
`21`	`21`	`*/`
`22`		`- public function limit($value): TransformationInterface`
	`22`	`+ public function limit($value): TransformationCompoundInterface`
`23`	`23`	`{`
`24`	`24`	`return new Limit($this->rethink, $this->message, $this, $value);`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`/**`
`28`	`28`	`* @inheritdoc`
`29`	`29`	`*/`
`30`		`- public function skip($value): TransformationInterface`
	`30`	`+ public function skip($value): TransformationCompoundInterface`
`31`	`31`	`{`
`32`	`32`	`return new Skip($this->rethink, $this->message, $this, $value);`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`/**`
`36`	`36`	`* @inheritdoc`
`37`	`37`	`*/`
`38`		`- public function orderBy($key): TransformationInterface`
	`38`	`+ public function orderBy($key): TransformationCompoundInterface`
`39`	`39`	`{`
`40`	`40`	`return new OrderBy($this->rethink, $this->message, $this, $key);`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`use TBolier\RethinkQL\Query\Operation\AbstractOperation;`
`7`	`7`	`use TBolier\RethinkQL\Query\QueryInterface;`
`8`	`8`
`9`		`-abstract class AbstractTransformationCompound extends AbstractOperation implements TransformationInterface`
	`9`	`+abstract class AbstractTransformationCompound extends AbstractOperation implements TransformationCompoundInterface`
`10`	`10`	`{`
`11`	`11`	`/**`
`12`	`12`	`* @inheritdoc`
`@@ -19,23 +19,23 @@ public function isEmpty(): QueryInterface`
`19`	`19`	`/**`
`20`	`20`	`* @inheritdoc`
`21`	`21`	`*/`
`22`		`- public function limit($value): TransformationInterface`
	`22`	`+ public function limit($value): TransformationCompoundInterface`
`23`	`23`	`{`
`24`	`24`	`return new Limit($this->rethink, $this->message, $this, $value);`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`/**`
`28`	`28`	`* @inheritdoc`
`29`	`29`	`*/`
`30`		`- public function skip($value): TransformationInterface`
	`30`	`+ public function skip($value): TransformationCompoundInterface`
`31`	`31`	`{`
`32`	`32`	`return new Skip($this->rethink, $this->message, $this, $value);`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`/**`
`36`	`36`	`* @inheritdoc`
`37`	`37`	`*/`
`38`		`- public function orderBy($key): TransformationInterface`
	`38`	`+ public function orderBy($key): TransformationCompoundInterface`
`39`	`39`	`{`
`40`	`40`	`return new OrderBy($this->rethink, $this->message, $this, $key);`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`use TBolier\RethinkQL\RethinkInterface;`
`9`	`9`	`use TBolier\RethinkQL\Types\Term\TermType;`
`10`	`10`
`11`		`-class Limit extends AbstractTransformation`
	`11`	`+class Limit extends AbstractTransformationCompound`
`12`	`12`	`{`
`13`	`13`	`/**`
`14`	`14`	`* @var int`