Merge pull request #30 from WikibaseSolutions/add-regex-operator

Add regex operator (#26)

Author: marijnvanwezel

src/Regex.php

@@ -0,0 +1,52 @@
+<?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;
+use WikibaseSolutions\CypherDSL\Types\PropertyTypes\StringType;
+
+/**
+ * Represents the application of the regex operator.
+ *
+ * @see https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-string
+ */
+class Regex extends BinaryOperator implements BooleanType
+{
+    use BooleanTypeTrait;
+
+    /**
+     * @inheritDoc
+     */
+    public function __construct(StringType $left, StringType $right)
+    {
+        parent::__construct($left, $right);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function getOperator(): string
+    {
+        return "=~";
+    }
+}

src/Traits/StringTypeTrait.php

@@ -23,6 +23,7 @@
 
 use WikibaseSolutions\CypherDSL\Contains;
 use WikibaseSolutions\CypherDSL\EndsWith;
+use WikibaseSolutions\CypherDSL\Regex;
 use WikibaseSolutions\CypherDSL\StartsWith;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\StringType;
 
@@ -65,4 +66,15 @@ public function startsWith(StringType $right): StartsWith
     {
         return new StartsWith($this, $right);
     }
+
+    /**
+     * Perform a regex comparison with the given expression.
+     *
+     * @param StringType $right
+     * @return Regex
+     */
+    public function regex(StringType $right): Regex
+    {
+        return new Regex($this, $right);
+    }
 }

src/Types/PropertyTypes/StringType.php

@@ -23,6 +23,7 @@
 
 use WikibaseSolutions\CypherDSL\Contains;
 use WikibaseSolutions\CypherDSL\EndsWith;
+use WikibaseSolutions\CypherDSL\Regex;
 use WikibaseSolutions\CypherDSL\StartsWith;
 
 /**
@@ -53,4 +54,12 @@ public function endsWith(StringType $right): EndsWith;
      * @return StartsWith
      */
     public function startsWith(StringType $right): StartsWith;
+
+    /**
+     * Perform a regex comparison with the given expression.
+     *
+     * @param StringType $right
+     * @return Regex
+     */
+    public function regex(StringType $right): Regex;
 }

tests/Unit/RegexTest.php

@@ -0,0 +1,64 @@
+<?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\Contains;
+use WikibaseSolutions\CypherDSL\Regex;
+use WikibaseSolutions\CypherDSL\Types\AnyType;
+use WikibaseSolutions\CypherDSL\Types\PropertyTypes\StringType;
+
+/**
+ * @covers \WikibaseSolutions\CypherDSL\Regex
+ */
+class RegexTest extends TestCase
+{
+    use TestHelper;
+
+    public function testToQuery()
+    {
+        $regex = new Regex($this->getQueryConvertableMock(StringType::class, "a"), $this->getQueryConvertableMock(StringType::class, "b"));
+
+        $this->assertSame("(a =~ b)", $regex->toQuery());
+    }
+
+    public function testCannotBeNested()
+    {
+        $regex = new Regex($this->getQueryConvertableMock(StringType::class, "a"), $this->getQueryConvertableMock(StringType::class, "b"));
+
+        $this->expectException(TypeError::class);
+
+        $regex = new Regex($regex, $regex);
+
+        $regex->toQuery();
+    }
+
+    public function testDoesNotAcceptAnyTypeAsOperands()
+    {
+        $this->expectException(TypeError::class);
+
+        $regex = new Regex($this->getQueryConvertableMock(AnyType::class, "a"), $this->getQueryConvertableMock(AnyType::class, "b"));
+
+        $regex->toQuery();
+    }
+}

tests/Unit/Traits/StringTypeTraitTest.php

@@ -25,6 +25,7 @@
 use PHPUnit\Framework\TestCase;
 use WikibaseSolutions\CypherDSL\Contains;
 use WikibaseSolutions\CypherDSL\EndsWith;
+use WikibaseSolutions\CypherDSL\Regex;
 use WikibaseSolutions\CypherDSL\StartsWith;
 use WikibaseSolutions\CypherDSL\Tests\Unit\TestHelper;
 use WikibaseSolutions\CypherDSL\Types\PropertyTypes\StringType;
@@ -72,4 +73,11 @@ public function testStartsWith()
 
         $this->assertInstanceOf(StartsWith::class, $startsWith);
     }
+
+    public function testRegex()
+    {
+        $regex = $this->a->regex($this->b);
+
+        $this->assertInstanceOf(Regex::class, $regex);
+    }
 }