refactor: Some code and documentation updates (#985)

* Some housekeeping and documentation updates * Code style fixes * Code style fixes * Code style fixes * Code style fixes * Change in APIRequest Class Co-authored-by: neelkanthk <[email protected]>
InfyOmLabs · Jun 22, 2022 · f09fdaf · f09fdaf
1 parent e3d2aab
commit f09fdaf
Show file tree

Hide file tree

Showing 14 changed files with 230 additions and 80 deletions.
diff --git a/src/Criteria/LimitOffsetCriteria.php b/src/Criteria/LimitOffsetCriteria.php
@@ -27,8 +27,8 @@ public function __construct(Request $request)
      */
     public function apply($model, \Prettus\Repository\Contracts\RepositoryInterface $repository)
     {
-        $limit = $this->request->get('limit', null);
-        $offset = $this->request->get('offset', null);
+        $limit = (int) $this->request->get('limit', null);
+        $offset = (int) $this->request->get('offset', null);
 
         if ($limit) {
             $model = $model->limit($limit);

diff --git a/src/Events/GeneratorFileCreated.php b/src/Events/GeneratorFileCreated.php
@@ -11,7 +11,18 @@ class GeneratorFileCreated
 {
     use SerializesModels;
 
+    /**
+     * Type of event.
+     *
+     * @var string
+     */
     public $type;
+
+    /**
+     * Event payload.
+     *
+     * @var array
+     */
     public $data;
 
     /**

diff --git a/src/Events/GeneratorFileCreating.php b/src/Events/GeneratorFileCreating.php
@@ -11,7 +11,18 @@ class GeneratorFileCreating
 {
     use SerializesModels;
 
+    /**
+     * Type of event.
+     *
+     * @var string
+     */
     public $type;
+
+    /**
+     * Event payload.
+     *
+     * @var array
+     */
     public $data;
 
     /**

diff --git a/src/Events/GeneratorFileDeleted.php b/src/Events/GeneratorFileDeleted.php
@@ -11,7 +11,18 @@ class GeneratorFileDeleted
 {
     use SerializesModels;
 
+    /**
+     * Type of event.
+     *
+     * @var string
+     */
     public $type;
+
+    /**
+     * Event payload.
+     *
+     * @var array
+     */
     public $data;
 
     /**

diff --git a/src/Events/GeneratorFileDeleting.php b/src/Events/GeneratorFileDeleting.php
@@ -11,7 +11,18 @@ class GeneratorFileDeleting
 {
     use SerializesModels;
 
+    /**
+     * Type of event.
+     *
+     * @var string
+     */
     public $type;
+
+    /**
+     * Event payload.
+     *
+     * @var array
+     */
     public $data;
 
     /**

diff --git a/src/Generators/API/APIControllerGenerator.php b/src/Generators/API/APIControllerGenerator.php
@@ -24,6 +24,11 @@ public function __construct(CommandData $commandData)
         $this->fileName = $this->commandData->modelName.'APIController.php';
     }
 
+    /**
+     * Generate API Controller Class.
+     *
+     * @return void
+     */
     public function generate()
     {
         if ($this->commandData->getOption('repositoryPattern')) {
@@ -73,6 +78,11 @@ private function fillDocs($templateData)
         return $templateData;
     }
 
+    /**
+     * Delete API Controller.
+     *
+     * @return void
+     */
     public function rollback()
     {
         if ($this->rollbackFile($this->path, $this->fileName)) {

diff --git a/src/Generators/API/APIRequestGenerator.php b/src/Generators/API/APIRequestGenerator.php
@@ -29,12 +29,22 @@ public function __construct(CommandData $commandData)
         $this->updateFileName = 'Update'.$this->commandData->modelName.'APIRequest.php';
     }
 
+    /**
+     * Generate API Request Class.
+     *
+     * @return void
+     */
     public function generate()
     {
         $this->generateCreateRequest();
         $this->generateUpdateRequest();
     }
 
+    /**
+     * Generate Create Request.
+     *
+     * @return void
+     */
     private function generateCreateRequest()
     {
         $templateData = get_template('api.request.create_request', 'laravel-generator');
@@ -47,6 +57,11 @@ private function generateCreateRequest()
         $this->commandData->commandInfo($this->createFileName);
     }
 
+    /**
+     * Generate Update Request.
+     *
+     * @return void
+     */
     private function generateUpdateRequest()
     {
         $modelGenerator = new ModelGenerator($this->commandData);
@@ -63,6 +78,11 @@ private function generateUpdateRequest()
         $this->commandData->commandInfo($this->updateFileName);
     }
 
+    /**
+     * Delete the generated Request Classes.
+     *
+     * @return void
+     */
     public function rollback()
     {
         if ($this->rollbackFile($this->path, $this->createFileName)) {

diff --git a/src/Generators/API/APIResourceGenerator.php b/src/Generators/API/APIResourceGenerator.php
@@ -24,6 +24,11 @@ public function __construct(CommandData $commandData)
         $this->fileName = $this->commandData->modelName.'Resource.php';
     }
 
+    /**
+     * Generate API Resources.
+     *
+     * @return void
+     */
     public function generate()
     {
         $templateData = get_template('api.resource.api_resource', 'laravel-generator');

diff --git a/src/Generators/API/APIRoutesGenerator.php b/src/Generators/API/APIRoutesGenerator.php
@@ -36,6 +36,11 @@ public function __construct(CommandData $commandData)
         $this->routesTemplate = fill_template($this->commandData->dynamicVars, $routesTemplate);
     }
 
+    /**
+     * Generate API Routes.
+     *
+     * @return void
+     */
     public function generate()
     {
         $this->routeContents .= "\n\n".$this->routesTemplate;
@@ -51,6 +56,11 @@ public function generate()
         $this->commandData->commandComment("\n".$this->commandData->config->mCamelPlural.' api routes added.');
     }
 
+    /**
+     * Remove API Routes.
+     *
+     * @return void
+     */
     public function rollback()
     {
         if (Str::contains($this->routeContents, $this->routesTemplate)) {

diff --git a/src/Generators/MigrationGenerator.php b/src/Generators/MigrationGenerator.php
@@ -47,20 +47,22 @@ private function generateFields()
         $createdAtField = null;
         $updatedAtField = null;
 
-        foreach ($this->commandData->fields as $field) {
-            if ($field->name == 'created_at') {
-                $createdAtField = $field;
-                continue;
-            } else {
-                if ($field->name == 'updated_at') {
-                    $updatedAtField = $field;
+        if (isset($this->commandData->fields) && !empty($this->commandData->fields)) {
+            foreach ($this->commandData->fields as $field) {
+                if ($field->name == 'created_at') {
+                    $createdAtField = $field;
                     continue;
+                } else {
+                    if ($field->name == 'updated_at') {
+                        $updatedAtField = $field;
+                        continue;
+                    }
                 }
-            }
 
-            $fields[] = $field->migrationText;
-            if (!empty($field->foreignKeyText)) {
-                $foreignKeys[] = $field->foreignKeyText;
+                $fields[] = $field->migrationText;
+                if (!empty($field->foreignKeyText)) {
+                    $foreignKeys[] = $field->foreignKeyText;
+                }
             }
         }
 
@@ -91,18 +93,20 @@ public function rollback()
 
         $files = [];
 
-        foreach ($allFiles as $file) {
-            $files[] = $file->getFilename();
-        }
+        if (!empty($allFiles)) {
+            foreach ($allFiles as $file) {
+                $files[] = $file->getFilename();
+            }
 
-        $files = array_reverse($files);
+            $files = array_reverse($files);
 
-        foreach ($files as $file) {
-            if (Str::contains($file, $fileName)) {
-                if ($this->rollbackFile($this->path, $file)) {
-                    $this->commandData->commandComment('Migration file deleted: '.$file);
+            foreach ($files as $file) {
+                if (Str::contains($file, $fileName)) {
+                    if ($this->rollbackFile($this->path, $file)) {
+                        $this->commandData->commandComment('Migration file deleted: '.$file);
+                    }
+                    break;
                 }
-                break;
             }
         }
     }

diff --git a/src/Generators/ModelGenerator.php b/src/Generators/ModelGenerator.php
@@ -65,13 +65,14 @@ private function fillTemplate($templateData)
 
         $fillables = [];
         $primaryKey = 'id';
-
-        foreach ($this->commandData->fields as $field) {
-            if ($field->isFillable) {
-                $fillables[] = "'".$field->name."'";
-            }
-            if ($field->isPrimary) {
-                $primaryKey = $field->name;
+        if (isset($this->commandData->fields) && !empty($this->commandData->fields)) {
+            foreach ($this->commandData->fields as $field) {
+                if ($field->isFillable) {
+                    $fillables[] = "'".$field->name."'";
+                }
+                if ($field->isPrimary) {
+                    $primaryKey = $field->name;
+                }
             }
         }
 
@@ -160,22 +161,27 @@ private function fillDocs($templateData)
         $fillables = '';
         $fieldsArr = [];
         $count = 1;
-        foreach ($this->commandData->relations as $relation) {
-            $field = $relationText = (isset($relation->inputs[0])) ? $relation->inputs[0] : null;
-            if (in_array($field, $fieldsArr)) {
-                $relationText = $relationText.'_'.$count;
-                $count++;
-            }
+        if (isset($this->commandData->relations) && !empty($this->commandData->relations)) {
+            foreach ($this->commandData->relations as $relation) {
+                $field = $relationText = (isset($relation->inputs[0])) ? $relation->inputs[0] : null;
+                if (in_array($field, $fieldsArr)) {
+                    $relationText = $relationText.'_'.$count;
+                    $count++;
+                }
 
-            $fillables .= ' * @property '.$this->getPHPDocType($relation->type, $relation, $relationText).PHP_EOL;
-            $fieldsArr[] = $field;
+                $fillables .= ' * @property '.$this->getPHPDocType($relation->type, $relation, $relationText).PHP_EOL;
+                $fieldsArr[] = $field;
+            }
         }
 
-        foreach ($this->commandData->fields as $field) {
-            if ($field->isFillable) {
-                $fillables .= ' * @property '.$this->getPHPDocType($field->fieldType).' $'.$field->name.PHP_EOL;
+        if (isset($this->commandData->fields) && !empty($this->commandData->fields)) {
+            foreach ($this->commandData->fields as $field) {
+                if ($field->isFillable) {
+                    $fillables .= ' * @property '.$this->getPHPDocType($field->fieldType).' $'.$field->name.PHP_EOL;
+                }
             }
         }
+
         $docsTemplate = str_replace('$GENERATE_DATE$', date('F j, Y, g:i a T'), $docsTemplate);
         $docsTemplate = str_replace('$PHPDOC$', $fillables, $docsTemplate);
 
@@ -251,10 +257,12 @@ private function generateRequiredFields()
     {
         $requiredFields = [];
 
-        foreach ($this->commandData->fields as $field) {
-            if (!empty($field->validations)) {
-                if (Str::contains($field->validations, 'required')) {
-                    $requiredFields[] = $field->name;
+        if (isset($this->commandData->fields) && !empty($this->commandData->fields)) {
+            foreach ($this->commandData->fields as $field) {
+                if (!empty($field->validations)) {
+                    if (Str::contains($field->validations, 'required')) {
+                        $requiredFields[] = $field->name;
+                    }
                 }
             }
         }
@@ -436,19 +444,21 @@ private function generateRelations()
 
         $count = 1;
         $fieldsArr = [];
-        foreach ($this->commandData->relations as $relation) {
-            $field = (isset($relation->inputs[0])) ? $relation->inputs[0] : null;
-
-            $relationShipText = $field;
-            if (in_array($field, $fieldsArr)) {
-                $relationShipText = $relationShipText.'_'.$count;
-                $count++;
-            }
+        if (isset($this->commandData->relations) && !empty($this->commandData->relations)) {
+            foreach ($this->commandData->relations as $relation) {
+                $field = (isset($relation->inputs[0])) ? $relation->inputs[0] : null;
+
+                $relationShipText = $field;
+                if (in_array($field, $fieldsArr)) {
+                    $relationShipText = $relationShipText.'_'.$count;
+                    $count++;
+                }
 
-            $relationText = $relation->getRelationFunctionText($relationShipText);
-            if (!empty($relationText)) {
-                $fieldsArr[] = $field;
-                $relations[] = $relationText;
+                $relationText = $relation->getRelationFunctionText($relationShipText);
+                if (!empty($relationText)) {
+                    $fieldsArr[] = $field;
+                    $relations[] = $relationText;
+                }
             }
         }
 

diff --git a/src/Request/APIRequest.php b/src/Request/APIRequest.php
@@ -20,6 +20,6 @@ public function response(array $errors)
     {
         $messages = implode(' ', Arr::flatten($errors));
 
-        return Response::json(ResponseUtil::makeError($messages), 400);
+        return Response::json(ResponseUtil::makeError($messages), Response::HTTP_BAD_REQUEST);
     }
 }