v2

.gitattributes

@@ -1,9 +1,10 @@
 * text=auto eol=lf
 
-/tests         export-ignore
-.editorconfig  export-ignore
-.gitattributes export-ignore
-.gitignore     export-ignore
-.travis.yml    export-ignore
-phpunit.xml    export-ignore
-phpcs.xml      export-ignore
+/tests            export-ignore
+.editorconfig     export-ignore
+.gitattributes    export-ignore
+.gitignore        export-ignore
+.php_cs           export-ignore
+.travis.yml       export-ignore
+phpcs.xml.dist    export-ignore
+phpunit.xml.dist  export-ignore

.gitignore

@@ -1,4 +1,4 @@
 vendor
 composer.lock
-.php_cs.cache
 coverage
+*.cache

.php_cs

@@ -1,130 +1,10 @@
 <?php
 
-$finder = PhpCsFixer\Finder::create()
-    ->files()
-    ->name('*.php')
-    ->in(__DIR__ . '/src')
-    ->in(__DIR__ . '/tests')
-;
-
-return PhpCsFixer\Config::create()
-    ->setRules(array(
-        '@PSR2' => true,
-        'array_syntax' => ['syntax' => 'short'],
-        'binary_operator_spaces' => ['align_double_arrow' => false, 'align_equals' => false],
-        'blank_line_after_namespace' => true,
-        'blank_line_after_opening_tag' => false,
-        'blank_line_before_return' => false,
-        'braces' => ['allow_single_line_closure' => false],
-        'cast_spaces' => true,
-        'class_definition' => ['singleLine' => false, 'singleItemSingleLine' => true, 'multiLineExtendsEachSingleLine' => true],
-        'class_keyword_remove' => false,
-        'combine_consecutive_unsets' => true,
-        'concat_space' => false,
-        'declare_equal_normalize' => ['space' => 'single'],
-        'declare_strict_types' => false,
-        'elseif' => true,
-        'encoding' => true,
-        'full_opening_tag' => true,
-        'function_declaration' => true,
-        'function_typehint_space' => true,
-        'general_phpdoc_annotation_remove' => ['expectedExceptionMessageRegExp', 'expectedException', 'expectedExceptionMessage'],
-        'hash_to_slash_comment' => true,
-        'header_comment' => false,
-        'heredoc_to_nowdoc' => true,
-        'include' => true,
-        'indentation_type' => true,
-        'line_ending' => true,
-        'linebreak_after_opening_tag' => true,
-        'lowercase_cast' => true,
-        'lowercase_constants' => true,
-        'lowercase_keywords' => true,
-        'mb_str_functions' => false,
-        'method_argument_space' => true,
-        'method_separation' => true,
-        'native_function_casing' => true,
-        'native_function_invocation' => false,
-        'new_with_braces' => true,
-        'no_blank_lines_after_class_opening' => true,
-        'no_blank_lines_after_phpdoc' => false,
-        'no_blank_lines_before_namespace' => false,
-        'no_closing_tag' => true,
-        'no_empty_comment' => true,
-        'no_empty_phpdoc' => true,
-        'no_empty_statement' => true,
-        'no_extra_consecutive_blank_lines' => ['break', 'continue', 'extra', 'return', 'throw', 'use', 'parenthesis_brace_block', 'square_brace_block', 'curly_brace_block'],
-        'no_leading_import_slash' => true,
-        'no_leading_namespace_whitespace' => true,
-        'no_mixed_echo_print' => ['use' => 'echo'],
-        'no_multiline_whitespace_around_double_arrow' => true,
-        'no_multiline_whitespace_before_semicolons' => true,
-        'no_short_bool_cast' => true,
-        'no_short_echo_tag' => true,
-        'no_singleline_whitespace_before_semicolons' => true,
-        'no_spaces_after_function_name' => true,
-        'no_spaces_around_offset' => true,
-        'no_spaces_inside_parenthesis' => true,
-        'no_trailing_comma_in_list_call' => true,
-        'no_trailing_comma_in_singleline_array' => true,
-        'no_trailing_whitespace' => true,
-        'no_trailing_whitespace_in_comment' => true,
-        'no_unneeded_control_parentheses' => true,
-        'no_unused_imports' => true,
-        'no_useless_else' => true,
-        'no_useless_return' => true,
-        'no_whitespace_before_comma_in_array' => true,
-        'no_whitespace_in_blank_line' => true,
-        'normalize_index_brace' => true,
-        'not_operator_with_space' => false,
-        'not_operator_with_successor_space' => false,
-        'object_operator_without_whitespace' => true,
-        'ordered_class_elements' => false,
-        'ordered_imports' => true,
-        'php_unit_fqcn_annotation' => true,
-        'php_unit_strict' => false,
-        'phpdoc_add_missing_param_annotation' => true,
-        'phpdoc_align' => true,
-        'phpdoc_inline_tag' => true,
-        'phpdoc_no_access' => true,
-        'phpdoc_no_alias_tag' => ['property-read' => 'property', 'property-write' => 'property', 'type' => 'var'],
-        'phpdoc_no_empty_return' => true,
-        'phpdoc_no_package' => true,
-        'phpdoc_no_useless_inheritdoc' => true,
-        'phpdoc_order' => true,
-        'phpdoc_return_self_reference' => true,
-        'phpdoc_scalar' => true,
-        'phpdoc_separation' => false,
-        'phpdoc_single_line_var_spacing' => true,
-        'phpdoc_summary' => false,
-        'phpdoc_to_comment' => true,
-        'phpdoc_trim' => true,
-        'phpdoc_types' => true,
-        'phpdoc_var_without_name' => true,
-        'pow_to_exponentiation' => false,
-        'pre_increment' => true,
-        'protected_to_private' => true,
-        'return_type_declaration' => true,
-        'self_accessor' => false,
-        'semicolon_after_instruction' => true,
-        'short_scalar_cast' => true,
-        'single_blank_line_at_eof' => true,
-        'single_blank_line_before_namespace' => false,
-        'single_class_element_per_statement' => true,
-        'single_import_per_statement' => true,
-        'single_line_after_imports' => true,
-        'single_quote' => true,
-        'space_after_semicolon' => true,
-        'standardize_not_equals' => true,
-        'strict_param' => false,
-        'switch_case_semicolon_to_colon' => true,
-        'switch_case_space' => true,
-        'ternary_operator_spaces' => true,
-        'ternary_to_null_coalescing' => false,
-        'trailing_comma_in_multiline_array' => true,
-        'trim_array_spaces' => true,
-        'unary_operator_spaces' => true,
-        'visibility_required' => true,
-        'whitespace_after_comma_in_array' => true,
-    ))
-    ->setFinder($finder)
-;
+return My\PhpCsFixerConfig::create()
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->files()
+            ->name('*.php')
+            ->in(__DIR__.'/src')
+            ->in(__DIR__.'/tests')
+    );

