HP-2116: Run pipelines on php-billing repo

.github/workflows/behat-tests.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: ['8.1']
+        php: ['8.1', '8.3']
         coverage-driver: [pcov]
     name: PHP ${{ matrix.php }}
     steps:

.github/workflows/phpunit-tests.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: ['8.1']
+        php: ['8.3']
         coverage-driver: [pcov]
     name: PHP ${{ matrix.php }}
     steps:

.github/workflows/psalm-analysis.yml

@@ -0,0 +1,44 @@
+name: Psalm Static Analysis
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: "0 9 * * 1"
+
+jobs:
+  psalm:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php: [ '8.3' ]
+        coverage-driver: [ pcov ]
+    name: PHP ${{ matrix.php }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: gmp
+          coverage: pcov
+          tools: composer:v2, infection
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: ${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
+
+      - name: Update composer
+        run: composer self-update
+
+      - name: Composer install
+        if: steps.composer-cache.outputs.cache-hit != 'true'
+        run: composer install -n
+
+      - name: Run Psalm
+        run: vendor/bin/psalm

composer.json

@@ -43,7 +43,7 @@
         }
     ],
     "require": {
-        "php": "^8.0",
+        "php": "^8.3",
         "moneyphp/money": "^3.0 | ^4.0",
         "hiqdev/php-units": "dev-master",
         "psr/simple-cache": "^1.0",
@@ -52,14 +52,15 @@
     "require-dev": {
         "ext-intl": "*",
         "behat/behat": "^3.4.3",
-        "phpunit/phpunit": "^8.1",
+        "phpunit/phpunit": "^10.0.0",
         "league/event": "^2.1",
         "hoa/ruler": "^2.17",
         "hiqdev/hidev": "dev-master",
         "hiqdev/hidev-php": "dev-master",
         "hiqdev/hidev-behat": "dev-master",
         "hiqdev/hidev-hiqdev": "dev-master",
-        "vimeo/psalm": "^3.0",
+        "hiqdev/php-data-mapper": "dev-master",
+        "vimeo/psalm": "^5.0",
         "cache/array-adapter": "*",
         "matthiasnoback/behat-expect-exception": "^v0.3.0"
     },

phpunit.xml.dist

@@ -5,9 +5,13 @@
             <directory>./tests/unit/</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist addUncoveredFilesFromWhitelist="true">
+
+    <coverage>
+        <include>
             <directory suffix=".php">./src/</directory>
-        </whitelist>
-    </filter>
+        </include>
+        <exclude>
+            <directory suffix=".php">./vendor/</directory>
+        </exclude>
+    </coverage>
 </phpunit>

psalm.xml

@@ -1,12 +1,25 @@
 <?xml version="1.0"?>
 <psalm
-    totallyTyped="false"
+    errorLevel="5"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
     xmlns="https://getpsalm.org/schema/config"
-    xsi:schemaLocation="https://getpsalm.org/schema/config file:///Users/silverfire/prj/github/hiqdev/php-billing/vendor/vimeo/psalm/config.xsd"
+    strictBinaryOperands="true"
+    allowStringToStandInForClass="true"
+    usePhpDocPropertiesWithoutMagicCall="true"
+    usePhpDocMethodsWithoutMagicCall="true"
+    ignoreInternalFunctionNullReturn="false"
+    findUnusedVariablesAndParams="true"
+    findUnusedPsalmSuppress="true"
+    ensureArrayStringOffsetsExist="true"
+    ensureArrayIntOffsetsExist="true"
+    ignoreInternalFunctionFalseReturn="false"
 >
     <projectFiles>
         <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
     </projectFiles>
 
     <issueHandlers>
@@ -23,7 +36,6 @@
         <MissingReturnType errorLevel="info" />
         <MissingPropertyType errorLevel="info" />
         <InvalidDocblock errorLevel="info" />
-        <MisplacedRequiredParam errorLevel="info" />
 
         <PropertyNotSetInConstructor errorLevel="info" />
         <MissingConstructor errorLevel="info" />
@@ -43,7 +55,6 @@
 
         <MoreSpecificReturnType errorLevel="info" />
         <LessSpecificReturnStatement errorLevel="info" />
-        <TypeCoercion errorLevel="info" />
 
         <PossiblyFalseArgument errorLevel="info" />
         <PossiblyFalseIterator errorLevel="info" />

src/Money/MultipliedMoney.php

@@ -4,7 +4,7 @@
 
 namespace hiqdev\php\billing\Money;
 
-use Laminas\Code\Reflection\Exception\InvalidArgumentException;
+use InvalidArgumentException;
 use Money\Currencies\ISOCurrencies;
 use Money\Currency;
 use Money\Money;
@@ -86,7 +86,7 @@ private static function calculateMultiplierToInteger(string $amount): int
             return 1;
         }
 
