refactor: updated generator commands. make:repo command updates models and API Resources

syntaxlexx · syntaxlexx · commit e5a1e5f200a0 · 2023-05-03T21:28:06.000+03:00
diff --git a/app/Console/Generators/EnumMakeCommand.php b/app/Console/Generators/EnumMakeCommand.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: lexxyungcarter
- * Date: 23/10/2019
- * Time: 12:18
- */
 
 namespace App\Console\Generators;
 
diff --git a/app/Console/Generators/FacadeMakeCommand.php b/app/Console/Generators/FacadeMakeCommand.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: lexxyungcarter
- * Date: 23/10/2019
- * Time: 12:18
- */
 
 namespace App\Console\Generators;
 
diff --git a/app/Console/Generators/FilterMakeCommand.php b/app/Console/Generators/FilterMakeCommand.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: lexxyungcarter
- * Date: 13/10/2019
- * Time: 21:04
- */
 
 namespace App\Console\Generators;
 
diff --git a/app/Console/Generators/RepositoryMakeCommand.php b/app/Console/Generators/RepositoryMakeCommand.php
@@ -2,6 +2,8 @@
 
 namespace App\Console\Generators;
 
+use Str;
+
 class RepositoryMakeCommand extends GeneratorCommand
 {
     /**
@@ -16,7 +18,7 @@ class RepositoryMakeCommand extends GeneratorCommand
      *
      * @var string
      */
-    protected $description = 'Create a new AceLords project event class';
+    protected $description = 'Create a repository class';
 
     /**
      * The type of class being generated.
@@ -56,4 +58,70 @@ protected function getDefaultNamespace($rootNamespace)
     {
         return $rootNamespace.'\Repositories';
     }
+
+    /**
+     * Replace the namespace for the given stub.
+     *
+     * @param  string  $stub
+     * @param  string  $name
+     * @return $this
+     */
+    protected function replaceNamespace(&$stub, $name)
+    {
+        $stub = str_replace(
+            [
+                'DummyNamespace',
+                'DummyRootNamespace',
+                'NamespacedDummyUserModel',
+                'DummyModelTableName',
+                'DummySeederClassName',
+                'DummyModel',
+                'DummyResource',
+                'DummyResourceCollection',
+            ],
+            [
+                $this->getNamespace($name),
+                $this->rootNamespace(),
+                $this->userProviderModel(),
+                $this->getDefaultModelTableName($name),
+                $this->getSeederNameFromClassName(),
+                $this->getModelNameFromClassName(),
+                $this->getResourceNameFromClassName(),
+                $this->getResourceCollectionNameFromClassName(),
+            ],
+            $stub
+        );
+
+        return $this;
+    }
+
+    /**
+     * Get model name.
+     *
+     * @return string
+     */
+    protected function getModelNameFromClassName()
+    {
+        return Str::replace('Repository', '', $this->className);
+    }
+
+    /**
+     * Get resource name.
+     *
+     * @return string
+     */
+    protected function getResourceNameFromClassName()
+    {
+        return $this->getModelNameFromClassName() . 'Resource';
+    }
+
+    /**
+     * Get resource collection name.
+     *
+     * @return string
+     */
+    protected function getResourceCollectionNameFromClassName()
+    {
+        return $this->getModelNameFromClassName() . 'ResourceCollection';
+    }
 }
diff --git a/app/Console/Generators/ResourceMakeCommand.php b/app/Console/Generators/ResourceMakeCommand.php
@@ -19,7 +19,7 @@ class ResourceMakeCommand extends GeneratorCommand
      *
      * @var string
      */
-    protected $description = 'Create a new AceLords project resource';
+    protected $description = 'Create a new resource';
 
     /**
      * The type of class being generated.
diff --git a/app/Console/Generators/ServiceMakeCommand.php b/app/Console/Generators/ServiceMakeCommand.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: lexxyungcarter
- * Date: 23/10/2019
- * Time: 12:22
- */
 
 namespace App\Console\Generators;
 
@@ -22,7 +16,7 @@ class ServiceMakeCommand extends GeneratorCommand
      *
      * @var string
      */
-    protected $description = 'Create a new AceLords project service class for a facade class';
+    protected $description = 'Create a new service class for a facade class';
 
     /**
      * The type of class being generated.
diff --git a/app/Console/Generators/WidgetMakeCommand.php b/app/Console/Generators/WidgetMakeCommand.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: lexxyungcarter
- * Date: 14/10/2019
- * Time: 16:32
- */
 
 namespace App\Console\Generators;
 
@@ -22,7 +16,7 @@ class WidgetMakeCommand extends GeneratorCommand
      *
      * @var string
      */
