Add tests and example

Author: Iyadhfaleh

examples/toolbox-clock-without-attribute.php

@@ -0,0 +1,34 @@
+<?php
+
+use PhpLlm\LlmChain\Bridge\OpenAI\GPT;
+use PhpLlm\LlmChain\Bridge\OpenAI\PlatformFactory;
+use PhpLlm\LlmChain\Chain;
+use PhpLlm\LlmChain\Chain\ToolBox\ChainProcessor;
+use PhpLlm\LlmChain\Chain\ToolBox\Tool\ClockWithoutAttribute;
+use PhpLlm\LlmChain\Chain\ToolBox\ToolAnalyzer;
+use PhpLlm\LlmChain\Chain\ToolBox\ToolBox;
+use PhpLlm\LlmChain\Model\Message\Message;
+use PhpLlm\LlmChain\Model\Message\MessageBag;
+use Symfony\Component\Clock\Clock as SymfonyClock;
+use Symfony\Component\Dotenv\Dotenv;
+
+require_once dirname(__DIR__).'/vendor/autoload.php';
+(new Dotenv())->loadEnv(dirname(__DIR__).'/.env');
+
+if (empty($_ENV['OPENAI_API_KEY'])) {
+    echo 'Please set the OPENAI_API_KEY environment variable.'.PHP_EOL;
+    exit(1);
+}
+
+$platform = PlatformFactory::create($_ENV['OPENAI_API_KEY']);
+$llm = new GPT(GPT::GPT_4O_MINI);
+
+$clock = new ClockWithoutAttribute(new SymfonyClock());
+$toolBox = new ToolBox(new ToolAnalyzer(), ['clock' => $clock]);
+$processor = new ChainProcessor($toolBox);
+$chain = new Chain($platform, $llm, [$processor], [$processor]);
+
+$messages = new MessageBag(Message::ofUser('What date and time is it?'));
+$response = $chain->call($messages);
+
+echo $response->getContent().PHP_EOL;

src/Chain/ToolBox/ChainProcessor.php

@@ -19,7 +19,7 @@ final class ChainProcessor implements InputProcessor, OutputProcessor, ChainAwar
     use ChainAwareTrait;
 
     public function __construct(
-        private readonly ToolBoxInterface $toolBox,
+        private ToolBoxInterface $toolBox,
     ) {
     }
 
@@ -30,12 +30,11 @@ public function processInput(Input $input): void
         }
 
         $toolMap = $this->toolBox->getMap();
-
-        $options = $input->getOptions();
         if ([] === $toolMap) {
             return;
         }
 
+        $options = $input->getOptions();
         $options['tools'] = $toolMap;
         $input->setOptions($options);
     }

src/Chain/ToolBox/ToolAnalyzer.php

@@ -15,7 +15,6 @@ public function __construct(
     }
 
     /**
-     * @param int|string $toolKey
      * @param class-string $className
      *
      * @return iterable<Metadata>
@@ -26,7 +25,7 @@ public function getMetadata(string|int $toolKey, string $className): iterable
         $attributes = $reflectionClass->getAttributes(AsTool::class);
 
         if (0 === \count($attributes)) {
-            if (true !== is_string($toolKey)) {
+            if (false === is_string($toolKey)) {
                 throw new InvalidToolImplementation('Use AsTool attribute to configure your tools or create your toolBox like "new ToolBox([\'toolName\' => $toolInstance]")');
             }
 

tests/Chain/ToolBox/ToolAnalyzerTest.php

@@ -11,6 +11,7 @@
 use PhpLlm\LlmChain\Exception\InvalidToolImplementation;
 use PhpLlm\LlmChain\Tests\Fixture\Tool\ToolMultiple;
 use PhpLlm\LlmChain\Tests\Fixture\Tool\ToolRequiredParams;
+use PhpLlm\LlmChain\Tests\Fixture\Tool\ToolWithoutAttribute;
 use PhpLlm\LlmChain\Tests\Fixture\Tool\ToolWrong;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\Test;
@@ -32,17 +33,45 @@ protected function setUp(): void
     }
 
     #[Test]
-    public function withoutAttribute(): void
+    public function toolWrong(): void
     {
         $this->expectException(InvalidToolImplementation::class);
-        iterator_to_array($this->toolAnalyzer->getMetadata(ToolWrong::class));
+        iterator_to_array($this->toolAnalyzer->getMetadata(0, ToolWrong::class));
+    }
+
+    #[Test]
+    public function toolWithoutAttribute(): void
+    {
+        $metadatas = iterator_to_array($this->toolAnalyzer->getMetadata('tool_without_attribute', ToolWithoutAttribute::class));
+
+        self::assertToolConfiguration(
+            metadata: $metadatas[0],
+            className: ToolWithoutAttribute::class,
+            name: 'tool_without_attribute',
+            description: 'Use "AsTool" attribute to add description',
+            method: '__invoke',
+            parameters: [
+                'type' => 'object',
+                'properties' => [
+                    'text' => [
+                        'type' => 'string',
+                        'description' => 'The text given to the tool',
+                    ],
+                    'number' => [
+                        'type' => 'integer',
+                        'description' => 'A number given to the tool',
+                    ],
+                ],
+                'required' => ['text', 'number'],
+            ],
+        );
     }
 
     #[Test]
     public function getDefinition(): void
     {
         /** @var Metadata[] $metadatas */
-        $metadatas = iterator_to_array($this->toolAnalyzer->getMetadata(ToolRequiredParams::class));
+        $metadatas = iterator_to_array($this->toolAnalyzer->getMetadata(0, ToolRequiredParams::class));
 
         self::assertToolConfiguration(
             metadata: $metadatas[0],
@@ -70,7 +99,7 @@ className: ToolRequiredParams::class,
     #[Test]
     public function getDefinitionWithMultiple(): void
     {
-        $metadatas = iterator_to_array($this->toolAnalyzer->getMetadata(ToolMultiple::class));
+        $metadatas = iterator_to_array($this->toolAnalyzer->getMetadata(0, ToolMultiple::class));
 
         self::assertCount(2, $metadatas);
 

tests/Fixture/Tool/ToolWithoutAttribute.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpLlm\LlmChain\Tests\Fixture\Tool;
+
+final class ToolWithoutAttribute
+{
+    /**
+     * @param string $text   The text given to the tool
+     * @param int    $number A number given to the tool
+     */
+    public function __invoke(string $text, int $number): string
+    {
+        return sprintf('%s says "%d".', $text, $number);
+    }
+}