Work on rewriting traits to new DSL

Author: marijnvanwezel

src/Clauses/CallProcedureClause.php

@@ -11,6 +11,7 @@
 
 use WikibaseSolutions\CypherDSL\Expressions\Procedures\Procedure;
 use WikibaseSolutions\CypherDSL\Expressions\Variable;
+use WikibaseSolutions\CypherDSL\Syntax\Alias;
 use WikibaseSolutions\CypherDSL\Traits\CastTrait;
 use WikibaseSolutions\CypherDSL\Traits\ErrorTrait;
 use WikibaseSolutions\CypherDSL\Traits\EscapeTrait;
@@ -56,17 +57,15 @@ public function setProcedure(Procedure $procedure): self
     /**
      * Adds a variable to yield.
      *
-     * TODO: Allow variables to be aliased
-     *
-     * @param Variable|string $yields The variable to yield
+     * @param Variable|Alias|string $yields The variable to yield
      * @return $this
      */
     public function addYield(...$yields): self
     {
         $res = [];
 
         foreach ($yields as $yield) {
-            $res[] = self::toName($yield);
+            $res[] = $yield instanceof Alias ? $yield : self::toName($yield);
         }
 
         $this->yields = array_merge($this->yields, $res);

src/Clauses/LimitClause.php

@@ -11,6 +11,7 @@
 
 use WikibaseSolutions\CypherDSL\Query;
 use WikibaseSolutions\CypherDSL\Traits\CastTrait;
+use WikibaseSolutions\CypherDSL\Types\PropertyTypes\IntegerType;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\NumeralType;
 
 /**
@@ -29,31 +30,29 @@ final class LimitClause extends Clause
     /**
      * The expression of the LIMIT statement.
      *
-     * @var NumeralType|null $limit
+     * @var IntegerType|null $limit
      */
-    private ?NumeralType $limit = null;
+    private ?IntegerType $limit = null;
 
     /**
      * Sets the expression that returns the limit.
      *
-     * TODO: Rewrite this to only accept IntegerType (this also requires work in other parts of the DSL)
-     *
-     * @param NumeralType|int $limit The limit
+     * @param IntegerType|int $limit The limit
      * @return $this
      */
     public function setLimit($limit): self
     {
-        $this->limit = self::toNumeralType($limit);
+        $this->limit = self::toIntegerType($limit);
 
         return $this;
     }
 
     /**
      * Returns the limit of the clause.
      *
-     * @return NumeralType|null
+     * @return IntegerType|null
      */
-    public function getLimit(): ?NumeralType
+    public function getLimit(): ?IntegerType
     {
         return $this->limit;
     }

src/Clauses/RemoveClause.php

@@ -1,24 +1,12 @@
-<?php
-
+<?php declare(strict_types=1);
 /*
- * Cypher DSL
- * Copyright (C) 2021  Wikibase Solutions
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * This file is part of php-cypher-dsl.
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * Copyright (C) 2021-  Wikibase Solutions
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
  */
-
 namespace WikibaseSolutions\CypherDSL\Clauses;
 
 use WikibaseSolutions\CypherDSL\Expressions\Label;
@@ -30,8 +18,10 @@
  * This class represents a REMOVE clause.
  *
  * @see https://neo4j.com/docs/cypher-manual/current/clauses/remove/
+ * @see https://s3.amazonaws.com/artifacts.opencypher.org/openCypher9.pdf (page 113)
+ * @see Query::remove() for a more convenient method to construct this class
  */
-class RemoveClause extends Clause
+final class RemoveClause extends Clause
 {
     use ErrorTrait;
 
@@ -41,32 +31,15 @@ class RemoveClause extends Clause
     private array $expressions = [];
 
     /**
-     * Sets the expressions of the REMOVE clause. This overwrites any previously set expressions.
-     *
-     * @param (Property|Label)[] $expressions The expressions to remove
-     * @return RemoveClause
-     */
-    public function setExpressions(array $expressions): self
-    {
-        foreach ($expressions as $expression) {
-            $this->assertClass('expression', [Property::class, Label::class], $expression);
-        }
-
-        $this->expressions = $expressions;
-
-        return $this;
-    }
-
-    /**
-     * Add an expression to the REMOVE clause. This expression usually returns a property (a.b) or a label (a:b).
+     * Add one or more expressions to the REMOVE clause.
      *
-     * @param Property|Label $expression The expression to add
+     * @param Property|Label ...$expressions The expressions to add
      * @return RemoveClause
      */
-    public function addExpression($expression): self
+    public function addExpression(...$expressions): self
     {
-        $this->assertClass('expression', [Property::class, Label::class], $expression);
-        $this->expressions[] = $expression;
+        self::assertClassArray('expressions', [Property::class, Label::class], $expressions);
+        $this->expressions = array_merge($this->expressions, $expressions);
 
         return $this;
     }

src/Clauses/ReturnClause.php

@@ -1,38 +1,31 @@
-<?php
-
+<?php declare(strict_types=1);
 /*
- * Cypher DSL
- * Copyright (C) 2021  Wikibase Solutions
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * This file is part of php-cypher-dsl.
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * Copyright (C) 2021- Wikibase Solutions
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
  */
-
 namespace WikibaseSolutions\CypherDSL\Clauses;
 
+use WikibaseSolutions\CypherDSL\Patterns\Pattern;
+use WikibaseSolutions\CypherDSL\QueryConvertible;
+use WikibaseSolutions\CypherDSL\Syntax\Alias;
+use WikibaseSolutions\CypherDSL\Traits\CastTrait;
 use WikibaseSolutions\CypherDSL\Traits\ErrorTrait;
-use WikibaseSolutions\CypherDSL\Traits\EscapeTrait;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
 
 /**
  * This class represents a RETURN clause.
  *
  * @see https://neo4j.com/docs/cypher-manual/current/clauses/return/
+ * @see https://s3.amazonaws.com/artifacts.opencypher.org/openCypher9.pdf (page 74)
+ * @see Query::returning() for a more convenient method to construct this class
  */
-class ReturnClause extends Clause
+final class ReturnClause extends Clause
 {
-    use EscapeTrait;
+    use CastTrait;
     use ErrorTrait;
 
     /**
@@ -41,57 +34,40 @@ class ReturnClause extends Clause
     private bool $distinct = false;
 
     /**
-     * @var AnyType[] The expressions to return
+     * @var AnyType[]|Alias[] The expressions to return
      */
     private array $columns = [];
 
     /**
-     * Sets the columns of this RETURN clause. This overwrites any previously set columns.
+     * Add a new column to this RETURN clause.
      *
-     * @param AnyType[] $columns The columns; if the key is non-numerical, it will be used as the alias
+     * @param AnyType|Alias|Pattern|int|float|string|bool|array ...$columns The values to return
      *
      * @return $this
      *
      * @see https://neo4j.com/docs/cypher-manual/current/clauses/return/#return-column-alias
      */
-    public function setColumns(array $columns): self
+    public function addColumn(...$columns): self
     {
+        $res = [];
+
         foreach ($columns as $column) {
-            $this->assertClass('column', AnyType::class, $column);
+            $res[] = $column instanceof Alias ? $column : self::toAnyType($column);
         }
 
-        $this->columns = $columns;
+        $this->columns = array_merge($this->columns, $res);
 
         return $this;
     }
 
     /**
-     * Add a new column to this RETURN clause.
+     * Sets this query to only retrieve unique rows.
      *
-     * @param AnyType $column The expression to return
-     * @param string $alias The alias of this column
+     * @param bool $distinct
      *
      * @return $this
      *
-     * @see https://neo4j.com/docs/cypher-manual/current/clauses/return/#return-column-alias
-     */
-    public function addColumn(AnyType $column, string $alias = ""): self
-    {
-        if ($alias !== "") {
-            $this->columns[$alias] = $column;
-        } else {
-            $this->columns[] = $column;
-        }
-
-        return $this;
-    }
-
-    /**
-     * Sets this query to only retrieve unique rows.
-     *
-     * @see    https://neo4j.com/docs/cypher-manual/current/clauses/return/#return-unique-results
-     * @param bool $distinct
-     * @return ReturnClause
+     * @see https://neo4j.com/docs/cypher-manual/current/clauses/return/#return-unique-results
      */
     public function setDistinct(bool $distinct = true): self
     {
@@ -103,7 +79,7 @@ public function setDistinct(bool $distinct = true): self
     /**
      * Returns the columns to return. Aliased columns have string keys instead of integers.
      *
-     * @return AnyType[]
+     * @return AnyType[]|Alias[]
      */
     public function getColumns(): array
     {
@@ -135,15 +111,9 @@ protected function getClause(): string
      */
     protected function getSubject(): string
     {
-        $expressions = [];
-
-        foreach ($this->columns as $alias => $expression) {
-            $expressionQuery = $expression->toQuery();
-            $expressions[] = is_int($alias) ?
-                $expressionQuery :
-                sprintf("%s AS %s", $expressionQuery, $this->escape($alias));
-        }
-
-        return implode(", ", $expressions);
+        return implode(
+            ", ",
+            array_map(fn (QueryConvertible $column) => $column->toQuery(), $this->columns)
+        );
     }
 }

src/Clauses/SetClause.php

@@ -1,24 +1,12 @@
-<?php
-
+<?php declare(strict_types=1);
 /*
- * Cypher DSL
- * Copyright (C) 2021  Wikibase Solutions
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * This file is part of php-cypher-dsl.
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * Copyright (C) 2021- Wikibase Solutions
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
  */
-
 namespace WikibaseSolutions\CypherDSL\Clauses;
 
 use WikibaseSolutions\CypherDSL\Expressions\Label;
@@ -30,8 +18,10 @@
  * This class represents a SET clause.
  *
  * @see https://neo4j.com/docs/cypher-manual/current/clauses/set/
+ * @see https://s3.amazonaws.com/artifacts.opencypher.org/openCypher9.pdf (page 107)
+ * @see Query::set() for a more convenient method to construct this class
  */
-class SetClause extends Clause
+final class SetClause extends Clause
 {
     use ErrorTrait;
 
@@ -43,7 +33,7 @@ class SetClause extends Clause
     /**
      * Sets the subjects of this SET clause. This will overwrite any previously added expressions.
      *
-     * @param (PropertyReplacement|Label)[] $expressions The expressions to set
+     * @param PropertyReplacement[]|Label[] $expressions The expressions to set
      * @return $this
      */
     public function setExpressions(array $expressions): self
@@ -58,23 +48,23 @@ public function setExpressions(array $expressions): self
     }
 
     /**
-     * Add an expression.
+     * Add one or more expressions to this SET clause.
      *
-     * @param PropertyReplacement|Label $expression The expression to add to this set clause
+     * @param PropertyReplacement|Label $expressions The expressions to add to this set clause
      * @return $this
      */
-    public function add($expression): self
+    public function add(...$expressions): self
     {
-        $this->assertClass('expression', [PropertyReplacement::class, Label::class], $expression);
-        $this->expressions[] = $expression;
+        $this->assertClassArray('expression', [PropertyReplacement::class, Label::class], $expressions);
+        $this->expressions = array_merge($this->expressions, $expressions);
 
         return $this;
     }
 
     /**
      * Returns the expressions to SET.
      *
-     * @return (PropertyReplacement|Label)[]
+     * @return PropertyReplacement[]|Label[]
      */
     public function getExpressions(): array
     {