Merge pull request #103 from dotkernel/issue-100

Issue #100: Remove PHP 8.1 and add PHP 8.4 & 8.5 support

Author: alexmerlin

.github/workflows/codecov.yml

@@ -17,6 +17,8 @@ jobs:
         php:
           - "8.2"
           - "8.3"
+          - "8.4"
+          - "8.5"
 
     steps:
       - name: Checkout

.github/workflows/static-analysis.yml

@@ -0,0 +1,50 @@
+on:
+  - push
+
+name: Run PHPStan checks
+
+jobs:
+  mutation:
+    name: PHPStan ${{ matrix.php }}-${{ matrix.os }}
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+
+        php:
+          - "8.2"
+          - "8.3"
+          - "8.4"
+          - "8.5"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - 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@v4
+        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 static analysis with PHPStan
+        run:  vendor/bin/phpstan analyse

.laminas-ci.json

@@ -1,6 +1,3 @@
-{
-  "ignore_php_platform_requirements": {
-    "8.4": true
-  },
-  "backwardCompatibilityCheck": true
-}
+{
+  "backwardCompatibilityCheck": true
+}

README.md

@@ -1,12 +1,11 @@
 # dot-mail
 
-> [!IMPORTANT]
 > dot-mail is a wrapper on top of [symfony mailer](https://github.com/symfony/mailer)
 
-## dot-mail badges
+## Badges
 
 ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-mail)