-        [$integer, $fraction] = explode('.', $amount, 2);
+        [, $fraction] = explode('.', $amount, 2);
         return (int)('1' . implode(array_fill(0, strlen($fraction), 0)));
     }
 

src/action/AbstractAction.php

@@ -13,7 +13,6 @@
 use DateInterval;
 use DateTimeImmutable;
 use hiqdev\php\billing\customer\CustomerInterface;
-use hiqdev\php\billing\EntityInterface;
 use hiqdev\php\billing\Exception\CannotReassignException;
 use hiqdev\php\billing\sale\SaleInterface;
 use hiqdev\php\billing\target\TargetInterface;
@@ -27,7 +26,7 @@
  *
  * @author Andrii Vasyliev <sol@hiqdev.com>
  */
-abstract class AbstractAction implements ActionInterface, EntityInterface
+abstract class AbstractAction implements \JsonSerializable, ActionInterface
 {
     /** @var int */
     protected $id;

src/action/ActionInterface.php

@@ -12,6 +12,7 @@
 
 use DateTimeImmutable;
 use hiqdev\php\billing\customer\CustomerInterface;
+use hiqdev\php\billing\EntityInterface;
 use hiqdev\php\billing\price\PriceInterface;
 use hiqdev\php\billing\sale\SaleInterface;
 use hiqdev\php\billing\target\TargetInterface;
@@ -30,7 +31,7 @@
  *
  * @author Andrii Vasyliev <sol@hiqdev.com>
  */
-interface ActionInterface extends \JsonSerializable
+interface ActionInterface extends EntityInterface
 {
     /**
      * Returns if the given price applicable to this action.

src/charge/modifiers/FixedDiscount.php

@@ -45,7 +45,7 @@ public function getValue(ChargeInterface $charge = null): Discount
 
     public function isAbsolute()
     {
-        return $this->getAddon(self::VALUE)->isAbsolute();
+        return $this->getValue()->isAbsolute();
     }
 
     public function isRelative()

src/charge/modifiers/FullCombination.php

@@ -57,7 +57,7 @@ public function modifyCharge(?ChargeInterface $charge, ActionInterface $action):
                 return []; // If there was at least one charge, but it disappeared – modifier does not want this charge to happen. Stop.
             }
 
-            $originalChargeExists = array_reduce($leftCharges, function ($result, Charge $item) use ($charge) {
+            $originalChargeExists = array_reduce($leftCharges, static function ($result, Charge $item) use ($charge) {
                 return $result || $charge === $item;
             }, false);
             if ($charge && !$originalChargeExists) {
@@ -66,7 +66,6 @@ public function modifyCharge(?ChargeInterface $charge, ActionInterface $action):
             // $leftCharge will contain original charge and 0+ additional charges (discounts)
         }
 
-        /** @var Charge $leftTotal */
         /** @var Charge $charge */
         $leftTotal = $this->sumCharges($charge, $leftCharges);
         if ($this->right->isSuitable($leftTotal, $action)) {
@@ -78,7 +77,6 @@ public function modifyCharge(?ChargeInterface $charge, ActionInterface $action):
 
             $lastLeftCharge = end($leftCharges);
             $rightCharges = array_filter($dirtyRightCharges, function (ChargeInterface $charge) use ($leftTotal, $lastLeftCharge) {
-                /** @var Charge $charge */
                 if ($charge->getParent() === $leftTotal) {
                     $charge->overwriteParent($lastLeftCharge);
                 }
@@ -109,6 +107,7 @@ public function modifyCharge(?ChargeInterface $charge, ActionInterface $action):
                 $charge->setComment($leftTotal->getComment());
             }
 
+            /** @var Charge $leftTotal */
             $events = $leftTotal->releaseEvents();
             if (!empty($events)) {
                 foreach ($events as $event) {

src/charge/modifiers/Installment.php

@@ -56,7 +56,7 @@ public function getTarget()
         return new Target(Target::ANY, Target::ANY);
     }
 
-    public function till($dummy)
+    public function till($time)
     {
         throw new FormulaSemanticsError('till can not be defined for installment');
     }
@@ -154,7 +154,7 @@ private function createInstallmentFinishingCharge(ChargeInterface $charge, DateT
         return $result;
     }
 
-    private function createInstallmentStartingCharge(ChargeInterface $charge, DateTimeImmutable $month): ChargeInterface
+    private function createInstallmentStartingCharge(Charge $charge, DateTimeImmutable $month): ChargeInterface
     {
         $charge->recordThat(InstallmentWasStarted::onCharge($charge, $month));
 

src/charge/modifiers/addons/Period.php

@@ -74,5 +74,5 @@ public static function ensureValidValue($value)
      *
      * @return DateTimeImmutable time of period end
      */
-    abstract public function addTo(DateTimeImmutable $startTime): DateTimeImmutable;
+    abstract public function addTo(DateTimeImmutable $since): DateTimeImmutable;
 }

src/formula/Asserter.php

@@ -13,6 +13,7 @@
 use hiqdev\php\billing\charge\modifiers\FullCombination;
 use Hoa\Ruler\Context;
 use Hoa\Ruler\Model\Model;
+use Hoa\Visitor\Element;
 
 /**
  * @author Andrii Vasyliev <sol@hiqdev.com>
@@ -35,6 +36,11 @@ public function makeAnd($lhs, $rhs)
 
     public function visitModel(Model $element, &$handle = null, $eldnah = null)
     {
-        return $element->getExpression()->accept($this, $handle, $eldnah);
+        return $this->getExpression($element)->accept($this, $handle, $eldnah);
+    }
+
+    private function getExpression(Model $element): Element
+    {
+        return $element->getExpression();
     }
 }

src/order/Calculator.php

@@ -11,7 +11,6 @@
 namespace hiqdev\php\billing\order;
 
 use Exception;
-use hiqdev\php\billing\action\Action;
 use hiqdev\php\billing\action\ActionInterface;
 use hiqdev\php\billing\action\TemporaryActionInterface;
 use hiqdev\php\billing\charge\Charge;
@@ -23,7 +22,6 @@
 use hiqdev\php\billing\plan\PlanInterface;
 use hiqdev\php\billing\plan\PlanRepositoryInterface;
 use hiqdev\php\billing\price\PriceInterface;
-use hiqdev\php\billing\sale\Sale;
 use hiqdev\php\billing\sale\SaleInterface;
 use hiqdev\php\billing\sale\SaleRepositoryInterface;
 use hiqdev\php\billing\tools\ActualDateTimeProvider;
@@ -63,14 +61,12 @@ public function calculateOrder(OrderInterface $order): array
         $plans = $this->findPlans($order);
         $charges = [];
         foreach ($order->getActions() as $actionKey => $action) {
-            if ($plans[$actionKey] === null) {
-                continue;
-            }
-
-            try {
-                $charges = array_merge($charges, $this->calculatePlan($plans[$actionKey], $action));
-            } catch (Throwable $e) {
-                throw ActionChargingException::forAction($action, $e);
+            if (!empty($plans[$actionKey])) {
+                try {
+                    $charges = array_merge($charges, $this->calculatePlan($plans[$actionKey], $action));
+                } catch (Throwable $e) {
+                    throw ActionChargingException::forAction($action, $e);
+                }
             }
         }
 
@@ -157,19 +153,15 @@ public function calculateCharge(PriceInterface $price, ActionInterface $action):
 
     /**
      * @throws Exception
-     * @return PlanInterface[]|Plan
+     * @return PlanInterface[]
      */
-    private function findPlans(OrderInterface $order)
+    private function findPlans(OrderInterface $order): array
     {
         $sales = $this->findSales($order);
         $plans = [];
         $lookPlanIds = [];
         foreach ($order->getActions() as $actionKey => $action) {
-            /** @var Action $action */
-            if ($sales[$actionKey] === false) {
-                /// it is ok when no sale found for upper resellers
-                $plans[$actionKey] = null;
-            } else {
+            if (!empty($sales[$actionKey])) {
                 $sale = $sales[$actionKey];
                 /** @var Plan|PlanInterface[] $plan */
                 $plan = $sale->getPlan();
@@ -185,12 +177,15 @@ private function findPlans(OrderInterface $order)
                 } else {
                     $plans[$actionKey] = null;
                 }
+            } else {
+                // It is ok when no sale found for upper resellers
+                $plans[$actionKey] = null;
             }
         }
 
         if ($lookPlanIds) {
             $foundPlans = $this->planRepository->findByIds($lookPlanIds);
-            foreach ($foundPlans as $actionKey => $plan) {
+            foreach ($foundPlans as $plan) {
                 $foundPlans[$plan->getId()] = $plan;
             }
             foreach ($lookPlanIds as $actionKey => $planId) {
@@ -205,9 +200,10 @@ private function findPlans(OrderInterface $order)
     }
 
     /**
-     * @return SaleInterface[]|Sale
+     * @param OrderInterface $order
+     * @return SaleInterface[]
      */
-    private function findSales(OrderInterface $order)
+    private function findSales(OrderInterface $order): array
     {
         $sales = [];
         $lookActions = [];