Merge pull request #639 from barbushin/Fix-pipeline-issues

Fix pipeline issues

Author: Sebbo94BY

.github/workflows/php.yml

@@ -7,38 +7,13 @@ on:
     branches: [ develop ]
 
 jobs:
-  provide_php_versions_json:
-    runs-on: ubuntu-20.04
-
-    steps:
-      # git clone + use PHP + composer install
-      - uses: actions/checkout@v2
-      - uses: shivammathur/setup-php@v2
-        with:
-          php-version: 8.0
-
-      - uses: "ramsey/composer-install@v1"
-
-      # to see the output
-      - run: vendor/bin/easy-ci php-versions-json
-
-      # here we create the json, we need the "id:" so we can use it in "outputs" bellow
-      -
-        id: output_data
-        run: echo "::set-output name=matrix::$(vendor/bin/easy-ci php-versions-json)"
-
-    # here, we save the result of this 1st phase to the "outputs"
-    outputs:
-        matrix: ${{ steps.output_data.outputs.matrix }}
-
   static-analysis:
     name: Static Analysis PHP ${{ matrix.php-versions }}
     runs-on: ${{ matrix.operating-system }}
-    needs: provide_php_versions_json
     strategy:
       matrix:
-        operating-system: ['ubuntu-latest', 'ubuntu-20.04']
-        php-versions: ${{ fromJson(needs.provide_php_versions_json.outputs.matrix) }}
+        operating-system: ['ubuntu-20.04']
+        php-versions: ['7.2', '7.3', '7.4', '8.0', '8.1']
 
     steps:
     - name: Setup PHP
@@ -66,6 +41,7 @@ jobs:
         key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
         restore-keys: |
           ${{ runner.os }}-composer-
+
     - name: Install dependencies
       if: steps.composer-cache.outputs.cache-hit != 'true'
       run: composer install --prefer-dist --no-progress --no-suggest
@@ -76,11 +52,10 @@ jobs:
   phpunit:
     name: PHP ${{ matrix.php-versions }} Unit Tests
     runs-on: ${{ matrix.operating-system }}
-    needs: provide_php_versions_json
     strategy:
       matrix:
-        operating-system: ['ubuntu-latest', 'ubuntu-20.04']
-        php-versions: ${{ fromJson(needs.provide_php_versions_json.outputs.matrix) }}
+        operating-system: ['ubuntu-20.04']
+        php-versions: ['7.2', '7.3', '7.4', '8.0', '8.1']
 
     steps:
     - name: Setup PHP
@@ -108,6 +83,7 @@ jobs:
         key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
         restore-keys: |
           ${{ runner.os }}-composer-
+
     - name: Install dependencies
       if: steps.composer-cache.outputs.cache-hit != 'true'
       run: composer install --prefer-dist --no-progress --no-suggest
@@ -156,6 +132,6 @@ jobs:
     - name: Run tests
       uses: paambaati/[email protected]
       env:
-        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        CC_TEST_REPORTER_ID: "945dfb58a832d233a3caeb84e3e6d3be212e8c7abcb48117fce63b9adcb43647"
       with:
         coverageCommand: ./vendor/bin/phpunit --testdox --stop-on-failure --coverage-clover=clover.xml

composer-require-checker.config.json

@@ -0,0 +1,18 @@
+{
+    "symbol-whitelist" : [
+        "null", "true", "false",
+        "static", "self", "parent",
+        "array", "string", "int", "float", "bool", "iterable", "callable", "void", "object", "mixed", "never",
+        "IMAP\\Connection"
+    ],
+    "php-core-extensions" : [
+        "Core",
+        "date",
+        "pcre",
+        "Phar",
+        "Reflection",
+        "SPL",
+        "standard"
+    ],
+    "scan-files" : []
+}

composer.json

@@ -30,7 +30,7 @@
         "ext-mbstring": "*"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "~3.0.0",
+        "friendsofphp/php-cs-fixer": "^3.4",
         "maglnet/composer-require-checker": "^2.0|^3.2",
         "nikic/php-parser": "^4.3,<4.7|^4.10",
         "paragonie/hidden-string": "^1.0",
@@ -39,15 +39,13 @@
         "povils/phpmnd": "^2.2",
         "psalm/plugin-phpunit": "^0.10.0|^0.15.1",
         "roave/security-advisories": "dev-master",
