improve error messages by inluding info about user input

Author: Wout Gevaert

src/Clauses/CallProcedureClause.php

@@ -22,6 +22,8 @@
 namespace WikibaseSolutions\CypherDSL\Clauses;
 
 use InvalidArgumentException;
+use TypeError;
+use WikibaseSolutions\CypherDSL\ErrorHandling\ErrorTextHelper;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
 use WikibaseSolutions\CypherDSL\Variable;
 
@@ -75,7 +77,13 @@ public function withArguments(array $arguments): self
     {
         foreach ($arguments as $argument) {
             if (!($argument instanceof AnyType)) {
-                throw new InvalidArgumentException("\$arguments should only consist of AnyType objects");
+                throw new TypeError(
+                    ErrorTextHelper::getTypeErrorObjectArrayText(
+                        'arguments',
+                        'AnyType',
+                        $argument
+                    )
+                );
             }
         }
 

src/Functions/RawFunction.php

@@ -22,6 +22,7 @@
 namespace WikibaseSolutions\CypherDSL\Functions;
 
 use InvalidArgumentException;
+use TypeError;
 use WikibaseSolutions\CypherDSL\Traits\BooleanTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\ListTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\MapTypeTrait;
@@ -37,6 +38,7 @@
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\StringType;
 use WikibaseSolutions\CypherDSL\Types\StructuralTypes\NodeType;
 use WikibaseSolutions\CypherDSL\Types\StructuralTypes\PathType;
+use WikibaseSolutions\CypherDSL\ErrorHandling\ErrorTextHelper;
 
 /**
  * This class represents any function call.
@@ -78,7 +80,13 @@ public function __construct(string $functionName, array $parameters)
     {
         foreach ($parameters as $parameter) {
             if (!($parameter instanceof AnyType)) {
-                throw new InvalidArgumentException("\$parameters should only consist of AnyType objects");
+                throw new TypeError(
+                    ErrorTextHelper::getTypeErrorObjectArrayText(
+                        'parameters',
+                        'AnyType',
+                        $parameter
+                    )
+                );
             }
         }
 

src/Query.php

@@ -38,6 +38,7 @@
 use WikibaseSolutions\CypherDSL\Clauses\WhereClause;
 use WikibaseSolutions\CypherDSL\Clauses\WithClause;
 use WikibaseSolutions\CypherDSL\Functions\FunctionCall;
+use WikibaseSolutions\CypherDSL\ErrorHandling\ErrorTextHelper;
 use WikibaseSolutions\CypherDSL\Literals\Boolean;
 use WikibaseSolutions\CypherDSL\Literals\Decimal;
 use WikibaseSolutions\CypherDSL\Literals\Literal;
@@ -235,7 +236,9 @@ public function match($patterns): self
 
         foreach ($patterns as $pattern) {
             if (!($pattern instanceof StructuralType)) {
-                throw new TypeError("\$patterns should only consist of StructuralType objects");
+                throw new TypeError(
+                    ErrorTextHelper::getTypeErrorObjectArrayText('patterns', 'StructuralType', $pattern)
+                );
             }
 
             $matchClause->addPattern($pattern);
@@ -268,7 +271,13 @@ public function returning($expressions, bool $distinct = false): self
 
         foreach ($expressions as $maybeAlias => $expression) {
             if (!($expression instanceof AnyType)) {
-                throw new TypeError("\$expressions should only consist of AnyType objects");
+                throw new TypeError(
+                    ErrorTextHelper::getTypeErrorObjectArrayText(
+                        'expressions',
+                        'AnyType',
+                        $expression
+                    )
+                );
             }
 
             if ($expression instanceof Node) {
@@ -305,7 +314,13 @@ public function create($patterns): self
 
         foreach ($patterns as $pattern) {
             if (!($pattern instanceof StructuralType)) {
-                throw new TypeError("\$patterns should only consist of StructuralType objects");
+                throw new TypeError(
+                    ErrorTextHelper::getTypeErrorObjectArrayText(
+                        'patterns',
+                        'StructuralType',
+                        $pattern
+                    )
+                );
             }
 
             $createClause->addPattern($pattern);
@@ -335,7 +350,13 @@ public function delete($nodes): self
 
         foreach ($nodes as $node) {
             if (!($node instanceof NodeType)) {
-                throw new TypeError("\$nodes should exist of only NodeType objects");
+                throw new TypeError(
+                    ErrorTextHelper::getTypeErrorObjectArrayText(
+                        'nodes',
+                        'NodeType',
+                        $node
+                    )
+                );
             }
 
             $deleteClause->addNode($node);
@@ -366,7 +387,13 @@ public function detachDelete($nodes): self
 
         foreach ($nodes as $node) {
             if (!($node instanceof NodeType)) {
-                throw new TypeError("\$nodes should exist of only NodeType objects");
+                throw new TypeError(
+                    ErrorTextHelper::getTypeErrorObjectArrayText(
+                        'nodes',
+                        'NodeType',
+                        $node
+                    )
+                );
             }
 
             $deleteClause->addNode($node);
@@ -444,7 +471,13 @@ public function optionalMatch($patterns): self
 
         foreach ($patterns as $pattern) {
             if (!($pattern instanceof StructuralType)) {
-                throw new TypeError("\$patterns should only consist of StructuralType objects");
+                throw new TypeError(
+                    ErrorTextHelper::getTypeErrorObjectArrayText(
+                        'patterns',
+                        'StructuralType',
+                        $pattern
+                    )
+                );
             }
 
             $optionalMatchClause->addPattern($pattern);
@@ -476,7 +509,13 @@ public function orderBy($properties, bool $descending = false): self
 
         foreach ($properties as $property) {
             if (!($property instanceof Property)) {
-                throw new TypeError("\$properties should only consist of Property objects");
+                throw new TypeError(
+                    ErrorTextHelper::getTypeErrorObjectArrayText(
+                        'properties',
+                        'PropertyType',
+                        $property
+                    )
+                );
             }
 
             $orderByClause->addProperty($property);
@@ -506,7 +545,13 @@ public function remove($expressions): self
 
         foreach ($expressions as $expression) {
             if (!($expression instanceof Property) && !($expression instanceof Label)) {
-                throw new TypeError("\$expressions should consist of only Property or Label objects");
+                throw new TypeError(
+                    ErrorTextHelper::getTypeErrorObjectArrayText(
+                        'expressions',
+                        'Property or Label',
+                        $expression
+                    )
+                );
             }
 
             $removeClause->addExpression($expression);
@@ -536,7 +581,11 @@ public function set($expressions): self
 
         foreach ($expressions as $expression) {
             if (!($expression instanceof Assignment) && !($expression instanceof Label)) {
-                throw new TypeError("\$expressions should only consist of Assignment and Label objects");
+                throw new TypeError(
+                    'expressions',
+                    'Assignment and Label',
+                    $expression
+                );
             }
 
             $setClause->addAssignment($expression);
@@ -586,7 +635,13 @@ public function with($expressions): self
 
         foreach ($expressions as $maybeAlias => $expression) {
             if (!($expression instanceof AnyType)) {
-                throw new TypeError("\$expressions should only consist of AnyType objects");
+                throw new TypeError(
+                    ErrorTextHelper::getTypeErrorObjectArrayText(
+                        'expressions',
+                        'AnyType',
+                        $expression
+                    )
+                );
             }
 
             if ($expression instanceof Node) {
@@ -678,4 +733,4 @@ public function build(): string
             " ", array_filter($builtClauses, fn($clause) => !empty($clause))
         );
     }
-}
+}