Merge pull request #2 from KLisica/directory_versioning

klisica · web-flow · commit 6f2b17670383 · 2022-01-29T15:49:03.000+01:00
Directory versioning
diff --git a/config/config.php b/config/config.php
@@ -7,5 +7,24 @@
     'create_requests' => true,
     'create_repository' => true,
     'create_controller' => true,
-    'create_test' => true
+    'create_test' => true,
+
+    // API versioning.
+    'version' => 'v1',
+
+    /**
+     * List of instances that should ignore versioning. Available:
+     *
+     *  - controllers
+     *  - models
+     *  - repositories
+     *  - resources
+     *  - requests
+     *  - services
+     *
+     */
+    'versioning_disabled_for' => ['models'],
+
+    // The api route file path to autoimport resource routes.
+    'api_file_path' => '/routes/api.php'
 ];
diff --git a/src/Commands/CreateController.php b/src/Commands/CreateController.php
@@ -19,7 +19,13 @@ protected function getStub()
 
     protected function getDefaultNamespace($rootNamespace)
     {
-        return "$rootNamespace\\Http\\Controllers";
+        $versioning_enabled
+            = (bool) config('api._version') &&
+            !in_array('controllers', config('api-formula.versioning_disabled_for'));
+
+        return $versioning_enabled
+            ? "$rootNamespace\\Http\\Controllers\\" . config('api._version')
+            : "$rootNamespace\\Http\\Controllers";
     }
 
     /**
diff --git a/src/Commands/CreateFormula.php b/src/Commands/CreateFormula.php
@@ -81,7 +81,16 @@ public function handle()
 
         if ($resourceChoice == $answers[0]) {
             // Create model resource.
-            $this->call('make:resource', ['name' => $modelName . 'Resource']);
+            $resourceName = $modelName;
+
+            if (
+                (bool) config('api._version') &&
+                !in_array('resources', config('api-formula.versioning_disabled_for'))
+            ) {
+                $resourceName = config('api._version') . "/$modelName";
+            }
+
+            $this->call('make:resource', ['name' => $resourceName . 'Resource']);
         }
 
         if ($serviceChoice == $answers[0]) {
@@ -131,7 +140,16 @@ public function buildArchitecture(string $modelName)
     {
         // Create model resource.
         if (config('api-formula.create_resource')) {
-            $this->call('make:resource', ['name' => $modelName . 'Resource']);
+            $resourceName = $modelName;
+
+            if (
+                (bool) config('api._version') &&
+                !in_array('resources', config('api-formula.versioning_disabled_for'))
+            ) {
+                $resourceName = config('api._version') . "/$modelName";
+            }
+
+            $this->call('make:resource', ['name' => $resourceName . 'Resource']);
         }
 
         // Create model service.
diff --git a/src/Commands/CreateModel.php b/src/Commands/CreateModel.php
@@ -2,8 +2,8 @@
 
 namespace KLisica\ApiFormula\Commands;
 
-use Illuminate\Console\Command;
 use KLisica\ApiFormula\Extended\GeneratorCommand;
+use Illuminate\Console\Command;
 use Illuminate\Support\Str;
 
 class CreateModel extends GeneratorCommand
@@ -19,7 +19,13 @@ protected function getStub()
 
     protected function getDefaultNamespace($rootNamespace)
     {
-        return "$rootNamespace\\Models";
+        $versioning_enabled
+            = (bool) config('api._version') &&
+            !in_array('models', config('api-formula.versioning_disabled_for'));
+
+        return $versioning_enabled
+            ? "$rootNamespace\\Models\\" . config('api._version')
+            : "$rootNamespace\\Models";
     }
 
     /**
diff --git a/src/Commands/CreateRepository.php b/src/Commands/CreateRepository.php
@@ -19,7 +19,13 @@ protected function getStub()
 
     protected function getDefaultNamespace($rootNamespace)
     {
-        return "$rootNamespace\\Repositories";
+        $versioning_enabled
+            = (bool) config('api._version') &&
+            !in_array('repositories', config('api-formula.versioning_disabled_for'));
+
+        return $versioning_enabled
+            ? "$rootNamespace\\Repositories\\" . config('api._version')
+            : "$rootNamespace\\Repositories";
     }
 
     /**
diff --git a/src/Commands/CreateRepositoryInterface.php b/src/Commands/CreateRepositoryInterface.php
@@ -18,7 +18,13 @@ protected function getStub()
 
     protected function getDefaultNamespace($rootNamespace)
     {
-        return "$rootNamespace\\Repositories";
+        $versioning_enabled
+            = (bool) config('api._version') &&
+            !in_array('repositories', config('api-formula.versioning_disabled_for'));
+
+        return $versioning_enabled
+            ? "$rootNamespace\\Repositories\\" . config('api._version')
+            : "$rootNamespace\\Repositories";
     }
 
     /**
diff --git a/src/Commands/CreateRequest.php b/src/Commands/CreateRequest.php
@@ -18,7 +18,13 @@ protected function getStub()
 
     protected function getDefaultNamespace($rootNamespace)
     {
-        return "$rootNamespace\\Http\\Requests";
+        $versioning_enabled
+            = (bool) config('api._version') &&
+            !in_array('requests', config('api-formula.versioning_disabled_for'));
+
+        return $versioning_enabled
+            ? "$rootNamespace\\Http\\Requests\\" . config('api._version')
+            : "$rootNamespace\\Http\\Requests";
     }
 
     /**
diff --git a/src/Commands/CreateService.php b/src/Commands/CreateService.php
@@ -18,7 +18,13 @@ protected function getStub()
 
     protected function getDefaultNamespace($rootNamespace)
     {
-        return "$rootNamespace\\Http\\Services";
+        $versioning_enabled
+            = (bool) config('api._version') &&
+            !in_array('services', config('api-formula.versioning_disabled_for'));
+
+        return $versioning_enabled
+            ? "$rootNamespace\\Http\\Services\\" . config('api._version')
+            : "$rootNamespace\\Http\\Services";
     }
 
     /**
diff --git a/src/Commands/Stubs/Controller.stub b/src/Commands/Stubs/Controller.stub
@@ -3,11 +3,12 @@
 namespace {{ namespace }};
 
 use Illuminate\Http\Request;
-use App\Repositories\Interfaces\{{ model }}RepositoryInterface;
-use App\Http\Resources\{{ model }}Resource;
-use App\Http\Services\{{ model }}Service;
-use App\Http\Requests\{{ model }}\Create{{ model }};
-use App\Http\Requests\{{ model }}\Update{{ model }};
+use App\Http\Controllers\Controller;
+use {{ repository_path }};
+use {{ resource_path }};
+use {{ service_path }};
+use {{ create_request_path }};
+use {{ update_request_path }};
 use {{ namespacedModel }};
 
 class {{ class }} extends Controller
diff --git a/src/Helpers/BuildReplacements.php b/src/Helpers/BuildReplacements.php
@@ -14,10 +14,64 @@ class BuildReplacements
     public function replaceStrings(string $model_name): array
     {
         return [
+            '{{ repository_path }}' => $this->getFilePathString('repositories', $model_name),
+            '{{ resource_path }}' => $this->getFilePathString('resources', $model_name),
+            '{{ service_path }}' => $this->getFilePathString('services', $model_name),
+            '{{ create_request_path }}' => $this->getFilePathString('requests', $model_name, 'Create' . $model_name),
+            '{{ update_request_path }}' => $this->getFilePathString('requests', $model_name, 'Update' . $model_name),
             '{{ namespacedModel }}' => "App\\Models\\$model_name",
             '{{ model }}' => $model_name,
             '{{ model_var }}' => Str::snake($model_name),
             '{{ model_lc }}' => lcfirst($model_name)
         ];
     }
+
+    /**
+     * Set up file path string.
+     *
+     * @param   string $instance
+     * @param   string $model_name
+     * @param   string $fixed_model_name
+     * @return  string $path
+     */
+    public function getFilePathString(string $instance, string $model_name, ?string $fixed_model_name = null): string
+    {
+        // Return service path.
+        if ($instance == 'repositories') {
+            return $this->versioningEnabled($instance)
+                ? 'App\\Http\\Resources\\' . config('api._version') . '\\' . $model_name . 'Resource'
+                : 'App\\Http\\Resources\\' . $model_name . 'Resource';
+        }
+
+        // Return service path.
+        if ($instance == 'services') {
+            return $this->versioningEnabled($instance)
+                ? 'App\\Http\\Services\\' . config('api._version') . '\\' . $model_name . 'Service'
+                : 'App\\Http\\Services\\' . $model_name . 'Service';
+        }
+
+        // Return request path.
+        if ($instance == 'requests') {
+            return $this->versioningEnabled($instance)
+                ? 'App\\Http\\Requests\\' . config('api._version') . "\\$model_name\\$fixed_model_name"
+                : "App\\Http\\Requests\\$model_name\\$fixed_model_name";
+        }
+
+        // By default returning repository interface path.
+        return $this->versioningEnabled($instance)
+            ? 'App\\Repositories\\' . config('api._version') . '\\Interfaces\\' . $model_name . 'RepositoryInterface'
+            : 'App\\Repositories\\Interfaces\\' . $model_name . 'RepositoryInterface';
+    }
+
+    /**
+     * Check if versioning is enabled for specific instance.
+     *
+     * @param   string $instance
+     * @return  bool
+     */
+    public function versioningEnabled(string $instance): bool
+    {
+        return (bool) config('api._version') &&
+            !in_array($instance, config('api-formula.versioning_disabled_for'));
+    }
 }
