From d544274bd6cb3405f8ab2cae5cce80d9cb51778d Mon Sep 17 00:00:00 2001
From: Cerys Lewis <cerysamberlewis@gmail.com>
Date: Wed, 8 May 2024 12:35:06 +0100
Subject: [PATCH] just committing an untested Query Builder to show an example

---
 ...ConflictingFieldAlreadyExistsException.php |  17 +++
 .../QueryBuilderInvalidInputException.php     |  17 +++
 ...yBuilderRequiredFieldIsNotSetException.php |  17 +++
 src/QueryBuilder/QueryBuilder.php             |  15 +++
 src/QueryBuilder/QueryBuilderTrait.php        |  23 ++++
 src/QueryBuilder/QueryBuilders/Put.php        | 113 ++++++++++++++++++
 6 files changed, 202 insertions(+)
 create mode 100644 src/Exceptions/QueryBuilderConflictingFieldAlreadyExistsException.php
 create mode 100755 src/Exceptions/QueryBuilderInvalidInputException.php
 create mode 100644 src/Exceptions/QueryBuilderRequiredFieldIsNotSetException.php
 create mode 100644 src/QueryBuilder/QueryBuilder.php
 create mode 100755 src/QueryBuilder/QueryBuilderTrait.php
 create mode 100755 src/QueryBuilder/QueryBuilders/Put.php

