Merge pull request #1 from designcise/2.x

designcise · web-flow · commit 27387ba19cde · 2020-05-06T22:34:24.000+02:00
v2.0.0
diff --git a/.gitattributes b/.gitattributes
@@ -1,2 +1,9 @@
 # Auto detect text files and perform LF normalization
 * text=auto
+
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/.travis.yml export-ignore
+/phpunit.xml export-ignore
+/phpstan.neon export-ignore
+/test export-ignore
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,5 @@
+/vendor/
+/.idea
+.DS_Store
+*.cache
+composer.lock
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,22 @@
+cache:
+  apt: true
+  directories:
+    - $HOME/.composer/cache/files
+
+language: php
+
+php:
+  - 7.4.0
+
+before_script:
+  - travis_retry composer install --no-interaction --no-suggest --prefer-source
+
+script:
+  - vendor/bin/phpunit --configuration phpunit.xml --coverage-clover=coverage.xml
+
+after_success:
+  - bash <(curl -s https://codecov.io/bash)
+
+branches:
+  only:
+    - 2.x
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,7 +1,18 @@
-Copyright (c) 2017-2018 Daniyal Hamid (https://designcise.com).
+# License
+
+### Copyright (c) 2017-2020 Daniyal Hamid (https://designcise.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+### Third-party software used in BitFrame Microframework
+
+Portions of this package either build-upon or take inspiration from the work done by:
+
+- **FastRoute Router**
+  * Credit For: FastRoute Library
+  * Copyright (c) 2013 by Nikita Popov.
+  * MIT License
diff --git a/README.md b/README.md
@@ -1,50 +1,65 @@
-# BitFrame\Router\FastRouteRouter
+# BitFrame\FastRoute
+
+[![codecov](https://codecov.io/gh/designcise/bitframe-fastroute/branch/2.x/graph/badge.svg)](https://codecov.io/gh/designcise/bitframe-fastroute)
+[![Build Status](https://travis-ci.org/designcise/bitframe-fastroute.svg?branch=2.x)](https://travis-ci.org/designcise/bitframe-fastroute)
 
 FastRoute wrapper class to manage http routes as a middleware.
 
-### Installation
+## Installation
+
+Install using composer:
 
-See [installation docs](https://www.bitframephp.com/middleware/router/fastroute) for instructions on installing and using this middleware.
+```
+$ composer require designcise/bitframe-fastroute
+```
 
-### Usage Example
+Please note that this package requires PHP 7.4.0 or newer.
+
+## Usage Example
 
 ```
-use \BitFrame\Router\FastRouteRouter;
+use BitFrame\App;
+use BitFrame\Emitter\SapiEmitter;
+use BitFrame\FastRoute\Router;
 
 require 'vendor/autoload.php';
 
-$app = new \BitFrame\Application;
+$app = new App();
+$router = new Router();
 
-$app->map(['GET', 'POST'], '/test', function ($request, $response, $next) {
+$router->map(['GET', 'POST'], '/test', function ($request, $handler) {
+    $response = $handler->handle($request);
     $response->getBody()->write('Test Page');
-    
     return $response;
 });
 
 $app->run([
-    /* In order to output response from the router (or router middleware), 
-     * make sure you include a response emitter middleware, for example:
-     * \BitFrame\Message\DiactorosResponseEmitter::class, */
-    // router should normally be the last middleware to run
-    FastRouteRouter::class
+    SapiEmitter::class,
+    $router,
+    // ...
 ]);
 ```
 
-### Tests
+## Tests
+
+To run the tests you can use the following commands:
 
-To execute the test suite, you will need [PHPUnit](https://phpunit.de/).
+| Command          | Type            |
+| ---------------- |:---------------:|
+| `composer test`  | PHPUnit tests   |
+| `composer style` | CodeSniffer     |
+| `composer md`    | MessDetector    |
+| `composer check` | PHPStan         |
 
-### Contributing
+## Contributing
 
 * File issues at https://github.com/designcise/bitframe-fastroute/issues
 * Issue patches to https://github.com/designcise/bitframe-fastroute/pulls
 
-### Documentation
-
-Documentation is available at:
+## Documentation
 
-* https://www.bitframephp.com/middleware/router/fastroute/
+Complete documentation for v2.0 will be available soon.
 
-### License
+## License
 
 Please see [License File](LICENSE.md) for licensing information.
diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "designcise/bitframe-fastroute",
-    "version": "1.0.4",
+    "version": "2.0.0",
     "type": "library",
     "description": "FastRoute router middleware for BitFrame microframework",
     "license": "MIT",
@@ -11,22 +11,34 @@
         }
     ],
     "require": {
-        "php": ">=7.1.0",
-        "designcise/bitframe": "^1.0",
+        "php": ">=7.4.0",
         "psr/http-server-middleware": "~1.0",
-        "nikic/fast-route": "^1.3"
+        "designcise/bitframe": "2.x-dev"
     },
     "require-dev": {
-        "phpunit/phpunit": "^6.4"
+        "phpunit/phpunit": "^8.5",
+        "phpspec/prophecy": "~1.0",
+        "squizlabs/php_codesniffer": "3.*",
+        "phpmd/phpmd": "@stable",
+        "phpstan/phpstan": "*"
     },
     "autoload": {
         "psr-4": {
-            "BitFrame\\Router\\": "src/"
+            "BitFrame\\FastRoute\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "BitFrame\\Test\\": "test/"
+            "BitFrame\\FastRoute\\Test\\": "test/"
         }
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "scripts": {
+        "style": "vendor/bin/phpcs --standard=PSR12 src",
+        "check": "vendor/bin/phpstan analyse src --level=5 -c phpstan.neon",
+        "md": "vendor/bin/phpmd src text cleancode,unusedcode,codesize,design,naming",
+        "test": "vendor/bin/phpunit --configuration phpunit.xml --testsuite bitframe_fastroute"
     }
 }
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,3 @@
+parameters:
+  treatPhpDocTypesAsCertain: false
+  reportStaticMethodSignatures: false
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,24 +1,25 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
-<phpunit bootstrap="vendor/autoload.php"
-		 backupGlobals="false"
+<phpunit backupGlobals="false"
          backupStaticAttributes="false"
          colors="true"
          convertErrorsToExceptions="true"
          convertNoticesToExceptions="true"
          convertWarningsToExceptions="true"
          processIsolation="false"
-         syntaxCheck="false"
-        >
+    >
     <testsuites>
-        <testsuite name="BitFrame Tests">
-            <directory>./test/</directory>
+        <testsuite name="bitframe_fastroute">
+            <directory suffix="Test.php">./test</directory>
         </testsuite>
     </testsuites>
 
     <filter>
         <whitelist>
-            <directory>./src/</directory>
+            <directory suffix=".php">./src/</directory>
+            <exclude>
+                <directory suffix=".php">./src/Exception</directory>
+            </exclude>
         </whitelist>
     </filter>
 </phpunit>
diff --git a/src/Exception/BadRouteException.php b/src/Exception/BadRouteException.php
@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * BitFrame Framework (https://www.bitframephp.com)
+ *
+ * @author    Daniyal Hamid
+ * @copyright Copyright (c) 2017-2020 Daniyal Hamid (https://designcise.com)
+ * @license   https://bitframephp.com/about/license MIT License
+ */
+
+declare(strict_types=1);
+
+namespace BitFrame\FastRoute\Exception;
+
+use LogicException;
+
+class BadRouteException extends LogicException
+{
+}
diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php
@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * BitFrame Framework (https://www.bitframephp.com)
+ *
+ * @author    Daniyal Hamid
+ * @copyright Copyright (c) 2017-2020 Daniyal Hamid (https://designcise.com)
+ * @license   https://bitframephp.com/about/license MIT License
+ */
+
+declare(strict_types=1);
+
+namespace BitFrame\FastRoute\Exception;
+
+use RuntimeException;
+
+use function http_response_code;
+
+/**
+ * Represents an HTTP error.
+ */
+class HttpException extends RuntimeException
+{
+    public function __construct(string $message, int $statusCode = 500)
+    {
+        http_response_code($statusCode);
+        parent::__construct($message, $statusCode);
+    }
+}
diff --git a/src/Exception/MethodNotAllowedException.php b/src/Exception/MethodNotAllowedException.php
@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * BitFrame Framework (https://www.bitframephp.com)
+ *
+ * @author    Daniyal Hamid
+ * @copyright Copyright (c) 2017-2020 Daniyal Hamid (https://designcise.com)
+ * @license   https://bitframephp.com/about/license MIT License
+ */
+
+declare(strict_types=1);
+
+namespace BitFrame\FastRoute\Exception;
+
+use function sprintf;
+
+/**
+ * Represents an HTTP 405 error.
+ */
+class MethodNotAllowedException extends HttpException
+{
+    /**
+     * @param string $method Name of the method
+     */
+    public function __construct(string $method)
+    {
+        parent::__construct(sprintf('Method "%s" Not Allowed', $method), 405);
+    }
+}
diff --git a/src/Exception/RouteNotFoundException.php b/src/Exception/RouteNotFoundException.php
@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * BitFrame Framework (https://www.bitframephp.com)
+ *
+ * @author    Daniyal Hamid
+ * @copyright Copyright (c) 2017-2020 Daniyal Hamid (https://designcise.com)
+ * @license   https://bitframephp.com/about/license MIT License
+ */
+
+declare(strict_types=1);
+
+namespace BitFrame\FastRoute\Exception;
+
+use function sprintf;
+
+/**
+ * Represents a route not found error.
+ */
+class RouteNotFoundException extends HttpException
+{
+    /**
+     * @param string $type
+     */
+    public function __construct(string $type)
+    {
+        parent::__construct(sprintf('Route "%s" cannot be found', $type), 404);
+    }
+}
diff --git a/src/FastRouteRouter.php b/src/FastRouteRouter.php
diff --git a/src/RouteCollection.php b/src/RouteCollection.php
diff --git a/src/Router.php b/src/Router.php
diff --git a/test/FastRouteRouterTest.php b/test/FastRouteRouterTest.php
diff --git a/test/RouteCollectionTest.php b/test/RouteCollectionTest.php
diff --git a/test/RouterTest.php b/test/RouterTest.php

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+parameters:`
	`2`	`+ treatPhpDocTypesAsCertain: false`
	`3`	`+ reportStaticMethodSignatures: false`