-    protected $description = 'Create a new AceLords project widget class';
+    protected $description = 'Create a new widget class';
 
     /**
      * The type of class being generated.
diff --git a/app/Console/Generators/stubs/repository.stub b/app/Console/Generators/stubs/repository.stub
@@ -3,6 +3,11 @@
 namespace DummyNamespace;
 
 use DB;
+use Exception;
+use App\Models\DummyModel;
+use App\Events\CRUDErrorOccurred;
+use App\Http\Resources\DummyResource;
+use App\Http\Resources\DummyResourceCollection;
 
 class DummyClass
 {
@@ -13,7 +18,7 @@ class DummyClass
      *
      * @return void
      */
-    public function __construct(Model $model)
+    public function __construct(DummyModel $model)
     {
         $this->model = $model;
     }
@@ -23,35 +28,35 @@ class DummyClass
      *
      * @param string $pagination
      *
-     * @return ModelResourceCollection
+     * @return DummyResourceCollection
      */
     public function get($pagination = 'm')
     {
         $data = $this->model->latest()
-            ->paginate(core_paginate($pagination));
+            ->paginate(pagination($pagination));
 
-        return new ModelResourceCollection($data);
+        return new DummyResourceCollection($data);
     }
 
     /**
      * find model record
      * @param $id
      *
-     * @return ModelResource
+     * @return DummyResource
      */
     public function find($id)
     {
         $item = $this->model->findOrFail($id);
 
-        return new ModelResource($item);
+        return new DummyResource($item);
     }
 
     /**
      * search records
      *
      * @param string $pagination
      *
-     * @return ModelResourceCollection
+     * @return DummyResourceCollection
      */
     public function search($pagination = 'm')
     {
@@ -60,15 +65,15 @@ class DummyClass
         $data = $this->model
             ->where('name', 'LIKE', '%' . $term . '%')
             ->latest()
-            ->paginate(core_paginate($pagination));
+            ->paginate(pagination($pagination));
 
-        return new ModelResourceCollection($data);
+        return new DummyResourceCollection($data);
     }
 
     /**
      * create a new record
      *
-     * @return ModelResource
+     * @return DummyResource
      */
     public function create()
     {
@@ -80,21 +85,23 @@ class DummyClass
             ]);
 
             DB::commit();
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             DB::rollBack();
 
-            debugOn() ? dde($e->getMessage()) : false;
+            ddOnError($e);
+
+            event(new CRUDErrorOccurred($e->getMessage()));
 
             return false;
         }
 
-        return new ModelResource($data);
+        return new DummyResource($data);
     }
 
     /**
      * update a record
      *
-     * @return ModelResource
+     * @return DummyResource
      */
     public function update($id)
     {
@@ -108,15 +115,17 @@ class DummyClass
             ]);
 
             DB::commit();
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             DB::rollBack();
 
-            debugOn() ? dde($e->getMessage()) : false;
+            ddOnError($e);
+
+            event(new CRUDErrorOccurred($e->getMessage()));
 
             return false;
         }
 
