ci: add rector/rector (#18)

OskarStark · web-flow · commit c1fad8a48f4b · 2024-09-22T22:51:48.000+02:00
diff --git a/.github/workflows/pipeline.yml b/.github/workflows/pipeline.yml
@@ -31,6 +31,9 @@ jobs:
       - name: Code Style PHP
         run: vendor/bin/php-cs-fixer fix --dry-run
 
+      - name: Rector
+        run: vendor/bin/rector
+
       - name: PHPStan
         run: vendor/bin/phpstan analyse
 
diff --git a/Makefile b/Makefile
@@ -2,6 +2,7 @@ qa:
 	vendor/bin/php-cs-fixer fix
 	vendor/bin/phpstan
 	vendor/bin/phpunit
+	vendor/bin/rector
 
 qa-lowest:
 	composer update --prefer-lowest
diff --git a/composer.json b/composer.json
@@ -27,6 +27,7 @@
         "phpstan/phpstan": "^1.12",
         "phpunit/phpunit": "^11.3",
         "probots-io/pinecone-php": "^1.0",
+        "rector/rector": "^1.2",
         "symfony/clock": "^6.4 || ^7.1",
         "symfony/console": "^6.4 || ^7.1",
         "symfony/css-selector": "^6.4 || ^7.1",
diff --git a/rector.php b/rector.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Php74\Rector\Closure\ClosureToArrowFunctionRector;
+use Rector\PHPUnit\Set\PHPUnitSetList;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__.'/examples',
+        __DIR__.'/src',
+        __DIR__.'/tests',
+    ])
+    ->withPhpSets(php82: true)
+    ->withSets([
+        PHPUnitSetList::PHPUNIT_110,
+        PHPUnitSetList::ANNOTATIONS_TO_ATTRIBUTES,
+    ])
+    ->withImportNames(importNames: true, importShortClasses: false)
+    ->withSkip([
+        ClosureToArrowFunctionRector::class,
+    ])
+    ->withTypeCoverageLevel(0);
diff --git a/src/Anthropic/Model/Claude.php b/src/Anthropic/Model/Claude.php
@@ -11,7 +11,7 @@
 use PhpLlm\LlmChain\Response\Choice;
 use PhpLlm\LlmChain\Response\Response;
 
