Add Cheques Module with CRUD Operations and Tests (Integration & End-to-End)

.gitignore

@@ -8,6 +8,7 @@
 .env
 .env.backup
 .env.production
+.env.testing
 .phpunit.result.cache
 Homestead.json
 Homestead.yaml

app/Http/Controllers/ChequeController.php

@@ -0,0 +1,155 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use App\Http\Requests\ChequeRequest;
+use App\Models\ActivityLog;
+use App\Models\Cheque;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Hash;
+use Illuminate\Support\Facades\Storage;
+
+class ChequeController extends Controller
+{
+    /**
+     * Display a listing of the resource.
+     */
+    public function index()
+    {
+        $cheques = Cheque::all();
+        return view('cheques.index', compact('cheques'));
+    }
+
+    /**
+     * Show the form for creating a new resource.
+     */
+    public function create()
+    {
+        return view('cheques.create');
+    }
+
+    /**
+     * Store a newly created resource in storage.
+     */
+    public function store(ChequeRequest $request)
+    {
+        try {
+            DB::beginTransaction();
+
+            $cheque = Cheque::create($request->validated());
+            // Log the activity
+            $user = auth()->user();
+            $ipAddress = $request->ip();
+            $userAgent = $request->header('User-Agent');
+            $action = 'Cheque Created Successfully';
+            ActivityLog::create([
+                'user_id' => $user ? $user->id : null,
+                'ip_address' => $ipAddress,
+                'user_agent' => $userAgent,
+                'action' => $action,
+                'details' => 'Cheque ' . $cheque->check_number . ' Created Successfully by ' . $user->name
+            ]);
+
+            DB::commit();
+
+            toast('Cheque ' . $cheque->check_number . ' added successfully', 'success');
+            return redirect()->route('cheque.index');
+        } catch (\Exception $e) {
+            DB::rollback();
+            dd($e);
+            toast('Whoops!!! Something went wrong ' . $e->getMessage(), 'error');
+            return redirect()->back();
+        }
+    }
+
+    /**
+     * Display the specified resource.
+     */
+    public function show(string $cheque)
+    {
+        return view('cheques.show', [
+            'cheque' => Cheque::findOrFail($cheque)
+        ]);
+    }
+
+    /**
+     * Show the form for editing the specified resource.
+     */
+    public function edit(string $cheque)
+    {
+        return view('cheques.edit', [
+            'cheque' => Cheque::findOrFail($cheque)
+        ]);
+    }
+
+    /**
+     * Update the specified resource in storage.
+     */
+    public function update(ChequeRequest $request, Cheque $cheque)
+    {
+        try {
+            DB::beginTransaction();
+            $cheque->update($request->validated());
+            // Log the activity
+            $user = auth()->user();
+            $ipAddress = $request->ip();
+            $userAgent = $request->header('User-Agent');
+            $action = 'Cheque Updated Successfully';
+            ActivityLog::create([
+                'user_id' => $user ? $user->id : null,
+                'ip_address' => $ipAddress,
+                'user_agent' => $userAgent,
+                'action' => $action,
+                'details' => 'Cheque ' . $cheque->check_number . ' Updated Successfully by ' . $user->name
+            ]);
+            DB::commit();
+
+            toast('Cheque ' . $cheque->check_number . ' updated successfully', 'success');
+            return redirect()->route('cheque.index');
+        } catch (\Exception $e) {
+            DB::rollBack();
+            toast('Whoops!!! Something went wrong ' . $e->getMessage(), 'error');
+            return redirect()->back();
+        }
+    }
+
+    /**
+     * Remove the specified resource from storage.
+     */
+    public function destroy(Cheque $cheque, Request $request)
+    {
+        try {
+            $check_password = Hash::check($request->password, auth()->user()->password);
+            if (!$check_password) {
+                toast('These credentials do not match our records', 'error');
+
+                return redirect()->back();
+            }
+            DB::beginTransaction();
+            $chequeNumber = $cheque->check_number;
+            $cheque->delete();
+
+            // Log the activity
+            $user = auth()->user();
+            $ipAddress = $request->ip();
+            $userAgent = $request->header('User-Agent');
+            $action = 'Cheque Deleted Successfully';
+            ActivityLog::create([
+                'user_id' => $user ? $user->id : null,
+                'ip_address' => $ipAddress,
+                'user_agent' => $userAgent,
+                'action' => $action,
+                'details' => 'Cheque ' . $chequeNumber . ' Deleted Successfully by ' . $user->name
+            ]);
+            DB::commit();
+
+            toast('Cheque deleted successfully', 'success');
+            return redirect()->route('cheque.index');
+        } catch (\Exception $e) {
+            DB::rollBack();
+            toast('Whoops!!! Something went wrong ' .  $e->getMessage(), 'error');
+            return redirect()->back();
+        }
+    }
+}

app/Http/Requests/ChequeRequest.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace App\Http\Requests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class ChequeRequest extends FormRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return true;
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array<string, \Illuminate\Contracts\Validation\ValidationRule|array<mixed>|string>
+     */
+    public function rules(): array
+    {
+        $chequeId = $this->cheque ? $this->cheque->id : null;
+
+        return [
+            'check_number' => 'required|string|unique:cheques,check_number,' . $chequeId,
+            'amount' => 'required|numeric|min:1',
+            'beneficiary' => 'required|string|max:255',
+        ];
+    }
+
+    public function messages(): array
+    {
+        return [
+            'check_number.required' => 'Check number is required.',
+            'check_number.string' => 'Check number must be a valid string.',
+            'check_number.unique' => 'This check number is already in use. Please use a different one.',
+
+            'amount.required' => 'Amount is required.',
+            'amount.numeric' => 'Amount must be a numeric value.',
+            'amount.min' => 'Amount must be at least 1.',
+
+            'beneficiary.required' => 'Beneficiary is required.',
+            'beneficiary.string' => 'Beneficiary must be a valid string.',
+            'beneficiary.max' => 'Beneficiary cannot exceed 255 characters.',
+        ];
+    }
+}

app/Models/ActvityLog.php → app/Models/ActivityLog.php

@@ -14,10 +14,6 @@ class ActivityLog extends Model
         'user_agent',
         'action',
         'details',
-
-    ];
-
-
-
 
+    ];
 }

app/Models/Cheque.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\SoftDeletes;
+
+class Cheque extends Model
+{
+    use HasFactory, SoftDeletes;
+
+    protected $fillable = [
+        'check_number',
+        'amount',
+        'beneficiary',
+    ];
+}

composer.json

@@ -29,6 +29,7 @@
     },
     "require-dev": {
         "fakerphp/faker": "^1.9.1",
+        "laravel/dusk": "^8.2",
         "laravel/pint": "^1.0",
         "laravel/sail": "^1.18",
         "mockery/mockery": "^1.4.4",