From 444b194019e32a2340e815e8514fafc67ac5f6ef Mon Sep 17 00:00:00 2001
From: JiaJia Ji <kingjia90@gmail.com>
Date: Mon, 12 Dec 2022 14:44:03 +0100
Subject: [PATCH] [Task]: Setup Phpstan #4 (#4)

* Task: Setup PHPStan

* Task: Add phpstan require-dev

* Task: fix handleResponse phpdoc

* Task: add/fix phpdoc params and return

* Apply php-cs-fixer changes

* fix missing null in phpdocblock

Co-authored-by: kingjia90 <kingjia90@users.noreply.github.com>
---
 .github/ci/files/.env                         |  1 +
 .../ci/scripts/setup-pimcore-environment.sh   |  5 ++
 .github/workflows/static-analysis.yml         | 50 +++++++++++++++++++
 composer.json                                 |  3 ++
 phpstan-baseline.neon                         |  2 +
 phpstan-bootstrap.php                         | 19 +++++++
 phpstan.neon                                  |  8 +++
 src/PaymentManager/Payment/Klarna.php         | 19 +++++--
 8 files changed, 102 insertions(+), 5 deletions(-)
 create mode 100644 .github/ci/files/.env
 create mode 100755 .github/ci/scripts/setup-pimcore-environment.sh
 create mode 100644 .github/workflows/static-analysis.yml
 create mode 100644 phpstan-baseline.neon
 create mode 100644 phpstan-bootstrap.php
 create mode 100644 phpstan.neon

diff --git a/.github/ci/files/.env b/.github/ci/files/.env
new file mode 100644
index 0000000..4250748
--- /dev/null
+++ b/.github/ci/files/.env
@@ -0,0 +1 @@
+APP_ENV=test
\ No newline at end of file
diff --git a/.github/ci/scripts/setup-pimcore-environment.sh b/.github/ci/scripts/setup-pimcore-environment.sh
new file mode 100755
index 0000000..95116c5
--- /dev/null
+++ b/.github/ci/scripts/setup-pimcore-environment.sh
@@ -0,0 +1,5 @@
+#!/bin/bash
+
+set -eu -o xtrace
+
+cp .github/ci/files/.env .
\ No newline at end of file
diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
new file mode 100644
index 0000000..3050e5e
--- /dev/null
+++ b/.github/workflows/static-analysis.yml
@@ -0,0 +1,50 @@
+name: "Static Analysis"
+
+on:
+    pull_request:
+        branches:
+            - "[0-9]+.[0-9]+"
+            - "[0-9]+.x"
+    push:
+        branches:
+            - "[0-9]+.[0-9]+"
+            - "[0-9]+.x"
+
+jobs:
+    static-analysis-phpstan:
+        name: "Static Analysis with PHPStan"
+        runs-on: "ubuntu-20.04"
+        strategy:
+            matrix:
+                include:
+                    - { php-version: 8.0, database: "mariadb:10.7", pimcore_version: "", dependencies: lowest, experimental: false }
+                    - { php-version: 8.1, database: "mariadb:10.7", pimcore_version: "", dependencies: highest, experimental: false }
+        steps:
+            - name: "Checkout code"
+              uses: "actions/checkout@v2"
+
+            - name: "Install PHP"
+              uses: "shivammathur/setup-php@v2"
+              with:
+                  coverage: "none"
+                  php-version: "${{ matrix.php-version }}"
+
+            - name: "Setup Pimcore environment"
+              run: |
+                  .github/ci/scripts/setup-pimcore-environment.sh
+
+#            - name: "Update Pimcore version"
+#              env:
+#                  PIMCORE_VERSION: "${{ matrix.pimcore_version }}"
+#              run: |
+#                  if [ ! -z "$PIMCORE_VERSION" ]; then
+#                        composer require --no-update pimcore/pimcore:"${PIMCORE_VERSION}"
+#                  fi
+
+            - name: "Install dependencies with Composer"
+              uses: "ramsey/composer-install@v2"
+              with:
+                  dependency-versions: "${{ matrix.dependencies }}"
+
+            - name: "Run a static analysis with phpstan/phpstan"
+              run: "vendor/bin/phpstan analyse ${{ matrix.phpstan_args }} -c phpstan.neon --memory-limit=-1"
\ No newline at end of file
diff --git a/composer.json b/composer.json
index 0759aca..df3ff1a 100644
--- a/composer.json
+++ b/composer.json
@@ -10,6 +10,9 @@
     "klarna/checkout": "^3.0.0",
     "pimcore/pimcore": "^10.0.0"
   },
