Code cleanup

cognesy · Aug 10, 2024 · beb7c6f · beb7c6f
1 parent 4dec204
commit beb7c6f
Show file tree

Hide file tree

Showing 117 changed files with 125 additions and 702 deletions.
diff --git a/docs/cookbook/examples/troubleshooting/debugging.mdx b/docs/cookbook/examples/troubleshooting/debugging.mdx
@@ -31,7 +31,7 @@ class User {
 }
 
 $instructor = (new Instructor)->withClient(new OpenAIClient(
-    apiKey: Env::get('OPENAI_API_KEY'),// . 'invalid', // intentionally invalid API key
+    apiKey: Env::get('OPENAI_API_KEY'),//  . 'invalid', // intentionally invalid API key
     baseUri: Env::get('OPENAI_BASE_URI'),
 ));
 

diff --git a/src-hub/Commands/GenerateDocs.php b/src-hub/Commands/GenerateDocs.php
@@ -1,7 +1,7 @@
 <?php
 namespace Cognesy\InstructorHub\Commands;
 
-use Cognesy\Instructor\Utils\Color;
+use Cognesy\Instructor\Utils\Cli\Color;
 use Cognesy\InstructorHub\Core\Cli;
 use Cognesy\InstructorHub\Core\Command;
 use Cognesy\InstructorHub\Services\MintlifyDocGenerator;

diff --git a/src-hub/Commands/ListAllExamples.php b/src-hub/Commands/ListAllExamples.php
@@ -1,7 +1,7 @@
 <?php
 namespace Cognesy\InstructorHub\Commands;
 
-use Cognesy\Instructor\Utils\Color;
+use Cognesy\Instructor\Utils\Cli\Color;
 use Cognesy\InstructorHub\Core\Cli;
 use Cognesy\InstructorHub\Core\Command;
 use Cognesy\InstructorHub\Data\Example;

diff --git a/src-hub/Commands/RunAllExamples.php b/src-hub/Commands/RunAllExamples.php
@@ -1,7 +1,7 @@
 <?php
 namespace Cognesy\InstructorHub\Commands;
 
-use Cognesy\Instructor\Utils\Color;
+use Cognesy\Instructor\Utils\Cli\Color;
 use Cognesy\InstructorHub\Core\Cli;
 use Cognesy\InstructorHub\Core\Command;
 use Cognesy\InstructorHub\Services\Runner;

diff --git a/src-hub/Commands/RunOneExample.php b/src-hub/Commands/RunOneExample.php
@@ -1,7 +1,7 @@
 <?php
 namespace Cognesy\InstructorHub\Commands;
 
-use Cognesy\Instructor\Utils\Color;
+use Cognesy\Instructor\Utils\Cli\Color;
 use Cognesy\InstructorHub\Core\Cli;
 use Cognesy\InstructorHub\Core\Command;
 use Cognesy\InstructorHub\Data\Example;

diff --git a/src-hub/Commands/ShowExample.php b/src-hub/Commands/ShowExample.php
@@ -1,7 +1,7 @@
 <?php
 namespace Cognesy\InstructorHub\Commands;
 
-use Cognesy\Instructor\Utils\Color;
+use Cognesy\Instructor\Utils\Cli\Color;
 use Cognesy\InstructorHub\Core\Cli;
 use Cognesy\InstructorHub\Core\Command;
 use Cognesy\InstructorHub\Services\ExampleRepository;

diff --git a/src-hub/Core/Cli.php b/src-hub/Core/Cli.php
@@ -2,8 +2,8 @@
 
 namespace Cognesy\InstructorHub\Core;
 
