Merge pull request #13 from ray-di/annotation-query

Rename @AliasQuery to @query annotation

composer.json

@@ -27,7 +27,7 @@
     },
     "autoload": {
         "psr-4": {
-            "Ray\\Query\\": "src/"
+            "Ray\\Query\\": ["src/", "src-deprecated"]
         }
     },
     "autoload-dev": {

demo/Todo.php

@@ -4,19 +4,19 @@
 
 namespace Ray\Query;
 
-use Ray\Query\Annotation\AliasQuery;
+use Ray\Query\Annotation\Query;
 
 class Todo
 {
     /**
-     * @AliasQuery("todo_item_by_id")
+     * @Query("todo_item_by_id")
      */
     public function get(string $id)
     {
     }
 
     /**
-     * @AliasQuery(id="todo_insert?id={uuid}", templated=true)
+     * @Query(id="todo_insert?id={uuid}", templated=true)
      */
     public function create(string $uuid, string $title)
     {

demo/run.php

@@ -4,4 +4,4 @@
 
 passthru('php ' . __DIR__ . '/0-manual-injection.php');
 passthru('php ' . __DIR__ . '/1-constructor-injection.php');
-passthru('php ' . __DIR__ . '/2-alias-query.php');
+passthru('php ' . __DIR__ . '/2-query-annotation.php');

src/Annotation/AliasQuery.php → src-deprecated/AliasQuery.php

@@ -9,6 +9,8 @@
  *
  * @Annotation
  * @Target("METHOD")
+ *
+ * @deprecated use MapQuery instead
  */
 final class AliasQuery
 {

src/SqlAliasInterceptor.php → src-deprecated/SqlAliasInterceptor.php

@@ -11,6 +11,9 @@
 use Ray\Di\InjectorInterface;
 use Ray\Query\Annotation\AliasQuery;
 
+/**
+ * @deprecated use MapQueryInterceptor instead
+ */
 class SqlAliasInterceptor implements MethodInterceptor
 {
     /**

src/Annotation/Query.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Query\Annotation;
+
+/**
+ * Annotates your class methods into which the Injector should inject values
+ *
+ * @Annotation
+ * @Target("METHOD")
+ */
+final class Query
+{
+    /**
+     * Query ID
+     *
+     * @var string
+     */
+    public $id;
+
+    /**
+     * Is ID templated ?
+     *
+     * @var bool
+     */
+    public $templated = false;
+
+    /**
+     * @Enum({"row", "row_list"})
+     *
+     * @var string
+     */
+    public $type = 'row_list';
+}

src/QueryInterceptor.php

@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Query;
+
+use BEAR\Resource\ResourceObject;
+use Ray\Aop\MethodInterceptor;
+use Ray\Aop\MethodInvocation;
+use Ray\Aop\ReflectionMethod;
+use Ray\Di\InjectorInterface;
+use Ray\Query\Annotation\Query;
+
+class QueryInterceptor implements MethodInterceptor
+{
+    /**
+     * @var InjectorInterface
+     */
+    private $injector;
+
+    public function __construct(InjectorInterface $injector)
+    {
+        $this->injector = $injector;
+    }
+
+    public function invoke(MethodInvocation $invocation)
+    {
+        /** @var ReflectionMethod $method */
+        $method = $invocation->getMethod();
+        /** @var Query $query */
+        $query = $method->getAnnotation(Query::class);
+        $namedArguments = (array) $invocation->getNamedArguments();
+        list($queryId, $params) = $query->templated ? $this->templated($query, $namedArguments) : [$query->id, $namedArguments];
+        $interface = $query->type === 'row' ? RowInterface::class : RowListInterface::class;
+        $query = $this->injector->getInstance($interface, $queryId);
+        if ($query instanceof QueryInterface) {
+            return $this->getQueryResult($invocation, $query, $params);
+        }
+
+        return $invocation->proceed();
+    }
+
+    private function getQueryResult(MethodInvocation $invocation, QueryInterface $query, array $param)
+    {
+        $result = $query($param);
+        $object = $invocation->getThis();
+        if ($object instanceof ResourceObject) {
+            return $this->returnRo($object, $invocation, $result);
+        }
+
+        return $result;
+    }
+
+    private function returnRo(ResourceObject $ro, MethodInvocation $invocation, $result) : ResourceObject
+    {
+        if (! $result) {
+            return $this->return404($ro);
+        }
+        $ro->body = $result;
+
+        return $invocation->proceed();
+    }
+
+    private function return404(ResourceObject $ro) : ResourceObject
+    {
+        $ro->code = 404;
+        $ro->body = [];
+
+        return $ro;
+    }
+
+    private function templated(Query $query, array $namedArguments) : array
+    {
+        $url = parse_url(uri_template($query->id, $namedArguments));
+        if (! $url) {
+            throw new \InvalidArgumentException($query->id);
+        }
+        $queryId = $url['path'];
+        isset($url['query']) ? parse_str($url['query'], $params) : $params = $namedArguments;
+
+        return [$queryId, $params + $namedArguments];
+    }
+}

src/SqlQueryModule.php

@@ -5,7 +5,7 @@
 namespace Ray\Query;
 
 use Ray\Di\AbstractModule;
-use Ray\Query\Annotation\AliasQuery;
+use Ray\Query\Annotation\Query;
 
 class SqlQueryModule extends AbstractModule
 {
@@ -48,8 +48,13 @@ protected function configure()
         }
         $this->bindInterceptor(
             $this->matcher->any(),
-            $this->matcher->annotatedWith(AliasQuery::class),
-            [SqlAliasInterceptor::class]
+            $this->matcher->annotatedWith(Query::class),
+            [QueryInterceptor::class]
+        );
+        $this->bindInterceptor(
+            $this->matcher->any(),
+            $this->matcher->annotatedWith(Query::class),
+            [QueryInterceptor::class]
         );
     }
 

tests/Fake/FakeAlias.php

@@ -8,12 +8,12 @@
  */
 namespace Ray\Query;
 
-use Ray\Query\Annotation\AliasQuery;
+use Ray\Query\Annotation\Query;
 
 class FakeAlias
 {
     /**
-     * @AliasQuery("todo_item_by_id", type="row")
+     * @Query("todo_item_by_id", type="row")
      */
     public function get(string $id)
     {

tests/Fake/FakeAliasNamed.php

@@ -8,12 +8,12 @@
  */
 namespace Ray\Query;
 
-use Ray\Query\Annotation\AliasQuery;
+use Ray\Query\Annotation\Query;
 
 class FakeAliasNamed
 {
     /**
-     * @AliasQuery(id="todo_item_by_id?id={a}", templated=true, type="row")
+     * @Query(id="todo_item_by_id?id={a}", templated=true, type="row")
      */
     public function get(string $a)
     {