Merge pull request #220 from RonasIT/217-available-relations

[217]: fill getAvailableRelations with passed relations

Author: DenTray

src/Generators/EntityGenerator.php

@@ -328,4 +328,20 @@ protected function checkResourceExists(string $path, string $resourceName, ?stri
             throw new ResourceAlreadyExistsException($filePath);
         }
     }
+
+    protected function getRelationName(string $relation, string $type): string
+    {
+        $relationName = Str::snake($relation);
+
+        if ($this->isPluralRelation($type)) {
+            $relationName = Str::plural($relationName);
+        }
+
+        return $relationName;
+    }
+
+    protected function isPluralRelation(string $relation): bool
+    {
+        return in_array($relation, ['hasMany', 'belongsToMany']);
+    }
 }

src/Generators/ModelGenerator.php

@@ -9,11 +9,6 @@
 
 class ModelGenerator extends EntityGenerator
 {
-    protected const array PLURAL_NUMBER_REQUIRED = [
-        'belongsToMany',
-        'hasMany',
-    ];
-
     public function generate(): void
     {
         $this->checkResourceExists('models', $this->model, $this->modelSubFolder);
@@ -160,17 +155,6 @@ protected function getCasts(array $fields): array
         return $result;
     }
 
-    private function getRelationName(string $relation, string $type): string
-    {
-        $relationName = Str::snake($relation);
-
-        if (in_array($type, self::PLURAL_NUMBER_REQUIRED)) {
-            $relationName = Str::plural($relationName);
-        }
-
-        return $relationName;
-    }
-
     protected function getImportedRelations(): array
     {
         $result = [];
@@ -259,7 +243,7 @@ protected function isRequired(string $typeName): bool
 
     protected function getRelationType(string $model, string $relation): string
     {
-        if (in_array($relation, self::PLURAL_NUMBER_REQUIRED)) {
+        if ($this->isPluralRelation($relation)) {
             return "Collection<{$model}>";
         }
 

src/Generators/RequestsGenerator.php

@@ -79,6 +79,7 @@ protected function createRequest($method, $needToValidate = true, $parameters =
             'servicesNamespace' => $this->generateNamespace($this->paths['services']),
             'entityNamespace' => $this->getModelClass($this->model),
             'needToValidateWith' => !is_null(Arr::first($parameters, fn ($parameter) => $parameter['name'] === 'with.*')),
+            'availableRelations' => $this->getAvailableRelations(),
         ]);
 
         $this->saveClass('requests', "{$method}{$modelName}Request",
@@ -208,6 +209,22 @@ protected function getRules($name, $type, $required, $nullable, $present): array
         ];
     }
 
+    protected function getAvailableRelations(): array
+    {
+        $availableRelations = [];
+
+        $relations = $this->prepareRelations();
+
+        foreach ($relations as $type => $entities) {
+            array_push(
+                $availableRelations,
+                ...Arr::map($entities, fn ($entity) => $this->getRelationName($entity, $type)),
+            );
+        }
+
+        return $availableRelations;
+    }
+
     private function getEntityName($method): string
     {
         if ($method === self::SEARCH_METHOD) {

stubs/request.blade.php

@@ -50,8 +50,15 @@ public function validateResolved(): void
     //TODO: don't forget to review relations list
     protected function getAvailableRelations(): array
     {
+@if(!empty($availableRelations))
         return [
+@foreach($availableRelations as $relation)
+            '{{ $relation }}',
+@endforeach
         ];
+@else
+        return [];
+@endif
     }
 @endif
 }

tests/fixtures/CommandTest/get_request.php

@@ -32,7 +32,6 @@ public function validateResolved(): void
     //TODO: don't forget to review relations list
     protected function getAvailableRelations(): array
     {
-        return [
-        ];
+        return [];
     }
 }

tests/fixtures/CommandTest/search_request.php

@@ -26,7 +26,6 @@ public function rules(): array
     //TODO: don't forget to review relations list
     protected function getAvailableRelations(): array
     {
-        return [
-        ];
+        return [];
     }
 }

tests/fixtures/CommandTest/search_request_subfolder_model.php

@@ -26,7 +26,6 @@ public function rules(): array
     //TODO: don't forget to review relations list
     protected function getAvailableRelations(): array
     {
-        return [
-        ];
+        return [];
     }
 }

tests/fixtures/RequestGeneratorTest/get_request.php

@@ -33,6 +33,8 @@ public function validateResolved(): void
     protected function getAvailableRelations(): array
     {
         return [
+            'comments',
+            'user',
         ];
     }
 }

tests/fixtures/RequestGeneratorTest/search_request.php

@@ -29,6 +29,8 @@ public function rules(): array
     protected function getAvailableRelations(): array
     {
         return [
+            'comments',
+            'user',
         ];
     }
 }