diff --git a/src/Helpers/FileManager.php b/src/Helpers/FileManager.php
@@ -11,19 +11,31 @@ class FileManager
      *
      * @param string $repository
      * @param string $comment
+     * @param string $comment
+     * @return void
      */
-    public function importRepositoryFiles(string $repository, string $comment)
+    public function importRepositoryFiles(string $repository, string $comment): void
     {
         $file = base_path() . '/app/Providers/RepositoryServiceProvider.php';
+        $api_version = config('api._version');
 
         // Use statements.
         if ($comment == '// @API_FORMULA_USE_AUTOIMPORT') {
             $interface = $repository . 'Interface';
 
-            $snippet
-                = "use App\\Repositories\\Interfaces\\$interface;\n"
-                . "use App\\Repositories\\$repository;\n"
+            if ($api_version) {
+                // Set versioned snippet.
+                $snippet
+                = "use App\\Repositories\\$api_version\\Interfaces\\$interface;\n"
+                . "use App\\Repositories\\$api_version\\$repository;\n"
                 . "// @API_FORMULA_USE_AUTOIMPORT";
+            } else {
+                // Set regular snippet.
+                $snippet
+                    = "use App\\Repositories\\Interfaces\\$interface;\n"
+                    . "use App\\Repositories\\$repository;\n"
+                    . "// @API_FORMULA_USE_AUTOIMPORT";
+            }
         }
 
         // Bind function.
@@ -53,7 +65,8 @@ public function importRepositoryFiles(string $repository, string $comment)
     public function importApiRoute(string $controller, string $model)
     {
         $comment = '// @API_FORMULA_AUTOIMPORT';
-        $file = base_path() . '/routes/api.php';
+        $fileName = config('api-formula.api_file_path') ?? '/routes/api.php';
+        $file = base_path() . $fileName;
 
         // Import function.
         $snippet
diff --git a/src/Providers/ApiFormulaServiceProvider.php b/src/Providers/ApiFormulaServiceProvider.php
@@ -2,8 +2,11 @@
 
 namespace KLisica\ApiFormula\Providers;
 
+use Illuminate\Support\Facades\Config;
 use Illuminate\Support\ServiceProvider;
 use KLisica\ApiFormula\Commands\CreateController;
+use Illuminate\Support\Str;
+
 // Commands.
 use KLisica\ApiFormula\Commands\SetupFormula;
 use KLisica\ApiFormula\Commands\CreateFormula;
@@ -24,7 +27,16 @@ public function boot()
                 dirname(__DIR__, 2) . '/config/config.php'
                     => config_path('api-formula.php'),
             ]);
