Merge pull request #10 from n4ss1m/refactor_rector

Refactor: Enable Rector Rules for Code Quality and Strictness
PiteurStudio · Feb 2, 2025 · f1521f2 · f1521f2
2 parents 933757f + 241cbbf
commit f1521f2
Show file tree

Hide file tree

Showing 26 changed files with 150 additions and 87 deletions.
diff --git a/rector.php b/rector.php
@@ -3,10 +3,23 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
+use Rector\Set\ValueObject\SetList;
 
 return RectorConfig::configure()
     ->withPaths([
         __DIR__.'/src',
         __DIR__.'/tests',
     ])
+    ->withSets([
+        SetList::DEAD_CODE,
+        SetList::CODE_QUALITY,
+        SetList::CODING_STYLE,
+        SetList::TYPE_DECLARATION,
+        SetList::PRIVATIZATION,
+        SetList::NAMING,
+        SetList::RECTOR_PRESET,
+        SetList::STRICT_BOOLEANS,
+        SetList::EARLY_RETURN,
+        SetList::INSTANCEOF,
+    ])
     ->withPhpSets();
diff --git a/src/Contracts/ShippingProviderContract.php b/src/Contracts/ShippingProviderContract.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CourierDZ\Contracts;
 
 interface ShippingProviderContract

diff --git a/src/CourierDZ.php b/src/CourierDZ.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CourierDZ;
 
 use CourierDZ\Enum\ShippingProvider;
@@ -11,14 +13,14 @@ class CourierDZ
     /**
      * Create a new ShippingService instance for the given provider.
      *
-     * @param  ShippingProvider  $provider  The provider to use
+     * @param  ShippingProvider  $shippingProvider  The provider to use
      * @param  array<non-empty-string, non-empty-string>  $credentials  The credentials to use for the provider
      *
      * @throws InvalidProviderException
      */
