ref: throw custom exception for assertion violation

devscast · Dec 27, 2024 · 5f198f8 · 5f198f8
1 parent 079b7af
commit 5f198f8
Show file tree

Hide file tree

Showing 19 changed files with 55 additions and 19 deletions.
diff --git a/src/Assert.php b/src/Assert.php
@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Lugha package.
+ *
+ * (c) Bernard Ngandu <bernard@devscast.tech>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Devscast\Lugha;
+
+use Devscast\Lugha\Exception\InvalidArgumentException;
+
+/**
+ * Class Assert.
+ *
+ * @author bernard-ng <bernard@devscast.tech>
+ */
+final class Assert extends \Webmozart\Assert\Assert
+{
+    #[\Override]
+    protected static function reportInvalidArgument($message)
+    {
+        throw new InvalidArgumentException($message);
+    }
+}
diff --git a/src/Model/Completion/CompletionConfig.php b/src/Model/Completion/CompletionConfig.php
@@ -13,7 +13,7 @@
 
 namespace Devscast\Lugha\Model\Completion;
 
-use Webmozart\Assert\Assert;
+use Devscast\Lugha\Assert;
 
 /**
  * Class CompletionConfig.

diff --git a/src/Model/Completion/Prompt/PromptTemplate.php b/src/Model/Completion/Prompt/PromptTemplate.php
@@ -13,9 +13,9 @@
 
 namespace Devscast\Lugha\Model\Completion\Prompt;
 
+use Devscast\Lugha\Assert;
 use Devscast\Lugha\Exception\UnformattedPromptTemplateException;
 use Devscast\Lugha\Exception\UnreadableFileException;
-use Webmozart\Assert\Assert;
 
 /**
  * Class PromptTemplate.

diff --git a/src/Model/Completion/Tools/FunctionInfo.php b/src/Model/Completion/Tools/FunctionInfo.php
@@ -13,7 +13,7 @@
 
 namespace Devscast\Lugha\Model\Completion\Tools;
 
-use Webmozart\Assert\Assert;
+use Devscast\Lugha\Assert;
 
 /**
  * Class FunctionInfo.

diff --git a/src/Model/Completion/Tools/Parameter.php b/src/Model/Completion/Tools/Parameter.php
@@ -13,7 +13,7 @@
 
 namespace Devscast\Lugha\Model\Completion\Tools;
 
-use Webmozart\Assert\Assert;
+use Devscast\Lugha\Assert;
 
 /**
  * Class Parameter.

diff --git a/src/Model/Embedding/DimensionReducer.php b/src/Model/Embedding/DimensionReducer.php
@@ -13,7 +13,7 @@
 
 namespace Devscast\Lugha\Model\Embedding;
 
-use Webmozart\Assert\Assert;
+use Devscast\Lugha\Assert;
 
 /**
  * Class DimensionReducer.

diff --git a/src/Model/Embedding/Distance.php b/src/Model/Embedding/Distance.php
@@ -13,6 +13,8 @@
 
 namespace Devscast\Lugha\Model\Embedding;
 
+use Devscast\Lugha\Exception\InvalidArgumentException;
+
 /**
  * Class Distance.
  * Represents the distance metric to use when comparing vectors.
@@ -48,7 +50,7 @@ enum Distance
     public function compute(array $a, array $b): float
     {
         if (count($a) !== count($b)) {
-            throw new \InvalidArgumentException('Vectors must have the same dimension.');
+            throw new InvalidArgumentException('Vectors must have the same dimension.');
         }
 
         return match ($this) {

diff --git a/src/Model/Embedding/EmbeddingConfig.php b/src/Model/Embedding/EmbeddingConfig.php
@@ -13,7 +13,7 @@
 
 namespace Devscast\Lugha\Model\Embedding;
 
-use Webmozart\Assert\Assert;
+use Devscast\Lugha\Assert;
 
 /**
  * Class EmbeddingConfig.

diff --git a/src/Model/Reranking/RerankingConfig.php b/src/Model/Reranking/RerankingConfig.php
@@ -13,7 +13,7 @@
 
 namespace Devscast\Lugha\Model\Reranking;
 
-use Webmozart\Assert\Assert;
+use Devscast\Lugha\Assert;
 
 /**
  * Class RerankingConfig.

diff --git a/src/Provider/ProviderConfig.php b/src/Provider/ProviderConfig.php
@@ -13,7 +13,7 @@
 
 namespace Devscast\Lugha\Provider;
 
-use Webmozart\Assert\Assert;
+use Devscast\Lugha\Assert;
 
 /**
  * Class ProviderConfig.

diff --git a/src/Provider/Service/Client/GoogleClient.php b/src/Provider/Service/Client/GoogleClient.php
@@ -13,6 +13,7 @@
 
 namespace Devscast\Lugha\Provider\Service\Client;
 
+use Devscast\Lugha\Assert;
 use Devscast\Lugha\Exception\ServiceIntegrationException;
 use Devscast\Lugha\Model\Completion\Chat\History;
 use Devscast\Lugha\Model\Completion\CompletionConfig;
@@ -23,7 +24,6 @@
 use Devscast\Lugha\Provider\Service\Client;
 use Devscast\Lugha\Provider\Service\HasCompletionSupport;
 use Devscast\Lugha\Provider\Service\HasEmbeddingSupport;
-use Webmozart\Assert\Assert;
 
 /**
  * Class GoogleClient.

diff --git a/src/Provider/Service/Client/MistralClient.php b/src/Provider/Service/Client/MistralClient.php
@@ -13,6 +13,7 @@
 
 namespace Devscast\Lugha\Provider\Service\Client;
 
+use Devscast\Lugha\Assert;
 use Devscast\Lugha\Exception\ServiceIntegrationException;
 use Devscast\Lugha\Model\Completion\Chat\History;
 use Devscast\Lugha\Model\Completion\CompletionConfig;
@@ -23,7 +24,6 @@
 use Devscast\Lugha\Provider\Service\Client;
 use Devscast\Lugha\Provider\Service\HasCompletionSupport;
 use Devscast\Lugha\Provider\Service\HasEmbeddingSupport;
-use Webmozart\Assert\Assert;
 
 /**
  * Class MistralClient.

diff --git a/src/Provider/Service/Client/OllamaClient.php b/src/Provider/Service/Client/OllamaClient.php
@@ -13,6 +13,7 @@
 
 namespace Devscast\Lugha\Provider\Service\Client;
 
+use Devscast\Lugha\Assert;
 use Devscast\Lugha\Exception\ServiceIntegrationException;
 use Devscast\Lugha\Model\Completion\Chat\History;
 use Devscast\Lugha\Model\Completion\CompletionConfig;
@@ -23,7 +24,6 @@
 use Devscast\Lugha\Provider\Service\Client;
 use Devscast\Lugha\Provider\Service\HasCompletionSupport;
 use Devscast\Lugha\Provider\Service\HasEmbeddingSupport;
-use Webmozart\Assert\Assert;
 
 /**
  * Class OllamaClient.

diff --git a/src/Provider/Service/Client/OpenAIClient.php b/src/Provider/Service/Client/OpenAIClient.php
@@ -13,6 +13,7 @@
 
 namespace Devscast\Lugha\Provider\Service\Client;
 
+use Devscast\Lugha\Assert;
 use Devscast\Lugha\Exception\ServiceIntegrationException;
 use Devscast\Lugha\Model\Completion\Chat\History;
 use Devscast\Lugha\Model\Completion\CompletionConfig;
@@ -23,7 +24,6 @@
 use Devscast\Lugha\Provider\Service\Client;
 use Devscast\Lugha\Provider\Service\HasCompletionSupport;
 use Devscast\Lugha\Provider\Service\HasEmbeddingSupport;
-use Webmozart\Assert\Assert;
 
 /**
  * Class OpenAIClient.

diff --git a/src/Provider/Service/Client/VoyagerClient.php b/src/Provider/Service/Client/VoyagerClient.php
@@ -13,6 +13,7 @@
 
 namespace Devscast\Lugha\Provider\Service\Client;
 
+use Devscast\Lugha\Assert;
 use Devscast\Lugha\Exception\ServiceIntegrationException;
 use Devscast\Lugha\Model\Embedding\EmbeddingConfig;
 use Devscast\Lugha\Model\Reranking\RankedDocument;
@@ -24,7 +25,6 @@
 use Devscast\Lugha\Provider\Service\HasEmbeddingSupport;
 use Devscast\Lugha\Provider\Service\HasRerankingSupport;
 use Devscast\Lugha\Retrieval\Document;
-use Webmozart\Assert\Assert;
 
 /**
  * Class VoyagerClient.

diff --git a/src/Provider/Service/HasEmbeddingSupport.php b/src/Provider/Service/HasEmbeddingSupport.php
@@ -13,6 +13,7 @@
 
 namespace Devscast\Lugha\Provider\Service;
 
+use Devscast\Lugha\Exception\InvalidArgumentException;
 use Devscast\Lugha\Exception\ServiceIntegrationException;
 use Devscast\Lugha\Model\Embedding\EmbeddingConfig;
 use Devscast\Lugha\Provider\Response\EmbeddingResponse;
@@ -29,7 +30,7 @@ interface HasEmbeddingSupport
      * @param EmbeddingConfig $config The configuration to use for embeddings.
      *
      * @throws ServiceIntegrationException when any error occurs during the request.
-     * @throws \InvalidArgumentException when the prompt is empty.
+     * @throws InvalidArgumentException when the prompt is empty.
      */
     public function embeddings(string $prompt, EmbeddingConfig $config): EmbeddingResponse;
 }
