Move event handling to a dedicated Dispatchable trait

gehrisandro · gehrisandro · commit 8d5f752a708e · 2023-12-05T15:22:29.000+01:00
diff --git a/src/Client.php b/src/Client.php
@@ -42,7 +42,8 @@ public function __construct(
      */
     public function completions(): Completions
     {
-        return new Completions($this->transporter, $this->events);
+        return (new Completions($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 
     /**
@@ -52,7 +53,8 @@ public function completions(): Completions
      */
     public function chat(): Chat
     {
-        return new Chat($this->transporter, $this->events);
+        return (new Chat($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 
     /**
@@ -62,7 +64,8 @@ public function chat(): Chat
      */
     public function embeddings(): Embeddings
     {
-        return new Embeddings($this->transporter, $this->events);
+        return (new Embeddings($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 
     /**
@@ -72,7 +75,8 @@ public function embeddings(): Embeddings
      */
     public function audio(): Audio
     {
-        return new Audio($this->transporter, $this->events);
+        return (new Audio($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 
     /**
@@ -82,7 +86,8 @@ public function audio(): Audio
      */
     public function edits(): Edits
     {
-        return new Edits($this->transporter, $this->events);
+        return (new Edits($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 
     /**
@@ -92,7 +97,8 @@ public function edits(): Edits
      */
     public function files(): Files
     {
-        return new Files($this->transporter, $this->events);
+        return (new Files($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 
     /**
@@ -102,7 +108,8 @@ public function files(): Files
      */
     public function models(): Models
     {
-        return new Models($this->transporter, $this->events);
+        return (new Models($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 
     /**
@@ -112,7 +119,8 @@ public function models(): Models
      */
     public function fineTuning(): FineTuning
     {
-        return new FineTuning($this->transporter, $this->events);
+        return (new FineTuning($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 
     /**
@@ -124,7 +132,8 @@ public function fineTuning(): FineTuning
      */
     public function fineTunes(): FineTunes
     {
-        return new FineTunes($this->transporter, $this->events);
+        return (new FineTunes($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 
     /**
@@ -134,7 +143,8 @@ public function fineTunes(): FineTunes
      */
     public function moderations(): Moderations
     {
-        return new Moderations($this->transporter, $this->events);
+        return (new Moderations($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 
     /**
@@ -144,7 +154,8 @@ public function moderations(): Moderations
      */
     public function images(): Images
     {
-        return new Images($this->transporter, $this->events);
+        return (new Images($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 
     /**
@@ -154,7 +165,8 @@ public function images(): Images
      */
     public function assistants(): Assistants
     {
-        return new Assistants($this->transporter, $this->events);
+        return (new Assistants($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 
     /**
@@ -164,6 +176,7 @@ public function assistants(): Assistants
      */
     public function threads(): ThreadsContract
     {
-        return new Threads($this->transporter, $this->events);
+        return (new Threads($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 }
diff --git a/src/Resources/Assistants.php b/src/Resources/Assistants.php
@@ -15,6 +15,7 @@
 
 final class Assistants implements AssistantsContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Transportable;
 
     /**
@@ -125,6 +126,7 @@ public function list(array $parameters = []): AssistantListResponse
      */
     public function files(): AssistantsFilesContract
     {
-        return new AssistantsFiles($this->transporter, $this->events);
+        return (new AssistantsFiles($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 }
diff --git a/src/Resources/AssistantsFiles.php b/src/Resources/AssistantsFiles.php
@@ -14,6 +14,7 @@
 
 final class AssistantsFiles implements AssistantsFilesContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Transportable;
 
     /**
diff --git a/src/Resources/Audio.php b/src/Resources/Audio.php
@@ -14,6 +14,7 @@
 
 final class Audio implements AudioContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Transportable;
 
     /**
diff --git a/src/Resources/Chat.php b/src/Resources/Chat.php
@@ -14,6 +14,7 @@
 
 final class Chat implements ChatContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Streamable;
     use Concerns\Transportable;
 
diff --git a/src/Resources/Completions.php b/src/Resources/Completions.php
@@ -14,6 +14,7 @@
 
 final class Completions implements CompletionsContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Streamable;
     use Concerns\Transportable;
 
diff --git a/src/Resources/Concerns/Dispatchable.php b/src/Resources/Concerns/Dispatchable.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenAI\Resources\Concerns;
+
+use OpenAI\Contracts\DispatcherContract;
+
+trait Dispatchable
+{
+    private DispatcherContract $events;
+
+    public function setEventDispatcher(DispatcherContract $events): static
+    {
+        $this->events = $events;
+
+        return $this;
+    }
+
+    public function event(object $event): void
+    {
+        $this->events->dispatch($event);
+    }
+}
diff --git a/src/Resources/Concerns/Transportable.php b/src/Resources/Concerns/Transportable.php
@@ -4,23 +4,15 @@
 
 namespace OpenAI\Resources\Concerns;
 
-use OpenAI\Contracts\DispatcherContract;
 use OpenAI\Contracts\TransporterContract;
 
 trait Transportable
 {
     /**
      * Creates a Client instance with the given API token.
      */
-    public function __construct(
-        private readonly TransporterContract $transporter,
-        private readonly DispatcherContract $events,
-    ) {
-        // ..
-    }
-
-    public function event(object $event): void
+    public function __construct(private readonly TransporterContract $transporter)
     {
-        $this->events->dispatch($event);
+        // ..
     }
 }
diff --git a/src/Resources/Edits.php b/src/Resources/Edits.php
@@ -12,6 +12,7 @@
 
 final class Edits implements EditsContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Transportable;
 
     /**
diff --git a/src/Resources/Embeddings.php b/src/Resources/Embeddings.php
@@ -12,6 +12,7 @@
 
 final class Embeddings implements EmbeddingsContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Transportable;
 
     /**
diff --git a/src/Resources/Files.php b/src/Resources/Files.php
@@ -15,6 +15,7 @@
 
 final class Files implements FilesContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Transportable;
 
     /**
diff --git a/src/Resources/FineTunes.php b/src/Resources/FineTunes.php
@@ -16,6 +16,7 @@
 
 final class FineTunes implements FineTunesContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Transportable;
 
     /**
diff --git a/src/Resources/FineTuning.php b/src/Resources/FineTuning.php
@@ -14,6 +14,7 @@
 
 final class FineTuning implements FineTuningContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Transportable;
 
     /**
diff --git a/src/Resources/Images.php b/src/Resources/Images.php
@@ -14,6 +14,7 @@
 
 final class Images implements ImagesContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Transportable;
 
     /**
diff --git a/src/Resources/Models.php b/src/Resources/Models.php
@@ -14,6 +14,7 @@
 
 final class Models implements ModelsContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Transportable;
 
     /**
diff --git a/src/Resources/Moderations.php b/src/Resources/Moderations.php
@@ -12,6 +12,7 @@
 
 final class Moderations implements ModerationsContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Transportable;
 
     /**
diff --git a/src/Resources/Threads.php b/src/Resources/Threads.php
@@ -16,6 +16,7 @@
 
 final class Threads implements ThreadsContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Transportable;
 
     /**
@@ -126,7 +127,8 @@ public function delete(string $id): ThreadDeleteResponse
      */
     public function messages(): ThreadsMessagesContract
     {
-        return new ThreadsMessages($this->transporter, $this->events);
+        return (new ThreadsMessages($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 
     /**
@@ -136,6 +138,7 @@ public function messages(): ThreadsMessagesContract
      */
     public function runs(): ThreadsRunsContract
     {
-        return new ThreadsRuns($this->transporter, $this->events);
+        return (new ThreadsRuns($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 }
diff --git a/src/Resources/ThreadsMessages.php b/src/Resources/ThreadsMessages.php
@@ -15,6 +15,7 @@
 
 final class ThreadsMessages implements ThreadsMessagesContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Transportable;
 
     /**
@@ -125,6 +126,7 @@ public function list(string $threadId, array $parameters = []): ThreadMessageLis
      */
     public function files(): ThreadsMessagesFilesContract
     {
-        return new ThreadsMessagesFiles($this->transporter, $this->events);
+        return (new ThreadsMessagesFiles($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 }
diff --git a/src/Resources/ThreadsMessagesFiles.php b/src/Resources/ThreadsMessagesFiles.php
@@ -13,6 +13,7 @@
 
 final class ThreadsMessagesFiles implements ThreadsMessagesFilesContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Transportable;
 
     /**
diff --git a/src/Resources/ThreadsRuns.php b/src/Resources/ThreadsRuns.php
@@ -14,6 +14,7 @@
 
 final class ThreadsRuns implements ThreadsRunsContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Transportable;
 
     /**
@@ -145,6 +146,7 @@ public function list(string $threadId, array $parameters = []): ThreadRunListRes
      */
     public function steps(): ThreadsRunsStepsContract
     {
-        return new ThreadsRunsSteps($this->transporter, $this->events);
+        return (new ThreadsRunsSteps($this->transporter))
+            ->setEventDispatcher($this->events);
     }
 }
diff --git a/src/Resources/ThreadsRunsSteps.php b/src/Resources/ThreadsRunsSteps.php
@@ -13,6 +13,7 @@
 
 final class ThreadsRunsSteps implements ThreadsRunsStepsContract
 {
+    use Concerns\Dispatchable;
     use Concerns\Transportable;
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,8 @@ public function __construct(`
`42`	`42`	`*/`
`43`	`43`	`public function completions(): Completions`
`44`	`44`	`{`
`45`		`- return new Completions($this->transporter, $this->events);`
	`45`	`+ return (new Completions($this->transporter))`
	`46`	`+ ->setEventDispatcher($this->events);`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`/**`
`@@ -52,7 +53,8 @@ public function completions(): Completions`
`52`	`53`	`*/`
`53`	`54`	`public function chat(): Chat`
`54`	`55`	`{`
`55`		`- return new Chat($this->transporter, $this->events);`
	`56`	`+ return (new Chat($this->transporter))`
	`57`	`+ ->setEventDispatcher($this->events);`
`56`	`58`	`}`
`57`	`59`
`58`	`60`	`/**`
`@@ -62,7 +64,8 @@ public function chat(): Chat`
`62`	`64`	`*/`
`63`	`65`	`public function embeddings(): Embeddings`
`64`	`66`	`{`
`65`		`- return new Embeddings($this->transporter, $this->events);`
	`67`	`+ return (new Embeddings($this->transporter))`
	`68`	`+ ->setEventDispatcher($this->events);`
`66`	`69`	`}`
`67`	`70`
`68`	`71`	`/**`
`@@ -72,7 +75,8 @@ public function embeddings(): Embeddings`
`72`	`75`	`*/`
`73`	`76`	`public function audio(): Audio`
`74`	`77`	`{`
`75`		`- return new Audio($this->transporter, $this->events);`
	`78`	`+ return (new Audio($this->transporter))`
	`79`	`+ ->setEventDispatcher($this->events);`
`76`	`80`	`}`
`77`	`81`
`78`	`82`	`/**`
`@@ -82,7 +86,8 @@ public function audio(): Audio`
`82`	`86`	`*/`
`83`	`87`	`public function edits(): Edits`
`84`	`88`	`{`
`85`		`- return new Edits($this->transporter, $this->events);`
	`89`	`+ return (new Edits($this->transporter))`
	`90`	`+ ->setEventDispatcher($this->events);`
`86`	`91`	`}`
`87`	`92`
`88`	`93`	`/**`
`@@ -92,7 +97,8 @@ public function edits(): Edits`
`92`	`97`	`*/`
`93`	`98`	`public function files(): Files`
`94`	`99`	`{`
`95`		`- return new Files($this->transporter, $this->events);`
	`100`	`+ return (new Files($this->transporter))`
	`101`	`+ ->setEventDispatcher($this->events);`
`96`	`102`	`}`
`97`	`103`
`98`	`104`	`/**`
`@@ -102,7 +108,8 @@ public function files(): Files`
`102`	`108`	`*/`
`103`	`109`	`public function models(): Models`
`104`	`110`	`{`
`105`		`- return new Models($this->transporter, $this->events);`
	`111`	`+ return (new Models($this->transporter))`
	`112`	`+ ->setEventDispatcher($this->events);`
`106`	`113`	`}`
`107`	`114`
`108`	`115`	`/**`
`@@ -112,7 +119,8 @@ public function models(): Models`
`112`	`119`	`*/`
`113`	`120`	`public function fineTuning(): FineTuning`
`114`	`121`	`{`
`115`		`- return new FineTuning($this->transporter, $this->events);`
	`122`	`+ return (new FineTuning($this->transporter))`
	`123`	`+ ->setEventDispatcher($this->events);`
`116`	`124`	`}`
`117`	`125`
`118`	`126`	`/**`
`@@ -124,7 +132,8 @@ public function fineTuning(): FineTuning`
`124`	`132`	`*/`
`125`	`133`	`public function fineTunes(): FineTunes`
`126`	`134`	`{`
`127`		`- return new FineTunes($this->transporter, $this->events);`
	`135`	`+ return (new FineTunes($this->transporter))`
	`136`	`+ ->setEventDispatcher($this->events);`
`128`	`137`	`}`
`129`	`138`
`130`	`139`	`/**`
`@@ -134,7 +143,8 @@ public function fineTunes(): FineTunes`
`134`	`143`	`*/`
`135`	`144`	`public function moderations(): Moderations`
`136`	`145`	`{`
`137`		`- return new Moderations($this->transporter, $this->events);`
	`146`	`+ return (new Moderations($this->transporter))`
	`147`	`+ ->setEventDispatcher($this->events);`
`138`	`148`	`}`
`139`	`149`
`140`	`150`	`/**`
`@@ -144,7 +154,8 @@ public function moderations(): Moderations`
`144`	`154`	`*/`
`145`	`155`	`public function images(): Images`
`146`	`156`	`{`
`147`		`- return new Images($this->transporter, $this->events);`
	`157`	`+ return (new Images($this->transporter))`
	`158`	`+ ->setEventDispatcher($this->events);`
`148`	`159`	`}`
`149`	`160`
`150`	`161`	`/**`
`@@ -154,7 +165,8 @@ public function images(): Images`
`154`	`165`	`*/`
`155`	`166`	`public function assistants(): Assistants`
`156`	`167`	`{`
`157`		`- return new Assistants($this->transporter, $this->events);`
	`168`	`+ return (new Assistants($this->transporter))`
	`169`	`+ ->setEventDispatcher($this->events);`
`158`	`170`	`}`
`159`	`171`
`160`	`172`	`/**`
`@@ -164,6 +176,7 @@ public function assistants(): Assistants`
`164`	`176`	`*/`
`165`	`177`	`public function threads(): ThreadsContract`
`166`	`178`	`{`
`167`		`- return new Threads($this->transporter, $this->events);`
	`179`	`+ return (new Threads($this->transporter))`
	`180`	`+ ->setEventDispatcher($this->events);`
`168`	`181`	`}`
`169`	`182`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`
`16`	`16`	`final class Assistants implements AssistantsContract`
`17`	`17`	`{`
	`18`	`+ use Concerns\Dispatchable;`
`18`	`19`	`use Concerns\Transportable;`
`19`	`20`
`20`	`21`	`/**`
`@@ -125,6 +126,7 @@ public function list(array $parameters = []): AssistantListResponse`
`125`	`126`	`*/`
`126`	`127`	`public function files(): AssistantsFilesContract`
`127`	`128`	`{`
`128`		`- return new AssistantsFiles($this->transporter, $this->events);`
	`129`	`+ return (new AssistantsFiles($this->transporter))`
	`130`	`+ ->setEventDispatcher($this->events);`
`129`	`131`	`}`
`130`	`132`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`
`15`	`15`	`final class AssistantsFiles implements AssistantsFilesContract`
`16`	`16`	`{`
	`17`	`+ use Concerns\Dispatchable;`
`17`	`18`	`use Concerns\Transportable;`
`18`	`19`
`19`	`20`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -4,23 +4,15 @@`
`4`	`4`
`5`	`5`	`namespace OpenAI\Resources\Concerns;`
`6`	`6`
`7`		`-use OpenAI\Contracts\DispatcherContract;`
`8`	`7`	`use OpenAI\Contracts\TransporterContract;`
`9`	`8`
`10`	`9`	`trait Transportable`
`11`	`10`	`{`
`12`	`11`	`/**`
`13`	`12`	`* Creates a Client instance with the given API token.`
`14`	`13`	`*/`
`15`		`- public function __construct(`
`16`		`- private readonly TransporterContract $transporter,`
`17`		`- private readonly DispatcherContract $events,`
`18`		`- ) {`
`19`		`- // ..`
`20`		`- }`
`21`		`-`
`22`		`- public function event(object $event): void`
	`14`	`+ public function __construct(private readonly TransporterContract $transporter)`
`23`	`15`	`{`
`24`		`- $this->events->dispatch($event);`
	`16`	`+ // ..`
`25`	`17`	`}`
`26`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`
`13`	`13`	`final class Edits implements EditsContract`
`14`	`14`	`{`
	`15`	`+ use Concerns\Dispatchable;`
`15`	`16`	`use Concerns\Transportable;`
`16`	`17`
`17`	`18`	`/**`