-        return new ModelResource($data);
+        return new DummyResource($data);
     }
 
     /**
@@ -128,6 +137,16 @@ class DummyClass
      */
     public function delete($id)
     {
-        return $this->model->findOrFail($id)->delete();
+        try {
+            $resp = $this->model->findOrFail($id)->delete();
+        } catch (Exception $e) {
+            event(new CRUDErrorOccurred($e->getMessage()));
+
+            return false;
+        }
+
+        // event - alert
+
+        return $resp;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ class ResourceMakeCommand extends GeneratorCommand`
`19`	`19`	`*`
`20`	`20`	`* @var string`
`21`	`21`	`*/`
`22`		`- protected $description = 'Create a new AceLords project resource';`
	`22`	`+ protected $description = 'Create a new resource';`
`23`	`23`
`24`	`24`	`/**`
`25`	`25`	`* The type of class being generated.`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,11 @@`
`3`	`3`	`namespace DummyNamespace;`
`4`	`4`
`5`	`5`	`use DB;`
	`6`	`+use Exception;`
	`7`	`+use App\Models\DummyModel;`
	`8`	`+use App\Events\CRUDErrorOccurred;`
	`9`	`+use App\Http\Resources\DummyResource;`
	`10`	`+use App\Http\Resources\DummyResourceCollection;`
`6`	`11`
`7`	`12`	`class DummyClass`
`8`	`13`	`{`
`@@ -13,7 +18,7 @@ class DummyClass`
`13`	`18`	`*`
`14`	`19`	`* @return void`
`15`	`20`	`*/`
`16`		`- public function __construct(Model $model)`
	`21`	`+ public function __construct(DummyModel $model)`
`17`	`22`	`{`
`18`	`23`	`$this->model = $model;`
`19`	`24`	`}`
`@@ -23,35 +28,35 @@ class DummyClass`
`23`	`28`	`*`
`24`	`29`	`* @param string $pagination`
`25`	`30`	`*`
`26`		`- * @return ModelResourceCollection`
	`31`	`+ * @return DummyResourceCollection`
`27`	`32`	`*/`
`28`	`33`	`public function get($pagination = 'm')`
`29`	`34`	`{`
`30`	`35`	`$data = $this->model->latest()`
`31`		`- ->paginate(core_paginate($pagination));`
	`36`	`+ ->paginate(pagination($pagination));`
`32`	`37`
`33`		`- return new ModelResourceCollection($data);`
	`38`	`+ return new DummyResourceCollection($data);`
`34`	`39`	`}`
`35`	`40`
`36`	`41`	`/**`
`37`	`42`	`* find model record`
`38`	`43`	`* @param $id`
`39`	`44`	`*`
`40`		`- * @return ModelResource`
	`45`	`+ * @return DummyResource`
`41`	`46`	`*/`
`42`	`47`	`public function find($id)`
`43`	`48`	`{`
`44`	`49`	`$item = $this->model->findOrFail($id);`
`45`	`50`
`46`		`- return new ModelResource($item);`
	`51`	`+ return new DummyResource($item);`
`47`	`52`	`}`
`48`	`53`
`49`	`54`	`/**`
`50`	`55`	`* search records`
`51`	`56`	`*`
`52`	`57`	`* @param string $pagination`
`53`	`58`	`*`
`54`		`- * @return ModelResourceCollection`
	`59`	`+ * @return DummyResourceCollection`
`55`	`60`	`*/`
`56`	`61`	`public function search($pagination = 'm')`
`57`	`62`	`{`
`@@ -60,15 +65,15 @@ class DummyClass`
`60`	`65`	`$data = $this->model`
`61`	`66`	`->where('name', 'LIKE', '%' . $term . '%')`
`62`	`67`	`->latest()`
`63`		`- ->paginate(core_paginate($pagination));`
	`68`	`+ ->paginate(pagination($pagination));`
`64`	`69`
`65`		`- return new ModelResourceCollection($data);`
	`70`	`+ return new DummyResourceCollection($data);`
`66`	`71`	`}`
`67`	`72`
`68`	`73`	`/**`
`69`	`74`	`* create a new record`
`70`	`75`	`*`
`71`		`- * @return ModelResource`
	`76`	`+ * @return DummyResource`
`72`	`77`	`*/`
`73`	`78`	`public function create()`
`74`	`79`	`{`
`@@ -80,21 +85,23 @@ class DummyClass`
`80`	`85`	`]);`
`81`	`86`
`82`	`87`	`DB::commit();`
`83`		`- } catch (\Exception $e) {`
	`88`	`+ } catch (Exception $e) {`
`84`	`89`	`DB::rollBack();`
`85`	`90`
`86`		`- debugOn() ? dde($e->getMessage()) : false;`
	`91`	`+ ddOnError($e);`
	`92`	`+`
	`93`	`+ event(new CRUDErrorOccurred($e->getMessage()));`
`87`	`94`
`88`	`95`	`return false;`
`89`	`96`	`}`
`90`	`97`
`91`		`- return new ModelResource($data);`
	`98`	`+ return new DummyResource($data);`
`92`	`99`	`}`
`93`	`100`
`94`	`101`	`/**`
`95`	`102`	`* update a record`
`96`	`103`	`*`
`97`		`- * @return ModelResource`
	`104`	`+ * @return DummyResource`
`98`	`105`	`*/`
`99`	`106`	`public function update($id)`
`100`	`107`	`{`
`@@ -108,15 +115,17 @@ class DummyClass`
`108`	`115`	`]);`
`109`	`116`
`110`	`117`	`DB::commit();`
`111`		`- } catch (\Exception $e) {`
	`118`	`+ } catch (Exception $e) {`
`112`	`119`	`DB::rollBack();`
`113`	`120`
`114`		`- debugOn() ? dde($e->getMessage()) : false;`
	`121`	`+ ddOnError($e);`
	`122`	`+`
	`123`	`+ event(new CRUDErrorOccurred($e->getMessage()));`
`115`	`124`
`116`	`125`	`return false;`
`117`	`126`	`}`
`118`	`127`
`119`		`- return new ModelResource($data);`
	`128`	`+ return new DummyResource($data);`
`120`	`129`	`}`
`121`	`130`
`122`	`131`	`/**`
`@@ -128,6 +137,16 @@ class DummyClass`
`128`	`137`	`*/`
`129`	`138`	`public function delete($id)`
`130`	`139`	`{`
`131`		`- return $this->model->findOrFail($id)->delete();`
	`140`	`+ try {`
	`141`	`+ $resp = $this->model->findOrFail($id)->delete();`
	`142`	`+ } catch (Exception $e) {`
	`143`	`+ event(new CRUDErrorOccurred($e->getMessage()));`
	`144`	`+`
	`145`	`+ return false;`
	`146`	`+ }`
	`147`	`+`
	`148`	`+ // event - alert`
	`149`	`+`
	`150`	`+ return $resp;`
`132`	`151`	`}`
`133`	`152`	`}`