Task/49 Upgrade valinor (#86)

* Updates error handling for 2.x messages.
* Adds rector to the project.
* Update PHP container to PHP 8.4 to use property hooks
* Adds a custom rector rule to change phpstan hints for non-empty-strings to use property hook to validate when setting
* Adds a custom rector rule to change phpstan hints for non-negative-int to use property hook to validate when setting
* Add rector rule to turn positive-int var hints into a set hook property.
* Apply more set property hooks to value objects.
* Upgrades phpstan, phpcode sniffer dev  dependencies.

Author: omerida

.phpcs.xml

@@ -6,13 +6,22 @@
 
     <rule ref="Squiz.ControlStructures.ControlSignature">
         <properties>
-            <property name="requiredSpacesBeforeColon" value="0" />
+            <property name="requiredSpacesBeforeColon" value="1" />
         </properties>
     </rule>
+    <rule ref="PSR12.Functions.ReturnTypeDeclaration">
+        <exclude-pattern>src/Value/*</exclude-pattern>
+    </rule>
+    <rule ref="Squiz.Functions.MultiLineFunctionDeclaration.EmptyLine">
+        <exclude-pattern>src/Value/*</exclude-pattern>
+    </rule>
+
     <rule ref="PSR12">
         <exclude name="Squiz.Functions.MultiLineFunctionDeclaration.NewlineBeforeOpenBrace" />
         <exclude name="PSR1.Methods.CamelCapsMethodName.NotCamelCaps" />
         <exclude name="Squiz.Classes.ValidClassName.NotCamelCaps" />
+        <exclude name="Squiz.Functions.MultiLineFunctionDeclaration.Indent" />
+        <exclude name="Generic.WhiteSpace.ScopeIndent.Incorrect" />
     </rule>
 
     <rule ref="Generic.Files.LineLength">

README.md

@@ -15,4 +15,13 @@ Get Info about your agent:
 ./spacetraders agent
 ```
 
-Add the token to `.env` file to authenticate other requests.
+Add the token to `.env` file to authenticate other requests.
+
+## Branch Names
+
+For any PR, the commit hook will check the following requirements for a branch name:
+
+1. Must start with 'task/', 'bug/', or 'feature/'
+2. Must include an issue number (digits) followed by a dash.
+3. Must end with a descriptive slug (letters, numbers, dashes).
+

bin/rector.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+set -e
+
+CONTAINER="php"
+docker compose run \
+   --rm \
+   --workdir /var/www \
+   "$CONTAINER" \
+   ./vendor/bin/rector "$@"

cli/Command/Fleet/ExtractShipController.php

@@ -13,7 +13,7 @@
 use Phparch\SpaceTradersCLI\Render;
 
 #[HelpInfo(
-    description: "Extract mininerals at a waypoint.",
+    description: "Extract minerals at a waypoint.",
     params: ['ship symbol']
 )]
 class ExtractShipController extends CommandController
@@ -30,7 +30,6 @@ public function handle(): void
 
         try {
             $response = $client->extractShip($shipSymbol);
-            //$response = $this->getMock();
 
             $cooldown = new Render\Ship\Cooldown($response->cooldown);
             echo $cooldown->output();
@@ -42,7 +41,10 @@ public function handle(): void
         } catch (APIException $ex) {
             $error = new Render\Exception($ex);
             echo $error->output();
-            $cooldown = Value\Ship\CoolDown::fromArray($ex->data['cooldown']);
+
+            /** @var iterable<string, mixed> $raw */
+            $raw = $ex->data['cooldown'];
+            $cooldown = Value\Ship\CoolDown::fromArray($raw);
             $render = new Render\Ship\Cooldown($cooldown);
             echo $render->output();
         }

cli/Render/Agent.php

@@ -6,8 +6,7 @@ class Agent extends AbstractRenderer
 {
     public function __construct(
         public \Phparch\SpaceTraders\Value\Agent $agent,
-    )
-    {
+    ) {
     }
 
     public function output(): string

cli/Render/Exception.php

@@ -6,8 +6,7 @@ class Exception extends AbstractRenderer
 {
     public function __construct(
         public \Exception $ex,
-    )
-    {
+    ) {
     }
 
     public function output(): string

cli/Render/GoodsDetailList.php

@@ -9,8 +9,7 @@ class GoodsDetailList extends AbstractRenderer
     public function __construct(
         /** @var Detail[] $goods */
         public array $goods,
-    )
-    {
+    ) {
     }
 
     public function output(): string

cli/Render/Market.php

@@ -9,8 +9,7 @@ class Market extends AbstractRenderer
 {
     public function __construct(
         public Value\Market $market,
-    )
-    {
+    ) {
     }
 
     public function output(): string

cli/Render/Market/Transaction.php

@@ -9,8 +9,7 @@ class Transaction extends AbstractRenderer
 {
     public function __construct(
         public readonly Value\Market\Transaction $transaction,
-    )
-    {
+    ) {
     }
 
     public function output(): string

cli/Render/Market/TransactionsList.php

@@ -10,8 +10,7 @@ class TransactionsList extends AbstractRenderer
     public function __construct(
         /** @var Transaction[] $transactions */
         public array $transactions,
-    )
-    {
+    ) {
     }
 
     public function output(): string