Add 'IN' operator (#1)

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.4.0",
+  "version": "2.5.0",
   "type": "library",
   "keywords": [
     "neo4j",

src/In.php

@@ -0,0 +1,53 @@
+<?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\CompositeTypes\ListType;
+use WikibaseSolutions\CypherDSL\Types\PropertyTypes\BooleanType;
+use WikibaseSolutions\CypherDSL\Types\PropertyTypes\PropertyType;
+
+/**
+ * Represents the application of the "IN" operator.
+ *
+ * @see https://neo4j.com/docs/cypher-manual/current/clauses/where/#where-in-operator
+ */
+class In extends BinaryOperator implements BooleanType
+{
+    use BooleanTypeTrait;
+
+    /**
+     * @inheritDoc
+     */
+    public function __construct(PropertyType $left, ListType $right)
+    {
+        parent::__construct($left, $right);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function getOperator(): string
+    {
+        return "IN";
+    }
+}

src/Traits/PropertyTypeTrait.php

@@ -22,7 +22,9 @@
 namespace WikibaseSolutions\CypherDSL\Traits;
 
 use WikibaseSolutions\CypherDSL\Equality;
+use WikibaseSolutions\CypherDSL\In;
 use WikibaseSolutions\CypherDSL\Inequality;
+use WikibaseSolutions\CypherDSL\Types\CompositeTypes\ListType;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\PropertyType;
 
 /**
@@ -54,4 +56,15 @@ public function notEquals(PropertyType $right): Inequality
     {
         return new Inequality($this, $right);
     }
+
+    /**
+     * Checks whether the element exists in the given list.
+     *
+     * @param ListType $right
+     * @return In
+     */
+    public function in(ListType $right): In
+    {
+        return new In($this, $right);
+    }
 }

src/Types/PropertyTypes/PropertyType.php

@@ -3,8 +3,10 @@
 namespace WikibaseSolutions\CypherDSL\Types\PropertyTypes;
 
 use WikibaseSolutions\CypherDSL\Equality;
+use WikibaseSolutions\CypherDSL\In;
 use WikibaseSolutions\CypherDSL\Inequality;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
+use WikibaseSolutions\CypherDSL\Types\CompositeTypes\ListType;
 
 /**
  * Represents any property type in Cypher.
@@ -47,4 +49,12 @@ public function equals(PropertyType $right): Equality;
      * @return Inequality
      */
     public function notEquals(PropertyType $right): Inequality;
+
+    /**
+     * Checks whether the element exists in the given list.
+     *
+     * @param ListType $right
+     * @return In
+     */
+    public function in(ListType $right): In;
 }

tests/Unit/InTest.php

@@ -0,0 +1,57 @@
+<?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\In;
+use WikibaseSolutions\CypherDSL\Types\AnyType;
+use WikibaseSolutions\CypherDSL\Types\CompositeTypes\ListType;
+use WikibaseSolutions\CypherDSL\Types\PropertyTypes\PropertyType;
+
+/**
+ * @covers \WikibaseSolutions\CypherDSL\In
+ */
+class InTest extends TestCase
+{
+    use TestHelper;
+
+    public function testToQuery()
+    {
+        $inequality = new In($this->getQueryConvertableMock(PropertyType::class, "a"), $this->getQueryConvertableMock(ListType::class, "b"));
+
+        $this->assertSame("(a IN b)", $inequality->toQuery());
+
+        $inequality = new In($inequality, $this->getQueryConvertableMock(ListType::class, "c"));
+
+        $this->assertSame("((a IN b) IN c)", $inequality->toQuery());
+    }
+
+    public function testDoesNotAcceptAnyTypeAsOperands()
+    {
+        $this->expectException(TypeError::class);
+
+        $inequality = new In($this->getQueryConvertableMock(AnyType::class, "a"), $this->getQueryConvertableMock(AnyType::class, "b"));
+
+        $inequality->toQuery();
+    }
+}

tests/Unit/Traits/PropertyTypeTraitTest.php

@@ -24,8 +24,10 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use WikibaseSolutions\CypherDSL\Equality;
+use WikibaseSolutions\CypherDSL\In;
 use WikibaseSolutions\CypherDSL\Inequality;
 use WikibaseSolutions\CypherDSL\Tests\Unit\TestHelper;
+use WikibaseSolutions\CypherDSL\Types\CompositeTypes\ListType;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\PropertyType;
 
 /**
@@ -45,10 +47,16 @@ class PropertyTypeTraitTest extends TestCase
      */
     private $b;
 
+    /**
+     * @var MockObject|ListType
+     */
+    private $list;
+
     public function setUp(): void
     {
         $this->a = $this->getQueryConvertableMock(PropertyType::class, "10");
         $this->b = $this->getQueryConvertableMock(PropertyType::class, "15");
+        $this->list = $this->getQueryConvertableMock(ListType::class, "['foobar']");
     }
 
     public function testEquals()
@@ -64,4 +72,11 @@ public function testNotEquals()
 
         $this->assertInstanceOf(Inequality::class, $notEquals);
     }
+
+    public function testIn()
+    {
+        $in = $this->a->in($this->list);
+
+        $this->assertInstanceOf(In::class, $in);
+    }
 }