Allow inverse application of the 'IN' operator

This commit adds a function to the ListType interface that allows for the inverse application of the 'IN' operator. More precisely, it allows you to call 'has' on a ListType to use the 'IN' operator. No new functionality is added.

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

src/ExpressionList.php

@@ -23,6 +23,7 @@
 
 use TypeError;
 use WikibaseSolutions\CypherDSL\Traits\EscapeTrait;
+use WikibaseSolutions\CypherDSL\Traits\ListTypeTrait;
 use WikibaseSolutions\CypherDSL\Types\AnyType;
 use WikibaseSolutions\CypherDSL\Types\CompositeTypes\ListType;
 
@@ -37,6 +38,7 @@
 class ExpressionList implements ListType
 {
     use EscapeTrait;
+    use ListTypeTrait;
 
     /**
      * @var array The list of expressions

src/Functions/RawFunction.php

@@ -23,6 +23,7 @@
 
 use InvalidArgumentException;
 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;
@@ -50,6 +51,7 @@ class RawFunction extends FunctionCall implements
     PathType
 {
     use BooleanTypeTrait;
+    use ListTypeTrait;
     use MapTypeTrait;
     use NodeTypeTrait;
     use NumeralTypeTrait;

src/Parameter.php

@@ -24,6 +24,7 @@
 use InvalidArgumentException;
 use WikibaseSolutions\CypherDSL\Traits\BooleanTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\EscapeTrait;
+use WikibaseSolutions\CypherDSL\Traits\ListTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\MapTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\NumeralTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\StringTypeTrait;
@@ -46,6 +47,7 @@ class Parameter implements
     StringType
 {
     use EscapeTrait;
+    use ListTypeTrait;
     use BooleanTypeTrait;
     use MapTypeTrait;
     use NumeralTypeTrait;

src/Property.php

@@ -23,6 +23,7 @@
 
 use WikibaseSolutions\CypherDSL\Traits\BooleanTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\EscapeTrait;
+use WikibaseSolutions\CypherDSL\Traits\ListTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\MapTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\NumeralTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\StringTypeTrait;
@@ -40,6 +41,7 @@ class Property implements BooleanType, NumeralType, StringType, MapType, ListTyp
 {
     use EscapeTrait;
     use BooleanTypeTrait;
+    use ListTypeTrait;
     use NumeralTypeTrait;
     use StringTypeTrait;
     use MapTypeTrait;

src/RawExpression.php

@@ -22,6 +22,7 @@
 namespace WikibaseSolutions\CypherDSL;
 
 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;
@@ -49,6 +50,7 @@ class RawExpression implements
     PathType
 {
     use BooleanTypeTrait;
+    use ListTypeTrait;
     use MapTypeTrait;
     use NodeTypeTrait;
     use NumeralTypeTrait;

src/Traits/ListTypeTrait.php

@@ -0,0 +1,42 @@
+<?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\Traits;
+
+use WikibaseSolutions\CypherDSL\In;
+use WikibaseSolutions\CypherDSL\Types\PropertyTypes\PropertyType;
+
+/**
+ * This trait should be used by any expression that returns a list.
+ */
+trait ListTypeTrait
+{
+    /**
+     * Checks whether the given element exists in this list.
+     *
+     * @param PropertyType $left
+     * @return In
+     */
+    public function has(PropertyType $left): In
+    {
+        return new In($left, $this);
+    }
+}

src/Types/CompositeTypes/ListType.php

@@ -21,9 +21,19 @@
 
 namespace WikibaseSolutions\CypherDSL\Types\CompositeTypes;
 
+use WikibaseSolutions\CypherDSL\In;
+use WikibaseSolutions\CypherDSL\Types\PropertyTypes\PropertyType;
+
 /**
  * Represent the type "list".
  */
 interface ListType extends CompositeType
 {
+    /**
+     * Checks whether the given element exists in this list.
+     *
+     * @param PropertyType $left
+     * @return In
+     */
+    public function has(PropertyType $left): In;
 }

src/Variable.php

@@ -24,6 +24,7 @@
 use WikibaseSolutions\CypherDSL\Traits\AssignableTrait;
 use WikibaseSolutions\CypherDSL\Traits\BooleanTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\EscapeTrait;
+use WikibaseSolutions\CypherDSL\Traits\ListTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\MapTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\NumeralTypeTrait;
 use WikibaseSolutions\CypherDSL\Traits\PathTypeTrait;
@@ -54,6 +55,7 @@ class Variable implements
 {
     use EscapeTrait;
     use BooleanTypeTrait;
+    use ListTypeTrait;
     use MapTypeTrait;
     use NumeralTypeTrait;
     use PathTypeTrait;

tests/Unit/Traits/ListTypeTraitTest.php

@@ -0,0 +1,60 @@
+<?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\Traits;
+
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use WikibaseSolutions\CypherDSL\In;
+use WikibaseSolutions\CypherDSL\Tests\Unit\TestHelper;
+use WikibaseSolutions\CypherDSL\Types\CompositeTypes\ListType;
+use WikibaseSolutions\CypherDSL\Types\PropertyTypes\PropertyType;
+
+/**
+ * @covers \WikibaseSolutions\CypherDSL\Traits\ListTypeTrait
+ */
+class ListTypeTraitTest extends TestCase
+{
+    use TestHelper;
+
+    /**
+     * @var MockObject|PropertyType
+     */
+    private $a;
+
+    /**
+     * @var MockObject|ListType
+     */
+    private $b;
+
+    public function setUp(): void
+    {
+        $this->a = $this->getQueryConvertableMock(PropertyType::class, "a");
+        $this->b = $this->getQueryConvertableMock(ListType::class, "[]");
+    }
+
+    public function testHas()
+    {
+        $has = $this->b->has($this->a);
+
+        $this->assertInstanceOf(In::class, $has);
+    }
+}