diff --git a/src/Exceptions/QueryBuilderConflictingFieldAlreadyExistsException.php b/src/Exceptions/QueryBuilderConflictingFieldAlreadyExistsException.php
new file mode 100644
index 0000000..62b088b
--- /dev/null
+++ b/src/Exceptions/QueryBuilderConflictingFieldAlreadyExistsException.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace Darksparrow\DeegraphPHP\Exceptions;
+
+use Exception;
+
+class QueryBuilderConflictingFieldAlreadyExistsException extends Exception
+{
+    public function __construct(
+        string $message = "You have tried to set a field which would nullify a field you've previously set.",
+        int $code = 422
+    ) {
+        parent::__construct($message, $code);
+        $this->message = "$message";
+        $this->code = $code;
+    }
+}
diff --git a/src/Exceptions/QueryBuilderInvalidInputException.php b/src/Exceptions/QueryBuilderInvalidInputException.php
new file mode 100755
index 0000000..1388f55
--- /dev/null
+++ b/src/Exceptions/QueryBuilderInvalidInputException.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace Darksparrow\DeegraphPHP\Exceptions;
+
+use Exception;
+
+class QueryBuilderInvalidInputException extends Exception
+{
+    public function __construct(
+        string $message = "The value you have entered doesn't pass regex validation.",
+        int $code = 422
+    ) {
+        parent::__construct($message, $code);
+        $this->message = "$message";
+        $this->code = $code;
+    }
+}
diff --git a/src/Exceptions/QueryBuilderRequiredFieldIsNotSetException.php b/src/Exceptions/QueryBuilderRequiredFieldIsNotSetException.php
new file mode 100644
index 0000000..d602249
--- /dev/null
+++ b/src/Exceptions/QueryBuilderRequiredFieldIsNotSetException.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace Darksparrow\DeegraphPHP\Exceptions;
+
+use Exception;
+
+class QueryBuilderRequiredFieldIsNotSetException extends Exception
+{
+    public function __construct(
+        string $message = "A field that is required for this operation has not been set.",
+        int $code = 422
+    ) {
+        parent::__construct($message, $code);
+        $this->message = "$message";
+        $this->code = $code;
+    }
+}
diff --git a/src/QueryBuilder/QueryBuilder.php b/src/QueryBuilder/QueryBuilder.php
new file mode 100644
index 0000000..0bad704
--- /dev/null
+++ b/src/QueryBuilder/QueryBuilder.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace Darksparrow\DeegraphPHP\QueryBuilder;
+
+use Darksparrow\DeegraphPHP\QueryBuilder\QueryBuilders\Insert;
+use Darksparrow\DeegraphPHP\QueryBuilder\QueryBuilders\Put;
+use Darksparrow\DeegraphPHP\QueryBuilder\QueryBuilders\Select;
+
+class QueryBuilder
+{
+    public function Put(): Put
+    {
+        return new Put();
+    }
+}
diff --git a/src/QueryBuilder/QueryBuilderTrait.php b/src/QueryBuilder/QueryBuilderTrait.php
new file mode 100755
index 0000000..65d3d72
--- /dev/null
+++ b/src/QueryBuilder/QueryBuilderTrait.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace Darksparrow\DeegraphPHP\QueryBuilder;
+
+use Darksparrow\DeegraphPHP\Exceptions\QueryBuilderConflictingFieldAlreadyExistsException;
+use Darksparrow\DeegraphPHP\Exceptions\QueryBuilderException;
+use Darksparrow\DeegraphPHP\Exceptions\QueryBuilderInvalidInputException;
+
+trait QueryBuilderTrait
+{
+    protected function Validate(string $target, string $pattern): string
+    {
+        if (!preg_match(pattern: $pattern, subject: $target))
+            throw new QueryBuilderInvalidInputException();
+        return $target;
+    }
+
+    protected function EnsureNotSet(string $target): void
+    {
+        if ($target != "")
+            throw new QueryBuilderConflictingFieldAlreadyExistsException();
+    }
+}
diff --git a/src/QueryBuilder/QueryBuilders/Put.php b/src/QueryBuilder/QueryBuilders/Put.php
new file mode 100755
index 0000000..82245a2
--- /dev/null
+++ b/src/QueryBuilder/QueryBuilders/Put.php
@@ -0,0 +1,113 @@
+<?php
+
+namespace Darksparrow\DeegraphPHP\QueryBuilder\QueryBuilders;
+
+use Darksparrow\DeegraphPHP\Exceptions\QueryBuilderConflictingFieldAlreadyExistsException;
+use Darksparrow\DeegraphPHP\Exceptions\QueryBuilderInvalidInputException;
+use Darksparrow\DeegraphPHP\Exceptions\QueryBuilderRequiredFieldIsNotSetException;
+use Darksparrow\DeegraphPHP\QueryBuilder\QueryBuilderTrait;
+
+final class Put
+{
+    use QueryBuilderTrait;
+
+    protected string $PutWhat = "";
+    protected string $PutAt = "";
+    protected string $PutInto = "";
+    protected bool $Safe = false;
+
+
+    public function __construct()
+    {
+    }
+
+    /**
+     * @throws QueryBuilderRequiredFieldIsNotSetException
+     */
+    public function __toString(): string
+    {
+        $builder = "PUT";
+        if($this->PutWhat != "") $builder .= " $this->PutWhat";
+
+        if($this->PutAt != "") $builder .= " $this->PutAt";
+        elseif ($this->PutInto != "") $builder .= " $this->PutInto";
+        else throw new QueryBuilderRequiredFieldIsNotSetException();
+
+        if($this->Safe) $builder .= " SAFE";
+        return $builder;
+    }
+
+
+    /**
+     * @throws QueryBuilderInvalidInputException
+     */
+    public function Schema(string $uri): Put
+    {
+        $this->PutWhat = self::Validate(
+            target: "SCHEMA \"$uri\"",
+            pattern: "/SCHEMA \".+\"/"
+        );
+        return $this;
+    }
+
+    /**
+     * @throws QueryBuilderInvalidInputException
+     */
+    public function URI(string $uri): Put
+    {
+        $this->PutWhat = self::Validate(
+            target: "URI \"$uri\"",
+            pattern: "/URI \".+\"/"
+        );
+        return $this;
+    }
+
+    /**
+     * @throws QueryBuilderInvalidInputException
+     */
+    public function DataURI(string $mimeType, string $data): Put
+    {
+        $this->PutWhat = self::Validate(
+            target: "URI \"data:$mimeType;$data\"",
+            pattern: "/URI \"data:[a-zA-Z0-9]/[a-zA-Z0-9];.+\"/"
+        );
+        return $this;
+    }
+
+
+    /**
+     * @throws QueryBuilderInvalidInputException
+     * @throws QueryBuilderConflictingFieldAlreadyExistsException
+     */
+    public function At(string $node, string $uwu): Put
+    {
+        self::EnsureNotSet($this->PutInto);
+        $this->PutAt = self::Validate(
+            target: 'AT {' . $node . '}/' . $uwu,
+            pattern: "/AT {[a-zA-Z0-9\-]+}\/[a-zA-Z0-9]+/"
+        );
+        return $this;
+    }
+
+
+    /**
+     * @throws QueryBuilderInvalidInputException
+     * @throws QueryBuilderConflictingFieldAlreadyExistsException
+     */
+    public function Into(string $relativePath, string $propertyName): Put
+    {
+        self::EnsureNotSet($this->PutAt);
+        $this->PutInto = self::Validate(
+            target: "INTO \"$relativePath\" AS \"$propertyName\"",
+            pattern: "/INTO \"[a-zA-Z0-9\-]+\" AS \"[a-zA-Z0-9]+\"/"
+        );
+        return $this;
+    }
+
+
+    public function Safe(): Put
+    {
+        $this->Safe = true;
+        return $this;
+    }
+}