Refactor PHPDoc comments and improve type hints in ItemMerchantFeeDeductible and MerchantFeeDeductibleTest

- Updated PHPDoc annotations to use 'list<string>' for fillable properties in ItemMerchantFeeDeductible.
- Enhanced type hints in MerchantFeeDeductibleTest for better clarity and maintainability.
- Removed unnecessary assertions and whitespace for cleaner test code.

Author: rez1dent3

src/Services/PrepareService.php

@@ -118,25 +118,28 @@ public function transferExtraLazy(
 
         $amountWithoutDiscount = $this->mathService->sub($amount, $discount, $toWallet->decimal_places);
         $depositAmount = $this->mathService->compare($amountWithoutDiscount, 0) === -1 ? '0' : $amountWithoutDiscount;
-        
+
         // Check if fee should be deducted from merchant's payout instead of added to customer's payment
         // This follows the exact same pattern as TaxService::getFee() which checks $wallet instanceof Taxable
         // The $to parameter is the product model that implements Wallet through HasWallet trait
         // We can check $to directly since it's the model that implements the interface
         $isMerchantFeeDeductible = $to instanceof MerchantFeeDeductible;
-        
+
         if ($isMerchantFeeDeductible) {
             // Fee is deducted from merchant's deposit
             $withdrawAmount = $depositAmount;
             $merchantDepositAmount = $this->mathService->sub($depositAmount, $fee, $toWallet->decimal_places);
             // Ensure merchant deposit amount is not negative
-            $merchantDepositAmount = $this->mathService->compare($merchantDepositAmount, 0) === -1 ? '0' : $merchantDepositAmount;
+            $merchantDepositAmount = $this->mathService->compare(
+                $merchantDepositAmount,
+                0
+            ) === -1 ? '0' : $merchantDepositAmount;
         } else {
             // Fee is added to customer's withdrawal (current behavior)
             $withdrawAmount = $this->mathService->add($depositAmount, $fee, $fromWallet->decimal_places);
             $merchantDepositAmount = $depositAmount;
         }
-        
+
         $extra = $this->extraDtoAssembler->create($meta);
         $withdrawOption = $extra->getWithdrawOption();
         $depositOption = $extra->getDepositOption();

src/Traits/HasGift.php

@@ -127,7 +127,10 @@ public function gift(Wallet $to, ProductInterface $product, bool $force = false)
                 $withdrawAmount = $amount;
                 $merchantDepositAmount = $mathService->sub($amount, $fee);
                 // Ensure merchant deposit amount is not negative
-                $merchantDepositAmount = $mathService->compare($merchantDepositAmount, 0) === -1 ? '0' : $merchantDepositAmount;
+                $merchantDepositAmount = $mathService->compare(
+                    $merchantDepositAmount,
+                    0
+                ) === -1 ? '0' : $merchantDepositAmount;
             } else {
                 // Fee is added to customer's withdrawal (current behavior)
                 $withdrawAmount = $mathService->add($amount, $fee);

tests/Infra/Factories/ItemMerchantFeeDeductibleFactory.php

@@ -24,4 +24,3 @@ public function definition(): array
         ];
     }
 }
-

tests/Infra/Models/ItemMerchantFeeDeductible.php

@@ -24,7 +24,7 @@ final class ItemMerchantFeeDeductible extends Model implements ProductLimitedInt
     use HasWallet;
 
     /**
-     * @var array<int, string>
+     * @var list<string>
      */
     protected $fillable = ['name', 'quantity', 'price'];
 
@@ -69,4 +69,3 @@ public function getFeePercent(): float
         return 5.0;
     }
 }
-

tests/Units/Domain/MerchantFeeDeductibleTest.php

@@ -36,7 +36,7 @@ public function testPay(): void
         // With MerchantFeeDeductible, customer pays only the product price (no fee added)
         $productPrice = $product->getAmountProduct($buyer);
         $fee = (int) $math->div($math->mul($productPrice, $product->getFeePercent()), 100);
-        
+
         // Customer only needs to deposit the product price
         $balance = $productPrice;
 
@@ -45,7 +45,6 @@ public function testPay(): void
 
         self::assertNotSame(0, $buyer->balanceInt);
         $transfer = $buyer->pay($product);
-        self::assertNotNull($transfer);
 
         $withdraw = $transfer->withdraw;
         $deposit = $transfer->deposit;
