adhere to (mostly) PSR12, check codestyle in CI

Update AltoRouter.php for php 8.4

.github/workflows/php-check-syntax.yml

@@ -0,0 +1,20 @@
+name: Check PHP syntax
+
+on: [ push, pull_request ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-versions: ['7.3', '7.4', '8.0', '8.1', '8.2', '8.3', 'highest']
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+
+      - name: checkout repo
+        uses: actions/checkout@v3
+
+      - run: composer run check-syntax

.github/workflows/php.yml

@@ -0,0 +1,42 @@
+name: PHP
+
+on: [ push, pull_request ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-versions: [ '7.3',  'highest' ]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          tools: composer
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        if: steps.composer-cache.outputs.cache-hit != 'true'
+        run: composer install --no-progress
+
+      - name: Check codestyle
+        run: composer run-script check-codestyle
+
+      - name: Run test suite
+        run: composer run-script test

.gitignore

@@ -6,3 +6,4 @@ build
 vendor
 composer.lock
 phpunit.xml
+.phpunit.result.cache

.travis.yml

@@ -1,21 +0,0 @@
-language: php
-php:
-  - 5.6
-  - 7.0
-  - 7.1
-  - 7.2
-  - 7.3
-install:
-  - composer update --prefer-source
-script:
-  - vendor/bin/phpunit
-after_script:
-  - vendor/bin/test-reporter
-env:
-  global:
-    secure: XnXSc7nxJMIrm/EJ1KuwlN4f+sj2R/sR0IFHdOdbOfMKyZ/u6WEgZ3vNrdeAsisiC/QUJJ00DGku1pAl3t3Hzvam0N/SiHtXjB1ZLVbX00S1PEZ6Z+h9zoaUBXWoN6+0OdKN0Xjmj2lwvTpvUxUZXNabilOw0F9WS/+JasofqBQ=
-sudo: false
-cache:
-  directories:
-    - vendor
-    - $HOME/.composer/cache

AltoRouter.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
 MIT License
 
@@ -13,7 +14,6 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 class AltoRouter
 {
-
     /**
      * @var array Array of all routes (incl. named routes).
      */
@@ -49,7 +49,7 @@ class AltoRouter
      * @param array $matchTypes
      * @throws Exception
      */
-    public function __construct(array $routes = [], $basePath = '', array $matchTypes = [])
+    public function __construct(array $routes = [], string $basePath = '', array $matchTypes = [])
     {
         $this->addRoutes($routes);
         $this->setBasePath($basePath);
@@ -61,7 +61,7 @@ class AltoRouter
      * Useful if you want to process or display routes.
      * @return array All routes.
      */
-    public function getRoutes()
+    public function getRoutes(): array
     {
         return $this->routes;
     }
@@ -93,7 +93,7 @@ class AltoRouter
      * Useful if you are running your application from a subdirectory.
      * @param string $basePath
      */
-    public function setBasePath($basePath)
+    public function setBasePath(string $basePath)
     {
         $this->basePath = $basePath;
     }
@@ -117,7 +117,7 @@ class AltoRouter
      * @param string $name Optional name of this route. Supply if you want to reverse route this url in your application.
      * @throws Exception
      */
-    public function map($method, $route, $target, $name = null)
+    public function map(string $method, string $route, $target, ?string $name = null)
     {
 
         $this->routes[] = [$method, $route, $target, $name];
@@ -128,8 +128,6 @@ class AltoRouter
             }
             $this->namedRoutes[$name] = $route;
         }
-
-        return;
     }
 
     /**
@@ -138,11 +136,11 @@ class AltoRouter
      * Generate the URL for a named route. Replace regexes with supplied parameters
      *
      * @param string $routeName The name of the route.
-     * @param array @params Associative array of parameters to replace placeholders with.
+     * @param array $params Associative array of parameters to replace placeholders with.
      * @return string The URL of the route with named parameters in place.
      * @throws Exception
      */
-    public function generate($routeName, array $params = [])
+    public function generate(string $routeName, array $params = []): string
     {
 
         // Check if named route exists
@@ -186,7 +184,7 @@ class AltoRouter
      * @param string $requestMethod
      * @return array|boolean Array with route information on success, false on failure (no match).
      */
-    public function match($requestUrl = null, $requestMethod = null)
+    public function match(?string $requestUrl = null, ?string $requestMethod = null)
     {
 
         $params = [];
@@ -204,7 +202,7 @@ class AltoRouter
             $requestUrl = substr($requestUrl, 0, $strpos);
         }
 
-        $lastRequestUrlChar = $requestUrl ? $requestUrl[strlen($requestUrl)-1] : '';
+        $lastRequestUrlChar = $requestUrl ? $requestUrl[strlen($requestUrl) - 1] : '';
 
         // set Request Method if it isn't passed as a parameter
         if ($requestMethod === null) {
@@ -233,8 +231,8 @@ class AltoRouter
                 $match = strcmp($requestUrl, $route) === 0;
             } else {
                 // Compare longest non-param string with url before moving on to regex
-				// Check if last character before param is a slash, because it could be optional if param is optional too (see https://github.com/dannyvankooten/AltoRouter/issues/241)
+                // Check if last character before param is a slash, because it could be optional if param is optional too (see https://github.com/dannyvankooten/AltoRouter/issues/241)
-                if (strncmp($requestUrl, $route, $position) !== 0 && ($lastRequestUrlChar === '/' || $route[$position-1] !== '/')) {
+                if (strncmp($requestUrl, $route, $position) !== 0 && ($lastRequestUrlChar === '/' || $route[$position - 1] !== '/')) {
                     continue;
                 }
 
@@ -264,10 +262,10 @@ class AltoRouter
 
     /**
      * Compile the regex for a given route (EXPENSIVE)
-     * @param $route
+     * @param string $route
      * @return string
      */
-    protected function compileRoute($route)
+    protected function compileRoute(string $route): string
     {
         if (preg_match_all('`(/|\.|)\[([^:\]]*+)(?::([^:\]]*+))?\](\?|)`', $route, $matches, PREG_SET_ORDER)) {
             $matchTypes = $this->matchTypes;

README.md

@@ -1,4 +1,5 @@
-# AltoRouter  [![Build Status](https://img.shields.io/travis/dannyvankooten/AltoRouter/master)](https://travis-ci.org/dannyvankooten/AltoRouter) [![Latest Stable Version](https://poser.pugx.org/altorouter/altorouter/v/stable.svg)](https://packagist.org/packages/altorouter/altorouter) [![License](https://poser.pugx.org/altorouter/altorouter/license.svg)](https://packagist.org/packages/altorouter/altorouter) [![Code Climate](https://codeclimate.com/github/dannyvankooten/AltoRouter/badges/gpa.svg)](https://codeclimate.com/github/dannyvankooten/AltoRouter) [![Test Coverage](https://codeclimate.com/github/dannyvankooten/AltoRouter/badges/coverage.svg)](https://codeclimate.com/github/dannyvankooten/AltoRouter)
+# AltoRouter  ![PHP status](https://github.com/dannyvankooten/AltoRouter/workflows/PHP/badge.svg) [![Latest Stable Version](https://poser.pugx.org/altorouter/altorouter/v/stable.svg)](https://packagist.org/packages/altorouter/altorouter) [![License](https://poser.pugx.org/altorouter/altorouter/license.svg)](https://packagist.org/packages/altorouter/altorouter)
+
 AltoRouter is a small but powerful routing class, heavily inspired by [klein.php](https://github.com/chriso/klein.php/).
 
 ```php
@@ -29,13 +30,13 @@ echo $router->generate('user-details', ['id' => 5]); // Output: "/users/5"
 
 ## Getting started
 
-You need PHP >= 5.6 to use AltoRouter, although we highly recommend you [use an officially supported PHP version](https://secure.php.net/supported-versions.php) that is not EOL.
+You need PHP >= 7.3 to use AltoRouter, although we highly recommend you [use an officially supported PHP version](https://secure.php.net/supported-versions.php) that is not EOL.
 
-- [Install AltoRouter](http://altorouter.com/usage/install.html)
+- [Install AltoRouter](https://dannyvankooten.github.io/AltoRouter//usage/install.html)
-- [Rewrite all requests to AltoRouter](http://altorouter.com/usage/rewrite-requests.html)
+- [Rewrite all requests to AltoRouter](https://dannyvankooten.github.io/AltoRouter//usage/rewrite-requests.html)
-- [Map your routes](http://altorouter.com/usage/mapping-routes.html)
+- [Map your routes](https://dannyvankooten.github.io/AltoRouter//usage/mapping-routes.html)
-- [Match requests](http://altorouter.com/usage/matching-requests.html)
+- [Match requests](https://dannyvankooten.github.io/AltoRouter//usage/matching-requests.html)
-- [Process the request your preferred way](http://altorouter.com/usage/processing-requests.html)
+- [Process the request your preferred way](https://dannyvankooten.github.io/AltoRouter//usage/processing-requests.html)
 
 ## Contributors
 - [Danny van Kooten](https://github.com/dannyvankooten)

composer.json

@@ -20,17 +20,18 @@
       }
    ],
    "require": {
-      "php": ">=5.6.0"
+      "php": ">=7.3"
    },
    "require-dev": {
-      "phpunit/phpunit": "5.7.*",
+      "phpunit/phpunit": "9.6.*",
-      "codeclimate/php-test-reporter": "dev-master",
+      "squizlabs/php_codesniffer": "3.6.2"
-      "squizlabs/php_codesniffer": "3.4.2"
    },
    "autoload": {
       "classmap": ["AltoRouter.php"]
    },
    "scripts": {
-     "test": "vendor/bin/phpunit"
+      "test": "phpunit",
+      "check-syntax": "find . -name '*.php' -not -path './vendor/*' -print0 | xargs -0 -n1 php --define error_reporting=-1 -l",
+      "check-codestyle": "phpcs -ns"
    }
 }

phpcs.xml

@@ -1,9 +1,10 @@
 <?xml version="1.0"?>
 <ruleset name="rules">
     <description>rules</description>
-    <rule ref="PSR2"/>
+    <rule ref="PSR12">
+        <exclude name="PSR1.Classes.ClassDeclaration.MissingNamespace" />
+    </rule>
     <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
-    <file>tests</file>
     <file>AltoRouter.php</file>
     <file>examples/</file>
     <arg name="colors"/>

phpunit.xml.dist

@@ -1,17 +1,17 @@
-<phpunit
+<?xml version="1.0"?>
-	colors="true"
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" verbose="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-	verbose="true">
+  <coverage>
-	<testsuites>
+    <include>
-		<testsuite name="altorouter">
+      <file>./AltoRouter.php</file>
-			<directory>./tests/</directory>
+    </include>
-		</testsuite>
+    <report>
-	</testsuites>
+      <clover outputFile="build/logs/clover.xml"/>
-	<filter>
+    </report>
-        <whitelist>
+  </coverage>
-            <file>./AltoRouter.php</file>
+  <testsuites>
-        </whitelist>
+    <testsuite name="altorouter">
-	</filter>
+      <directory>./tests/</directory>
-	<logging>
+    </testsuite>
-		<log type="coverage-clover" target="build/logs/clover.xml"/>
+  </testsuites>
-	</logging>
+  <logging/>
-</phpunit>
+</phpunit>

tests/AltoRouterTest.php

@@ -25,23 +25,26 @@ class SimpleTraversable implements Iterator
         ['POST', '/bar', 'bar_action', 'second_route']
     ];
 
+    #[\ReturnTypeWillChange]
     public function current()
     {
         return $this->_data[$this->_position];
     }
+
+    #[\ReturnTypeWillChange]
     public function key()
     {
         return $this->_position;
     }
-    public function next()
+    public function next() : void
     {
         ++$this->_position;
     }
-    public function rewind()
+    public function rewind() : void
     {
         $this->_position = 0;
     }
-    public function valid()
+    public function valid() : bool
     {
         return isset($this->_data[$this->_position]);
     }
@@ -58,19 +61,11 @@ class AltoRouterTest extends PHPUnit\Framework\TestCase
      * Sets up the fixture, for example, opens a network connection.
      * This method is called before a test is executed.
      */
-    protected function setUp()
+    protected function setUp() : void
     {
         $this->router = new AltoRouterDebug;
     }
 
-    /**
-     * Tears down the fixture, for example, closes a network connection.
-     * This method is called after a test is executed.
-     */
-    protected function tearDown()
-    {
-    }
-
     /**
      * @covers AltoRouter::getRoutes
      */
@@ -81,7 +76,7 @@ class AltoRouterTest extends PHPUnit\Framework\TestCase
         $target = static function () {
         };
 
-        $this->assertInternalType('array', $this->router->getRoutes());
+        $this->assertIsArray($this->router->getRoutes());
         // $this->assertIsArray($this->router->getRoutes()); // for phpunit 7.x
         $this->router->map($method, $route, $target);
         $this->assertEquals([[$method, $route, $target, null]], $this->router->getRoutes());
@@ -134,6 +129,7 @@ class AltoRouterTest extends PHPUnit\Framework\TestCase
      */
     public function testAddRoutesThrowsExceptionOnInvalidArgument()
     {
+        $this->expectException(RuntimeException::class);
         $this->router->addRoutes(new stdClass);
     }
 
@@ -142,7 +138,7 @@ class AltoRouterTest extends PHPUnit\Framework\TestCase
      */
     public function testSetBasePath()
     {
-    	$this->router->setBasePath('/some/path');
+        $this->router->setBasePath('/some/path');
         $this->assertEquals('/some/path', $this->router->getBasePath());
 
         $this->router->setBasePath('/some/path');
@@ -518,18 +514,17 @@ class AltoRouterTest extends PHPUnit\Framework\TestCase
     }
 
     public function testMatchWithSlashBeforeOptionalPart()
-	{
+    {
-		$this->router->map('GET', '/archives/[lmin:category]?', 'Article#archives');
+        $this->router->map('GET', '/archives/[lmin:category]?', 'Article#archives');
-		$expected =  [
+        $expected =  [
-			'target' => 'Article#archives',
+            'target' => 'Article#archives',
-			'params' => [],
+            'params' => [],
-			'name' => null
+            'name' => null
-		];
+        ];
 
-		$this->assertEquals($expected, $this->router->match('/archives/', 'GET'));
+        $this->assertEquals($expected, $this->router->match('/archives/', 'GET'));
-		$this->assertEquals($expected, $this->router->match('/archives', 'GET'));
+        $this->assertEquals($expected, $this->router->match('/archives', 'GET'));
-
+    }
-	}
 
     /**
      * @covers AltoRouter::addMatchTypes

tests/benchmark-parse-api.php

@@ -13,46 +13,46 @@
 
 require __DIR__ . '/../vendor/autoload.php';
 $routes = [
-	["POST", "/1/classes/[a:className]"],
+    ["POST", "/1/classes/[a:className]"],
-	["GET", "/1/classes/[a:className]/[i:objectId]"],
+    ["GET", "/1/classes/[a:className]/[i:objectId]"],
-	["PUT", "/1/classes/[a:className]/[i:objectId]"],
+    ["PUT", "/1/classes/[a:className]/[i:objectId]"],
-	["GET", "/1/classes/[a:className]"],
+    ["GET", "/1/classes/[a:className]"],
-	["DELETE", "/1/classes/[a:className]/[i:objectId]"],
+    ["DELETE", "/1/classes/[a:className]/[i:objectId]"],
 
-	// Users
+    // Users
-	["POST", "/1/users"],
+    ["POST", "/1/users"],
-	["GET", "/1/login"],
+    ["GET", "/1/login"],
-	["GET", "/1/users/[i:objectId]"],
+    ["GET", "/1/users/[i:objectId]"],
-	["PUT", "/1/users/[i:objectId]"],
+    ["PUT", "/1/users/[i:objectId]"],
-	["GET", "/1/users"],
+    ["GET", "/1/users"],
-	["DELETE", "/1/users/[i:objectId]"],
+    ["DELETE", "/1/users/[i:objectId]"],
-	["POST", "/1/requestPasswordReset"],
+    ["POST", "/1/requestPasswordReset"],
 
-	// Roles
+    // Roles
-	["POST", "/1/roles"],
+    ["POST", "/1/roles"],
-	["GET", "/1/roles/[i:objectId]"],
+    ["GET", "/1/roles/[i:objectId]"],
-	["PUT", "/1/roles/[i:objectId]"],
+    ["PUT", "/1/roles/[i:objectId]"],
-	["GET", "/1/roles"],
+    ["GET", "/1/roles"],
-	["DELETE", "/1/roles/[i:objectId]"],
+    ["DELETE", "/1/roles/[i:objectId]"],
 
-	// Files
+    // Files
-	["POST", "/1/files/:fileName"],
+    ["POST", "/1/files/:fileName"],
 
-	// Analytics
+    // Analytics
-	["POST", "/1/events/[a:eventName]"],
+    ["POST", "/1/events/[a:eventName]"],
 
-	// Push Notifications
+    // Push Notifications
-	["POST", "/1/push"],
+    ["POST", "/1/push"],
 
-	// Installations
+    // Installations
-	["POST", "/1/installations"],
+    ["POST", "/1/installations"],
-	["GET", "/1/installations/[i:objectId]"],
+    ["GET", "/1/installations/[i:objectId]"],
-	["PUT", "/1/installations/[i:objectId]"],
+    ["PUT", "/1/installations/[i:objectId]"],
-	["GET", "/1/installations"],
+    ["GET", "/1/installations"],
-	["DELETE", "/1/installations/[i:objectId]"],
+    ["DELETE", "/1/installations/[i:objectId]"],
 
-	// Cloud Functions
+    // Cloud Functions
-	["POST", "/1/functions"],
+    ["POST", "/1/functions"],
 ];
 $total_time = 0;
 $router = new AltoRouter();