-use Cognesy\Instructor\Utils\Color;
-use Cognesy\Instructor\Utils\Console;
+use Cognesy\Instructor\Utils\Cli\Color;
+use Cognesy\Instructor\Utils\Cli\Console;
 
 class Cli
 {

diff --git a/src-hub/Core/CliApp.php b/src-hub/Core/CliApp.php
@@ -2,7 +2,7 @@
 namespace Cognesy\InstructorHub\Core;
 
 use Cognesy\Instructor\Configuration\Configuration;
-use Cognesy\Instructor\Utils\Color;
+use Cognesy\Instructor\Utils\Cli\Color;
 
 abstract class CliApp {
     private CommandProvider $commandProvider;

diff --git a/src-hub/Utils/CliMarkdown.php b/src-hub/Utils/CliMarkdown.php
@@ -2,7 +2,7 @@
 namespace Cognesy\InstructorHub\Utils;
 
 use cebe\markdown\GithubMarkdown;
-use Cognesy\Instructor\Utils\Color as IColor;
+use Cognesy\Instructor\Utils\Cli\Color as IColor;
 use Cognesy\InstructorHub\Core\Cli;
 use Toolkit\Cli\Color;
 use Toolkit\Cli\Color\ColorTag;

diff --git a/src-hub/Views/DocGenView.php b/src-hub/Views/DocGenView.php
@@ -2,7 +2,7 @@
 
 namespace Cognesy\InstructorHub\Views;
 
-use Cognesy\Instructor\Utils\Color;
+use Cognesy\Instructor\Utils\Cli\Color;
 use Cognesy\InstructorHub\Core\Cli;
 use Cognesy\InstructorHub\Data\Example;
 

diff --git a/src-hub/Views/RunnerView.php b/src-hub/Views/RunnerView.php
@@ -2,7 +2,7 @@
 
 namespace Cognesy\InstructorHub\Views;
 
-use Cognesy\Instructor\Utils\Color;
+use Cognesy\Instructor\Utils\Cli\Color;
 use Cognesy\InstructorHub\Core\Cli;
 use Cognesy\InstructorHub\Data\Example;
 use Exception;

diff --git a/src/ApiClient/RequestConfig/CacheConfig.php b/src/ApiClient/RequestConfig/CacheConfig.php
@@ -2,7 +2,7 @@
 namespace Cognesy\Instructor\ApiClient\RequestConfig;
 
 use Closure;
-use Cognesy\Instructor\Utils\Json;
+use Cognesy\Instructor\Utils\Json\Json;
 use League\Flysystem\Filesystem;
 use League\Flysystem\Local\LocalFilesystemAdapter;
 use RuntimeException;

diff --git a/src/ApiClient/Requests/Traits/HandlesResponse.php b/src/ApiClient/Requests/Traits/HandlesResponse.php
@@ -4,7 +4,7 @@
 
 use Cognesy\Instructor\ApiClient\Responses\ApiResponse;
 use Cognesy\Instructor\ApiClient\Responses\PartialApiResponse;
-use Cognesy\Instructor\Utils\Json;
+use Cognesy\Instructor\Utils\Json\Json;
 use Exception;
 use Saloon\Http\Response;
 

diff --git a/src/ApiClient/Responses/ApiResponse.php b/src/ApiClient/Responses/ApiResponse.php
@@ -3,7 +3,7 @@
 namespace Cognesy\Instructor\ApiClient\Responses;
 
 use Cognesy\Instructor\Data\ToolCalls;
-use Cognesy\Instructor\Utils\Json;
+use Cognesy\Instructor\Utils\Json\Json;
 
 class ApiResponse
 {

diff --git a/src/Clients/Anthropic/Traits/HandlesResponse.php b/src/Clients/Anthropic/Traits/HandlesResponse.php
@@ -4,7 +4,7 @@
 
 use Cognesy\Instructor\ApiClient\Responses\ApiResponse;
 use Cognesy\Instructor\ApiClient\Responses\PartialApiResponse;
-use Cognesy\Instructor\Utils\Json;
+use Cognesy\Instructor\Utils\Json\Json;
 use Saloon\Http\Response;
 
 trait HandlesResponse

diff --git a/src/Clients/Cohere/Traits/HandlesResponse.php b/src/Clients/Cohere/Traits/HandlesResponse.php
@@ -3,7 +3,7 @@
 
 use Cognesy\Instructor\ApiClient\Responses\ApiResponse;
 use Cognesy\Instructor\ApiClient\Responses\PartialApiResponse;
-use Cognesy\Instructor\Utils\Json;
+use Cognesy\Instructor\Utils\Json\Json;
 use Saloon\Http\Response;
 
 trait HandlesResponse

diff --git a/src/Clients/Gemini/Traits/HandlesResponse.php b/src/Clients/Gemini/Traits/HandlesResponse.php
@@ -3,7 +3,7 @@
 
 use Cognesy\Instructor\ApiClient\Responses\ApiResponse;
 use Cognesy\Instructor\ApiClient\Responses\PartialApiResponse;
-use Cognesy\Instructor\Utils\Json;
+use Cognesy\Instructor\Utils\Json\Json;
 use Saloon\Http\Response;
 
 trait HandlesResponse

diff --git a/src/Contracts/CanBuildRequest.php b/src/Contracts/CanBuildRequest.php
diff --git a/src/Contracts/CanGenerateResponse.php b/src/Contracts/CanGenerateResponse.php
@@ -4,7 +4,7 @@
 
 use Cognesy\Instructor\ApiClient\Responses\ApiResponse;
 use Cognesy\Instructor\Data\ResponseModel;
-use Cognesy\Instructor\Utils\Result;
+use Cognesy\Instructor\Utils\Result\Result;
 
 interface CanGenerateResponse
 {

diff --git a/...s/CanProvideMessage/CanProvideMessage.php → src/Contracts/CanProvideMessage.php b/...s/CanProvideMessage/CanProvideMessage.php → src/Contracts/CanProvideMessage.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Cognesy\Instructor\Contracts\CanProvideMessage;
+namespace Cognesy\Instructor\Contracts;
 
 use Cognesy\Instructor\Data\Messages\Message;
 

diff --git a/src/Core/Factories/InstructorFactory.php b/src/Core/Factories/InstructorFactory.php
diff --git a/src/Core/Factories/StreamFactory.php b/src/Core/Factories/StreamFactory.php
diff --git a/src/Core/Response/ResponseGenerator.php b/src/Core/Response/ResponseGenerator.php
@@ -11,8 +11,8 @@
 use Cognesy\Instructor\Exceptions\JsonParsingException;
 use Cognesy\Instructor\Transformation\ResponseTransformer;
 use Cognesy\Instructor\Utils\Chain;
-use Cognesy\Instructor\Utils\Json;
-use Cognesy\Instructor\Utils\Result;
+use Cognesy\Instructor\Utils\Json\Json;
+use Cognesy\Instructor\Utils\Result\Result;
 use Cognesy\Instructor\Validation\ResponseValidator;
 use Cognesy\Instructor\Validation\ValidationResult;
 use Exception;

diff --git a/src/Core/StreamResponse/PartialsGenerator.php b/src/Core/StreamResponse/PartialsGenerator.php
@@ -24,8 +24,8 @@
 use Cognesy\Instructor\Transformation\ResponseTransformer;
 use Cognesy\Instructor\Utils\Arrays;
 use Cognesy\Instructor\Utils\Chain;
-use Cognesy\Instructor\Utils\Json;
-use Cognesy\Instructor\Utils\Result;
+use Cognesy\Instructor\Utils\Json\Json;
+use Cognesy\Instructor\Utils\Result\Result;
 use Exception;
 use Generator;
 

diff --git a/src/Core/StreamResponse/Traits/ValidatesPartialResponse.php b/src/Core/StreamResponse/Traits/ValidatesPartialResponse.php
@@ -6,8 +6,8 @@
 use Cognesy\Instructor\Exceptions\JsonParsingException;
 use Cognesy\Instructor\Utils\Arrays;
 use Cognesy\Instructor\Utils\Chain;
-use Cognesy\Instructor\Utils\Json;
-use Cognesy\Instructor\Utils\Result;
+use Cognesy\Instructor\Utils\Json\Json;
+use Cognesy\Instructor\Utils\Result\Result;
 use Exception;
 
 trait ValidatesPartialResponse

diff --git a/src/Data/Messages/Traits/Message/HandlesCreation.php b/src/Data/Messages/Traits/Message/HandlesCreation.php
@@ -2,7 +2,7 @@
 
 namespace Cognesy\Instructor\Data\Messages\Traits\Message;
 
-use Cognesy\Instructor\Contracts\CanProvideMessage\CanProvideMessage;
+use Cognesy\Instructor\Contracts\CanProvideMessage;
 use Cognesy\Instructor\Data\Messages\Message;
 use Cognesy\Instructor\Data\Messages\Utils\Text;
 use Exception;

diff --git a/src/Data/Messages/Traits/Messages/HandlesCreation.php b/src/Data/Messages/Traits/Messages/HandlesCreation.php
@@ -2,7 +2,7 @@
 
 namespace Cognesy\Instructor\Data\Messages\Traits\Messages;
 
-use Cognesy\Instructor\Contracts\CanProvideMessage\CanProvideMessage;
+use Cognesy\Instructor\Contracts\CanProvideMessage;
 use Cognesy\Instructor\Contracts\CanProvideMessages;
 use Cognesy\Instructor\Data\Messages\Message;
 use Cognesy\Instructor\Data\Messages\Messages;

diff --git a/src/Data/Messages/Utils/Text.php b/src/Data/Messages/Utils/Text.php
@@ -4,7 +4,7 @@
 
 use BackedEnum;
 use Closure;
-use Cognesy\Instructor\Utils\Json;
+use Cognesy\Instructor\Utils\Json\Json;
 
 // TODO: this should be moved to a chain-like component, so the way we handle inputs can be customized
 class Text

diff --git a/src/Data/Traits/Example/HandlesConversion.php b/src/Data/Traits/Example/HandlesConversion.php
@@ -3,7 +3,7 @@
 
 use BackedEnum;
 use Cognesy\Instructor\Data\Messages\Messages;
-use Cognesy\Instructor\Utils\Json;
+use Cognesy\Instructor\Utils\Json\Json;
 use Cognesy\Instructor\Utils\TemplateUtil;
 
 trait HandlesConversion

diff --git a/src/Data/Traits/Example/HandlesCreation.php b/src/Data/Traits/Example/HandlesCreation.php
@@ -1,7 +1,7 @@
 <?php
 namespace Cognesy\Instructor\Data\Traits\Example;
 
-use Cognesy\Instructor\Utils\Json;
+use Cognesy\Instructor\Utils\Json\Json;
 use Exception;
 
 trait HandlesCreation

diff --git a/src/Deserialization/Deserializers/SymfonyDeserializer.php b/src/Deserialization/Deserializers/SymfonyDeserializer.php
@@ -3,14 +3,13 @@
 
 use Cognesy\Instructor\Deserialization\Contracts\CanDeserializeClass;
 use Cognesy\Instructor\Deserialization\Exceptions\DeserializationException;
-use Cognesy\Instructor\Utils\Json;
+use Cognesy\Instructor\Utils\Json\Json;
 use Symfony\Component\PropertyInfo\Extractor\PhpDocExtractor;
 use Symfony\Component\PropertyInfo\Extractor\PhpStanExtractor;
 use Symfony\Component\PropertyInfo\Extractor\ReflectionExtractor;
 use Symfony\Component\PropertyInfo\PropertyInfoExtractor;
 use Symfony\Component\Serializer\Encoder\JsonEncoder;
 use Symfony\Component\Serializer\Normalizer\ArrayDenormalizer;
-use Symfony\Component\Serializer\Normalizer\DateTimeNormalizer;
 use Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer;
 use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
 use Symfony\Component\Serializer\Normalizer\PropertyNormalizer;

diff --git a/src/Deserialization/Exceptions/DeserializationException.php b/src/Deserialization/Exceptions/DeserializationException.php
@@ -2,7 +2,7 @@
 
 namespace Cognesy\Instructor\Deserialization\Exceptions;
 
-use Cognesy\Instructor\Utils\Json;
+use Cognesy\Instructor\Utils\Json\Json;
 
 class DeserializationException extends \Exception
 {

diff --git a/src/Deserialization/ResponseDeserializer.php b/src/Deserialization/ResponseDeserializer.php
@@ -10,7 +10,7 @@
 use Cognesy\Instructor\Events\Response\ResponseDeserializationAttempt;
 use Cognesy\Instructor\Events\Response\ResponseDeserializationFailed;
 use Cognesy\Instructor\Events\Response\ResponseDeserialized;
-use Cognesy\Instructor\Utils\Result;
+use Cognesy\Instructor\Utils\Result\Result;
 use Exception;
 
 class ResponseDeserializer

diff --git a/src/Events/ApiClient/ApiRequestInitiated.php b/src/Events/ApiClient/ApiRequestInitiated.php
@@ -2,7 +2,7 @@
 namespace Cognesy\Instructor\Events\ApiClient;
 
 use Cognesy\Instructor\Events\Event;
-use Cognesy\Instructor\Utils\Json;
+use Cognesy\Instructor\Utils\Json\Json;
 use Psr\Log\LogLevel;
 
 class ApiRequestInitiated extends Event

diff --git a/src/Events/ApiClient/ApiRequestSent.php b/src/Events/ApiClient/ApiRequestSent.php
@@ -2,7 +2,7 @@
 namespace Cognesy\Instructor\Events\ApiClient;
 
 use Cognesy\Instructor\Events\Event;
-use Cognesy\Instructor\Utils\Json;
+use Cognesy\Instructor\Utils\Json\Json;
 use Psr\Log\LogLevel;
 
 class ApiRequestSent extends Event

diff --git a/src/Events/ApiClient/ApiResponseReceived.php b/src/Events/ApiClient/ApiResponseReceived.php
@@ -3,7 +3,7 @@
 namespace Cognesy\Instructor\Events\ApiClient;
 
 use Cognesy\Instructor\Events\Event;
-use Cognesy\Instructor\Utils\Json;
+use Cognesy\Instructor\Utils\Json\Json;
 
 class ApiResponseReceived extends Event
 {

diff --git a/src/Events/ApiClient/ApiStreamConnected.php b/src/Events/ApiClient/ApiStreamConnected.php
@@ -3,7 +3,7 @@
 namespace Cognesy\Instructor\Events\ApiClient;
 
 use Cognesy\Instructor\Events\Event;
-use Cognesy\Instructor\Utils\Json;
+use Cognesy\Instructor\Utils\Json\Json;
 
 class ApiStreamConnected extends Event
 {

diff --git a/src/Events/ApiClient/ApiStreamResponseReceived.php b/src/Events/ApiClient/ApiStreamResponseReceived.php
@@ -1,7 +1,7 @@
 <?php
 namespace Cognesy\Instructor\Events\ApiClient;
 
-use Cognesy\Instructor\Utils\Json;
+use Cognesy\Instructor\Utils\Json\Json;
 
 class ApiStreamResponseReceived extends ApiResponseReceived
 {