dotkernel · alexmerlin · Aug 18, 2023 · Aug 17, 2023 · Aug 17, 2023 · Aug 18, 2023
diff --git a/.github/workflows/codecov.yml b/.github/workflows/codecov.yml
@@ -0,0 +1,53 @@
+on:
+  - push
+
+name: Run Codecov checks
+
+jobs:
+  code-coverage:
+    name: Code Coverage
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+
+        php:
+          - "8.1"
+          - "8.2"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "${{ matrix.php }}"
+          coverage: pcov
+          ini-values: assert.exception=1, zend.assertions=1, error_reporting=-1, log_errors_max_len=0, display_errors=On
+          tools: composer:v2, cs2pr
+
+      - name: Determine composer cache directory
+        run: echo "COMPOSER_CACHE_DIR=$(composer config cache-dir)" >> $GITHUB_ENV
+
+      - name: Cache dependencies installed with composer
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.COMPOSER_CACHE_DIR }}
+          key: php${{ matrix.php }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: |
+            php${{ matrix.php }}-composer-
+
+      - name: Install dependencies with composer
+        run: composer install --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
+
+      - name: Collect code coverage with PHPUnit
+        run: vendor/bin/phpunit --colors=always --coverage-clover clover.xml
+
+      - name: Send code coverage report to Codecov.io
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/cs-tests.yml b/.github/workflows/cs-tests.yml
@@ -0,0 +1,46 @@
+on:
+  - push
+
+name: Run phpcs checks
+
+jobs:
+  mutation:
+    name: PHP ${{ matrix.php }}-${{ matrix.os }}
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+
+        php:
+          - "8.1"
+          - "8.2"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "${{ matrix.php }}"
+          tools: composer:v2, cs2pr
+          coverage: none
+
+      - name: Determine composer cache directory
+        run: echo "COMPOSER_CACHE_DIR=$(composer config cache-dir)" >> $GITHUB_ENV
+
+      - name: Cache dependencies installed with composer
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.COMPOSER_CACHE_DIR }}
+          key: php${{ matrix.php }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: |
+            php${{ matrix.php }}-composer-
+      - name: Install dependencies with composer
+        run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
+
+      - name: Run phpcs checks
+        run: vendor/bin/phpcs
diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
@@ -0,0 +1,46 @@
+on:
+  - push
+
+name: Run static analysis
+
+jobs:
+  mutation:
+    name: PHP ${{ matrix.php }}-${{ matrix.os }}
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+
+        php:
+          - "8.1"
+          - "8.2"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "${{ matrix.php }}"
+          tools: composer:v2, cs2pr
+          coverage: none
+
+      - name: Determine composer cache directory
+        run: echo "COMPOSER_CACHE_DIR=$(composer config cache-dir)" >> $GITHUB_ENV
+
+      - name: Cache dependencies installed with composer
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.COMPOSER_CACHE_DIR }}
+          key: php${{ matrix.php }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: |
+            php${{ matrix.php }}-composer-
+      - name: Install dependencies with composer
+        run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
+
+      - name: Run static analysis
+        run: vendor/bin/psalm --no-cache --output-format=github --show-info=false --threads=4
diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml
@@ -0,0 +1,47 @@
+on:
+  - push
+
+name: Run PHPUnit tests
+
+jobs:
+  mutation:
+    name: PHP ${{ matrix.php }}-${{ matrix.os }}
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+
+        php:
+          - "8.1"
+          - "8.2"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "${{ matrix.php }}"
+          tools: composer:v2, cs2pr
+          coverage: none
+
+      - name: Determine composer cache directory
+        run: echo "COMPOSER_CACHE_DIR=$(composer config cache-dir)" >> $GITHUB_ENV
+
+      - name: Cache dependencies installed with composer
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.COMPOSER_CACHE_DIR }}
+          key: php${{ matrix.php }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: |
+            php${{ matrix.php }}-composer-
+
+      - name: Install dependencies with composer
+        run: composer install --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
+
+      - name: Run PHPUnit tests
+        run: vendor/bin/phpunit --colors=always
diff --git a/.gitignore b/.gitignore
@@ -13,6 +13,8 @@ composer.lock
 
 # User-specific stuff:
 .idea
+.phpunit.result.cache
+.phpcs-cache
 
 ## File-based project format:
 *.iws

diff --git a/README.md b/README.md
@@ -2,12 +2,17 @@
 
 
 ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-flashmessenger)
