refactor: introduce BaseRegexpFunction and ParserException (martin-georgiev#269)

Author: martin-georgiev

.github/workflows/sloth.yml

@@ -3,19 +3,21 @@ name: Sloth
 on:
   merge_group:
   pull_request:
-    branches:
-      - main
+
+permissions:
+  contents: read
+  checks: read
 
 jobs:
   sloth:
     runs-on: ubuntu-latest
     steps:
       - name: Sloth
-        uses: lendable/sloth@0.2
+        uses: lendable/sloth@0.2.0
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           interval: 10
-          ignored:
-            - Auto Request Review
-            - CodeRabbit
-            - Scrutinizer
+          ignored: |
+            Auto Request Review
+            CodeRabbit
+            Scrutinizer

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/BaseRegexpFunction.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions;
+
+abstract class BaseRegexpFunction extends BaseFunction
+{
+    abstract protected function getFunctionName(): string;
+
+    abstract protected function getParameterCount(): int;
+
+    protected function customiseFunction(): void
+    {
+        $parameters = \str_repeat(', %s', $this->getParameterCount() - 1);
+        $this->setFunctionPrototype($this->getFunctionName().'(%s'.$parameters.')');
+
+        for ($i = 0; $i < $this->getParameterCount(); $i++) {
+            $this->addNodeMapping('StringPrimary');
+        }
+    }
+}

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/BaseVariadicFunction.php

@@ -9,6 +9,7 @@
 use Doctrine\ORM\Query\Parser;
 use Doctrine\ORM\Query\SqlWalker;
 use Doctrine\ORM\Query\TokenType;
+use MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception\ParserException;
 use MartinGeorgiev\Utils\DoctrineOrm;
 
 /**
@@ -24,7 +25,7 @@ public function feedParserWithNodes(Parser $parser): void
 
         $this->nodes[] = $parser->{$this->commonNodeMapping}();
         if ($lexer->lookahead?->type === null) {
-            throw new \RuntimeException('The parser\'s "lookahead" property is not populated with a type');
+            throw ParserException::missingLookaheadType();
         }
 
         $aheadType = $lexer->lookahead->type;

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/Exception/ParserException.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Exception;
+
+class ParserException extends \RuntimeException
+{
+    public static function missingLookaheadType(): self
+    {
+        return new self('The parser\'s "lookahead" property is not populated with a type');
+    }
+}

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/RegexpLike.php

@@ -12,12 +12,15 @@
  *
  * @author Martin Georgiev <martin.georgiev@gmail.com>
  */
-class RegexpLike extends BaseFunction
+class RegexpLike extends BaseRegexpFunction
 {
-    protected function customiseFunction(): void
+    protected function getFunctionName(): string
     {
-        $this->setFunctionPrototype('regexp_like(%s, %s)');
-        $this->addNodeMapping('StringPrimary');
-        $this->addNodeMapping('StringPrimary');
+        return 'regexp_like';
+    }
+
+    protected function getParameterCount(): int
+    {
+        return 2;
     }
 }

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/RegexpMatch.php

@@ -12,12 +12,15 @@
  *
  * @author Martin Georgiev <martin.georgiev@gmail.com>
  */
-class RegexpMatch extends BaseFunction
+class RegexpMatch extends BaseRegexpFunction
 {
-    protected function customiseFunction(): void
+    protected function getFunctionName(): string
     {
-        $this->setFunctionPrototype('regexp_match(%s, %s)');
-        $this->addNodeMapping('StringPrimary');
-        $this->addNodeMapping('StringPrimary');
+        return 'regexp_match';
+    }
+
+    protected function getParameterCount(): int
+    {
+        return 2;
     }
 }

src/MartinGeorgiev/Doctrine/ORM/Query/AST/Functions/RegexpReplace.php

@@ -12,13 +12,15 @@
  *
  * @author Colin Doig
  */
-class RegexpReplace extends BaseFunction
+class RegexpReplace extends BaseRegexpFunction
 {
-    protected function customiseFunction(): void
+    protected function getFunctionName(): string
     {
-        $this->setFunctionPrototype('regexp_replace(%s, %s, %s)');
-        $this->addNodeMapping('StringPrimary');
-        $this->addNodeMapping('StringPrimary');
-        $this->addNodeMapping('StringPrimary');
+        return 'regexp_replace';
+    }
+
+    protected function getParameterCount(): int
+    {
+        return 3;
     }
 }