+  "require-dev": {
+    "phpstan/phpstan": "^1.9"
+  },
   "autoload": {
     "psr-4": {
       "Pimcore\\Bundle\\EcommerceFrameworkBundle\\": "src/"
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
new file mode 100644
index 0000000..364905f
--- /dev/null
+++ b/phpstan-baseline.neon
@@ -0,0 +1,2 @@
+parameters:
+	ignoreErrors:
diff --git a/phpstan-bootstrap.php b/phpstan-bootstrap.php
new file mode 100644
index 0000000..5aa99e2
--- /dev/null
+++ b/phpstan-bootstrap.php
@@ -0,0 +1,19 @@
+<?php
+
+if (file_exists(__DIR__ . '/vendor/autoload.php')) {
+    define('PIMCORE_PROJECT_ROOT', __DIR__);
+} elseif (file_exists(__DIR__ . '/../../../vendor/autoload.php')) {
+    define('PIMCORE_PROJECT_ROOT', __DIR__ . '/../../..');
+} elseif (getenv('PIMCORE_PROJECT_ROOT')) {
+    define('PIMCORE_PROJECT_ROOT', getenv('PIMCORE_PROJECT_ROOT'));
+} else {
+    throw new \Exception('Unknown configuration! Pimcore project root not found, please set env variable PIMCORE_PROJECT_ROOT.');
+}
+
+include PIMCORE_PROJECT_ROOT . '/vendor/autoload.php';
+\Pimcore\Bootstrap::setProjectRoot();
+\Pimcore\Bootstrap::bootstrap();
+
+if (!defined('PIMCORE_TEST')) {
+    define('PIMCORE_TEST', true);
+}
diff --git a/phpstan.neon b/phpstan.neon
new file mode 100644
index 0000000..b4359d6
--- /dev/null
+++ b/phpstan.neon
@@ -0,0 +1,8 @@
+parameters:
+    level: 5
+    paths:
+        - src
+    bootstrapFiles:
+        - phpstan-bootstrap.php
+includes:
+    - phpstan-baseline.neon
diff --git a/src/PaymentManager/Payment/Klarna.php b/src/PaymentManager/Payment/Klarna.php
index ca19697..f662ec6 100644
--- a/src/PaymentManager/Payment/Klarna.php
+++ b/src/PaymentManager/Payment/Klarna.php
@@ -108,7 +108,7 @@ public function getName()
      *
      * @param PriceInterface $price
      * @param array $config
-     * @param CartInterface  $cart
+     * @param null|CartInterface  $cart
      *
      * @return string
      *
@@ -157,7 +157,11 @@ public function startPayment(OrderAgentInterface $orderAgent, PriceInterface $pr
     }
 
     /**
-     * @inheritdoc
+     * Handles response of payment provider and creates payment status object
+     *
+     * @param StatusInterface|array $response
+     *
+     * @return StatusInterface
      */
     public function handleResponse($response)
     {
@@ -204,7 +208,7 @@ public function handleResponse($response)
     }
 
     /**
-     * @inheritdoc
+     * @return array
      */
     public function getAuthorizedData()
     {
@@ -220,7 +224,12 @@ public function setAuthorizedData(array $authorizedData)
     }
 
     /**
-     * @inheritdoc
+     * @param PriceInterface|null $price
+     * @param string|null $reference
+     *
+     * @return StatusInterface
+     *
+     * @throws \Exception
      */
     public function executeDebit(PriceInterface $price = null, $reference = null)
     {
@@ -274,7 +283,7 @@ public function executeCredit(PriceInterface $price, $reference, $transactionId)
     }
 
     /**
-     * @param string $uri
+     * @param string|null $uri
      *
      * @return \Klarna_Checkout_Order
      */