@@ -73,11 +72,12 @@ public function testPay(): void
 
     public function testGift(): void
     {
-        /**
-         * @var Buyer $santa
-         * @var Buyer $child
-         */
-        [$santa, $child] = BuyerFactory::times(2)->create();
+        /** @var \Illuminate\Database\Eloquent\Collection<int, Buyer> $buyers */
+        $buyers = BuyerFactory::times(2)->create();
+        /** @var Buyer $santa */
+        $santa = $buyers[0];
+        /** @var Buyer $child */
+        $child = $buyers[1];
         /** @var ItemMerchantFeeDeductible $product */
         $product = ItemMerchantFeeDeductibleFactory::new()->create([
             'quantity' => 1,
@@ -88,7 +88,7 @@ public function testGift(): void
 
         $productPrice = $product->getAmountProduct($santa);
         $fee = (int) $math->div($math->mul($productPrice, $product->getFeePercent()), 100);
-        
+
         // With MerchantFeeDeductible, customer pays only the product price
         $balance = $productPrice;
 
@@ -99,7 +99,6 @@ public function testGift(): void
         self::assertNotSame($santa->balanceInt, 0);
         self::assertSame($child->balanceInt, 0);
         $transfer = $santa->wallet->gift($child, $product);
-        self::assertNotNull($transfer);
 
         $withdraw = $transfer->withdraw;
         $deposit = $transfer->deposit;
@@ -131,11 +130,12 @@ public function testGiftFail(): void
         $this->expectExceptionCode(ExceptionInterface::INSUFFICIENT_FUNDS);
         $this->expectExceptionMessageStrict(trans('wallet::errors.insufficient_funds'));
 
-        /**
-         * @var Buyer $santa
-         * @var Buyer $child
-         */
-        [$santa, $child] = BuyerFactory::times(2)->create();
+        /** @var \Illuminate\Database\Eloquent\Collection<int, Buyer> $buyers */
+        $buyers = BuyerFactory::times(2)->create();
+        /** @var Buyer $santa */
+        $santa = $buyers[0];
+        /** @var Buyer $child */
+        $child = $buyers[1];
         /** @var ItemMerchantFeeDeductible $product */
         $product = ItemMerchantFeeDeductibleFactory::new()->create([
             'price' => 200,
@@ -173,12 +173,11 @@ public function testPayWithExactAmount(): void
         $buyer->deposit($productPrice);
         self::assertSame($buyer->balanceInt, $productPrice);
 
-        $transfer = $buyer->pay($product);
-        self::assertNotNull($transfer);
+        $buyer->pay($product);
 
         // Customer balance should be 0 after payment
         self::assertSame($buyer->balanceInt, 0);
-        
+
         // Merchant should receive product price minus fee
         $expectedMerchantAmount = $productPrice - $fee;
         self::assertSame($product->balanceInt, $expectedMerchantAmount);
@@ -216,19 +215,17 @@ public function testPayMultiWallet(): void
 
         // Pay from first wallet
         $transfer1 = $wallet1->pay($product);
-        self::assertNotNull($transfer1);
         self::assertSame($transfer1->status, Transfer::STATUS_PAID);
         self::assertSame($wallet1->balanceInt, 0);
-        
+
         $expectedMerchantAmount1 = $productPrice1 - $fee1;
         self::assertSame($product->balanceInt, $expectedMerchantAmount1);
 
         // Pay from second wallet
         $transfer2 = $wallet2->pay($product);
-        self::assertNotNull($transfer2);
         self::assertSame($transfer2->status, Transfer::STATUS_PAID);
         self::assertSame($wallet2->balanceInt, 0);
-        
+
         $expectedMerchantAmount2 = $productPrice2 - $fee2;
         self::assertSame($product->balanceInt, $expectedMerchantAmount1 + $expectedMerchantAmount2);
 
@@ -247,11 +244,12 @@ public function testPayMultiWallet(): void
 
     public function testTransfer(): void
     {
-        /**
-         * @var Buyer $from
-         * @var Buyer $to
-         */
-        [$from, $to] = BuyerFactory::times(2)->create();
+        /** @var \Illuminate\Database\Eloquent\Collection<int, Buyer> $buyers */
+        $buyers = BuyerFactory::times(2)->create();
+        /** @var Buyer $from */
+        $from = $buyers[0];
+        /** @var Buyer $to */
+        $to = $buyers[1];
 
         $math = app(MathServiceInterface::class);
         $amount = 100;
@@ -274,22 +272,19 @@ public function testTransfer(): void
         // Transfer from buyer to product (merchant)
         // With MerchantFeeDeductible, the merchant receives amount minus fee
         $transfer = $from->transfer($product, $amount);
-        self::assertNotNull($transfer);
         self::assertSame($transfer->status, Transfer::STATUS_TRANSFER);
 
         // From wallet should be empty
         self::assertSame($from->balanceInt, 0);
-        
+
         // Product (merchant) should receive amount minus fee
         $expectedMerchantAmount = $amount - $fee;
         self::assertSame($product->balanceInt, $expectedMerchantAmount);
         self::assertSame((int) $transfer->fee, $fee);
 
         // Transfer back from product to buyer
-        $transferBack = $product->transfer($from, $product->balanceInt);
-        self::assertNotNull($transferBack);
+        $product->transfer($from, $product->balanceInt);
         self::assertSame($from->balanceInt, $expectedMerchantAmount);
         self::assertSame($product->balanceInt, 0);
     }
 }
-