Bind SQL invokable object to the provider

.github/workflows/continuous-integration.yml

@@ -4,8 +4,6 @@ on:
   push:
   pull_request:
   workflow_dispatch:
-  schedule:
-    - cron: '42 15 * * *'
 
 jobs:
   phpunit:

.github/workflows/static-analysis.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.0
+          php-version: 8.1
           tools: cs2pr
           coverage: none
 
@@ -47,7 +47,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.0
+          php-version: 8.1
           tools: cs2pr
           coverage: none
 

composer.json

@@ -17,11 +17,12 @@
         "bear/resource": "^1.15",
         "doctrine/annotations": "^1.12",
         "guzzlehttp/guzzle": "^6.3 || ^7.0",
+        "koriym/param-reader": "^1.0",
         "koriym/query-locator": "^1.4",
+        "nikic/php-parser": "^v4.13",
         "ray/aop": "^2.10.3",
         "ray/aura-sql-module": "^1.10.0",
-        "ray/di": "^2.11",
-        "nikic/php-parser": "^v4.13"
+        "ray/di": "^2.11"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",

src/Annotation/Sql.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Query\Annotation;
+
+use Attribute;
+use Doctrine\Common\Annotations\Annotation\NamedArgumentConstructor;
+
+/**
+ * @Annotation
+ * @Target("PROPERTY")
+ * @NamedArgumentConstructor()
+ */
+#[Attribute(Attribute::TARGET_PROPERTY | Attribute::TARGET_PARAMETER)]
+final class Sql
+{
+    /** @var string */
+    public $sql;
+
+    public function __construct(string $sql)
+    {
+        $this->sql = $sql;
+    }
+}

src/Exception/SqlFileNotFoundException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Query\Exception;
+
+use LogicException;
+
+class SqlFileNotFoundException extends LogicException
+{
+}

src/Exception/SqlNotAnnotatedException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Query\Exception;
+
+use LogicException;
+
+class SqlNotAnnotatedException extends LogicException
+{
+}

src/InvokeInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Query;
+
+interface InvokeInterface extends QueryInterface
+{
+    /**
+     * @param array<string, mixed> ...$query
+     *
+     * @return iterable<mixed>
+     */
+    public function __invoke(array ...$query): iterable;
+}

src/RowInterfaceProvider.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Query;
+
+use Aura\Sql\ExtendedPdoInterface;
+use Ray\Di\InjectionPointInterface;
+use Ray\Di\ProviderInterface;
+
+final class RowInterfaceProvider implements ProviderInterface
+{
+    /** @var InjectionPointInterface */
+    private $ip;
+
+    /** @var ExtendedPdoInterface */
+    private $pdo;
+
+    /** @var SqlFinder */
+    private $finder;
+
+    public function __construct(
+        InjectionPointInterface $ip,
+        ExtendedPdoInterface $pdo,
+        SqlFinder $finder
+    ) {
+        $this->ip = $ip;
+        $this->pdo = $pdo;
+        $this->finder = $finder;
+    }
+
+    public function get(): SqlQueryRow
+    {
+        return new SqlQueryRow($this->pdo, ($this->finder)($this->ip->getParameter()));
+    }
+}

src/RowListInterface.php

@@ -4,7 +4,7 @@
 
 namespace Ray\Query;
 
-interface RowListInterface extends QueryInterface
+interface RowListInterface extends InvokeInterface
 {
     /**
      * @param array<string, mixed> ...$query

src/RowListInterfaceProvider.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Query;
+
+use Aura\Sql\ExtendedPdoInterface;
+use Ray\Di\InjectionPointInterface;
+use Ray\Di\ProviderInterface;
+
+final class RowListInterfaceProvider implements ProviderInterface
+{
+    /** @var InjectionPointInterface */
+    private $ip;
+
+    /** @var ExtendedPdoInterface */
+    private $pdo;
+
+    /** @var SqlFinder */
+    private $finder;
+
+    public function __construct(
+        InjectionPointInterface $ip,
+        ExtendedPdoInterface $pdo,
+        SqlFinder $finder
+    ) {
+        $this->ip = $ip;
+        $this->pdo = $pdo;
+        $this->finder = $finder;
+    }
+
+    public function get(): SqlQueryRowList
+    {
+        return new SqlQueryRowList($this->pdo, ($this->finder)($this->ip->getParameter()));
+    }
+}

src/SqlDir.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Query;
+
+final class SqlDir
+{
+    /** @var string */
+    public $value;
+
+    public function __construct(string $value)
+    {
+        $this->value = $value;
+    }
+}

