Merge pull request #30 from ray-di/type

[BC break] Add annotation type to specify return type
ray-di · May 26, 2022 · f72320e · f72320e
2 parents e79172d + f297305
commit f72320e
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 26 deletions.
diff --git a/src/Annotation/DbQuery.php b/src/Annotation/DbQuery.php
@@ -21,9 +21,19 @@ final class DbQuery
     /** @var string */
     public $entity;
 
-    public function __construct(string $id, string $entity = '')
+    /**
+     * @Enum({"row", "row_list", "exec"})
+     * @var 'row'|'row_list'|'exec'
+     */
+    public $type = 'row_list';
+
+    /**
+     * @param 'row'|'row_list'|'exec' $type
+     */
+    public function __construct(string $id, string $entity = '', string $type = 'row_list')
     {
         $this->id = $id;
         $this->entity = $entity;
+        $this->type = $type;
     }
 }
diff --git a/src/DbQueryInterceptor.php b/src/DbQueryInterceptor.php
@@ -12,7 +12,6 @@
 
 use function class_exists;
 use function method_exists;
-use function substr;
 
 class DbQueryInterceptor implements MethodInterceptor
 {
@@ -48,7 +47,7 @@ public function invoke(MethodInvocation $invocation)
 
         $fetchStyle = $this->getFetchMode($dbQury);
 
-        return $this->sqlQuery($dbQury->id, $values, $fetchStyle, $dbQury->entity);
+        return $this->sqlQuery($dbQury, $values, $fetchStyle, $dbQury->entity);
     }
 
     /**
@@ -74,18 +73,17 @@ private function getFetchMode(DbQuery $dbQuery): int
      *
      * @return array<mixed>|object|null
      */
-    private function sqlQuery(string $queryId, array $values, int $fetchStyle, $fetchArg)
+    private function sqlQuery(DbQuery $dbQuery, array $values, int $fetchStyle, $fetchArg)
     {
-        $postFix = substr($queryId, -4);
-        if ($postFix === 'list') {
-            return $this->sqlQuery->getRowList($queryId, $values, $fetchStyle, $fetchArg);
+        if ($dbQuery->type === 'row_list') {
+            return $this->sqlQuery->getRowList($dbQuery->id, $values, $fetchStyle, $fetchArg);
         }
 
-        if ($postFix === 'item') {
-            return $this->sqlQuery->getRow($queryId, $values, $fetchStyle, $fetchArg);
+        if ($dbQuery->type === 'row') {
+            return $this->sqlQuery->getRow($dbQuery->id, $values, $fetchStyle, $fetchArg);
         }
 
-        $this->sqlQuery->exec($queryId, $values);
+        $this->sqlQuery->exec($dbQuery->id, $values);
 
         return [];
     }

diff --git a/tests/DbQueryModuleTest.php b/tests/DbQueryModuleTest.php
@@ -52,7 +52,7 @@ protected function setUp(): void
         ]);
         $sqlDir = dirname(__DIR__) . '/tests/sql';
         $dbQueryConfig = new DbQueryConfig($sqlDir);
-        $module = new MediaQueryModule($mediaQueries, [$dbQueryConfig], new AuraSqlModule('sqlite::memory:', '', '', '', [PDO::ATTR_STRINGIFY_FETCHES => true])); // @phpstan-ignore-line
+        $module = new MediaQueryModule($mediaQueries, [$dbQueryConfig], new AuraSqlModule('sqlite::memory:', '', '', '', [PDO::ATTR_STRINGIFY_FETCHES => true]));
         $this->injector = new Injector($module, __DIR__ . '/tmp');
         $pdo = $this->injector->getInstance(ExtendedPdoInterface::class);
         assert($pdo instanceof ExtendedPdoInterface);

diff --git a/tests/Fake/Queries/PromiseItemInterface.php b/tests/Fake/Queries/PromiseItemInterface.php
@@ -9,9 +9,9 @@
 interface PromiseItemInterface
 {
     /**
-     * @DbQuery("promise_item")
+     * @DbQuery("promise_item", type="row")
      * @return array{id: string, title: string, time: string}
      */
-    #[DbQuery('promise_item')]
+    #[DbQuery('promise_item', type:'row')]
     public function get(string $id): array;
 }
diff --git a/tests/Fake/Queries/PromiseListInterface.php b/tests/Fake/Queries/PromiseListInterface.php
@@ -9,7 +9,7 @@
 interface PromiseListInterface
 {
     /**
-     * @DbQuery("promise_list")
+     * @DbQuery("promise_list", type="row_list")
      * @return array{id: string, title: string, time: string}
      */
     #[DbQuery('promise_list')]

diff --git a/tests/Fake/Queries/TodoConstcuctEntityInterface.php b/tests/Fake/Queries/TodoConstcuctEntityInterface.php
@@ -11,7 +11,7 @@
 interface TodoConstcuctEntityInterface
 {
     /**
-     * @DbQuery(id="todo_item", entity=TodoConstruct::class)
+     * @DbQuery(id="todo_item", entity=TodoConstruct::class, type="row")
      */
     #[DbQuery('todo_item', entity: TodoConstruct::class)]
     public function getItem(string $id): TodoConstruct;

diff --git a/tests/Fake/Queries/TodoEntityInterface.php b/tests/Fake/Queries/TodoEntityInterface.php
@@ -10,9 +10,9 @@
 interface TodoEntityInterface
 {
     /**
-     * @DbQuery(id="todo_item", entity=Todo::class)
+     * @DbQuery(id="todo_item", entity=Todo::class, type="row")
      */
-    #[DbQuery('todo_item', entity: Todo::class)]
+    #[DbQuery('todo_item', entity: Todo::class, type:'row')]
     public function getItem(string $id): Todo;
 
     /**

diff --git a/tests/Fake/Queries/TodoItemInterface.php b/tests/Fake/Queries/TodoItemInterface.php
@@ -9,9 +9,9 @@
 interface TodoItemInterface
 {
     /**
-     * @DbQuery("todo_item")
+     * @DbQuery("todo_item", type="row")
      * @return array{id: string, title: string}
      */
-    #[DbQuery('todo_item')]
+    #[DbQuery('todo_item', type:'row')]
     public function __invoke(string $id): array;
 }
diff --git a/vendor-bin/tools/composer.lock b/vendor-bin/tools/composer.lock