diff --git a/src/Provider/Service/HasRerankingSupport.php b/src/Provider/Service/HasRerankingSupport.php
@@ -13,6 +13,7 @@
 
 namespace Devscast\Lugha\Provider\Service;
 
+use Devscast\Lugha\Exception\InvalidArgumentException;
 use Devscast\Lugha\Exception\ServiceIntegrationException;
 use Devscast\Lugha\Model\Reranking\RerankingConfig;
 use Devscast\Lugha\Provider\Response\RerankingResponse;
@@ -31,7 +32,7 @@ interface HasRerankingSupport
      * @param RerankingConfig $config The configuration to use for reranking.
      *
      * @throws ServiceIntegrationException when any error occurs during the request.
-     * @throws \InvalidArgumentException when the prompt or documents are empty.
+     * @throws InvalidArgumentException when the prompt or documents are empty.
      */
     public function rerank(string $prompt, array $documents, RerankingConfig $config): RerankingResponse;
 }
diff --git a/tests/Model/Completion/Prompt/PromptTemplateTest.php b/tests/Model/Completion/Prompt/PromptTemplateTest.php
@@ -13,6 +13,7 @@
 
 namespace Devscast\Lugha\Tests\Model\Completion\Prompt;
 
+use Devscast\Lugha\Exception\InvalidArgumentException;
 use Devscast\Lugha\Exception\UnformattedPromptTemplateException;
 use Devscast\Lugha\Model\Completion\Prompt\PromptTemplate;
 use PHPUnit\Framework\TestCase;