-![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-flashmessenger/3.2.0)
+![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-flashmessenger/3.4.0)
 
 [![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-flashmessenger)](https://github.com/dotkernel/dot-flashmessenger/issues)
 [![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-flashmessenger)](https://github.com/dotkernel/dot-flashmessenger/network)
 [![GitHub stars](https://img.shields.io/github/stars/dotkernel/dot-flashmessenger)](https://github.com/dotkernel/dot-flashmessenger/stargazers)
-[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-flashmessenger)](https://github.com/dotkernel/dot-flashmessenger/blob/3.2.0/LICENSE.md)
+[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-flashmessenger)](https://github.com/dotkernel/dot-flashmessenger/blob/3.0/LICENSE.md)
+
+[![Build Static](https://github.com/dotkernel/dot-flashmessenger/actions/workflows/static-analysis.yml/badge.svg?branch=3.0)](https://github.com/dotkernel/dot-flashmessenger/actions/workflows/static-analysis.yml)
+
+[![SymfonyInsight](https://insight.symfony.com/projects/94ace687-5124-446f-a324-0ecca1b47f88/big.svg)](https://insight.symfony.com/projects/94ace687-5124-446f-a324-0ecca1b47f88)
+
 
 Flash messenger library for session messages between redirects. A flash message, or session message is a piece of text data that survives one requests(available only in the next request). 
 This library accepts session data as well, not just string messages, with the same behaviour.
@@ -111,4 +116,4 @@ The flash messenger service
 Dot\FlashMessenger\View\RendererInterface::class
 ```
 
-The registered renderer class
+The registered renderer class
diff --git a/composer.json b/composer.json
@@ -15,16 +15,23 @@
         "flashmessenger",
         "laminas"
     ],
+    "config": {
+        "sort-packages": true,
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
+    },
     "require": {
-        "php": "^7.4 || ~8.0.0 || ~8.1.0",
-        "psr/http-message": "^1.0.1",
-        "laminas/laminas-servicemanager": "^3.11.2",
-        "laminas/laminas-session": "^2.12"
+        "php": "~8.1.0 || ~8.2.0",
+        "psr/http-message": "^1.0 || ^2.0",
+        "laminas/laminas-servicemanager": "^3.21.0",
+        "laminas/laminas-session": "^2.16.0",
+        "mezzio/mezzio-template": "^2.8.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.5.20",
-        "squizlabs/php_codesniffer": "^3.6.2",
-        "mezzio/mezzio-template": "^2.4.0"
+        "laminas/laminas-coding-standard": "^2.5.0",
+        "phpunit/phpunit": "^10.3.2",
+        "vimeo/psalm": "^5.14.1"
     },
     "autoload": {
         "psr-4": {
@@ -35,5 +42,16 @@
         "psr-4": {
             "DotTest\\FlashMessenger\\": "test/"
         }
+    },
+    "scripts": {
+        "check": [
+            "@cs-check",
+            "@test"
+        ],
+        "cs-check": "phpcs",
+        "cs-fix": "phpcbf",
+        "test": "phpunit --colors=always",
+        "test-coverage": "phpunit --colors=always --coverage-clover clover.xml",
+        "static-analysis": "psalm --shepherd --stats"
     }
 }
diff --git a/phpcs.xml b/phpcs.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">
+
+    <arg name="basepath" value="."/>
+    <arg name="cache" value=".phpcs-cache"/>
+    <arg name="colors"/>
+    <arg name="extensions" value="php"/>
+    <arg name="parallel" value="80"/>
+
+    <!-- Show progress -->
+    <arg value="p"/>
+
+    <!-- Paths to check -->
+    <file>src</file>
+    <file>test</file>
+
+    <!-- Include all rules from the Laminas Coding Standard -->
+    <rule ref="LaminasCodingStandard"/>
+</ruleset>
diff --git a/phpunit.xml b/phpunit.xml
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.2/phpunit.xsd"
+         bootstrap="./vendor/autoload.php"
+         colors="true">
+    <testsuites>
+        <testsuite name="Dot-Flashmessenger Test Suite">
+            <directory>./test</directory>
+        </testsuite>
+    </testsuites>
+    <coverage/>
+    <source>
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </source>
+</phpunit>
diff --git a/psalm.xml b/psalm.xml
@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<psalm
+        errorLevel="4"
+        resolveFromConfigFile="true"
+        findUnusedCode="false"
+        findUnusedBaselineEntry="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"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>
diff --git a/src/ConfigProvider.php b/src/ConfigProvider.php
@@ -1,11 +1,6 @@
 <?php
-/**
- * @see https://github.com/dotkernel/dot-flashmessenger/ for the canonical source repository
- * @copyright Copyright (c) 2017 Apidemia (https://www.apidemia.com)
- * @license https://github.com/dotkernel/dot-flashmessenger/blob/master/LICENSE.md MIT License
- */
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Dot\FlashMessenger;
 
@@ -16,17 +11,12 @@
 use Dot\FlashMessenger\View\FlashMessengerRenderer;
 use Dot\FlashMessenger\View\RendererInterface;
 
-/**
- * Class ConfigProvider
- * @package Dot\FlashMessenger
- */
 class ConfigProvider
 {
     public function __invoke(): array
     {
         return [
-            'dependencies' => $this->getDependencyConfig(),
-
+            'dependencies'       => $this->getDependencyConfig(),
             'dot_flashmessenger' => [
                 'options' => [
                     'namespace' => 'dot_messenger',
@@ -35,22 +25,19 @@ public function __invoke(): array
         ];
     }
 
-    /**
-     * @return array
-     */
     public function getDependencyConfig(): array
     {
         return [
             'factories' => [
-                FlashMessenger::class => FlashMessengerFactory::class,
-                FlashMessengerOptions::class => FlashMessengerOptionsFactory::class,
+                FlashMessenger::class         => FlashMessengerFactory::class,
+                FlashMessengerOptions::class  => FlashMessengerOptionsFactory::class,
                 FlashMessengerRenderer::class => FlashMessengerRendererFactory::class,
             ],
-            'aliases' => [
+            'aliases'   => [
                 FlashMessengerInterface::class => FlashMessenger::class,
-                RendererInterface::class => FlashMessengerRenderer::class,
-                'FlashMessenger' => FlashMessenger::class,
-            ]
+                RendererInterface::class       => FlashMessengerRenderer::class,
+                'FlashMessenger'               => FlashMessenger::class,
+            ],
         ];
     }
 }