Release v1.2.1

.github/workflows/tests.yml

@@ -71,3 +71,11 @@ jobs:
 
       - name: Run tests
         run: ./vendor/bin/phpunit ./tests
+
+      - name: Upload test artifacts on failure
+        uses: actions/upload-artifact@v3
+        if: ${{ failure() }}
+        with:
+            name: ResizerTest-${{ matrix.operatingSystem }}-PHP${{ matrix.phpVersion }}
+            path: tests/artifacts/ResizerTest/
+            if-no-files-found: error

.gitignore

@@ -20,3 +20,4 @@ php_errors.log
 tests/.phpunit.result.cache
 .phpunit.result.cache
 tests/tmp
+tests/artifacts/*

composer.json

@@ -37,6 +37,7 @@
 
         "assetic/framework": "~3.0",
         "doctrine/dbal": "^2.6",
+        "enshrined/svg-sanitize": "^0.15",
         "erusev/parsedown-extra": "~0.7",
         "laravel/framework": "^9.1",
         "laravel/tinker": "^2.7",
@@ -47,7 +48,8 @@
         "symfony/yaml": "^6.0",
         "twig/twig": "~3.0",
         "wikimedia/less.php": "~3.0",
-        "wikimedia/minify": "~2.2"
+        "wikimedia/minify": "~2.2",
+        "winter/laravel-config-writer": "^1.0.1"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5.8",

phpstan-baseline.neon

@@ -260,11 +260,6 @@ parameters:
 			count: 1
 			path: src/Database/Relations/BelongsTo.php
 
-		-
-			message: "#^Call to an undefined method Illuminate\\\\Database\\\\Eloquent\\\\Model\\:\\:getRelationDefinition\\(\\)\\.$#"
-			count: 3
-			path: src/Database/Relations/BelongsTo.php
-
 		-
 			message: "#^Call to an undefined method Illuminate\\\\Database\\\\Eloquent\\\\Relations\\\\Relation\\:\\:getForeignKey\\(\\)\\.$#"
 			count: 3

src/Auth/Manager.php

@@ -1,9 +1,11 @@
 <?php namespace Winter\Storm\Auth;
 
+use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Cookie;
 use Illuminate\Support\Facades\Session;
 use Illuminate\Support\Facades\Request;
 use Illuminate\Contracts\Auth\Authenticatable;
+use Illuminate\Session\SessionManager;
 
 /**
  * Authentication manager
@@ -78,6 +80,7 @@ class Manager implements \Illuminate\Contracts\Auth\StatefulGuard
     protected function init()
     {
         $this->ipAddress = Request::ip();
+        $this->sessionManager = App::make(SessionManager::class);
     }
 
     //
@@ -479,7 +482,19 @@ protected function setPersistCodeInSession($user, $remember = true)
         Session::put($this->sessionKey, $toPersist);
 
         if ($remember) {
-            Cookie::queue(Cookie::forever($this->sessionKey, json_encode($toPersist)));
+            $config = $this->sessionManager->getSessionConfig();
+            Cookie::queue(
+                Cookie::forever(
+                    $this->sessionKey,
+                    json_encode($toPersist),
+                    $config['path'],
+                    $config['domain'],
+                    $config['secure'] ?? false,
+                    $config['http_only'] ?? true,
+                    false,
+                    $config['same_site'] ?? null
+                )
+            );
         }
     }
 

src/Config/ConfigWriter.php

@@ -1,7 +1,5 @@
 <?php namespace Winter\Storm\Config;
 
-use Exception;
-
 use PhpParser\Error;
 use PhpParser\Lexer\Emulative;
 use PhpParser\ParserFactory;

src/Console/Command.php

@@ -1,18 +1,19 @@
 <?php namespace Winter\Storm\Console;
 
-use Winter\Storm\Support\Str;
 use Illuminate\Console\Command as BaseCommand;
-use Symfony\Component\Console\Completion\CompletionInput;
-use Symfony\Component\Console\Completion\CompletionSuggestions;
+use Symfony\Component\Console\Command\SignalableCommandInterface;
 
 /**
  * Command base class
  * Contains utilities to make developing CLI commands nicer
  *
  * @author Luke Towers
  */