-        "sebastian/phpcpd": "^4.1|^6.0",
-        "symfony/symfony": "^5.4",
-        "symplify/easy-ci": "^9.4",
-        "vimeo/psalm": "^4.7"
+        "sebastian/phpcpd": "^4.1|^6.0"
     },
     "scripts": {
         "static-analysis": [
             "parallel-lint .php-cs-fixer.dist.php src tests examples",
             "phpcpd src tests",
+            "composer-require-checker check --config-file=composer-require-checker.config.json ./composer.json",
             "phpmnd ./ --exclude=./.github/ --exclude=./examples/ --exclude=./vendor/ --non-zero-exit-on-violation --hint",
             "php-cs-fixer fix --allow-risky=yes --no-interaction --dry-run -v",
             "psalm --show-info=false"

psalm.xml

@@ -1,21 +1,30 @@
 <?xml version="1.0"?>
 <psalm
-    totallyTyped="true"
-	findUnusedCode="true"
-    resolveFromConfigFile="true"
-    requireVoidReturnType="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
-    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    name="Psalm for php-imap"
+    useDocblockTypes="true"
+    errorLevel="1"
+    strictBinaryOperands="false"
+    rememberPropertyAssignmentsAfterCall="true"
+    checkForThrowsDocblock="false"
+    throwExceptionOnError="0"
+    findUnusedCode="false"
+    ensureArrayStringOffsetsExist="true"
+    ensureArrayIntOffsetsExist="true"
+    resolveFromConfigFile="true"
+    xsi:schemaLocation="https://getpsalm.org/schema/config config.xsd"
+    limitMethodComplexity="true"
     errorBaseline="./psalm.baseline.xml"
     cacheDirectory="./psalm/cache/"
+    findUnusedPsalmSuppress="true"
 >
     <projectFiles>
         <file name="./.php-cs-fixer.dist.php"/>
         <directory name="src"/>
-        <directory name="tests"/>
-        <directory name="examples"/>
         <ignoreFiles>
+            <directory name="tests"/>
+            <directory name="examples"/>
             <directory name="vendor"/>
         </ignoreFiles>
     </projectFiles>

src/PhpImap/DataPartInfo.php

@@ -109,8 +109,7 @@ protected function convertEncodingAfterFetch(): string
     {
         if (isset($this->charset) && !empty(\trim($this->charset))) {
             $this->data = $this->mail->decodeMimeStr(
-                (string) $this->data, // Data to convert
-                \trim($this->charset)
+                (string) $this->data // Data to convert
             );
         }
 

src/PhpImap/Imap.php

@@ -22,6 +22,7 @@
 use const SORTSIZE;
 use const SORTSUBJECT;
 use const SORTTO;
+use stdClass;
 use Throwable;
 use UnexpectedValueException;
 
@@ -572,6 +573,8 @@ static function (string $folder): string {
      * }> $body An indexed array of bodies (docblock is not complete)
      *
      * @todo flesh out array shape pending resolution of https://github.com/vimeo/psalm/issues/1518
+     *
+     * @psalm-pure
      */
     public static function mail_compose(array $envelope, array $body): string
     {
@@ -647,7 +650,7 @@ public static function mail_move(
     /**
      * @param false|resource $imap_stream
      */
-    public static function mailboxmsginfo($imap_stream): object
+    public static function mailboxmsginfo($imap_stream): stdClass
     {
         \imap_errors(); // flush errors
 
@@ -692,7 +695,7 @@ public static function open(
         array $params = []
     ) {
         if (\preg_match("/^\{.*\}(.*)$/", $mailbox, $matches)) {
-            $mailbox_name = $matches[1];
+            $mailbox_name = $matches[1] ?? '';
 
             if (!\mb_detect_encoding($mailbox_name, 'ASCII', true)) {
                 $mailbox = static::encodeStringToUtf7Imap($mailbox);
@@ -718,6 +721,8 @@ public static function open(
 
     /**
      * @param resource|false $imap_stream
+     *
+     * @psalm-pure
      */
     public static function ping($imap_stream): bool
     {
@@ -892,6 +897,9 @@ public static function setflag_full(
      * @param false|resource $imap_stream
      *
      * @psalm-param value-of<self::SORT_CRITERIA> $criteria
+     * @psalm-suppress InvalidArgument
+     *
+     * @todo InvalidArgument, although it's correct: Argument 3 of imap_sort expects int, bool provided https://www.php.net/manual/de/function.imap-sort.php
      *
      * @return int[]
      *
@@ -908,7 +916,7 @@ public static function sort(
         \imap_errors(); // flush errors
 
         $imap_stream = self::EnsureConnection($imap_stream, __METHOD__, 1);
-        $reverse = (bool) $reverse;
+        $reverse = $reverse;
 
         /** @var int */
         $criteria = $criteria;
@@ -952,11 +960,8 @@ public static function sort(
      *
      * @psalm-param SA_MESSAGES|SA_RECENT|SA_UNSEEN|SA_UIDNEXT|SA_UIDVALIDITY|SA_ALL $flags
      */
-    public static function status(
-        $imap_stream,
-        string $mailbox,
-        int $options
-    ): object {
+    public static function status($imap_stream, string $mailbox, int $options): stdClass
+    {
         $imap_stream = self::EnsureConnection($imap_stream, __METHOD__, 1);
 
         $mailbox = static::encodeStringToUtf7Imap($mailbox);
@@ -975,10 +980,8 @@ public static function status(
     /**
      * @param false|resource $imap_stream
      */
-    public static function subscribe(
-        $imap_stream,
-        string $mailbox
-    ): void {
+    public static function subscribe($imap_stream, string $mailbox): void
+    {
         $imap_stream = self::EnsureConnection($imap_stream, __METHOD__, 1);
 
         $mailbox = static::encodeStringToUtf7Imap($mailbox);
@@ -1042,6 +1045,8 @@ public static function unsubscribe(
      * Returns the provided string in UTF7-IMAP encoded format.
      *
      * @return string $str UTF-7 encoded string
+     *
+     * @psalm-pure
      */
     public static function encodeStringToUtf7Imap(string $str): string
     {
@@ -1058,6 +1063,8 @@ public static function encodeStringToUtf7Imap(string $str): string
      * Returns the provided string in UTF-8 encoded format.
      *
      * @return string $str, but UTF-8 encoded
+     *
+     * @psalm-pure
      */
     public static function decodeStringFromUtf7ImapToUtf8(string $str): string
     {
@@ -1076,6 +1083,8 @@ public static function decodeStringFromUtf7ImapToUtf8(string $str): string
      * @throws InvalidArgumentException if $maybe is not a valid resource
      *
      * @return resource
+     *
+     * @psalm-pure
      */
     private static function EnsureResource($maybe, string $method, int $argument)
     {
@@ -1105,6 +1114,8 @@ private static function EnsureConnection($maybe, string $method, int $argument)
 
     /**
      * @param array|false $errors
+     *
+     * @psalm-pure
      */
     private static function HandleErrors($errors, string $method): UnexpectedValueException
     {
@@ -1117,6 +1128,8 @@ private static function HandleErrors($errors, string $method): UnexpectedValueEx
 
     /**
      * @param scalar $msg_number
+     *
+     * @psalm-pure
      */
     private static function EnsureRange(
         $msg_number,

src/PhpImap/IncomingMail.php

@@ -4,7 +4,7 @@
 
 namespace PhpImap;
 
-use const FILEINFO_MIME;
+use const FILEINFO_MIME_TYPE;
 use InvalidArgumentException;
 
 /**
@@ -169,7 +169,7 @@ public function removeAttachment(string $id): bool
      */
     public function getInternalLinksPlaceholders(): array
     {
-        $fetchedHtml = (string) $this->__get('textHtml');
+        $fetchedHtml = $this->__get('textHtml');
 
         $match = \preg_match_all('/=["\'](ci?d:([\w\.%*@-]+))["\']/i', $fetchedHtml, $matches);
 
@@ -207,7 +207,7 @@ public function replaceInternalLinks(string $baseUri): string
      */
     public function embedImageAttachments(): void
     {
-        $fetchedHtml = (string) $this->__get('textHtml');
+        $fetchedHtml = $this->__get('textHtml');
 
         \preg_match_all("/\bcid:[^'\"\s]{1,256}/mi", $fetchedHtml, $matches);
 
@@ -225,7 +225,7 @@ public function embedImageAttachments(): void
                      */
                     if ($attachment->contentId == $cid || 'inline' == \mb_strtolower((string) $attachment->disposition)) {
                         $contents = $attachment->getContents();
-                        $contentType = (string) $attachment->getFileInfo(FILEINFO_MIME_TYPE);
+                        $contentType = $attachment->getFileInfo(FILEINFO_MIME_TYPE);
 
                         if (!\strstr($contentType, 'image')) {
                             continue;

src/PhpImap/IncomingMailAttachment.php

@@ -67,20 +67,20 @@ class IncomingMailAttachment
     /** @var string|null */
     public $fileExtension;
 
+    /** @var string|null */
+    public $mimeType;
+
     /** @var string|null */
     private $file_path;
 
     /** @var DataPartInfo|null */
     private $dataInfo;
 
-    /** @var string|null */
-    public $mimeType;
-
     /** @var string|null */
     private $filePath;
 
     /**
-     * @return string|false|null
+     * @return false|string
      */
     public function __get(string $name)
     {