Merge pull request #16 from WyriHaximus/feature-tested-objects-annotations

Nested resource annotation generator

Author: WyriHaximus

composer.lock

@@ -19,6 +19,7 @@
 use Symfony\CS\FileCacheManager;
 use Symfony\CS\Fixer;
 use Symfony\CS\FixerInterface;
+use WyriHaximus\ApiClient\Annotations\Nested;
 use WyriHaximus\ApiClient\Resource\ResourceInterface;
 
 class ResourceGenerator
@@ -260,6 +261,16 @@ protected function createBaseClass(array $yaml): string
         $class = $factory->class($yaml['class'])
             ->implement($yaml['class'] . 'Interface')
             ->makeAbstract();
+
+        if (isset($yaml['nested'])) {
+            $nestedResources = [];
+            foreach ($yaml['nested'] as $key => $resource) {
+                $nestedResources[] = $key . '="' . $resource . '"';
+            }
+            $docBlock = "/**\r\n * @Nested(" . implode(', ', $nestedResources) . ")\r\n */";
+            $class->setDocComment($docBlock);
+        }
+
         $class->addStmt(
             new Node\Stmt\TraitUse([
                 new Node\Name('TransportAwareTrait')
@@ -275,13 +286,19 @@ protected function createBaseClass(array $yaml): string
             $class->addStmt($this->createMethod($factory, $type, $name, $details));
         }
 
-        $node = $factory->namespace($yaml['namespace'])
+        $stmt = $factory->namespace($yaml['namespace']);
+        if (isset($yaml['nested'])) {
+            $stmt = $stmt->addStmt(
+                $factory->use(Nested::class)
+            );
+        }
+        $stmt
             ->addStmt($factory->use('WyriHaximus\ApiClient\Resource\TransportAwareTrait'))
             ->addStmt($class)
-
-            ->getNode()
         ;
 
+        $node = $stmt->getNode();
+
         $prettyPrinter = new PrettyPrinter\Standard();
         return $prettyPrinter->prettyPrintFile([
             $node

src/ResourceGenerator.php

@@ -45,8 +45,9 @@ public function testOutput()
         $getopt = Phake::mock(Context\Getopt::class);
         Phake::when($getopt)->get(1)->thenReturn($yamlPath . 'project.yaml');
         Phake::when($getopt)->get(2)->thenReturn($yamlPath . 'project-build.yaml');
-        Phake::when($getopt)->get(3)->thenReturn($this->temporaryDirectory);
-        Phake::when($getopt)->get(4)->thenReturn(null);
+        Phake::when($getopt)->get(3)->thenReturn($yamlPath . 'project-config.yaml');
+        Phake::when($getopt)->get(4)->thenReturn($this->temporaryDirectory);
+        Phake::when($getopt)->get(5)->thenReturn(null);
         Phake::when($context)->getopt([])->thenReturn($getopt);
         (new ResourceGenerator($context, $stdio))->run();
         $objects = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($resourcesPath), RecursiveIteratorIterator::SELF_FIRST);

tests/ResourceGeneratorTest.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace Example\Client\Resource\Async\Project;
+
+use Example\Client\Resource\Project\Config as BaseConfig;
+
+class Config extends BaseConfig
+{
+    public function refresh() : Config
+    {
+        return $this->wait($this->callAsync('refresh'));
+    }
+}

tests/resources/Async/Project/Config.php

@@ -2,8 +2,12 @@
 
 namespace Example\Client\Resource;
 
+use WyriHaximus\ApiClient\Annotations\Nested;
 use WyriHaximus\ApiClient\Resource\TransportAwareTrait;
 
+/**
+ * @Nested(build="Project\Build", config="Project\Config")
+ */
 abstract class Project implements ProjectInterface
 {
     use TransportAwareTrait;
@@ -24,9 +28,14 @@ abstract class Project implements ProjectInterface
     protected $description;
 
     /**
-     * @var array
+     * @var Project\Build
      */
-    protected $config = array();
+    protected $build;
+
+    /**
+     * @var Project\Config
+     */
+    protected $config;
 
     /**
      * @var SplObjectStorage
@@ -68,9 +77,17 @@ public function description() : string
     }
 
     /**
-     * @return array
+     * @return Project\Build
+     */
+    public function build() : Project\Build
+    {
+        return $this->build;
+    }
+
+    /**
+     * @return Project\Config
      */
-    public function config() : array
+    public function config() : Project\Config
     {
         return $this->config;
     }

tests/resources/Project.php

@@ -0,0 +1,62 @@
+<?php declare(strict_types=1);
+
+namespace Example\Client\Resource\Project;
+
+use WyriHaximus\ApiClient\Resource\TransportAwareTrait;
+
+abstract class Config implements ConfigInterface
+{
+    use TransportAwareTrait;
+
+    /**
+     * @var string
+     */
+    protected $a;
+
+    /**
+     * @var string
+     */
+    protected $b;
+
+    /**
+     * @var string
+     */
+    protected $c;
+
+    /**
+     * @var string
+     */
+    protected $d = 'abcd';
+
+    /**
+     * @return string
+     */
+    public function a() : string
+    {
+        return $this->a;
+    }
+
+    /**
+     * @return string
+     */
+    public function b() : string
+    {
+        return $this->b;
+    }
+
+    /**
+     * @return string
+     */
+    public function c() : string
+    {
+        return $this->c;
+    }
+
+    /**
+     * @return string
+     */
+    public function d() : string
+    {
+        return $this->d;
+    }
+}

tests/resources/Project/Config.php

@@ -0,0 +1,28 @@
+<?php declare(strict_types=1);
+
+namespace Example\Client\Resource\Project;
+
+use WyriHaximus\ApiClient\Resource\ResourceInterface;
+
+interface ConfigInterface extends ResourceInterface
+{
+    /**
+     * @return string
+     */
+    public function a() : string;
+
+    /**
+     * @return string
+     */
+    public function b() : string;
+
+    /**
+     * @return string
+     */
+    public function c() : string;
+
+    /**
+     * @return string
+     */
+    public function d() : string;
+}