Update tools and setup PHPStan

.github/workflows/ci.yaml

@@ -20,6 +20,18 @@ jobs:
               with:
                   args: --config=.php-cs-fixer.php --diff --dry-run
 
+    phpstan:
+      name: Static Analysis
+      runs-on: ubuntu-latest
+      steps:
+        - name: Checkout
+          uses: actions/checkout@v4
+
+        - name: PHPStan
+          uses: docker://oskarstark/phpstan-ga
+          env:
+            REQUIRE_DEV: true
+
     ci:
         name: Test PHP ${{ matrix.php-version }} ${{ matrix.name }}
         runs-on: ubuntu-latest
@@ -61,3 +73,21 @@ jobs:
 
             - name: Run Tests
               run: php vendor/bin/simple-phpunit
+
+    phar:
+      name: Create a PHAR and ensure it is working
+      runs-on: ubuntu-latest
+
+      steps:
+        - uses: actions/checkout@v3
+
+        - name: Build the PHAR
+          uses: ./.github/actions/phar
+
+        - name: Execute the PHAR
+          run: |
+            tools/phar/build/jolinotif.phar --help
+
+        - name: Trigger a notification
+          run: |
+            tools/phar/build/jolinotif.phar --title "Yolo" --body "Hello world!"

.gitignore

@@ -8,3 +8,7 @@
 /build/
 /.php-cs-fixer.cache
 /.phpunit.result.cache
+/var/
+
+# Castor
+.castor.stub.php

.php-cs-fixer.php

@@ -22,7 +22,9 @@
     ->in(__DIR__)
     ->append([
         __FILE__,
+        'castor.php',
     ])
+    ->notPath('var')
 ;
 
 return (new PhpCsFixer\Config())

CONTRIBUTING.md

