implemented and used AliasableTrait'

transistive · transistive · commit 9a5a5ac71a1a · 2022-03-09T01:00:52.000+01:00
diff --git a/src/Alias.php b/src/Alias.php
@@ -0,0 +1,59 @@
+<?php
+
+namespace WikibaseSolutions\CypherDSL;
+
+use WikibaseSolutions\CypherDSL\Types\AnyType;
+use function sprintf;
+
+class Alias implements AnyType
+{
+    /**
+     * @var QueryConvertable The original item to be aliased
+     */
+    private QueryConvertable $original;
+
+    /**
+     * @var Variable The new variable aliasing the original
+     */
+    private Variable $variable;
+
+    /**
+     * BinaryOperator constructor.
+     *
+     * @param QueryConvertable $original The original item to be aliased
+     * @param Variable $variable The new variable aliasing the original
+     */
+    public function __construct(QueryConvertable $original, Variable $variable)
+    {
+        $this->original = $original;
+        $this->variable = $variable;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function toQuery(): string
+    {
+        return sprintf("%s AS %s", $this->original->toQuery(), $this->variable->toQuery());
+    }
+
+    /**
+     * Gets the original item of the alias.
+     *
+     * @return QueryConvertable
+     */
+    public function getOriginal(): QueryConvertable
+    {
+        return $this->original;
+    }
+
+    /**
+     * Gets the variable from the alias.
+     *
+     * @return Variable
+     */
+    public function getVariable(): Variable
+    {
+        return $this->variable;
+    }
+}
diff --git a/src/AndOperator.php b/src/AndOperator.php
@@ -21,6 +21,7 @@
 
 namespace WikibaseSolutions\CypherDSL;
 
+use WikibaseSolutions\CypherDSL\Traits\AliasableTrait;
 use WikibaseSolutions\CypherDSL\Traits\BooleanTypeTrait;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\BooleanType;
 
diff --git a/src/Assignment.php b/src/Assignment.php
@@ -46,7 +46,7 @@ class Assignment extends BinaryOperator
      */
     public function __construct(AnyType $left, AnyType $right)
     {
-        $this->assertClass('left', [Property::class, Variable::class], $left);
+        self::assertClass('left', [Property::class, Variable::class], $left);
 
         parent::__construct($left, $right, false);
     }
diff --git a/src/BinaryOperator.php b/src/BinaryOperator.php
@@ -21,17 +21,20 @@
 
 namespace WikibaseSolutions\CypherDSL;
 
+use WikibaseSolutions\CypherDSL\Traits\AliasableTrait;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
 
 /**
  * This class represents the application of a binary operator, such as "+", "/" and "*".
  */
 abstract class BinaryOperator implements QueryConvertable
 {
+    use AliasableTrait;
+    
     /**
      * @var bool Whether to insert parentheses around the expression
      */
-    private bool $insertParentheses = true;
+    private bool $insertParentheses;
 
     /**
      * @var AnyType The left-hand of the expression
diff --git a/src/Functions/FunctionCall.php b/src/Functions/FunctionCall.php
@@ -22,6 +22,7 @@
 namespace WikibaseSolutions\CypherDSL\Functions;
 
 use WikibaseSolutions\CypherDSL\QueryConvertable;
+use WikibaseSolutions\CypherDSL\Traits\AliasableTrait;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
 use WikibaseSolutions\CypherDSL\Types\CompositeTypes\ListType;
 use WikibaseSolutions\CypherDSL\Types\CompositeTypes\MapType;
@@ -35,6 +36,8 @@
  */
 abstract class FunctionCall implements QueryConvertable
 {
+    use AliasableTrait;
+
     /**
      * Produces a raw function call. This enables the usage of unimplemented functions in your
      * Cypher queries. The parameters of this function are not type-checked.
diff --git a/src/Functions/LocalDateTime.php b/src/Functions/LocalDateTime.php
@@ -23,7 +23,6 @@
 
 use WikibaseSolutions\CypherDSL\Traits\LocalDateTimeTrait;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
-use WikibaseSolutions\CypherDSL\Types\PropertyTypes\DateType;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\LocalDateTimeType;
 
 /**
diff --git a/src/Functions/RawFunction.php b/src/Functions/RawFunction.php
@@ -26,9 +26,7 @@
 use WikibaseSolutions\CypherDSL\Traits\BooleanTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\ListTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\MapTypeTrait;
-use WikibaseSolutions\CypherDSL\Traits\NodeTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\NumeralTypeTrait;
-use WikibaseSolutions\CypherDSL\Traits\RelationshipTrait;
 use WikibaseSolutions\CypherDSL\Traits\StringTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\StructuralTypeTrait;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
diff --git a/src/Functions/Time.php b/src/Functions/Time.php
@@ -21,7 +21,6 @@
 
 namespace WikibaseSolutions\CypherDSL\Functions;
 
-use WikibaseSolutions\CypherDSL\Traits\LocalDateTimeTrait;
 use WikibaseSolutions\CypherDSL\Traits\TimeTrait;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\TimeType;
diff --git a/src/Literals/Boolean.php b/src/Literals/Boolean.php
@@ -21,6 +21,7 @@
 
 namespace WikibaseSolutions\CypherDSL\Literals;
 
+use WikibaseSolutions\CypherDSL\Traits\AliasableTrait;
 use WikibaseSolutions\CypherDSL\Traits\BooleanTypeTrait;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\BooleanType;
 
@@ -30,6 +31,7 @@
 class Boolean implements BooleanType
 {
     use BooleanTypeTrait;
+    use AliasableTrait;
 
     /**
      * @var bool The value
diff --git a/src/Literals/Decimal.php b/src/Literals/Decimal.php
@@ -21,6 +21,7 @@
 
 namespace WikibaseSolutions\CypherDSL\Literals;
 
+use WikibaseSolutions\CypherDSL\Traits\AliasableTrait;
 use WikibaseSolutions\CypherDSL\Traits\NumeralTypeTrait;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\NumeralType;
 
@@ -30,6 +31,7 @@
 class Decimal implements NumeralType
 {
     use NumeralTypeTrait;
+    use AliasableTrait;
 
     /**
      * @var string The value
diff --git a/src/Literals/StringLiteral.php b/src/Literals/StringLiteral.php
@@ -21,6 +21,7 @@
 
 namespace WikibaseSolutions\CypherDSL\Literals;
 
+use WikibaseSolutions\CypherDSL\Traits\AliasableTrait;
 use WikibaseSolutions\CypherDSL\Traits\StringTypeTrait;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\StringType;
 
@@ -33,6 +34,7 @@
 class StringLiteral implements StringType
 {
     use StringTypeTrait;
+    use AliasableTrait;
 
     /**
      * @var string
diff --git a/src/Patterns/Node.php b/src/Patterns/Node.php
@@ -22,15 +22,9 @@
 namespace WikibaseSolutions\CypherDSL\Patterns;
 
 use WikibaseSolutions\CypherDSL\Property;
-use WikibaseSolutions\CypherDSL\PropertyMap;
 use WikibaseSolutions\CypherDSL\Traits\EscapeTrait;
-use WikibaseSolutions\CypherDSL\Traits\HasPropertiesTrait;
-use WikibaseSolutions\CypherDSL\Traits\HasVariableTrait;
 use WikibaseSolutions\CypherDSL\Traits\NodeTypeTrait;
 use WikibaseSolutions\CypherDSL\Types\StructuralTypes\NodeType;
-use WikibaseSolutions\CypherDSL\Variable;
-use function is_string;
-use function trim;
 
 /**
  * This class represents a node.
diff --git a/src/PropertyMap.php b/src/PropertyMap.php
@@ -23,7 +23,6 @@
 
 use WikibaseSolutions\CypherDSL\Traits\ErrorTrait;
 use WikibaseSolutions\CypherDSL\Traits\EscapeTrait;
-use WikibaseSolutions\CypherDSL\Traits\HasPropertiesTrait;
 use WikibaseSolutions\CypherDSL\Traits\MapTypeTrait;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
 use WikibaseSolutions\CypherDSL\Types\CompositeTypes\MapType;
diff --git a/src/RawExpression.php b/src/RawExpression.php
@@ -21,6 +21,7 @@
 
 namespace WikibaseSolutions\CypherDSL;
 
+use WikibaseSolutions\CypherDSL\Traits\AliasableTrait;
 use WikibaseSolutions\CypherDSL\Traits\BooleanTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\DateTimeTrait;
 use WikibaseSolutions\CypherDSL\Traits\DateTrait;
@@ -80,6 +81,7 @@ class RawExpression implements
     use RelationshipTrait;
     use StringTypeTrait;
     use TimeTrait;
+    use AliasableTrait;
 
     /**
      * @var string The raw expression
diff --git a/src/Traits/AliasableTrait.php b/src/Traits/AliasableTrait.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace WikibaseSolutions\CypherDSL\Traits;
+
+use WikibaseSolutions\CypherDSL\Alias;
+use WikibaseSolutions\CypherDSL\Variable;
+use function is_string;
+
+trait AliasableTrait
+{
+    use ErrorTrait;
+
+    /**
+     * Creates an alias of the current expression.
+     *
+     * @param string|Variable $variable
+     * @return Alias
+     */
+    public function alias($variable): Alias
+    {
+        self::assertClassOrType($variable, [Variable::class, 'string'], 'variable');
+
+        $variable = is_string($variable) ? new Variable($variable) : $variable;
+
+        return new Alias($this, $variable);
+    }
+}
diff --git a/src/Traits/ErrorTrait.php b/src/Traits/ErrorTrait.php
@@ -23,8 +23,6 @@
 
 use __PHP_Incomplete_Class;
 use InvalidArgumentException;
-use ReflectionClass;
-use ReflectionException;
 use TypeError;
 use function get_class;
 use function gettype;
diff --git a/src/Traits/HasPropertiesTrait.php b/src/Traits/HasPropertiesTrait.php
@@ -2,7 +2,6 @@
 
 namespace WikibaseSolutions\CypherDSL\Traits;
 
-use WikibaseSolutions\CypherDSL\Property;
 use WikibaseSolutions\CypherDSL\PropertyMap;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
 use function is_array;
diff --git a/tests/AliasTest.php b/tests/AliasTest.php
@@ -0,0 +1,40 @@
+<?php
+
+namespace WikibaseSolutions\CypherDSL\Tests;
+
+use PHPUnit\Framework\TestCase;
+use WikibaseSolutions\CypherDSL\Alias;
+use WikibaseSolutions\CypherDSL\Tests\Unit\TestHelper;
+use WikibaseSolutions\CypherDSL\Variable;
+
+class AliasTest extends TestCase
+{
+    use TestHelper;
+
+    private Alias $alias;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->alias = new Alias(
+            $this->getQueryConvertableMock(Variable::class, "a"),
+            $this->getQueryConvertableMock(Variable::class, "b")
+        );
+    }
+
+    public function testToQuery(): void
+    {
+        $this->assertSame("a AS b", $this->alias->toQuery());
+    }
+
+    public function testGetOriginal(): void
+    {
+        $this->assertEquals($this->getQueryConvertableMock(Variable::class, "a"), $this->alias->getOriginal());
+    }
+
+    public function testGetVariable(): void
+    {
+        $this->assertEquals($this->getQueryConvertableMock(Variable::class, "b"), $this->alias->getVariable());
+    }
+}
diff --git a/tests/Unit/Clauses/SkipClauseTest.php b/tests/Unit/Clauses/SkipClauseTest.php
@@ -23,7 +23,6 @@
 
 use PHPUnit\Framework\TestCase;
 use TypeError;
-use WikibaseSolutions\CypherDSL\Clauses\LimitClause;
 use WikibaseSolutions\CypherDSL\Clauses\SkipClause;
 use WikibaseSolutions\CypherDSL\Tests\Unit\TestHelper;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
diff --git a/tests/Unit/Patterns/NodeTest.php b/tests/Unit/Patterns/NodeTest.php
@@ -21,7 +21,6 @@
 
 namespace WikibaseSolutions\CypherDSL\Tests\Unit\Patterns;
 
-use InvalidArgumentException;
 use PHPUnit\Framework\TestCase;
 use WikibaseSolutions\CypherDSL\ExpressionList;
 use WikibaseSolutions\CypherDSL\Literals\Decimal;
diff --git a/tests/Unit/Traits/ErrorTraitTest.php b/tests/Unit/Traits/ErrorTraitTest.php
@@ -24,7 +24,6 @@
 use TypeError;
 use PHPUnit\Framework\TestCase;
 use WikibaseSolutions\CypherDSL\Traits\ErrorTrait;
-use WikibaseSolutions\CypherDSL\Tests\Unit\Traits\ErrorHelperDummyA;
 
 /**
  * Dummy classes

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ class Assignment extends BinaryOperator`
`46`	`46`	`*/`
`47`	`47`	`public function __construct(AnyType $left, AnyType $right)`
`48`	`48`	`{`
`49`		`- $this->assertClass('left', [Property::class, Variable::class], $left);`
	`49`	`+ self::assertClass('left', [Property::class, Variable::class], $left);`
`50`	`50`
`51`	`51`	`parent::__construct($left, $right, false);`
`52`	`52`	`}`