-    public static function provider(ShippingProvider $provider, array $credentials): ShippingService
+    public static function provider(ShippingProvider $shippingProvider, array $credentials): ShippingService
     {
-        return new ShippingService($provider->value, $credentials);
+        return new ShippingService($shippingProvider->value, $credentials);
     }
 
     /**

diff --git a/src/Enum/ShippingProvider.php b/src/Enum/ShippingProvider.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CourierDZ\Enum;
 
 enum ShippingProvider: string

diff --git a/src/Exceptions/CreateOrderException.php b/src/Exceptions/CreateOrderException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CourierDZ\Exceptions;
 
 use Exception;

diff --git a/src/Exceptions/CreateOrderValidationException.php b/src/Exceptions/CreateOrderValidationException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CourierDZ\Exceptions;
 
 use Exception;

diff --git a/src/Exceptions/CredentialsException.php b/src/Exceptions/CredentialsException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CourierDZ\Exceptions;
 
 use Exception;

diff --git a/src/Exceptions/FunctionNotSupportedException.php b/src/Exceptions/FunctionNotSupportedException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CourierDZ\Exceptions;
 
 use Exception;

diff --git a/src/Exceptions/HttpException.php b/src/Exceptions/HttpException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CourierDZ\Exceptions;
 
 use Exception;

diff --git a/src/Exceptions/InvalidProviderException.php b/src/Exceptions/InvalidProviderException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CourierDZ\Exceptions;
 
 use Exception;

diff --git a/src/Exceptions/NotImplementedException.php b/src/Exceptions/NotImplementedException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CourierDZ\Exceptions;
 
 use Exception;

diff --git a/src/Exceptions/TrackingIdNotFoundException.php b/src/Exceptions/TrackingIdNotFoundException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CourierDZ\Exceptions;
 
 use Exception;

diff --git a/src/ProviderIntegrations/EcotrackProviderIntegration.php b/src/ProviderIntegrations/EcotrackProviderIntegration.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CourierDZ\ProviderIntegrations;
 
 use CourierDZ\Contracts\ShippingProviderContract;
@@ -61,7 +63,7 @@ public function __construct(array $credentials)
         $provider_name = (static::metadata())['name'];
 
         if (! isset($credentials['token'])) {
-            throw new CredentialsException("{$provider_name} credentials must include 'token'.");
+            throw new CredentialsException($provider_name." credentials must include 'token'.");
         }
 
         $this->credentials = $credentials;
@@ -91,7 +93,7 @@ public function testCredentials(): bool
 
             // Define the headers
             $headers = [
-                'Authorization' => "Bearer {$this->credentials['token']}",
+                'Authorization' => 'Bearer '.$this->credentials['token'],
             ];
 
             // Make the GET request
@@ -109,9 +111,9 @@ public function testCredentials(): bool
                 // If the request returns any other status code, throw an HttpException
                 default => throw new HttpException('Ecotrack '.static::metadata()['name'].', Unexpected error occurred.'),
             };
-        } catch (GuzzleException $e) {
+        } catch (GuzzleException $guzzleException) {
             // Handle exceptions
-            throw new HttpException($e->getMessage());
+            throw new HttpException($guzzleException->getMessage());
         }
     }
 
@@ -126,7 +128,7 @@ public function getRates(?int $from_wilaya_id, ?int $to_wilaya_id): array
 
             // Define the headers
             $headers = [
-                'Authorization' => "Bearer {$this->credentials['token']}",
+                'Authorization' => 'Bearer '.$this->credentials['token'],
             ];
 
             // Make the GET request
@@ -142,7 +144,7 @@ public function getRates(?int $from_wilaya_id, ?int $to_wilaya_id): array
             $result = json_decode($body, true);
 
             // If the to_wilaya_id is specified, filter the result to only include the specified wilaya
-            if ($to_wilaya_id) {
+            if ($to_wilaya_id !== null && $to_wilaya_id !== 0) {
                 foreach ($result['livraison'] as $wilaya) {
                     if ($wilaya['wilaya_id'] == $to_wilaya_id) {
                         // Return the first matching wilaya
@@ -157,9 +159,9 @@ public function getRates(?int $from_wilaya_id, ?int $to_wilaya_id): array
             // Return the list of shipping rates
             return $result['livraison'];
 
-        } catch (GuzzleException $e) {
+        } catch (GuzzleException $guzzleException) {
             // Handle exceptions
-            throw new HttpException($e->getMessage());
+            throw new HttpException($guzzleException->getMessage());
         }
     }
 
@@ -191,7 +193,7 @@ public function createOrder(array $orderData): array
 
             // Define the headers
             $headers = [
-                'Authorization' => "Bearer {$this->credentials['token']}",
+                'Authorization' => 'Bearer '.$this->credentials['token'],
                 'Content-Type' => 'application/json',
             ];
 
@@ -214,9 +216,9 @@ public function createOrder(array $orderData): array
             // Return the order response
             return $arrayResponse;
 
-        } catch (GuzzleException $e) {
+        } catch (GuzzleException $guzzleException) {
             // Handle exceptions
-            throw new HttpException($e->getMessage());
+            throw new HttpException($guzzleException->getMessage());
         }
     }
 
@@ -231,7 +233,7 @@ public function orderLabel(string $orderId): array
 
             // Define the headers
             $headers = [
-                'Authorization' => "Bearer {$this->credentials['token']}",
+                'Authorization' => 'Bearer '.$this->credentials['token'],
             ];
 
             // Make the GET request
@@ -254,7 +256,7 @@ public function orderLabel(string $orderId): array
             // Get the response body
             $label = $response->getBody()->getContents();
 
-            if (empty($label)) {
+            if ($label === '' || $label === '0') {
                 throw new HttpException('Failed to retrieve label for order with tracking ID '.$orderId.' - Empty response from Ecotrack');
             }
 
@@ -270,9 +272,9 @@ public function orderLabel(string $orderId): array
                 'data' => $base64data,
             ];
 
-        } catch (GuzzleException $e) {
+        } catch (GuzzleException $guzzleException) {
             // Handle exceptions
-            throw new HttpException($e->getMessage());
+            throw new HttpException($guzzleException->getMessage());
         }
     }
 

diff --git a/src/ProviderIntegrations/ProcolisProviderIntegration.php b/src/ProviderIntegrations/ProcolisProviderIntegration.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CourierDZ\ProviderIntegrations;
 
 use CourierDZ\Contracts\ShippingProviderContract;
@@ -108,9 +110,9 @@ public function testCredentials(): bool
                 // If the request returns any other status code, throw an HttpException
                 default => throw new HttpException('Procolis, Unexpected error occurred.'),
             };
-        } catch (GuzzleException $e) {
+        } catch (GuzzleException $guzzleException) {
             // Handle exceptions
-            throw new HttpException($e->getMessage());
+            throw new HttpException($guzzleException->getMessage());
         }
 
     }
@@ -142,7 +144,7 @@ public function getRates(?int $from_wilaya_id, ?int $to_wilaya_id): array
             $result = json_decode($body, true);
 
             // If the to_wilaya_id is specified, filter the result to only include the specified wilaya
-            if ($to_wilaya_id) {
+            if ($to_wilaya_id !== null && $to_wilaya_id !== 0) {
                 $filteredResult = [];
                 foreach ($result as $wilaya) {
                     if ($wilaya['IDWilaya'] == $to_wilaya_id) {
@@ -163,9 +165,9 @@ public function getRates(?int $from_wilaya_id, ?int $to_wilaya_id): array
             // Decode JSON response
             return $result;
 
-        } catch (GuzzleException $e) {
+        } catch (GuzzleException $guzzleException) {
             // Handle exceptions
-            throw new HttpException($e->getMessage());
+            throw new HttpException($guzzleException->getMessage());
         }
     }
 
@@ -230,9 +232,9 @@ public function createOrder(array $orderData): array
             // Return the created order
             return $arrayResponse['Colis'][0];
 
-        } catch (GuzzleException $e) {
+        } catch (GuzzleException $guzzleException) {
             // Handle exceptions
-            throw new HttpException($e->getMessage());
+            throw new HttpException($guzzleException->getMessage());
         }
     }
 
@@ -280,9 +282,9 @@ public function getOrder(string $trackingId): array
             // Decode JSON response
             return $arrayResponse['Colis'][0];
 
-        } catch (GuzzleException $e) {
+        } catch (GuzzleException $guzzleException) {
             // Handle exceptions
-            throw new HttpException($e->getMessage());
+            throw new HttpException($guzzleException->getMessage());
         }
     }
 

diff --git a/src/ProviderIntegrations/YalidineProviderIntegration.php b/src/ProviderIntegrations/YalidineProviderIntegration.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace CourierDZ\ProviderIntegrations;
 
 use CourierDZ\Contracts\ShippingProviderContract;
@@ -122,9 +124,9 @@ public function testCredentials(): bool
 
             // Any other status code is considered an unexpected error
             throw new HttpException('Yalidine, Unexpected error occurred.');
-        } catch (GuzzleException $e) {
+        } catch (GuzzleException $guzzleException) {
             // Handle exceptions
-            throw new HttpException($e->getMessage());
+            throw new HttpException($guzzleException->getMessage());
         }
     }
 
@@ -156,9 +158,9 @@ public function getRates($from_wilaya_id, $to_wilaya_id): array
             // Return the response body as an array
             return json_decode($response->getBody()->getContents(), true);
 
-        } catch (GuzzleException $e) {
+        } catch (GuzzleException $guzzleException) {
             // Handle exceptions
-            throw new HttpException($e->getMessage());
+            throw new HttpException($guzzleException->getMessage());
         }
     }
 
@@ -210,9 +212,9 @@ public function createOrder(array $orderData): array
             // Return the created order
             return $arrayResponse[$orderData['id']];
 
-        } catch (GuzzleException $e) {
+        } catch (GuzzleException $guzzleException) {
             // Handle exceptions
-            throw new HttpException($e->getMessage());
+            throw new HttpException($guzzleException->getMessage());
         }
     }
 
@@ -262,9 +264,9 @@ public function getOrder(string $trackingId): array
 
             return $data['data'][0];
 
-        } catch (GuzzleException $e) {
+        } catch (GuzzleException $guzzleException) {
             // Handle exceptions
-            throw new HttpException($e->getMessage());
+            throw new HttpException($guzzleException->getMessage());
         }
     }
 }