@@ -15,6 +15,16 @@ Here's some tips to make you the best contributor ever:
 * [Standard code](#standard-code)
 * [Keeping your fork up-to-date](#keeping-your-fork-up-to-date)
 
+Also, you will need to install Castor to run the tests and fix CS violations.
+See [Castor's documentation](https://castor.jolicode.com/getting-started/installation/)
+for more information.
+
+To install all the dependencies and tools, run the following command:
+
+```shell
+castor install
+```
+
 ## Rules
 
 Here are a few rules to follow in order to ease code reviews, and discussions
@@ -48,16 +58,23 @@ changes, improvements or alternatives may be given).
 Run the tests using the following script:
 
 ```shell
-make test
+castor phpunit
 ```
 
 ## Standard code
 
-Use [PHP CS fixer](http://cs.sensiolabs.org/) to make your code compliant with
-JoliNotif's coding standards:
+Use PHP-CS-Fixer to make your code compliant with JoliNotif's coding standards:
+
+```shell
+castor cs
+```
+
+## Static analysis
+
+Use PHPStan to ensure the code is free of errors:
 
 ```shell
-make cs
+castor phpstan
 ```
 
 ## Keeping your fork up-to-date

castor.php

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the JoliNotif project.
+ *
+ * (c) Loïck Piera <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Castor\Attribute\AsRawTokens;
+use Castor\Attribute\AsTask;
+
+use function Castor\import;
+use function Castor\mount;
+use function Castor\run;
+
+import(__DIR__ . '/tools/php-cs-fixer/castor.php');
+import(__DIR__ . '/tools/phpstan/castor.php');
+
+mount(__DIR__ . '/tools/phar');
+
+#[AsTask(description: 'Install dependencies')]
+function install(): void
+{
+    run(['composer', 'install'], workingDirectory: __DIR__);
+    qa\cs\install();
+    qa\phpstan\install();
+}
+
+#[AsTask(description: 'Run PHPUnit', ignoreValidationErrors: true)]
+function phpunit(#[AsRawTokens] array $rawTokens): void
+{
+    run(['vendor/bin/simple-phpunit', ...$rawTokens]);
+}

composer.json

@@ -26,7 +26,6 @@
         "symfony/process": "^5.4 || ^6.0 || ^7.0"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "^3.13",
         "symfony/finder": "^5.4 || ^6.0 || ^7.0",
         "symfony/phpunit-bridge": "^5.4 || ^6.0 || ^7.0"
     },

phpstan.neon

@@ -0,0 +1,12 @@
+includes:
+    #- phpstan-baseline.neon
+
+parameters:
+    level: 9
+    paths:
+        - src
+    tmpDir: 'var/phpstan/tmp'
+    inferPrivatePropertyTypeFromConstructor: true
+    checkGenericClassInNonGenericObjectType: false
+    excludePaths:
+        analyse: []

src/Exception/InvalidNotificationException.php

@@ -19,9 +19,9 @@ class InvalidNotificationException extends \LogicException implements Exception
 
     public function __construct(
         Notification $notification,
-        $message = '',
-        $code = 0,
-        ?Exception $previous = null
+        string $message = '',
+        int $code = 0,
+        ?\Throwable $previous = null
     ) {
         $this->notification = $notification;
 

src/Exception/NoSupportedNotifierException.php

@@ -14,9 +14,9 @@
 class NoSupportedNotifierException extends \RuntimeException implements Exception
 {
     public function __construct(
-        $message = 'No supported notifier',
-        $code = 0,
-        ?Exception $previous = null
+        string $message = 'No supported notifier',
+        int $code = 0,
+        ?\Throwable $previous = null
     ) {
         parent::__construct($message, $code, $previous);
     }

src/Notification.php

@@ -19,6 +19,7 @@ class Notification
     private ?string $title = null;
     private ?string $body = null;
     private ?string $icon = null;
+    /** @var array<string, string|int> */
     private array $options = [];
 
     public function getTitle(): ?string
@@ -62,17 +63,17 @@ public function setIcon(string $icon): self
                 : realpath($icon);
         }
 
-        $this->icon = $icon;
+        $this->icon = \is_string($icon) ? $icon : null;
 
         return $this;
     }
 
-    public function getOption(string $key): ?string
+    public function getOption(string $key): string|int|null
     {
         return $this->options[$key] ?? null;
     }
 
-    public function addOption(string $key, string $option): self
+    public function addOption(string $key, string|int $option): self
     {
         $this->options[$key] = $option;
 

src/Notifier/AppleScriptNotifier.php

@@ -40,18 +40,18 @@ public function getPriority(): int
 
     protected function getCommandLineArguments(Notification $notification): array
     {
-        $script = 'display notification "' . str_replace('"', '\\"', $notification->getBody()) . '"';
+        $script = 'display notification "' . str_replace('"', '\\"', $notification->getBody() ?? '') . '"';
 
         if ($notification->getTitle()) {
             $script .= ' with title "' . str_replace('"', '\\"', $notification->getTitle()) . '"';
         }
 
         if ($notification->getOption('subtitle')) {
-            $script .= ' subtitle "' . str_replace('"', '\\"', $notification->getOption('subtitle')) . '"';
+            $script .= ' subtitle "' . str_replace('"', '\\"', (string) $notification->getOption('subtitle')) . '"';
         }
 
         if ($notification->getOption('sound')) {
-            $script .= ' sound name "' . str_replace('"', '\\"', $notification->getOption('sound')) . '"';
+            $script .= ' sound name "' . str_replace('"', '\\"', (string) $notification->getOption('sound')) . '"';
         }
 
         return [

src/Notifier/BinaryProvider.php

@@ -39,6 +39,8 @@ public function getEmbeddedBinary(): string;
      * used inside a phar archive.
      *
      * All paths should be relative to the directory pointed by getRootDir().
+     *
+     * @return list<string>
      */
     public function getExtraFiles(): array;
 }

src/Notifier/CliBasedNotifier.php

@@ -86,6 +86,8 @@ public function send(Notification $notification): bool
 
     /**
      * Configure the process to run in order to send the notification.
+     *
+     * @return list<string|int>
      */
     abstract protected function getCommandLineArguments(Notification $notification): array;
 

src/Notifier/GrowlNotifyNotifier.php

@@ -32,7 +32,7 @@ protected function getCommandLineArguments(Notification $notification): array
     {
         $arguments = [
             '--message',
-            $notification->getBody(),
+            $notification->getBody() ?? '',
         ];
 
         if ($notification->getTitle()) {

src/Notifier/KDialogNotifier.php

@@ -39,7 +39,7 @@ protected function getCommandLineArguments(Notification $notification): array
         }
 
         $arguments[] = '--passivepopup';
-        $arguments[] = $notification->getBody();
+        $arguments[] = $notification->getBody() ?? '';
 
         // Timeout, in seconds
         $arguments[] = 5;

src/Notifier/NotifuNotifier.php

@@ -54,7 +54,7 @@ protected function getCommandLineArguments(Notification $notification): array
     {
         $arguments = [
             '/m',
-            $notification->getBody(),
+            $notification->getBody() ?? '',
         ];
 
         if ($notification->getTitle()) {

src/Notifier/NotifySendNotifier.php

@@ -42,7 +42,7 @@ protected function getCommandLineArguments(Notification $notification): array
             $arguments[] = $notification->getTitle();
         }
 
-        $arguments[] = $notification->getBody();
+        $arguments[] = $notification->getBody() ?? '';
 
         return $arguments;
     }

src/Notifier/SnoreToastNotifier.php

@@ -57,7 +57,7 @@ protected function getCommandLineArguments(Notification $notification): array
     {
         $arguments = [
             '-m',
-            $notification->getBody(),
+            $notification->getBody() ?? '',
         ];
 
         if ($notification->getTitle()) {

src/Notifier/TerminalNotifierNotifier.php

@@ -34,7 +34,7 @@ protected function getCommandLineArguments(Notification $notification): array
     {
         $arguments = [
             '-message',
-            $notification->getBody(),
+            $notification->getBody() ?? '',
         ];
 
         if ($notification->getTitle()) {

src/Notifier/ToasterNotifier.php

@@ -61,7 +61,7 @@ protected function getCommandLineArguments(Notification $notification): array
     {
         $arguments = [
             '-m',
-            $notification->getBody(),
+            $notification->getBody() ?? '',
         ];
 
         if ($notification->getTitle()) {

src/Notifier/WslNotifySendNotifier.php

@@ -56,7 +56,7 @@ protected function getCommandLineArguments(Notification $notification): array
         $arguments = [
             '--appId',
             'JoliNotif',
-            $notification->getBody(),
+            $notification->getBody() ?? '',
         ];
 
         if ($notification->getTitle()) {

tools/phar/box.json

@@ -1,25 +1,31 @@
 {
-    "base-path": "../../",
-    "directories": [
-        "bin",
-        "src"
-    ],
-    "files": [
-        "LICENSE",
-        "vendor/autoload.php"
-    ],
-    "finder": [
-        {
-            "name": "*.php",
-            "in": "vendor/composer"
-        },
-        {
-            "name": "*.php",
-            "exclude": ["Tests"],
-            "in": "vendor/symfony/process"
-        }
-    ],
-    "git-version": "package_version",
-    "main": "jolinotif",
-    "output": "tools/phar/build/jolinotif.phar"
+  "base-path": "../../",
+  "directories": [
+    "bin",
+    "src"
+  ],
+  "files": [
+    "LICENSE",
+    "vendor/autoload.php"
+  ],
+  "finder": [
+    {
+      "name": "*.php",
+      "in": "vendor/composer"
+    },
+    {
+      "name": "*.php",
+      "exclude": ["Tests"],
+      "in": "vendor/symfony/process"
+    }
+  ],
+  "compactors": [
+    "KevinGH\\Box\\Compactor\\Php"
+  ],
+  "annotations": false,
+  "compression": "GZ",
+  "check-requirements": false,
+  "git-version": "package_version",
+  "main": "jolinotif",
+  "output": "tools/phar/build/jolinotif.phar"
 }