src/SqlFinder.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Query;
+
+use Koriym\ParamReader\ParamReaderInterface;
+use Ray\Query\Annotation\Sql;
+use Ray\Query\Exception\SqlFileNotFoundException;
+use Ray\Query\Exception\SqlNotAnnotatedException;
+use ReflectionParameter;
+
+use function file_exists;
+use function file_get_contents;
+use function sprintf;
+
+final class SqlFinder
+{
+    /** @var ParamReaderInterface<object> */
+    private $reader;
+
+    /** @var SqlDir */
+    private $sqlDir;
+
+    /**
+     * @param ParamReaderInterface<object> $reader
+     */
+    public function __construct(
+        ParamReaderInterface $reader,
+        SqlDir $sqlDir
+    ) {
+        $this->reader = $reader;
+        $this->sqlDir = $sqlDir;
+    }
+
+    public function __invoke(ReflectionParameter $param): string
+    {
+        /** @var ?Sql $sqlAnnotation */
+        $sqlAnnotation = $this->reader->getParametrAnnotation($param, Sql::class);
+        if ($sqlAnnotation === null) {
+            throw new SqlNotAnnotatedException((string) $param);
+        }
+
+        $file = sprintf('%s/%s.sql', $this->sqlDir->value, $sqlAnnotation->sql);
+        if (! file_exists($file)) {
+            $msg = sprintf('%s:%s', (string) $param, $file);
+
+            throw new SqlFileNotFoundException($msg);
+        }
+
+        return (string) file_get_contents($file);
+    }
+}

src/SqlQueryModule.php

@@ -39,6 +39,7 @@ public function __construct(string $sqlDir, ?AbstractModule $module = null, ?cal
      */
     protected function configure()
     {
+        $this->bind(SqlDir::class)->toInstance(new SqlDir($this->sqlDir));
         /** @var SplFileInfo $fileInfo */
         foreach ($this->files($this->sqlDir) as $fileInfo) {
             $name = pathinfo((string) $fileInfo->getRealPath())['filename'];

src/SqlQueryProviderModule.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Query;
+
+use Koriym\ParamReader\ParamReader;
+use Koriym\ParamReader\ParamReaderInterface;
+use Ray\Di\AbstractModule;
+use Ray\Di\Scope;
+
+class SqlQueryProviderModule extends AbstractModule
+{
+    public function __construct(?AbstractModule $module = null)
+    {
+        parent::__construct($module);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function configure()
+    {
+        $this->bind(SqlFinder::class)->in(Scope::SINGLETON);
+        $this->bind(ParamReaderInterface::class)->to(ParamReader::class)->in(Scope::SINGLETON);
+        $this->bind(RowInterface::class)->toProvider(RowInterfaceProvider::class)->in(Scope::class);
+        $this->bind(RowListInterface::class)->toProvider(RowListInterfaceProvider::class)->in(Scope::class);
+        $this->bind(InvokeInterface::class)->toProvider(RowListInterfaceProvider::class)->in(Scope::class);
+    }
+}

src/SqlQueryRowList.php

@@ -54,8 +54,7 @@ public function __invoke(array ...$queries): iterable
         }
 
         $lastQuery = $result
-            ? strtolower(trim((string) $result->queryString, "\\ \t\n\r\0\x0B"))
-            : '';
+            ? strtolower(trim((string) $result->queryString, "\\ \t\n\r\0\x0B")) : '';
         if ($result instanceof PDOStatement && strpos($lastQuery, 'select') === 0) {
             return (array) $result->fetchAll(PDO::FETCH_ASSOC);
         }

tests/Fake/FakeTodoProviderSqlNotAnnotated.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Query;
+
+class FakeTodoProviderSqlNotAnnotated
+{
+    public $todoCreate;
+
+    public function __construct(
+        InvokeInterface $todoCreate
+    ){
+        $this->todoCreate = $todoCreate;
+    }
+}

tests/Fake/FakeTodoProviderSqlNotFound.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Query;
+
+use Ray\Query\Annotation\Sql;
+
+class FakeTodoProviderSqlNotFound
+{
+    /**
+     * @Sql("__invalid")
+     */
+    public $todoCreate;
+
+    public function __construct(
+        InvokeInterface $todoCreate
+    ){
+        $this->todoCreate = $todoCreate;
+    }
+}

tests/Fake/FakeTodoRepository.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Query;
+
+use Ray\Query\Annotation\Sql;
+
+class FakeTodoRepository
+{
+    /**
+     * @Sql("todo_insert")
+     */
+    public $todoCreate;
+
+    /**
+     * @Sql("todo_item_by_id")
+     */
+    public $todoItem;
+
+    /**
+     * @Sql("todo_list")
+     */
+    public $todoList;
+
+    public function __construct(
+        InvokeInterface  $todoCreate,
+        RowInterface     $todoItem,
+        RowListInterface $todoList
+    ){
+        $this->todoCreate = $todoCreate;
+        $this->todoItem = $todoItem;
+        $this->todoList = $todoList;
+    }
+}