-![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-mail/5.1.3)
+![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-mail/5.1.6)
 
 [![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-mail)](https://github.com/dotkernel/dot-mail/issues)
 [![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-mail)](https://github.com/dotkernel/dot-mail/network)
@@ -15,6 +14,7 @@
 
 [![Build Static](https://github.com/dotkernel/dot-mail/actions/workflows/continuous-integration.yml/badge.svg?branch=5.1)](https://github.com/dotkernel/dot-mail/actions/workflows/continuous-integration.yml)
 [![codecov](https://codecov.io/gh/dotkernel/dot-mail/branch/5.0/graph/badge.svg?token=G51NEHYKD3)](https://codecov.io/gh/dotkernel/dot-mail)
+[![PHPStan](https://github.com/dotkernel/dot-mail/actions/workflows/static-analysis.yml/badge.svg?branch=5.1)](https://github.com/dotkernel/dot-mail/actions/workflows/static-analysis.yml)
 
 ## Installation
 

SECURITY.md

@@ -2,39 +2,29 @@
 
 ## Supported Versions
 
-
 | Version | Supported          | PHP Version                                                                                              |
 |---------|--------------------|----------------------------------------------------------------------------------------------------------|
-| 5.x     | :white_check_mark: | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-mail/5.0.0) |
+| 5.x     | :white_check_mark: | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-mail/5.1.6) |
 | 4.x     | :white_check_mark: | ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-mail/4.3.0) |
 | <= 3.x  | :x:                |                                                                                                          |
 
-
 ## Reporting Potential Security Issues
 
-If you have encountered a potential security vulnerability in this project,
-please report it to us at <security@dotkernel.com>. We will work with you to
-verify the vulnerability and patch it.
+If you have encountered a potential security vulnerability in this project, please report it to us at <security@dotkernel.com>.
+We will work with you to verify the vulnerability and patch it.
 
 When reporting issues, please provide the following information:
 
 - Component(s) affected
 - A description indicating how to reproduce the issue
 - A summary of the security vulnerability and impact
 
-We request that you contact us via the email address above and give the
-project contributors a chance to resolve the vulnerability and issue a new
-release prior to any public exposure; this helps protect the project's
-users, and provides them with a chance to upgrade and/or update in order to
-protect their applications.
-
+We request that you contact us via the email address above and give the project contributors a chance to resolve the vulnerability and issue a new release prior to any public exposure;
+this helps protect the project's users and provides them with a chance to upgrade and/or update to protect their applications.
 
 ## Policy
 
 If we verify a reported security vulnerability, our policy is:
 
-- We will patch the current release branch, as well as the immediate prior minor
-  release branch.
-
-- After patching the release branches, we will immediately issue new security
-  fix releases for each patched release branch.
+- We will patch the current release branch, as well as the immediate prior minor release branch.
+- After patching the release branches, we will immediately issue new security fix releases for each patched release branch.

composer.json

@@ -27,18 +27,19 @@
         }
     },
     "require": {
-        "php": "~8.2.0 || ~8.3.0 || ~8.4.0",
+        "php": "~8.2.0 || ~8.3.0 || ~8.4.0 || ~8.5.0",
         "ext-fileinfo": "*",
         "ext-json": "*",
-        "laminas/laminas-servicemanager": "^3.22",
         "dotkernel/dot-event": "^3.4",
+        "laminas/laminas-servicemanager": "^3.22",
         "symfony/mailer": "^v7.1.6"
     },
     "require-dev": {
-        "laminas/laminas-coding-standard": "^3.0",
         "mikey179/vfsstream": "^v1.6.11",
-        "phpunit/phpunit": "^10.5",
-        "vimeo/psalm": "^5.23"
+        "laminas/laminas-coding-standard": "^3.0",
+        "phpstan/phpstan": "^2.1",
+        "phpstan/phpstan-phpunit": "^2.0",
+        "phpunit/phpunit": "^10.5"
     },
     "autoload": {
         "psr-4": {
@@ -53,12 +54,12 @@
     "scripts": {
         "check": [
             "@cs-check",
-            "@test"
+            "@test",
+            "@static-analysis"
         ],
         "cs-check": "phpcs",
         "cs-fix": "phpcbf",
-        "test": "phpunit --colors=always",
-        "test-coverage": "phpunit --colors=always --coverage-clover clover.xml",
-        "static-analysis": "psalm --shepherd --stats"
+        "static-analysis": "phpstan analyse --memory-limit 1G",
+        "test": "phpunit --colors=always"
     }
 }

docs/book/v4/configuration.md

@@ -3,7 +3,8 @@
 Register `dot-mail` in you project by adding `Dot\Mail\ConfigProvider::class` to your configuration aggregator (to `config/config.php` for example).
 After registering the `ConfigProvider` copy the configuration file `config/mail.global.php.dist` into your project's `config/autoload/` directory as `mail.global.php`.
 
-The resulting `mail.global.php` contains the necessary configurations for all available transport types, message options and logging options in one place. The config file provides a set of default values available to all mails under the `dot-mail.default` key.
+The resulting `mail.global.php` contains the necessary configurations for all available transport types, message options and logging options in one place.
+The config file provides a set of default values available to all mails under the `dot-mail.default` key.
 
 Many of these options can be programmatically set when sending the actual email.
 
@@ -49,11 +50,9 @@ Using `Laminas\Mail\Transport\File` as the transport will require uncommenting t
 ## Logging configuration
 
 Uncommenting the `dot-mail.log` key will save a copy of all sent emails' subject, recipient addresses, cc and bcc addresses alongside a timestamp.
-In order to enable it, make sure that your `mail.local.php` has the below `log` configuration under the `dot_mail` key:
+To enable it, make sure that your `mail.local.php` has the below `log` configuration under the `dot_mail` key:
 
 ```php
-<?php
-
 return [
     'dot_mail' => [
         ...

docs/book/v4/overview.md

@@ -2,6 +2,19 @@
 
 > dot-mail is a wrapper on top of [laminas-mail](https://github.com/laminas/laminas-mail)
 
+## Badges
+
+![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-mail)
+![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-mail/4.3.0)
+
+[![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-mail)](https://github.com/dotkernel/dot-mail/issues)
+[![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-mail)](https://github.com/dotkernel/dot-mail/network)
+[![GitHub stars](https://img.shields.io/github/stars/dotkernel/dot-mail)](https://github.com/dotkernel/dot-mail/stargazers)
+[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-mail)](https://github.com/dotkernel/dot-mail/blob/4.0/LICENSE.md)
+
+[![Build Static](https://github.com/dotkernel/dot-mail/actions/workflows/continuous-integration.yml/badge.svg?branch=4.0)](https://github.com/dotkernel/dot-mail/actions/workflows/continuous-integration.yml)
+[![codecov](https://codecov.io/gh/dotkernel/dot-mail/branch/4.0/graph/badge.svg?token=G51NEHYKD3)](https://codecov.io/gh/dotkernel/dot-mail)
+
 ## Extra features
 
-- the option to log the results of the mailing process it provides the developer with more information and greater control.
+The option to log the results of the mailing process it provides the developer with more information and greater control.

docs/book/v4/transports.md

@@ -9,20 +9,23 @@
 
 > Feel free to use any custom transport you desire, provided it implements the mentioned `TransportInterface`.
 
-`Sendmail` is a wrapper over PHP's `mail()` function, and as such has a different behaviour on Windows than on *nix systems. Using sendmail on Windows **will not work in combination with** `addBcc()`.
+`Sendmail` is a wrapper over PHP's `mail()` function, and as such has a different behavior on Windows than on *nix systems. Using sendmail on Windows **will not work in combination with** `addBcc()`.
 
 - Note: emails sent using the sendmail transport will be more often delivered to SPAM.
 
-`Smtp` connects to the configured SMTP host in order to handle sending emails. Saving a copy of an outgoing mail into a folder is possible for this transport only, and is done by uncommenting `save_sent_message_folder` in the config file `mail.local.php` under `dot_mail.default`.
+`Smtp` connects to the configured SMTP host to handle sending emails.
+Saving a copy of outgoing mail into a folder is possible for this transport only, and is done by uncommenting `save_sent_message_folder` in the config file `mail.local.php` under `dot_mail.default`.
 
-- Common folder names are `INBOX`, `INBOX.Archive`, `INBOX.Drafts`, `INBOX.Sent`, `INBOX.Spam`, `INBOX.Trash`. If you have `MailService` available in your class, you can call `$this->mailService->getFolderGlobalNames()` to list the folder global names for the email you are using.
+- Common folder names are `INBOX`, `INBOX.Archive`, `INBOX.Drafts`, `INBOX.Sent`, `INBOX.Spam`, `INBOX.Trash`.
+  If you have `MailService` available in your class, you can call `$this->mailService->getFolderGlobalNames()` to list the folder global names for the email you are using.
 - Multiple folders can be added to the `save_sent_message_folder` key to save a copy of the outgoing email in each folder.
 
-`File` writes each message individually in a file named after the configured format, placed in the configured directory. From here the files may be used for sending via another transport mechanism, or simply as logs.
+`File` writes each message individually in a file named after the configured format, placed in the configured directory.
+From here the files may be used for sending via another transport mechanism, or simply as logs.
 
 `InMemory` saves the message in memory, allowing access to the last "sent" message via the `getLastMessage()` function.
 
-- As the email is not sent, this transport can be helpful in development, with the access to the message being potentially useful in tests as well
+- As the email is not sent, this transport can be helpful in development, with the access to the message being potentially useful in tests as well.
 
 ```php
 $this->mailService->setBody('First email body');

docs/book/v4/usage.md

@@ -2,11 +2,13 @@
 
 ## Sending an e-mail
 
-Below is an example of how to use the email in the most basic way. You can add your own code to it e.g. to get the user data from a User object or from a config file, to use a template for the body.
+Below is an example of how to use the email in the most basic way. You can add your own code to it, e.g., to get the user data from a User object or from a config file, to use a template for the body.
 
-Note that `addTo` is only one of the methods available for the `Message` class returned by `getMessage()`. Other useful methods that were not included in the example are `addCc()`, `addBcc()`, `addReplyTo()`.
+Note that `addTo` is only one of the methods available for the `Message` class returned by `getMessage()`.
+Other useful methods that were not included in the example are `addCc()`, `addBcc()`, `addReplyTo()`.
 
-The returned type is boolean, but if the `isValid()` method is removed, the returned type becomes `MailResult` which allows the use of `getMessage()` for a more detailed error message. See the `Testing if an e-mail message is valid` section below.
+The returned type is boolean, but if the `isValid()` method is removed, the returned type becomes `MailResult` which allows the use of `getMessage()` for a more detailed error message.
+See the `Testing if an e-mail message is valid` section below.
 
 ```php
 public function sendBasicMail()
@@ -19,7 +21,8 @@ public function sendBasicMail()
 }
 ```
 
-It's optional, but recommended to call the above function in a `try-catch` block to display helpful error messages. The next example calls the `sendBasicMail` function from within `UserController`, but you can implement it in other controllers, just make sure that the controller's construct also includes the `FlashMessenger` parameter `$messenger`.
+It's optional but recommended to call the above function in a `try-catch` block to display helpful error messages.
+The next example calls the `sendBasicMail` function from within `UserController`, but you can implement it in other controllers, just make sure that the controller's construct also includes the `FlashMessenger` parameter `$messenger`.
 
 ```php
 try {
@@ -34,7 +37,7 @@ try {
 
 ## Testing if an e-mail message is valid
 
-After sending an e-mail you can check if the message was valid or not.
+After sending an e-mail, you can check if the message was valid or not.
 The `$this->mailService->send()->isValid()` method call will return a boolean value.
 If the returned result is `true`, the e-mail was valid, otherwise the e-mail was invalid.
 In case your e-mail was invalid, you can check for any errors using `$this->mailService->send()->getMessage()`.