HP-2824: Fix Failing Psalm Static Analysis in php-billing Composer Package Build (#111)

* AHN-131: Fix Failing Psalm Static Analysis in php-billing Composer Package Build

* AHN-131: removed unused CannotReassignException::getField() method

* AHN-131: removed unused CannotReassignException::$field property

* HP-2824: added context to ChargeOverlappingException class and removed ChargeOverlappingException::getCharge() method

* HP-2824: added context to ChargeStealingException class and removed ChargeStealingException::getCharge() method

* HP-2824: The context key 'filed' is a typo for 'field', and will cause problems for code inspecting context by this key.

* HP-2824: fixed template for PriceTypeCollection

* HP-2824: Remove the unused $charge property.

Author: VadymHrechukha

psalm.xml

@@ -14,6 +14,7 @@
     ensureArrayStringOffsetsExist="true"
     ensureArrayIntOffsetsExist="true"
     ignoreInternalFunctionFalseReturn="false"
+    ensureOverrideAttribute="false"
 >
     <projectFiles>
         <directory name="src" />

src/Exception/ActionChargingException.php

@@ -3,6 +3,8 @@
 
 namespace hiqdev\php\billing\Exception;
 
+use hidev\exception\HasContext;
+use hidev\exception\HasContextInterface;
 use hiqdev\php\billing\action\ActionInterface;
 use Throwable;
 
@@ -12,9 +14,9 @@
  *
  * @author Dmytro Naumenko <d.naumenko.a@gmail.com>
  */
-final class ActionChargingException extends RuntimeException
+final class ActionChargingException extends RuntimeException implements HasContextInterface
 {
-    private readonly ActionInterface $action;
+    use HasContext;
 
     public static function forAction(ActionInterface $action, Throwable $previousException): self
     {
@@ -32,13 +34,8 @@ public static function forAction(ActionInterface $action, Throwable $previousExc
         }
 
         $self = new self($message, 0, $previousException);
-        $self->action = $action;
+        $self->addContext(['action' => $action]);
 
         return $self;
     }
-
-    public function getAction(): ActionInterface
-    {
-        return $this->action;
-    }
 }

src/Exception/CannotReassignException.php

@@ -11,24 +11,22 @@
 namespace hiqdev\php\billing\Exception;
 
 use Exception;
+use hidev\exception\HasContext;
+use hidev\exception\HasContextInterface;
 use hiqdev\php\billing\ExceptionInterface;
 use Throwable;
 
 /**
  * @author Andrii Vasyliev <sol@hiqdev.com>
  */
-class CannotReassignException extends Exception implements ExceptionInterface
+class CannotReassignException extends Exception implements ExceptionInterface, HasContextInterface
 {
-    private $field;
+    use HasContext;
 
-    public function __construct(string $message, int $code = 0, Throwable $previous = null)
+    public function __construct(string $message, int $code = 0, ?Throwable $previous = null)
     {
-        $this->field = $message;
-        parent::__construct("cannot reassign $message", $code, $previous);
-    }
+        $this->addContext(['field' => $message]);
 
-    public function getField()
-    {
-        return $this->field;
+        parent::__construct("cannot reassign $message", $code, $previous);
     }
 }

src/Exception/ChargeOverlappingException.php

@@ -10,13 +10,15 @@
 
 namespace hiqdev\php\billing\Exception;
 
+use hidev\exception\HasContext;
+use hidev\exception\HasContextInterface;
 use hiqdev\php\billing\charge\ChargeInterface;
 use hiqdev\php\billing\ExceptionInterface;
 use Exception;
 
-final class ChargeOverlappingException extends Exception implements ExceptionInterface
+final class ChargeOverlappingException extends Exception implements ExceptionInterface, HasContextInterface
 {
-    private ChargeInterface $charge;
+    use HasContext;
 
     public static function forCharge(ChargeInterface $charge): self
     {
@@ -25,13 +27,11 @@ public static function forCharge(ChargeInterface $charge): self
             $charge->getId(),
             $charge->getUniqueString()
         ));
-        $self->charge = $charge;
+        $self->addContext([
+            'chargeTypeName' => $charge->getType()->getName(),
+            'chargeActionTime' => $charge->getAction()->getTime()->format(DATE_ATOM),
+        ]);
 
         return $self;
     }
-
-    public function getCharge(): ChargeInterface
-    {
-        return $this->charge;
-    }
 }

src/Exception/ChargeStealingException.php

@@ -11,6 +11,8 @@
 
 namespace hiqdev\php\billing\Exception;
 
+use hidev\exception\HasContext;
+use hidev\exception\HasContextInterface;
 use hiqdev\php\billing\charge\ChargeInterface;
 use hiqdev\php\billing\ExceptionInterface;
 use Exception;
@@ -21,17 +23,17 @@
  *
  * @author Dmytro Naumenko <d.naumenko.a@gmail.com>
  */
-final class ChargeStealingException extends Exception implements ExceptionInterface
+final class ChargeStealingException extends Exception implements ExceptionInterface, HasContextInterface
 {
-    private ChargeInterface $charge;
+    use HasContext;
 
     public static function fromPdoException(ChargeInterface $charge, Exception $exception): self
     {
         $self = new self(sprintf(
             'Charge being saved tries to steal an existing charge from another bill: %s',
             self::trimExceptionMessage($exception->getMessage())
         ));
-        $self->charge = $charge;
+        $self->addContext(['charge' => $charge]);
 
         return $self;
     }
@@ -40,9 +42,4 @@ private static function trimExceptionMessage(string $message): string
     {
         return preg_replace('/^.+ERROR:\s+([^\n]+).+$/s', '$1', $message);
     }
-
-    public function getCharge(): ChargeInterface
-    {
-        return $this->charge;
-    }
 }

src/formula/FormulaEngine.php

@@ -232,7 +232,7 @@ private function getOnce(): ChargeModifier
         return $this->once;
     }
 
-    public function __clone(): void
+    public function __clone()
     {
         if ($this->context !== null) {
             $this->context = clone $this->context;

src/product/Domain/Model/Price/PriceTypeCollection.php

@@ -9,6 +9,9 @@
 use IteratorAggregate;
 use Traversable;
 
+/**
+ * @template-implements IteratorAggregate<int, PriceTypeInterface>
+ */
 class PriceTypeCollection implements IteratorAggregate, Countable
 {
     /**