Merge pull request #7 from WikibaseSolutions/add-not-operator

Add "NOT" operator (#2)

Author: marijnvanwezel

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "wikibase-solutions/php-cypher-dsl",
   "description": "A PHP DSL for the Cypher Query Language",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "type": "library",
   "keywords": [
     "neo4j",

src/Not.php

@@ -0,0 +1,58 @@
+<?php
+
+/*
+ * 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 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.
+ *
+ * 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.
+ */
+
+namespace WikibaseSolutions\CypherDSL;
+
+use WikibaseSolutions\CypherDSL\Traits\BooleanTypeTrait;
+use WikibaseSolutions\CypherDSL\Types\PropertyTypes\BooleanType;
+
+/**
+ * Represents the application of the negation (NOT) operator.
+ *
+ * @see https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-boolean
+ */
+class Not implements BooleanType
+{
+    use BooleanTypeTrait;
+
+    /**
+     * @var BooleanType The expression to negate
+     */
+    private BooleanType $expression;
+
+    /**
+     * Not constructor.
+     *
+     * @param BooleanType $expression The expression to negate
+     */
+    public function __construct(BooleanType $expression)
+    {
+        $this->expression = $expression;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function toQuery(): string
+    {
+        return sprintf("(NOT %s)", $this->expression->toQuery());
+    }
+}

src/Traits/BooleanTypeTrait.php

@@ -22,6 +22,8 @@
 namespace WikibaseSolutions\CypherDSL\Traits;
 
 use WikibaseSolutions\CypherDSL\AndOperator;
+use WikibaseSolutions\CypherDSL\Minus;
+use WikibaseSolutions\CypherDSL\Not;
 use WikibaseSolutions\CypherDSL\OrOperator;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\BooleanType;
 use WikibaseSolutions\CypherDSL\XorOperator;
@@ -65,4 +67,14 @@ public function xor(BooleanType $right): XorOperator
     {
         return new XorOperator($this, $right);
     }
+
+    /**
+     * Negate this expression (using the NOT operator).
+     *
+     * @return Not
+     */
+    public function not(): Not
+    {
+        return new Not($this);
+    }
 }

src/Traits/NumeralTypeTrait.php

@@ -152,7 +152,7 @@ public function minus(NumeralType $right): Subtraction
     }
 
     /**
-     * Negate this expression.
+     * Negate this expression (negate the numeral using "-").
      *
      * @return Minus
      */

src/Types/PropertyTypes/BooleanType.php

@@ -22,6 +22,7 @@
 namespace WikibaseSolutions\CypherDSL\Types\PropertyTypes;
 
 use WikibaseSolutions\CypherDSL\AndOperator;
+use WikibaseSolutions\CypherDSL\Not;
 use WikibaseSolutions\CypherDSL\OrOperator;
 use WikibaseSolutions\CypherDSL\XorOperator;
 
@@ -53,4 +54,11 @@ public function or(BooleanType $right): OrOperator;
      * @return XorOperator
      */
     public function xor(BooleanType $right): XorOperator;
+
+    /**
+     * Negate this expression (using the NOT operator).
+     *
+     * @return Not
+     */
+    public function not(): Not;
 }

src/Types/PropertyTypes/NumeralType.php

@@ -119,7 +119,7 @@ public function times(NumeralType $right): Multiplication;
     public function minus(NumeralType $right): Subtraction;
 
     /**
-     * Negate this expression.
+     * Negate this expression (negate the numeral using "0").
      *
      * @return Minus
      */

tests/Unit/NotTest.php

@@ -0,0 +1,56 @@
+<?php
+
+/*
+ * 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 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.
+ *
+ * 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.
+ */
+
+namespace WikibaseSolutions\CypherDSL\Tests\Unit;
+
+use PHPUnit\Framework\TestCase;
+use TypeError;
+use WikibaseSolutions\CypherDSL\Not;
+use WikibaseSolutions\CypherDSL\Types\AnyType;
+use WikibaseSolutions\CypherDSL\Types\PropertyTypes\BooleanType;
+
+/**
+ * @covers \WikibaseSolutions\CypherDSL\Not
+ */
+class NotTest extends TestCase
+{
+    use TestHelper;
+
+    public function testToQuery()
+    {
+        $not = new Not($this->getQueryConvertableMock(BooleanType::class, "true"));
+
+        $this->assertSame("(NOT true)", $not->toQuery());
+
+        $not = new Not($not);
+
+        $this->assertSame("(NOT (NOT true))", $not->toQuery());
+    }
+
+    public function testDoesNotAcceptAnyTypeAsOperands()
+    {
+        $this->expectException(TypeError::class);
+
+        $and = new Not($this->getQueryConvertableMock(AnyType::class, "true"));
+
+        $and->toQuery();
+    }
+}

tests/Unit/Traits/BooleanTypeTraitTest.php

@@ -24,6 +24,7 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use WikibaseSolutions\CypherDSL\AndOperator;
+use WikibaseSolutions\CypherDSL\Not;
 use WikibaseSolutions\CypherDSL\OrOperator;
 use WikibaseSolutions\CypherDSL\Tests\Unit\TestHelper;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\BooleanType;
@@ -72,4 +73,11 @@ public function testXor()
 
         $this->assertInstanceOf(XorOperator::class, $xor);
     }
+
+    public function testNot()
+    {
+        $not = $this->a->not();
+
+        $this->assertInstanceOf(Not::class, $not);
+    }
 }