Merge pull request #9 from Lansoweb/php-8

update to php 8 and add new config key los -> basepath

Author: Lansoweb

.github/workflows/validate.yaml

@@ -212,4 +212,4 @@ jobs:
         run: "composer update --no-interaction --no-progress"
 
       - name: "Run static analysis"
-        run: "vendor/bin/psalm analyse --output-format=github"
+        run: "vendor/bin/psalm --output-format=github"

.gitignore

@@ -1,9 +1,4 @@
-._*
-.~lock.*
-.buildpath
-.project
-.settings
-vendor
-/composer.lock
-/build
-/.php_cs.cache
+/vendor
+composer.lock
+.phpunit.result.cache
+.php_cs.cache

README.md

@@ -27,7 +27,7 @@ Every request with `/site` prefix will be replaced:
 ```
 
 
-### Mezzio (formely Zend Expressive)
+### Mezzio (formerly Zend Expressive)
 
 If you are using [mezzio-skeleton](https://github.com/mezzio/mezzio-skeleton), 
 you can copy `config/los-basepath.global.php.dist` to `config/autoload/los-basepath.global.php` 
@@ -45,9 +45,12 @@ This can be achieved with the following code in your configuration file:
 
 ```php
 $scriptPath = dirname($_SERVER['SCRIPT_NAME']);
+
 return [
     // Use directory of script path if available, otherwise default to empty string.
-    'los_basepath' => strlen($scriptPath) > 1 ? $scriptPath : '',
+    'los' => [
+        'basepath' => strlen($scriptPath) > 1 ? $scriptPath : '',
+    ],
 
     // rest of the configuration ...
 ];

config/los-basepath.global.php.dist

@@ -1,6 +1,8 @@
 <?php
 return [
-    'los_basepath' => '',
+    'los' => [
+        'basepath' => '',
+    ],
     'dependencies' => [
         'factories' => [
             LosMiddleware\BasePath\BasePathMiddleware::class => LosMiddleware\BasePath\BasePathMiddlewareFactory::class

phpcs.xml.dist

@@ -1,8 +1,11 @@
 <?xml version="1.0"?>
-<ruleset name="Laminas Coding Standard">
-	<rule ref="LaminasCodingStandard"/>
+<ruleset name="Library Coding Standard">
 
 	<!-- Paths to check -->
 	<file>config</file>
 	<file>src</file>
+
+	<rule ref="Doctrine"/>
+	<rule ref="Generic.Metrics.CyclomaticComplexity"/>
+	<rule ref="Generic.Metrics.NestingLevel"/>
 </ruleset>

phpstan.neon.dist

@@ -0,0 +1,7 @@
+parameters:
+    level: max
+    paths:
+        - src
+        - config
+includes:
+    - vendor/phpstan/phpstan/conf/bleedingEdge.neon

phpunit.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<phpunit
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+        colors="true"
+>
+  <coverage processUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+    <report>
+      <text outputFile="php://stdout" showOnlySummary="true"/>
+    </report>
+  </coverage>
+  <testsuites>
+    <testsuite name="LosMiddleware\\BasePathTest">
+      <directory>./test</directory>
+    </testsuite>
+  </testsuites>
+</phpunit>

phpunit.xml.dist

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<psalm
+    totallyTyped="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="config" />
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>

psalm.xml.dist

@@ -1,41 +1,33 @@
 <?php
+
+declare(strict_types=1);
+
 namespace LosMiddleware\BasePath;
 
+use Mezzio\Helper\UrlHelper;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\MiddlewareInterface;
 use Psr\Http\Server\RequestHandlerInterface;
-use Mezzio\Helper\UrlHelper;
+
+use function strlen;
+use function strpos;
+use function substr;
 
 final class BasePathMiddleware implements MiddlewareInterface
 {
-    const BASE_PATH = 'los-basepath';
-
-    /**
-     * @var string
-     */
-    private $basePath;
-
-    /**
-     * @var UrlHelper
-     */
-    private $urlHelper;
-
-    /**
-     * @param string $basePath
-     * @param UrlHelper $urlHelper
-     */
-    public function __construct(string $basePath = '', UrlHelper $urlHelper = null)
+    public const BASE_PATH = 'los-basepath';
+
+    private string $basePath;
+
+    private ?UrlHelper $urlHelper;
+
+    public function __construct(string $basePath, ?UrlHelper $urlHelper)
     {
-        $this->basePath = $basePath;
+        $this->basePath  = $basePath;
         $this->urlHelper = $urlHelper;
     }
 
-    /**
-     * @param ServerRequestInterface $request
-     * @param RequestHandlerInterface $handler
-     * @return ResponseInterface
-     */
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
     {
         $uri = $request->getUri();
@@ -49,7 +41,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
         $path = substr($path, strlen($this->basePath)) ?: '/';
 
         $request = $request->withUri($uri->withPath($path));
-        $request = $request->withAttribute(static::BASE_PATH, $this->basePath . $path);
+        $request = $request->withAttribute(self::BASE_PATH, $this->basePath . $path);
 
         if ($this->urlHelper instanceof UrlHelper) {
             $this->urlHelper->setBasePath($this->basePath);