-abstract class Command extends BaseCommand
+abstract class Command extends BaseCommand implements SignalableCommandInterface
 {
+    use Traits\HandlesCleanup;
+    use Traits\ProvidesAutocompletion;
+
     /**
      * @var array List of commands that this command replaces (aliases)
      */
@@ -34,9 +35,10 @@ public function __construct()
      * Write a string in an alert box.
      *
      * @param  string  $string
+     * @param  int|string|null  $verbosity
      * @return void
      */
-    public function alert($string)
+    public function alert($string, $verbosity = null)
     {
         $maxLength = 80;
         $padding = 5;
@@ -59,82 +61,22 @@ public function alert($string)
         $width = $innerLineWidth + ($border * 2);
 
         // Top border
-        $this->comment(str_repeat('*', $width));
+        $this->comment(str_repeat('*', $width), $verbosity);
 
         // Alert content
         foreach ($lines as $line) {
             // Apply padding and borders to each line
             $this->comment(
                 str_repeat('*', $border)
                 . str_pad($line, $innerLineWidth, ' ', STR_PAD_BOTH)
-                . str_repeat('*', $border)
+                . str_repeat('*', $border),
+                $verbosity
             );
         }
 
         // Bottom border
-        $this->comment(str_repeat('*', $width));
+        $this->comment(str_repeat('*', $width), $verbosity);
 
         $this->newLine();
     }
-
-    /**
-     * Provide autocompletion for this command's input
-     */
-    public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
-    {
-        $inputs = [
-            'arguments' => $input->getArguments(),
-            'options'   => $input->getOptions(),
-        ];
-
-        foreach ($inputs as $type => $data) {
-            switch ($type) {
-                case 'arguments':
-                    $dataType = 'Argument';
-                    $suggestionType = 'Values';
-                    break;
-                case 'options':
-                    $dataType = 'Option';
-                    $suggestionType = 'Options';
-                    break;
-                default:
-                    // This should not be possible to ever be triggered given the type is hardcoded above
-                    throw new \Exception('Invalid input type being parsed during completion');
-            }
-            if (!empty($data)) {
-                foreach ($data as $name => $value) {
-                    // Skip the command argument since that's handled by Artisan directly
-                    if (
-                        $type === 'arguments'
-                        && in_array($name, ['command'])
-                    ) {
-                        continue;
-                    }
-
-                    $inputRoutingMethod = "mustSuggest{$dataType}ValuesFor";
-                    $suggestionValuesMethod = Str::camel('suggest ' . $name) . $suggestionType;
-                    $suggestionsMethod = 'suggest' . $suggestionType;
-
-                    if (
-                        method_exists($this, $suggestionValuesMethod)
-                        && $input->{$inputRoutingMethod}($name)
-                    ) {
-                        $values = $this->$suggestionValuesMethod($value, $inputs);
-                        $suggestions->{$suggestionsMethod}($values);
-                    }
-                }
-            }
-        }
-    }
-
-    /**
-     * Example implementation of a suggestion method
-     */
-    // public function suggestMyArgumentValues(string $value = null, array $allInput): array
-    // {
-    //     if ($allInput['arguments']['dependent'] === 'matches') {
-    //         return ['some', 'suggested', 'values'];
-    //     }
-    //     return ['all', 'values'];
-    // }
 }

src/Console/Traits/ConfirmsWithInput.php

@@ -4,7 +4,7 @@
  * Console Command Trait that provides confirmation step that requires set
  * input to be provided in order to act as confirmation for an action
  *
- * @package winter\wn-system-module
+ * @package winter\storm
  * @author Luke Towers
  */
 trait ConfirmsWithInput

src/Console/Traits/HandlesCleanup.php

