rebase and add notes/description feature

Author: 3m1n3nc3

database/migrations/update_wallets_logs_table.php.stub

@@ -12,8 +12,8 @@ return new class extends Migration
     public function up(): void
     {
         Schema::table('wallets_logs', function (Blueprint $table) {
-            if (!Schema::hasColumn('wallets_logs', 'detail')) {
-                $table->string('detail')->nullable()->after('status');
+            if (!Schema::hasColumn('wallets_logs', 'notes')) {
+                $table->string('notes')->nullable()->after('status');
             }
             if (!Schema::hasColumn('wallets_logs', 'reference')) {
                 $table->string('reference')->nullable()->after('ip');
@@ -27,8 +27,8 @@ return new class extends Migration
     public function down(): void
     {
         Schema::table('wallets_logs', function (Blueprint $table) {
-            if (Schema::hasColumn('wallets_logs', 'detail')) {
-                $table->dropColumn('detail');
+            if (Schema::hasColumn('wallets_logs', 'notes')) {
+                $table->dropColumn('notes');
             }
             if (Schema::hasColumn('wallets_logs', 'reference')) {
                 $table->dropColumn('reference');

src/Traits/BalanceOperation.php

@@ -19,25 +19,25 @@ public function hasBalance(): bool
     /**
      *  Decrement Balance and create a log entry.
      */
-    public function decrementAndCreateLog($value, $detail = null): void
+    public function decrementAndCreateLog($value, $notes = null): void
     {
-        $this->createLog('dec', $value, $detail);
+        $this->createLog('dec', $value, $notes);
         $this->decrement('balance', $value);
     }
 
     /**
      *  Increment Balance and create a log entry.
      */
-    public function incrementAndCreateLog($value, $detail = null): void
+    public function incrementAndCreateLog($value, $notes = null): void
     {
-        $this->createLog('inc', $value, $detail);
+        $this->createLog('inc', $value, $notes);
         $this->increment('balance', $value);
     }
 
     /**
      *  Create a new log record
      */
-    protected function createLog($logType, $value, $detail = null): void
+    protected function createLog($logType, $value, $notes = null): void
     {
         $currentBalance = $this->balance ?? 0;
 
@@ -56,10 +56,10 @@ protected function createLog($logType, $value, $detail = null): void
             'type' => $logType,
             'ip' => \Request::ip(),
             'value' => $value,
-            'detail' => $detail,
+            'notes' => $notes,
             'reference' => $reference
         ]);
 
         $this->createdLog->changeStatus('Done');
     }
-}
+}

src/Traits/HandlesDeposit.php

@@ -15,7 +15,7 @@ trait HandlesDeposit
     /**
      * Deposit an amount to the user's wallet of a specific type.
      */
-    public function deposit(string $type, int|float $amount, $detail = null): bool
+    public function deposit(string $type, int|float $amount, $notes = null): bool
     {
         $depositable = $this->getDepositableTypes();
 
@@ -27,10 +27,10 @@ public function deposit(string $type, int|float $amount, $detail = null): bool
             throw new InvalidValueException();
         }
 
-        DB::transaction(function () use ($type, $amount, $detail) {
+        DB::transaction(function () use ($type, $amount, $notes) {
             $type = WalletEnums::tryFrom($type);
             $wallet = $this->wallets()->firstOrCreate(['type' => $type]);
-            $wallet->incrementAndCreateLog($amount, $detail);
+            $wallet->incrementAndCreateLog($amount, $notes);
         });
 
         return true;
@@ -63,4 +63,4 @@ private function isRequestValid($type, array $depositable)
 
         return true;
     }
-}
+}

src/Traits/HandlesPayment.php

@@ -13,13 +13,13 @@ trait HandlesPayment
      *
      * @throws InsufficientBalanceException
      */
-    public function pay(int|float $orderValue, $detail = null): void
+    public function pay(int|float $orderValue, $notes = null): void
     {
         if (! $this->hasSufficientBalance($orderValue)) {
             throw new InsufficientBalanceException('Insufficient balance to cover the order.');
         }
 
-        DB::transaction(function () use ($orderValue, $detail) {
+        DB::transaction(function () use ($orderValue, $notes) {
             $remainingOrderValue = $orderValue;
 
             $walletsInOrder = $this->wallets()->whereIn('type', $this->walletsInOrder())->get();
@@ -30,7 +30,7 @@ public function pay(int|float $orderValue, $detail = null): void
                 }
 
                 $amountToDeduct = min($wallet->balance, $remainingOrderValue);
-                $wallet->decrementAndCreateLog($amountToDeduct, $detail);
+                $wallet->decrementAndCreateLog($amountToDeduct, $notes);
                 $remainingOrderValue -= $amountToDeduct;
 
                 if ($remainingOrderValue <= 0) {
@@ -43,4 +43,4 @@ public function pay(int|float $orderValue, $detail = null): void
             }
         });
     }
-}
+}