Merge pull request #2 from Applejack21/v1.0.2

more fixes and examples

Author: Applejack21

README.md

@@ -10,15 +10,7 @@ As well as this, it'll generate validation rules for the model based on the tabl
 Requires [Laravel](https://laravel.com/ "Laravel").
 Use composer to install it as described below:
 ```
-$ composer require applejack21/laravel-actions
-```
-
-```json
-{
-    "require": {
-        "applejack21/laravel-actions": "*"
-    }
-}
+composer require applejack21/laravel-actions
 ```
 
 <a name="usage"></a>
@@ -34,6 +26,10 @@ The command also has a few arguments you can pass to customise it:
 
 The files are then put into the folder ``app\Actions\<model_name>``. If there are files already in this folder it'll prompt you to replace these with the ones generated instead.
 
+<a name="examples"></a>
+## Examples
+See the ``examples`` folder for a list of action files that have been generated using this command based on the default User model from Laravel. I shall try my best to remember to update the examples alongside code changes.
+
 <a name="suggestions"></a>
 ## Suggestions
 You're free to fork this and modify the code as you wish to add in your own extra functionality. However, if you have any suggestions that should be added to this package, do create an issue with the suggestion or even a PR with your modified code!

src/Actions/MakeDeleteFile.php

@@ -28,11 +28,16 @@ public function execute(string $modelName, string $fileName, bool $permaDelete =
 
 		class Delete$modelName
 		{
-			public function execute($modelName $$lowerModel): $modelName
+			public function execute($modelName $$lowerModel): $modelName|bool
 			{
-				$$lowerModel ->delete();
+				\$deleted = $$lowerModel ->delete();
 
-				return tap($$lowerModel)->refresh();
+				// return the model if is utilises soft deletes as the record still exists
+				if(in_array('Illuminate\Database\Eloquent\SoftDeletes', class_uses($$lowerModel)) && \$deleted === true) {
+					return tap($$lowerModel)->refresh();
+				}
+
+				return \$deleted;
 			}
 		}
 		EOT;
@@ -46,11 +51,11 @@ public function execute($modelName $$lowerModel): $modelName
 
 		class Delete$modelName
 		{
-			public function execute($modelName $$lowerModel, bool $permaVariable = false): $modelName
+			public function execute($modelName $$lowerModel, bool $permaVariable = false): $modelName|bool
 			{
 				$permaVariable ? $$lowerModel ->forceDelete() : $$lowerModel ->delete();
 
-				return tap($$lowerModel)->refresh();
+				return $permaVariable ? true : tap($$lowerModel)->refresh();
 			}
 		}
 		EOT;

src/Examples/CreateUser.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace App\Actions\User;
+
+use App\Models\User;
+use Illuminate\Support\Facades\Validator;
+
+class CreateUser
+{
+	public function execute(array $request): User
+	{
+		$this->validate($request);
+
+		$user = User::create([
+			...$request,
+		]);
+
+		return tap($user)->refresh();
+	}
+
+	private function validate(array $request): array
+	{
+		return Validator::validate($request, [
+            'name' => 'required|max:255',
+            'email' => 'required|unique:users,email|max:255|email',
+            'email_verified_at' => 'nullable',
+            'password' => 'required|max:255|confirmed',
+            'two_factor_secret' => 'nullable',
+            'two_factor_recovery_codes' => 'nullable',
+            'two_factor_confirmed_at' => 'nullable',
+            'remember_token' => 'nullable|max:100',
+            'current_team_id' => 'nullable',
+            'profile_photo_path' => 'nullable|max:2048'
+		]);
+	}
+}

src/Examples/DeleteUser.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Actions\User;
+
+use App\Models\User;
+
+class DeleteUser
+{
+	public function execute(User $user): User|bool
+	{
+		$deleted = $user->delete();
+
+		// return the model if is utilises soft deletes as the record still exists
+		if(in_array('Illuminate\Database\Eloquent\SoftDeletes', class_uses($user)) && $deleted === true) {
+			return tap($user)->refresh();
+		}
+
+		return $deleted;
+
+	}
+}

src/Examples/DeleteUserWithPerma.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Actions\User;
+
+use App\Models\User;
+
+class DeleteUser
+{
+	/**
+	 * This option is recommended for models with soft deletes trait.
+	 */
+	public function execute(User $user, bool $perma = false): User|bool
+	{
+		$perma ? $user->forceDelete() : $user->delete();
+
+		return $perma ? true : tap($user)->refresh();
+	}
+}

src/Examples/GetUsers.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace App\Actions\User;
+
+use App\Models\User;
+use Illuminate\Database\Eloquent\Collection;
+
+class GetUsers
+{
+	public function execute(): Collection
+	{
+		return User::all();
+	}
+}

src/Examples/UpdateUser.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace App\Actions\User;
+
+use App\Models\User;
+use Illuminate\Support\Facades\Validator;
+
+class UpdateUser
+{
+	public function execute(User $user, array $request): User
+	{
+		$this->validate($request, $user);
+
+		$user->update([
+			...$request,
+		]);
+
+		return tap($user)->refresh();
+	}
+
+	private function validate(array $request, User $user): array
+	{
+		return Validator::validate($request, [
+			'name' => 'required|max:255',
+			'email' => 'required|unique:users,email|max:255|email',
+			'email_verified_at' => 'nullable',
+			'password' => 'required|max:255|confirmed',
+			'two_factor_secret' => 'nullable',
+			'two_factor_recovery_codes' => 'nullable',
+			'two_factor_confirmed_at' => 'nullable',
+			'remember_token' => 'nullable|max:100',
+			'current_team_id' => 'nullable',
+			'profile_photo_path' => 'nullable|max:2048'
+		]);
+	}
+}