Add base LunarException and other updates to exceptions (#1348)

Added a base `LunarException` class (that extends the standard `Exception` class) adding more flexibility for users. All Lunar exceptions now extend from that instead. --- Added types for method arguments where missing (base Cart and Fieldtype exceptions). --- Added a missing translation in the base `CartException` class. --- Formatted according to most empty Laravel framework exceptions (ex [MathException.php](https://github.com/laravel/framework/blob/e574ffa03436a85d0aefccca9d8127746b3032aa/src/Illuminate/Support/Exceptions/MathException.php#L7-L10), [DeadlockException.php](https://github.com/laravel/framework/blob/e574ffa03436a85d0aefccca9d8127746b3032aa/src/Illuminate/Database/DeadlockException.php#L7-L10)) --- Feel free to request or push changes 👍 --------- Co-authored-by: Glenn Jacobs <[email protected]>
lunarphp · May 6, 2024 · 6e0752a · 6e0752a
1 parent e616cb0
commit 6e0752a
Show file tree

Hide file tree

Showing 23 changed files with 55 additions and 53 deletions.
diff --git a/packages/core/resources/lang/en/exceptions.php b/packages/core/resources/lang/en/exceptions.php
@@ -5,6 +5,7 @@
     'cart_line_id_mismatch' => 'This cart line does not belong to this cart',
     'invalid_cart_line_quantity' => 'Expected quantity to be at least "1", ":quantity" found.',
     'maximum_cart_line_quantity' => 'Quantity cannot exceed :quantity.',
+    'carts.invalid_action' => 'The cart action was invalid',
     'carts.shipping_missing' => 'A shipping address is required',
     'carts.billing_missing' => 'A billing address is required',
     'carts.billing_incomplete' => 'The billing address is incomplete',

diff --git a/packages/core/src/Exceptions/CartLineIdMismatchException.php b/packages/core/src/Exceptions/CartLineIdMismatchException.php
@@ -2,8 +2,7 @@
 
 namespace Lunar\Exceptions;
 
-use Exception;
-
-class CartLineIdMismatchException extends Exception
+class CartLineIdMismatchException extends LunarException
 {
+    //
 }
diff --git a/packages/core/src/Exceptions/Carts/BillingAddressIncompleteException.php b/packages/core/src/Exceptions/Carts/BillingAddressIncompleteException.php
@@ -4,4 +4,5 @@
 
 class BillingAddressIncompleteException extends CartException
 {
+    //
 }
diff --git a/packages/core/src/Exceptions/Carts/BillingAddressMissingException.php b/packages/core/src/Exceptions/Carts/BillingAddressMissingException.php
@@ -4,4 +4,5 @@
 
 class BillingAddressMissingException extends CartException
 {
+    //
 }
diff --git a/packages/core/src/Exceptions/Carts/CartException.php b/packages/core/src/Exceptions/Carts/CartException.php
@@ -2,34 +2,32 @@
 
 namespace Lunar\Exceptions\Carts;
 
-use Exception;
 use Illuminate\Contracts\Support\MessageBag;
+use Lunar\Exceptions\LunarException;
 
-class CartException extends Exception
+class CartException extends LunarException
 {
     /**
-     * The cart exception message bag
+     * The cart exception message bag.
      */
     protected MessageBag $messageBag;
 
-    public function __construct(MessageBag $messageBag = null)
+    public function __construct(MessageBag $messageBag)
     {
         parent::__construct(static::summarize($messageBag));
+
         $this->messageBag = $messageBag;
     }
 
     /**
-     * Create an error message summary from the validation errors.
-     *
-     * @param  \Illuminate\Contracts\Validation\Validator  $validator
-     * @return string
+     * Create a summary from the error messages.
      */
-    protected static function summarize($messageBag)
+    protected static function summarize(MessageBag $messageBag): string
     {
         $messages = $messageBag->all();
 
         if (! count($messages) || ! is_string($messages[0])) {
-            return 'The cart action was invalid';
+            return __('lunar::exceptions.carts.invalid_action');
         }
 
         $message = array_shift($messages);
@@ -43,7 +41,10 @@ protected static function summarize($messageBag)
         return $message;
     }
 
-    public function errors()
+    /**
+     * Get the error message bag.
+     */
+    public function errors(): MessageBag
     {
         return $this->messageBag;
     }

diff --git a/packages/core/src/Exceptions/Carts/OrderExistsException.php b/packages/core/src/Exceptions/Carts/OrderExistsException.php
@@ -4,4 +4,5 @@
 
 class OrderExistsException extends CartException
 {
+    //
 }
diff --git a/packages/core/src/Exceptions/Carts/ShippingAddressIncompleteException.php b/packages/core/src/Exceptions/Carts/ShippingAddressIncompleteException.php
@@ -4,4 +4,5 @@
 
 class ShippingAddressIncompleteException extends CartException
 {
+    //
 }
diff --git a/packages/core/src/Exceptions/Carts/ShippingAddressMissingException.php b/packages/core/src/Exceptions/Carts/ShippingAddressMissingException.php
@@ -4,4 +4,5 @@
 
 class ShippingAddressMissingException extends CartException
 {
+    //
 }
diff --git a/packages/core/src/Exceptions/Carts/ShippingOptionMissingException.php b/packages/core/src/Exceptions/Carts/ShippingOptionMissingException.php
@@ -4,4 +4,5 @@
 
 class ShippingOptionMissingException extends CartException
 {
+    //
 }
diff --git a/packages/core/src/Exceptions/CustomerNotBelongsToUserException.php b/packages/core/src/Exceptions/CustomerNotBelongsToUserException.php
@@ -2,8 +2,7 @@
 
 namespace Lunar\Exceptions;
 
-use Exception;
-
-class CustomerNotBelongsToUserException extends Exception
+class CustomerNotBelongsToUserException extends LunarException
 {
+    //
 }
diff --git a/packages/core/src/Exceptions/DisallowMultipleCartOrdersException.php b/packages/core/src/Exceptions/DisallowMultipleCartOrdersException.php
@@ -2,9 +2,7 @@
 
 namespace Lunar\Exceptions;
 
-use Exception;
-
-class DisallowMultipleCartOrdersException extends Exception
+class DisallowMultipleCartOrdersException extends LunarException
 {
     public function __construct()
     {

diff --git a/packages/core/src/Exceptions/FieldTypeException.php b/packages/core/src/Exceptions/FieldTypeException.php
@@ -2,8 +2,7 @@
 
 namespace Lunar\Exceptions;
 
-use Exception;
-
-class FieldTypeException extends Exception
+class FieldTypeException extends LunarException
 {
+    //
 }
diff --git a/packages/core/src/Exceptions/FieldTypes/FieldTypeMissingException.php b/packages/core/src/Exceptions/FieldTypes/FieldTypeMissingException.php
@@ -2,11 +2,11 @@
 
 namespace Lunar\Exceptions\FieldTypes;
 
-use Exception;
+use Lunar\Exceptions\LunarException;
 
-class FieldTypeMissingException extends Exception
+class FieldTypeMissingException extends LunarException
 {
-    public function __construct($classname)
+    public function __construct(string $classname)
     {
         $this->message = __('lunar::exceptions.fieldtype_missing', [
             'class' => $classname,

diff --git a/packages/core/src/Exceptions/FieldTypes/InvalidFieldTypeException.php b/packages/core/src/Exceptions/FieldTypes/InvalidFieldTypeException.php
@@ -2,11 +2,11 @@
 
 namespace Lunar\Exceptions\FieldTypes;
 
-use Exception;
+use Lunar\Exceptions\LunarException;
 
-class InvalidFieldTypeException extends Exception
+class InvalidFieldTypeException extends LunarException
 {
-    public function __construct($classname)
+    public function __construct(string $classname)
     {
         $this->message = __('lunar::exceptions.invalid_fieldtype', [
             'class' => $classname,

diff --git a/packages/core/src/Exceptions/FingerprintMismatchException.php b/packages/core/src/Exceptions/FingerprintMismatchException.php
@@ -2,8 +2,7 @@
 
 namespace Lunar\Exceptions;
 
-use Exception;
-
-class FingerprintMismatchException extends Exception
+class FingerprintMismatchException extends LunarException
 {
+    //
 }
diff --git a/packages/core/src/Exceptions/InvalidCartLineQuantityException.php b/packages/core/src/Exceptions/InvalidCartLineQuantityException.php
@@ -2,8 +2,7 @@
 
 namespace Lunar\Exceptions;
 
-use Exception;
-
-class InvalidCartLineQuantityException extends Exception
+class InvalidCartLineQuantityException extends LunarException
 {
+    //
 }
diff --git a/packages/core/src/Exceptions/InvalidDataTypeValueException.php b/packages/core/src/Exceptions/InvalidDataTypeValueException.php
@@ -2,8 +2,7 @@
 
 namespace Lunar\Exceptions;
 
-use Exception;
-
-class InvalidDataTypeValueException extends Exception
+class InvalidDataTypeValueException extends LunarException
 {
+    //
 }
diff --git a/packages/core/src/Exceptions/InvalidPaymentTypeException.php b/packages/core/src/Exceptions/InvalidPaymentTypeException.php
@@ -2,8 +2,7 @@
 
 namespace Lunar\Exceptions;
 
-use Exception;
-
-class InvalidPaymentTypeException extends Exception
+class InvalidPaymentTypeException extends LunarException
 {
+    //
 }
diff --git a/packages/core/src/Exceptions/LunarException.php b/packages/core/src/Exceptions/LunarException.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Lunar\Exceptions;
+
+class LunarException extends \Exception
+{
+    //
+}
diff --git a/packages/core/src/Exceptions/MaximumCartLineQuantityException.php b/packages/core/src/Exceptions/MaximumCartLineQuantityException.php
@@ -2,8 +2,7 @@
 
 namespace Lunar\Exceptions;
 
-use Exception;
-
-class MaximumCartLineQuantityException extends Exception
+class MaximumCartLineQuantityException extends LunarException
 {
+    //
 }
diff --git a/packages/core/src/Exceptions/MissingCurrencyPriceException.php b/packages/core/src/Exceptions/MissingCurrencyPriceException.php
@@ -2,8 +2,7 @@
 
 namespace Lunar\Exceptions;
 
-use Exception;
-
-class MissingCurrencyPriceException extends Exception
+class MissingCurrencyPriceException extends LunarException
 {
+    //
 }
diff --git a/packages/core/src/Exceptions/NonPurchasableItemException.php b/packages/core/src/Exceptions/NonPurchasableItemException.php
@@ -2,9 +2,7 @@
 
 namespace Lunar\Exceptions;
 
-use Exception;
-
-class NonPurchasableItemException extends Exception
+class NonPurchasableItemException extends LunarException
 {
     public function __construct(string $classname)
     {

diff --git a/packages/core/src/Exceptions/SchedulingException.php b/packages/core/src/Exceptions/SchedulingException.php
@@ -2,8 +2,7 @@
 
 namespace Lunar\Exceptions;
 
-use Exception;
-
-class SchedulingException extends Exception
+class SchedulingException extends LunarException
 {
+    //
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,4 +4,5 @@ @@
     class BillingAddressIncompleteException extends CartException
     {
+        //
     }