-          }
+        }
+
+        // Setting global api version variable.
+        $apiVersion = (
+            Config::get('api-formula.version') &&
+            !empty(Config::get('api-formula.version'))
+        ) ? Str::ucfirst(Str::camel(Config::get('api-formula.version')))
+        : null;
+
+        config(['api._version' => $apiVersion]);
     }
 
     public function register()

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,13 @@ protected function getStub()`
`19`	`19`
`20`	`20`	`protected function getDefaultNamespace($rootNamespace)`
`21`	`21`	`{`
`22`		`- return "$rootNamespace\\Http\\Controllers";`
	`22`	`+ $versioning_enabled`
	`23`	`+ = (bool) config('api._version') &&`
	`24`	`+ !in_array('controllers', config('api-formula.versioning_disabled_for'));`
	`25`	`+`
	`26`	`+ return $versioning_enabled`
	`27`	`+ ? "$rootNamespace\\Http\\Controllers\\" . config('api._version')`
	`28`	`+ : "$rootNamespace\\Http\\Controllers";`
`23`	`29`	`}`
`24`	`30`
`25`	`31`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,13 @@ protected function getStub()`
`18`	`18`
`19`	`19`	`protected function getDefaultNamespace($rootNamespace)`
`20`	`20`	`{`
`21`		`- return "$rootNamespace\\Repositories";`
	`21`	`+ $versioning_enabled`
	`22`	`+ = (bool) config('api._version') &&`
	`23`	`+ !in_array('repositories', config('api-formula.versioning_disabled_for'));`
	`24`	`+`
	`25`	`+ return $versioning_enabled`
	`26`	`+ ? "$rootNamespace\\Repositories\\" . config('api._version')`
	`27`	`+ : "$rootNamespace\\Repositories";`
`22`	`28`	`}`
`23`	`29`
`24`	`30`	`/**`