-final class Claude implements LanguageModel
+final readonly class Claude implements LanguageModel
 {
     public function __construct(
         private ClaudeRuntime $runtime,
diff --git a/src/Anthropic/Runtime/Anthropic.php b/src/Anthropic/Runtime/Anthropic.php
@@ -7,7 +7,7 @@
 use PhpLlm\LlmChain\Anthropic\ClaudeRuntime;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
-final class Anthropic implements ClaudeRuntime
+final readonly class Anthropic implements ClaudeRuntime
 {
     public function __construct(
         private HttpClientInterface $httpClient,
diff --git a/src/DocumentEmbedder.php b/src/DocumentEmbedder.php
@@ -7,7 +7,7 @@
 use PhpLlm\LlmChain\Document\Document;
 use PhpLlm\LlmChain\Store\StoreInterface;
 
-final class DocumentEmbedder
+final readonly class DocumentEmbedder
 {
     public function __construct(
         private EmbeddingModel $embeddings,
diff --git a/src/OpenAI/Model/Embeddings.php b/src/OpenAI/Model/Embeddings.php
@@ -9,7 +9,7 @@
 use PhpLlm\LlmChain\OpenAI\Model\Embeddings\Version;
 use PhpLlm\LlmChain\OpenAI\Runtime;
 
-final class Embeddings implements EmbeddingModel
+final readonly class Embeddings implements EmbeddingModel
 {
     public function __construct(
         private Runtime $runtime,
diff --git a/src/OpenAI/Model/Gpt.php b/src/OpenAI/Model/Gpt.php
@@ -12,7 +12,7 @@
 use PhpLlm\LlmChain\Response\Response;
 use PhpLlm\LlmChain\Response\ToolCall;
 
-final class Gpt implements LanguageModel
+final readonly class Gpt implements LanguageModel
 {
     public function __construct(
         private Runtime $runtime,
diff --git a/src/OpenAI/Runtime/Azure.php b/src/OpenAI/Runtime/Azure.php
@@ -11,11 +11,11 @@
 final class Azure extends AbstractRuntime implements Runtime
 {
     public function __construct(
-        private HttpClientInterface $httpClient,
-        private string $baseUrl,
-        private string $deployment,
-        private string $apiVersion,
-        private string $key,
+        private readonly HttpClientInterface $httpClient,
+        private readonly string $baseUrl,
+        private readonly string $deployment,
+        private readonly string $apiVersion,
+        private readonly string $key,
     ) {
     }
 
diff --git a/src/OpenAI/Runtime/OpenAI.php b/src/OpenAI/Runtime/OpenAI.php
@@ -11,8 +11,8 @@
 final class OpenAI extends AbstractRuntime implements Runtime
 {
     public function __construct(
-        private HttpClientInterface $httpClient,
-        private string $apiKey,
+        private readonly HttpClientInterface $httpClient,
+        private readonly string $apiKey,
     ) {
     }
 
diff --git a/src/Store/Azure/SearchStore.php b/src/Store/Azure/SearchStore.php
@@ -11,14 +11,14 @@
 use Symfony\Component\Uid\Uuid;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
-final class SearchStore implements VectorStoreInterface
+final readonly class SearchStore implements VectorStoreInterface
 {
     public function __construct(
-        private readonly HttpClientInterface $httpClient,
-        private readonly string $endpointUrl,
-        private readonly string $apiKey,
-        private readonly string $indexName,
-        private readonly string $apiVersion,
+        private HttpClientInterface $httpClient,
+        private string $endpointUrl,
+        private string $apiKey,
+        private string $indexName,
+        private string $apiVersion,
     ) {
     }
 
diff --git a/src/Store/ChromaDb/Store.php b/src/Store/ChromaDb/Store.php
@@ -12,7 +12,7 @@
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Uid\Uuid;
 
-final class Store implements VectorStoreInterface
+final readonly class Store implements VectorStoreInterface
 {
     public function __construct(
         private Client $client,
diff --git a/src/StructuredOutput/SchemaFactory.php b/src/StructuredOutput/SchemaFactory.php
@@ -9,10 +9,10 @@
 use Symfony\Component\PropertyInfo\PropertyInfoExtractor;
 use Symfony\Component\PropertyInfo\Type;
 
-final class SchemaFactory
+final readonly class SchemaFactory
 {
     public function __construct(
-        private readonly PropertyInfoExtractor $propertyInfo,
+        private PropertyInfoExtractor $propertyInfo,
     ) {
     }
 
diff --git a/src/ToolBox/AsTool.php b/src/ToolBox/AsTool.php
@@ -5,12 +5,12 @@
 namespace PhpLlm\LlmChain\ToolBox;
 
 #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
-final class AsTool
+final readonly class AsTool
 {
     public function __construct(
-        public readonly string $name,
-        public readonly string $description,
-        public readonly string $method = '__invoke',
+        public string $name,
+        public string $description,
+        public string $method = '__invoke',
     ) {
     }
 }
diff --git a/src/ToolBox/Metadata.php b/src/ToolBox/Metadata.php
@@ -7,17 +7,17 @@
 /**
  * @phpstan-import-type ParameterDefinition from ParameterAnalyzer
  */
-final class Metadata implements \JsonSerializable
+final readonly class Metadata implements \JsonSerializable
 {
     /**
      * @param ParameterDefinition|null $parameters
      */
     public function __construct(
-        public readonly string $className,
-        public readonly string $name,
-        public readonly string $description,
-        public readonly string $method,
-        public readonly ?array $parameters,
+        public string $className,
+        public string $name,
+        public string $description,
+        public string $method,
+        public ?array $parameters,
     ) {
     }
 
diff --git a/src/ToolBox/Tool/Clock.php b/src/ToolBox/Tool/Clock.php
@@ -8,7 +8,7 @@
 use Symfony\Component\Clock\ClockInterface;
 
 #[AsTool('clock', description: 'Provides the current date and time.')]
-final class Clock
+final readonly class Clock
 {
     public function __construct(
         private ClockInterface $clock,
diff --git a/src/ToolBox/Tool/SerpApi.php b/src/ToolBox/Tool/SerpApi.php
@@ -8,7 +8,7 @@
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 #[AsTool(name: 'serpapi', description: 'search for information on the internet')]
-final class SerpApi
+final readonly class SerpApi
 {
     public function __construct(
         private HttpClientInterface $httpClient,
diff --git a/src/ToolBox/Tool/Wikipedia.php b/src/ToolBox/Tool/Wikipedia.php
@@ -9,7 +9,7 @@
 
 #[AsTool('wikipedia_search', description: 'Searches Wikipedia for a given query', method: 'search')]
 #[AsTool('wikipedia_article', description: 'Retrieves a Wikipedia article by its title', method: 'getArticle')]
-final class Wikipedia
+final readonly class Wikipedia
 {
     public function __construct(
         private HttpClientInterface $httpClient,
diff --git a/src/ToolBox/ToolAnalyzer.php b/src/ToolBox/ToolAnalyzer.php
@@ -6,10 +6,10 @@
 
 use PhpLlm\LlmChain\Exception\InvalidToolImplementation;
 
-final class ToolAnalyzer
+final readonly class ToolAnalyzer
 {
     public function __construct(
-        private readonly ParameterAnalyzer $parameterAnalyzer = new ParameterAnalyzer(),
+        private ParameterAnalyzer $parameterAnalyzer = new ParameterAnalyzer(),
     ) {
     }
 
diff --git a/tests/Message/MessageBagTest.php b/tests/Message/MessageBagTest.php
@@ -8,6 +8,7 @@
 use PhpLlm\LlmChain\Message\MessageBag;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\Small;
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\TestCase;
 
@@ -16,7 +17,8 @@
 #[Small]
 final class MessageBagTest extends TestCase
 {
-    public function testGetSystemMessage(): void
+    #[Test]
+    public function getSystemMessage(): void
     {
         $messageBag = new MessageBag(
             Message::forSystem('My amazing system prompt.'),
@@ -29,7 +31,8 @@ public function testGetSystemMessage(): void
         self::assertSame('My amazing system prompt.', $systemMessage->content);
     }
 
-    public function testGetSystemMessageWithoutSystemMessage(): void
+    #[Test]
+    public function getSystemMessageWithoutSystemMessage(): void
     {
         $messageBag = new MessageBag(
             Message::ofAssistant('It is time to sleep.'),
@@ -39,7 +42,8 @@ public function testGetSystemMessageWithoutSystemMessage(): void
         self::assertNull($messageBag->getSystemMessage());
     }
 
-    public function testWith(): void
+    #[Test]
+    public function with(): void
     {
         $messageBag = new MessageBag(
             Message::forSystem('My amazing system prompt.'),
@@ -55,7 +59,8 @@ public function testWith(): void
         self::assertSame('It is time to wake up.', $newMessageBag[3]->content);
     }
 
-    public function testWithoutSystemMessage(): void
+    #[Test]
+    public function withoutSystemMessage(): void
     {
         $messageBag = new MessageBag(
             Message::forSystem('My amazing system prompt.'),
@@ -70,7 +75,8 @@ public function testWithoutSystemMessage(): void
         self::assertSame('It is time to sleep.', $newMessageBag[0]->content);
     }
 
-    public function testPrepend(): void
+    #[Test]
+    public function prepend(): void
     {
         $messageBag = new MessageBag(
             Message::ofAssistant('It is time to sleep.'),
@@ -85,7 +91,8 @@ public function testPrepend(): void
         self::assertSame('My amazing system prompt.', $newMessageBag[0]->content);
     }
 
-    public function testJsonSerialize(): void
+    #[Test]
+    public function jsonSerialize(): void
     {
         $messageBag = new MessageBag(
             Message::forSystem('My amazing system prompt.'),
diff --git a/tests/Message/MessageTest.php b/tests/Message/MessageTest.php
@@ -9,6 +9,7 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Small;
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\TestCase;
 
@@ -17,7 +18,8 @@
 #[Small]
 final class MessageTest extends TestCase
 {
-    public function testCreateSystemMessage(): void
+    #[Test]
+    public function createSystemMessage(): void
     {
         $message = Message::forSystem('My amazing system prompt.');
 
@@ -29,7 +31,8 @@ public function testCreateSystemMessage(): void
         self::assertFalse($message->hasToolCalls());
     }
 
-    public function testCreateAssistantMessage(): void
+    #[Test]
+    public function createAssistantMessage(): void
     {
         $message = Message::ofAssistant('It is time to sleep.');
 
@@ -41,7 +44,8 @@ public function testCreateAssistantMessage(): void
         self::assertFalse($message->hasToolCalls());
     }
 
-    public function testCreateAssistantMessageWithToolCalls(): void
+    #[Test]
+    public function createAssistantMessageWithToolCalls(): void
     {
         $toolCalls = [
             new ToolCall('call_123456', 'my_tool', ['foo' => 'bar']),
@@ -57,7 +61,8 @@ public function testCreateAssistantMessageWithToolCalls(): void
         self::assertTrue($message->hasToolCalls());
     }
 
-    public function testCreateUserMessage(): void
+    #[Test]
+    public function createUserMessage(): void
     {
         $message = Message::ofUser('Hi, my name is John.');
 
@@ -69,7 +74,8 @@ public function testCreateUserMessage(): void
         self::assertFalse($message->hasToolCalls());
     }
 
-    public function testCreateToolCallMessage(): void
+    #[Test]
+    public function createToolCallMessage(): void
     {
         $toolCall = new ToolCall('call_123456', 'my_tool', ['foo' => 'bar']);
         $message = Message::ofToolCall($toolCall, 'Foo bar.');
@@ -84,7 +90,8 @@ public function testCreateToolCallMessage(): void
     }
 
     #[DataProvider('provideJsonScenarios')]
-    public function testJsonSerialize(Message $message, array $expected): void
+    #[Test]
+    public function jsonSerialize(Message $message, array $expected): void
     {
         self::assertSame($expected, $message->jsonSerialize());
     }
diff --git a/tests/Response/ChoiceTest.php b/tests/Response/ChoiceTest.php
diff --git a/tests/Response/ResponseTest.php b/tests/Response/ResponseTest.php
diff --git a/tests/Response/ToolCallTest.php b/tests/Response/ToolCallTest.php
diff --git a/tests/StructuredOutput/SchemaFactoryTest.php b/tests/StructuredOutput/SchemaFactoryTest.php
diff --git a/tests/ToolBox/ParameterAnalyzerTest.php b/tests/ToolBox/ParameterAnalyzerTest.php
diff --git a/tests/ToolBox/ToolAnalyzerTest.php b/tests/ToolBox/ToolAnalyzerTest.php
diff --git a/tests/ToolBox/ToolBoxTest.php b/tests/ToolBox/ToolBoxTest.php

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`use PhpLlm\LlmChain\Response\Choice;`
`12`	`12`	`use PhpLlm\LlmChain\Response\Response;`
`13`	`13`
`14`		`-final class Claude implements LanguageModel`
	`14`	`+final readonly class Claude implements LanguageModel`
`15`	`15`	`{`
`16`	`16`	`public function __construct(`
`17`	`17`	`private ClaudeRuntime $runtime,`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`use PhpLlm\LlmChain\Anthropic\ClaudeRuntime;`
`8`	`8`	`use Symfony\Contracts\HttpClient\HttpClientInterface;`
`9`	`9`
`10`		`-final class Anthropic implements ClaudeRuntime`
	`10`	`+final readonly class Anthropic implements ClaudeRuntime`
`11`	`11`	`{`
`12`	`12`	`public function __construct(`
`13`	`13`	`private HttpClientInterface $httpClient,`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`use PhpLlm\LlmChain\Document\Document;`
`8`	`8`	`use PhpLlm\LlmChain\Store\StoreInterface;`
`9`	`9`
`10`		`-final class DocumentEmbedder`
	`10`	`+final readonly class DocumentEmbedder`
`11`	`11`	`{`
`12`	`12`	`public function __construct(`
`13`	`13`	`private EmbeddingModel $embeddings,`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`use PhpLlm\LlmChain\OpenAI\Model\Embeddings\Version;`
`10`	`10`	`use PhpLlm\LlmChain\OpenAI\Runtime;`
`11`	`11`
`12`		`-final class Embeddings implements EmbeddingModel`
	`12`	`+final readonly class Embeddings implements EmbeddingModel`
`13`	`13`	`{`
`14`	`14`	`public function __construct(`
`15`	`15`	`private Runtime $runtime,`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`use PhpLlm\LlmChain\Response\Response;`
`13`	`13`	`use PhpLlm\LlmChain\Response\ToolCall;`
`14`	`14`
`15`		`-final class Gpt implements LanguageModel`
	`15`	`+final readonly class Gpt implements LanguageModel`
`16`	`16`	`{`
`17`	`17`	`public function __construct(`
`18`	`18`	`private Runtime $runtime,`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,8 @@`
`11`	`11`	`final class OpenAI extends AbstractRuntime implements Runtime`
`12`	`12`	`{`
`13`	`13`	`public function __construct(`
`14`		`- private HttpClientInterface $httpClient,`
`15`		`- private string $apiKey,`
	`14`	`+ private readonly HttpClientInterface $httpClient,`
	`15`	`+ private readonly string $apiKey,`
`16`	`16`	`) {`
`17`	`17`	`}`
`18`	`18`
Original file line number	Diff line number	Diff line change
`@@ -9,10 +9,10 @@`
`9`	`9`	`use Symfony\Component\PropertyInfo\PropertyInfoExtractor;`
`10`	`10`	`use Symfony\Component\PropertyInfo\Type;`
`11`	`11`
`12`		`-final class SchemaFactory`
	`12`	`+final readonly class SchemaFactory`
`13`	`13`	`{`
`14`	`14`	`public function __construct(`
`15`		`- private readonly PropertyInfoExtractor $propertyInfo,`
	`15`	`+ private PropertyInfoExtractor $propertyInfo,`
`16`	`16`	`) {`
`17`	`17`	`}`
`18`	`18`
Original file line number	Diff line number	Diff line change
`@@ -5,12 +5,12 @@`
`5`	`5`	`namespace PhpLlm\LlmChain\ToolBox;`
`6`	`6`
`7`	`7`	`#[\Attribute(\Attribute::TARGET_CLASS \| \Attribute::IS_REPEATABLE)]`
`8`		`-final class AsTool`
	`8`	`+final readonly class AsTool`
`9`	`9`	`{`
`10`	`10`	`public function __construct(`
`11`		`- public readonly string $name,`
`12`		`- public readonly string $description,`
`13`		`- public readonly string $method = '__invoke',`
	`11`	`+ public string $name,`
	`12`	`+ public string $description,`
	`13`	`+ public string $method = '__invoke',`
`14`	`14`	`) {`
`15`	`15`	`}`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`use Symfony\Component\Clock\ClockInterface;`
`9`	`9`
`10`	`10`	`#[AsTool('clock', description: 'Provides the current date and time.')]`
`11`		`-final class Clock`
	`11`	`+final readonly class Clock`
`12`	`12`	`{`
`13`	`13`	`public function __construct(`
`14`	`14`	`private ClockInterface $clock,`
Original file line number	Diff line number	Diff line change
`@@ -6,10 +6,10 @@`
`6`	`6`
`7`	`7`	`use PhpLlm\LlmChain\Exception\InvalidToolImplementation;`
`8`	`8`
`9`		`-final class ToolAnalyzer`
	`9`	`+final readonly class ToolAnalyzer`
`10`	`10`	`{`
`11`	`11`	`public function __construct(`
`12`		`- private readonly ParameterAnalyzer $parameterAnalyzer = new ParameterAnalyzer(),`
	`12`	`+ private ParameterAnalyzer $parameterAnalyzer = new ParameterAnalyzer(),`
`13`	`13`	`) {`
`14`	`14`	`}`
`15`	`15`