Api shorthand add routes to routes/api.php (#210)

Author: Pr3d4dor

src/Generators/RouteGenerator.php

@@ -23,13 +23,17 @@ public function output(array $tree): array
         }
 
         $routes = '';
+        $path = 'routes/web.php';
         /** @var \Blueprint\Models\Controller $controller */
         foreach ($tree['controllers'] as $controller) {
             $routes .= PHP_EOL . PHP_EOL . $this->buildRoutes($controller);
+
+            if ($controller->isApiResource()) {
+                $path = 'routes/api.php';
+            }
         }
         $routes .= PHP_EOL;
 
-        $path = 'routes/web.php';
         $this->files->append($path, $routes);
 
         return ['updated' => [$path]];
@@ -45,9 +49,14 @@ protected function buildRoutes(Controller $controller)
 
         $resource_methods = array_intersect($methods, Controller::$resourceMethods);
         if (count($resource_methods)) {
-            $routes .= sprintf("Route::resource('%s', '%s')", $slug, $className);
+            $routes .= $controller->isApiResource()
+                ? sprintf("Route::apiResource('%s', '%s')", $slug, $className)
+                : sprintf("Route::resource('%s', '%s')", $slug, $className);
+
+            $missing_methods = $controller->isApiResource()
+                ? array_diff(Controller::$apiResourceMethods, $resource_methods)
+                : array_diff(Controller::$resourceMethods, $resource_methods);
 
-            $missing_methods = array_diff(Controller::$resourceMethods, $resource_methods);
             if (count($missing_methods)) {
                 if (count($missing_methods) < 4) {
                     $routes .= sprintf("->except('%s')", implode("', '", $missing_methods));
@@ -56,7 +65,6 @@ protected function buildRoutes(Controller $controller)
                 }
             }
 
-
             $routes .= ';' . PHP_EOL;
         }
 

src/Lexers/ControllerLexer.php

@@ -36,6 +36,7 @@ public function analyze(array $tokens): array
                 unset($original['resource']);
                 // this gives the ability to both use a shorthand and override some methods
                 $definition = array_merge($definition, $original);
+                $controller->setApiResource(true);
             }
 
             foreach ($definition as $method => $body) {

src/Models/Controller.php

@@ -10,6 +10,9 @@ class Controller
     /** @var array */
     public static $resourceMethods = ['index', 'create', 'store', 'edit', 'update', 'show', 'destroy'];
 
+    /** @var array  */
+    public static $apiResourceMethods = ['index', 'store', 'update', 'show', 'destroy'];
+
     /**
      * @var string
      */
@@ -25,6 +28,11 @@ class Controller
      */
     private $methods = [];
 
+    /**
+     * @var bool
+     */
+    private $apiResource = false;
+
     /**
      * Controller constructor.
      * @param $name
@@ -92,4 +100,20 @@ public function prefix()
 
         return $this->name();
     }
+
+    /**
+     * @param bool $apiResource
+     */
+    public function setApiResource(bool $apiResource)
+    {
+        $this->apiResource = $apiResource;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isApiResource(): bool
+    {
+        return $this->apiResource;
+    }
 }

tests/Feature/Generator/RouteGeneratorTest.php

@@ -57,6 +57,24 @@ public function output_writes_migration_for_route_tree($definition, $routes)
         $this->assertEquals(['updated' => [$path]], $this->subject->output($tree));
     }
 
+    /**
+     * @test
+     */
+    public function output_writes_migration_for_route_tree_api_routes()
+    {
+        $definition = "definitions/api-routes-example.bp";
+        $routes = "routes/api-routes.php";
+        $path = 'routes/api.php';
+
+        $this->files->expects('append')
+            ->with($path, $this->fixture($routes));
+
+        $tokens = $this->blueprint->parse($this->fixture($definition));
+        $tree = $this->blueprint->analyze($tokens);
+
+        $this->assertEquals(['updated' => [$path]], $this->subject->output($tree));
+    }
+
     public function controllerTreeDataProvider()
     {
         return [

tests/Feature/Lexers/ControllerLexerTest.php

@@ -245,6 +245,7 @@ public function it_returns_an_api_resource_controller()
 
         $controller = $actual['controllers']['Comment'];
         $this->assertEquals('CommentController', $controller->className());
+        $this->assertTrue($controller->isApiResource());
 
         $methods = $controller->methods();
         $this->assertCount(5, $methods);

tests/fixtures/definitions/api-routes-example.bp

@@ -0,0 +1,12 @@
+models:
+  Certificate:
+    name: string
+    certificate_type_id: id
+    reference: string
+    document: string
+    expiry_date: date
+    remarks: text nullable
+
+controllers:
+  Certificate:
+    resource: api

tests/fixtures/routes/api-routes.php

@@ -0,0 +1,3 @@
+
+
+Route::apiResource('certificate', 'CertificateController');