@@ -56,15 +57,15 @@ public function testItCanFormatAPromptTemplateWithMultiplePlaceholders(): void
 
     public function testItFailsToCreateAPromptTemplateWithEmptyTemplate(): void
     {
-        $this->expectException(\InvalidArgumentException::class);
+        $this->expectException(InvalidArgumentException::class);
         $this->expectExceptionMessage('Template cannot be empty');
 
         new PromptTemplate('');
     }
 
     public function testItFailsToFormatAPromptTemplateWithEmptyValues(): void
     {
-        $this->expectException(\InvalidArgumentException::class);
+        $this->expectException(InvalidArgumentException::class);
         $this->expectExceptionMessage('Values cannot be empty');
 
         $template = PromptTemplate::from('Hello {context}');

diff --git a/tests/Model/Embedding/DistanceTest.php b/tests/Model/Embedding/DistanceTest.php
@@ -13,6 +13,7 @@
 
 namespace Devscast\Lugha\Tests\Model\Embedding;
 
+use Devscast\Lugha\Exception\InvalidArgumentException;
 use Devscast\Lugha\Model\Embedding\Distance;
 use PHPUnit\Framework\TestCase;
 
@@ -25,7 +26,7 @@ final class DistanceTest extends TestCase
 {
     public function testVectorWithDifferentDimensions(): void
     {
-        $this->expectException(\InvalidArgumentException::class);
+        $this->expectException(InvalidArgumentException::class);
         $this->expectExceptionMessage('Vectors must have the same dimension.');
 
         $distance = Distance::COSINE;