.travis.yml

@@ -2,9 +2,8 @@ language: php
 sudo: false
 
 php:
-  - 7.0
-  - 7.1
   - 7.2
+  - 7.3
 
 before_script:
   - composer self-update

CHANGELOG.md

@@ -5,45 +5,35 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased]
-
-### Fixed
-
-- Use `phpstan` as a dev dependency to detect bugs
-
+## [2.0.0] - 2019-12-03
 ### Added
+- A second argument in the constructor to pass a `ResponseFactoryInterface`
 
-- Added `responseFactory` option to `__construct`
+### Removed
+- Support for PHP 7.0 and 7.1
 
 ## [1.0.0] - 2018-09-23
-
 ### Added
-
 - [#3] `continueOnError()` option
 
 ### Removed
-
 - [#3] `defaultHandler()` option
 
 ## [0.2.1] - 2018-08-22
-
 ### Changed
-
 - Empty paths are always returned as `/`.
 - A `/` prefix works properly as well.
 
 ## [0.2.0] - 2018-08-22
-
 ### Changed
-
 - Update `middlewares/utils` library for compatibility with `middlewares/request-handler`.
 
 ## 0.1.0 - 2018-08-22
-
 First version
 
 [#3]: https://github.com/middlewares/base-path-router/issues/3
 
+[2.0.0]: https://github.com/middlewares/base-path-router/compare/v1.0.0...v2.0.0
 [1.0.0]: https://github.com/middlewares/base-path-router/compare/v0.2.1...v1.0.0
 [0.2.1]: https://github.com/middlewares/base-path-router/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/middlewares/base-path-router/compare/v0.1.0...v0.2.0

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018
+Copyright (c) 2019
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -10,7 +10,7 @@ A middleware dispatching to other middleware stacks, based on different path pre
 
 ## Requirements
 
-* PHP >= 7.0
+* PHP >= 7.2
 * A [PSR-7 http library](https://github.com/middlewares/awesome-psr15-middlewares#psr-7-implementations)
 * A [PSR-15 middleware dispatcher](https://github.com/middlewares/awesome-psr15-middlewares#dispatcher)
 
@@ -24,7 +24,7 @@ composer require middlewares/base-path-router
 
 You may also want to install [middlewares/request-handler](https://packagist.org/packages/middlewares/request-handler).
 
-## Usage
+## Example
 
 This example uses [middleware/request-handler](https://github.com/middlewares/request-handler) to execute the route handler:
 
@@ -43,17 +43,31 @@ $response = $dispatcher->dispatch(new ServerRequest());
 
 **BasePathRouter** allows anything to be defined as the router handler (a closure, callback, action object, controller class, etc). The middleware will store this handler in a request attribute.
 
-## Options
+## Usage
+
+You have to set an array of paths (as keys) and handlers (as values).
+
+```php
+$router = new Middlewares\BasePathRouter([
+    '/foo' => $routerFoo,
+    '/bar' => $routerBar,
+    '/foo/bar' => $routerFooBar,
+]);
+```
+
+Optionally, you can provide a `Psr\Http\Message\ResponseFactoryInterface` as the second argument, to create the error responses (`404`) if the router is not found. If it's not defined, [Middleware\Utils\Factory](https://github.com/middlewares/utils#factory) will be used to detect it automatically.
 
-#### `__construct(array $middlewares)`
+```php
+$responseFactory = new MyOwnResponseFactory();
 
-Array with the paths (as keys) and handlers (as values).
+$router = new Middlewares\BasePathRouter($paths, $responseFactory);
+```
 
-#### `continueOnError(true)`
+### continueOnError
 
 Set `true` to continue to the next middleware instead return an empty 404 response for non-matching requests (i.e. those that do not have an URI path start with one of the provided prefixes).
 
-#### `stripPrefix(bool $stripPrefix)`
+### stripPrefix
 
 By default, subsequent middleware will receive a slightly manipulated request object: any matching path prefixes will be stripped from the URI.
 This helps when you have a hierarchical setup of routers, where subsequent routers (e.g. one for the API stack mounted under the `/api` endpoint) can ignore the common prefix.
@@ -66,10 +80,20 @@ $router = (new Middlewares\BasePathRouter([
     ]))->stripPrefix(false);
 ```
 
-#### `attribute(string $attribute)`
+### attribute
 
 The attribute name used to store the handler in the server request. The default attribute name is `request-handler`.
 
+```php
+$dispatcher = new Dispatcher([
+    //Save the route handler in an attribute called "route"
+    (new Middlewares\BasePathRouter($paths))->attribute('route'),
+
+    //Execute the route handler
+    (new Middlewares\RequestHandler())->attribute('route')
+]);
+```
+
 ---
 
 Please see [CHANGELOG](CHANGELOG.md) for more information about recent changes and [CONTRIBUTING](CONTRIBUTING.md) for contributing details.

composer.json

@@ -16,16 +16,16 @@
         "issues": "https://github.com/middlewares/base-path-router/issues"
     },
     "require": {
-        "php": "^7.0",
-        "middlewares/utils": "^2.0",
+        "php": "^7.2",
+        "middlewares/utils": "^3.0",
         "psr/http-server-middleware": "^1.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^6.0",
-        "zendframework/zend-diactoros": "^1.3",
+        "phpunit/phpunit": "^8.1",
+        "zendframework/zend-diactoros": "^2.2",
         "friendsofphp/php-cs-fixer": "^2.0",
         "squizlabs/php_codesniffer": "^3.0",
-        "phpstan/phpstan": "^0.9.2|^0.10.3"
+        "oscarotero/php-cs-fixer-config": "^1.0"
     },
     "autoload": {
         "psr-4": {
@@ -42,8 +42,7 @@
             "phpunit --coverage-text",
             "phpcs"
         ],
-        "cs-fix": "php-cs-fixer fix .",
-        "coverage": "phpunit --coverage-html=coverage",
-        "analyse": "phpstan analyse --no-progress --level 7 src"
+        "cs-fix": "php-cs-fixer fix",
+        "coverage": "phpunit --coverage-html=coverage"
     }
 }