@@ -0,0 +1,77 @@
+<?php namespace Winter\Storm\Console\Traits;
+
+/**
+ * Console Command Trait that injects cross-platform signal handling to trigger
+ * cleanup on exit through the handleCleanup() method on the implementing class.
+ *
+ * >**NOTE:** This trait requires the implementing class to implement the
+ * Symfony\Component\Console\Command\SignalableCommandInterface interface
+ *
+ * @package winter\storm
+ * @author Luke Towers
+ */
+trait HandlesCleanup
+{
+    /**
+     * Returns the process signals this command listens to
+     * @see https://www.php.net/manual/en/pcntl.constants.php
+     * Used to support the handleCleanup() end-class method
+     */
+    public function getSubscribedSignals(): array
+    {
+        $signals = [];
+        if (method_exists($this, 'handleCleanup')) {
+            // Handle Windows OS
+            if (PHP_OS_FAMILY === 'Windows') {
+                // Attach to Windows Ctrl+C & Ctrl+Break events
+                if (function_exists('sapi_windows_set_ctrl_handler')) {
+                    sapi_windows_set_ctrl_handler([$this, 'handleWindowsSignal'], true);
+                }
+            // Handle Unix-like OS
+            } else {
+                $signals = [SIGINT, SIGTERM, SIGQUIT];
+            }
+        }
+
+        return $signals;
+    }
+
+    /**
+     * Handle the provided Unix process signal
+     */
+    public function handleSignal(int $signal): void
+    {
+        // Handle the signal
+        if (method_exists($this, 'handleCleanup')) {
+            $this->handleCleanup();
+        }
+
+        // Exit cleanly at this point if this was a user termination
+        if (in_array($signal, [SIGINT, SIGQUIT])) {
+            exit(0);
+        }
+    }
+
+    /**
+     * Handle the provided Windows process singal.
+     */
+    public function handleWindowsSignal(int $event): void
+    {
+        // Remove the handler
+        sapi_windows_set_ctrl_handler([$this, 'handleWindowsSignal'], false);
+
+        // Handle the signal
+        if (
+            method_exists($this, 'handleCleanup')
+            && (
+                $event === PHP_WINDOWS_EVENT_CTRL_C
+                || $event === PHP_WINDOWS_EVENT_CTRL_BREAK
+            )
+        ) {
+            $this->handleCleanup();
+
+            // Exit cleanly at this point if this was a user termination
+            exit(0);
+        }
+    }
+}

src/Console/Traits/ProvidesAutocompletion.php

@@ -0,0 +1,76 @@
+<?php namespace Winter\Storm\Console\Traits;
+
+use Winter\Storm\Support\Str;
+use Symfony\Component\Console\Completion\CompletionInput;
+use Symfony\Component\Console\Completion\CompletionSuggestions;
+
+/**
+ * Console Command Trait that injects cross-platform signal handling to trigger
+ * cleanup on exit through the handleCleanup() method on the implementing class.
+ *
+ * @package winter\storm
+ * @author Luke Towers
+ */
+trait ProvidesAutocompletion
+{
+    /**
+     * Provide autocompletion for this command's input
+     */
+    public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
+    {
+        $inputs = [
+            'arguments' => $input->getArguments(),
+            'options'   => $input->getOptions(),
+        ];
+
+        foreach ($inputs as $type => $data) {
+            switch ($type) {
+                case 'arguments':
+                    $dataType = 'Argument';
+                    $suggestionType = 'Values';
+                    break;
+                case 'options':
+                    $dataType = 'Option';
+                    $suggestionType = 'Options';
+                    break;
+                default:
+                    // This should not be possible to ever be triggered given the type is hardcoded above
+                    throw new \Exception('Invalid input type being parsed during completion');
+            }
+            if (!empty($data)) {
+                foreach ($data as $name => $value) {
+                    // Skip the command argument since that's handled by Artisan directly
+                    if (
+                        $type === 'arguments'
+                        && in_array($name, ['command'])
+                    ) {
+                        continue;
+                    }
+
+                    $inputRoutingMethod = "mustSuggest{$dataType}ValuesFor";
+                    $suggestionValuesMethod = Str::camel('suggest ' . $name) . $suggestionType;
+                    $suggestionsMethod = 'suggest' . $suggestionType;
+
+                    if (
+                        method_exists($this, $suggestionValuesMethod)
+                        && $input->{$inputRoutingMethod}($name)
+                    ) {
+                        $values = $this->$suggestionValuesMethod($value, $inputs);
+                        $suggestions->{$suggestionsMethod}($values);
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * Example implementation of a suggestion method
+     */
+    // public function suggestMyArgumentValues(string $value = null, array $allInput): array
+    // {
+    //     if ($allInput['arguments']['dependent'] === 'matches') {
+    //         return ['some', 'suggested', 'values'];
+    //     }
+    //     return ['all', 'values'];
+    // }
+}