Update StyleCI config + fixes

yiisoft · Nov 20, 2020 · ad23303 · ad23303
1 parent 27baa1d
commit ad23303
Show file tree

Hide file tree

Showing 13 changed files with 149 additions and 37 deletions.
diff --git a/.styleci.yml b/.styleci.yml
@@ -1,6 +1,90 @@
 preset: psr12
+risky: true
+
+version: 8
 
 finder:
-  exclude:
-    - docs
-    - vendor
+    exclude:
+        - docs
+        - vendor
+        - resources
+        - views
+        - public
+    not-name:
+        - UnionCar.php
+
+enabled:
+    - alpha_ordered_imports
+    - alpha_ordered_traits
+    - array_indentation
+    - array_push
+    - combine_consecutive_issets
+    - combine_consecutive_unsets
+    - combine_nested_dirname
+    - declare_strict_types
+    - dir_constant
+    - final_static_access
+    - fully_qualified_strict_types
+    - function_to_constant
+    - hash_to_slash_comment
+    - is_null
+    - logical_operators
+    - magic_constant_casing
+    - magic_method_casing
+    - method_separation
+    - modernize_types_casting
+    - native_function_casing
+    - native_function_type_declaration_casing
+    - no_alias_functions
+    - no_alternative_syntax
+    - no_empty_comment
+    - no_empty_phpdoc
+    - no_empty_statement
+    - no_extra_block_blank_lines
+    - no_short_bool_cast
+    - no_short_echo_tag
+    - no_superfluous_elseif
+    - no_unneeded_control_parentheses
+    - no_unneeded_curly_braces
+    - no_unneeded_final_method
+    - no_unset_cast
+    - no_unused_imports
+    - no_unused_lambda_imports
+    - no_useless_else
+    - no_useless_return
+    - normalize_index_brace
+    - php_unit_dedicate_assert
+    - php_unit_dedicate_assert_internal_type
+    - php_unit_expectation
+    - php_unit_mock
+    - php_unit_mock_short_will_return
+    - php_unit_namespaced
+    - php_unit_no_expectation_annotation
+    - phpdoc_no_empty_return
+    - phpdoc_no_useless_inheritdoc
+    - phpdoc_order
+    - phpdoc_property
+    - phpdoc_scalar
+    - phpdoc_separation
+    - phpdoc_singular_inheritdoc
+    - phpdoc_trim
+    - phpdoc_trim_consecutive_blank_line_separation
+    - phpdoc_type_to_var
+    - phpdoc_types
+    - phpdoc_types_order
+    - phpdoc_var_without_name
+    - print_to_echo
+    - regular_callable_call
+    - return_assignment
+    - self_accessor
+    - self_static_accessor
+    - set_type_to_cast
+    - short_array_syntax
+    - short_list_syntax
+    - simplified_if_return
+    - single_quote
+    - standardize_not_equals
+    - ternary_to_null_coalescing
+    - trailing_comma_in_multiline_array
+    - unalign_double_arrow
+    - unalign_equals
diff --git a/config/common.php b/config/common.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use Yiisoft\Router\Group;
 use Yiisoft\Router\RouteCollectorInterface;
 

diff --git a/src/Group.php b/src/Group.php
@@ -32,7 +32,7 @@ private function __construct(?string $prefix = null, ?callable $callback = null,
      * Create a new instance
      *
      * @param string|null $prefix
-     * @param callable|array $routes
+     * @param array|callable $routes
      * @param MiddlewareDispatcher $dispatcher
      *
      * @return self
@@ -42,11 +42,11 @@ public static function create(?string $prefix = null, $routes = [], MiddlewareDi
         if (\is_callable($routes)) {
             $callback = $routes;
         } elseif (is_array($routes)) {
-            $callback = static function (Group $group) use (&$routes) {
+            $callback = static function (self $group) use (&$routes) {
                 foreach ($routes as $route) {
                     if ($route instanceof Route) {
                         $group->addRoute($route);
-                    } elseif ($route instanceof Group) {
+                    } elseif ($route instanceof self) {
                         $group->addGroup($route);
                     } else {
                         throw new InvalidArgumentException('Route should be either instance of Route or Group.');
@@ -88,7 +88,7 @@ public function addRoute(Route $route): self
         return $this;
     }
 
-    public function addGroup(Group $group): self
+    public function addGroup(self $group): self
     {
         if (!$group->hasDispatcher() && $this->hasDispatcher()) {
             $group = $group->withDispatcher($this->dispatcher);
@@ -98,7 +98,7 @@ public function addGroup(Group $group): self
     }
 
     /**
-     * @param MiddlewareInterface|callable|string|array $middleware
+     * @param array|callable|MiddlewareInterface|string $middleware
      */
     private function validateMiddleware($middleware): void
     {
@@ -134,6 +134,7 @@ private function isCallable($definition): bool
 
     /**
      * @param callable|MiddlewareInterface $middleware
+     *
      * @return $this
      */
     public function addMiddleware($middleware): self
@@ -145,7 +146,7 @@ public function addMiddleware($middleware): self
     }
 
     /**
-     * @return Route[]|Group[]
+     * @return Group[]|Route[]
      */
     public function getItems(): array
     {

diff --git a/src/Route.php b/src/Route.php
@@ -20,7 +20,7 @@ final class Route
     private ?MiddlewareDispatcher $dispatcher = null;
 
     /**
-     * @var callable[]|string[]|array[]
+     * @var array[]|callable[]|string[]
      */
     private array $middlewareDefinitions = [];
     private array $defaults = [];
@@ -58,8 +58,9 @@ public function hasDispatcher(): bool
 
     /**
      * @param string $pattern
-     * @param callable|string|array|null $middlewareDefinition primary route handler {@see addMiddleware()}
+     * @param array|callable|string|null $middlewareDefinition primary route handler {@see addMiddleware()}
      * @param MiddlewareDispatcher|null $dispatcher
+     *
      * @return self
      */
     public static function get(string $pattern, $middlewareDefinition = null, ?MiddlewareDispatcher $dispatcher = null): self
@@ -69,8 +70,9 @@ public static function get(string $pattern, $middlewareDefinition = null, ?Middl
 
     /**
      * @param string $pattern
-     * @param callable|string|array|null $middlewareDefinition primary route handler {@see addMiddleware()}
+     * @param array|callable|string|null $middlewareDefinition primary route handler {@see addMiddleware()}
      * @param MiddlewareDispatcher|null $dispatcher
+     *
      * @return self
      */
     public static function post(string $pattern, $middlewareDefinition = null, ?MiddlewareDispatcher $dispatcher = null): self
@@ -80,8 +82,9 @@ public static function post(string $pattern, $middlewareDefinition = null, ?Midd
 
     /**
      * @param string $pattern
-     * @param callable|string|array|null $middlewareDefinition primary route handler {@see addMiddleware()}
+     * @param array|callable|string|null $middlewareDefinition primary route handler {@see addMiddleware()}
      * @param MiddlewareDispatcher|null $dispatcher
+     *
      * @return self
      */
     public static function put(string $pattern, $middlewareDefinition = null, ?MiddlewareDispatcher $dispatcher = null): self
@@ -91,8 +94,9 @@ public static function put(string $pattern, $middlewareDefinition = null, ?Middl
 
     /**
      * @param string $pattern
-     * @param callable|string|array|null $middlewareDefinition primary route handler {@see addMiddleware()}
+     * @param array|callable|string|null $middlewareDefinition primary route handler {@see addMiddleware()}
      * @param MiddlewareDispatcher|null $dispatcher
+     *
      * @return self
      */
     public static function delete(string $pattern, $middlewareDefinition = null, ?MiddlewareDispatcher $dispatcher = null): self
@@ -102,8 +106,9 @@ public static function delete(string $pattern, $middlewareDefinition = null, ?Mi
 
     /**
      * @param string $pattern
-     * @param callable|string|array|null $middlewareDefinition primary route handler {@see addMiddleware()}
+     * @param array|callable|string|null $middlewareDefinition primary route handler {@see addMiddleware()}
      * @param MiddlewareDispatcher|null $dispatcher
+     *
      * @return self
      */
     public static function patch(string $pattern, $middlewareDefinition = null, ?MiddlewareDispatcher $dispatcher = null): self
@@ -113,8 +118,9 @@ public static function patch(string $pattern, $middlewareDefinition = null, ?Mid
 
     /**
      * @param string $pattern
-     * @param callable|string|array|null $middlewareDefinition primary route handler {@see addMiddleware()}
+     * @param array|callable|string|null $middlewareDefinition primary route handler {@see addMiddleware()}
      * @param MiddlewareDispatcher|null $dispatcher
+     *
      * @return self
      */
     public static function head(string $pattern, $middlewareDefinition = null, ?MiddlewareDispatcher $dispatcher = null): self
@@ -124,8 +130,9 @@ public static function head(string $pattern, $middlewareDefinition = null, ?Midd
 
     /**
      * @param string $pattern
-     * @param callable|string|array|null $middlewareDefinition primary route handler {@see addMiddleware()}
+     * @param array|callable|string|null $middlewareDefinition primary route handler {@see addMiddleware()}
      * @param MiddlewareDispatcher|null $dispatcher
+     *
      * @return self
      */
     public static function options(string $pattern, $middlewareDefinition = null, ?MiddlewareDispatcher $dispatcher = null): self
@@ -136,8 +143,9 @@ public static function options(string $pattern, $middlewareDefinition = null, ?M
     /**
      * @param array $methods
      * @param string $pattern
-     * @param callable|string|array|null $middlewareDefinition primary route handler {@see addMiddleware()}
+     * @param array|callable|string|null $middlewareDefinition primary route handler {@see addMiddleware()}
      * @param MiddlewareDispatcher|null $dispatcher
+     *
      * @return self
      */
     public static function methods(
@@ -157,8 +165,9 @@ public static function methods(
 
     /**
      * @param string $pattern
-     * @param callable|string|array|null $middlewareDefinition primary route handler {@see addMiddleware()}
+     * @param array|callable|string|null $middlewareDefinition primary route handler {@see addMiddleware()}
      * @param MiddlewareDispatcher|null $dispatcher
+     *
      * @return self
      */
     public static function anyMethod(string $pattern, $middlewareDefinition = null, ?MiddlewareDispatcher $dispatcher = null): self
@@ -191,6 +200,7 @@ public function host(string $host): self
      * Parameter default values indexed by parameter names
      *
      * @param array $defaults
+     *
      * @return self
      */
     public function defaults(array $defaults): self
@@ -211,7 +221,8 @@ public function defaults(array $defaults): self
      * injection container passed to the route. Current request and handler could be obtained by
      * type-hinting for ServerRequestInterface and RequestHandlerInterface.
      *
-     * @param callable|string|array $middlewareDefinition
+     * @param array|callable|string $middlewareDefinition
+     *
      * @return Route
      */
     public function addMiddleware($middlewareDefinition): self

diff --git a/src/RouteCollection.php b/src/RouteCollection.php
@@ -38,6 +38,7 @@ public function getRoutes(): array
 
     /**
      * @param string $name
+     *
      * @return Route
      */
     public function getRoute(string $name): Route
@@ -54,6 +55,7 @@ public function getRoute(string $name): Route
      * Returns routes tree array
      *
      * @param bool $routeAsString
+     *
      * @return array
      */
     public function getRouteTree(bool $routeAsString = true): array
@@ -72,7 +74,7 @@ private function ensureItemsInjected(): void
     /**
      * Build routes array
      *
-     * @param Route[]|Group[] $items
+     * @param Group[]|Route[] $items
      */
     private function injectItems(array $items): void
     {
@@ -83,7 +85,8 @@ private function injectItems(array $items): void
 
     /**
      * Add an item into routes array
-     * @param Route|Group $route
+     *
+     * @param Group|Route $route
      */
     private function injectItem($route): void
     {
@@ -146,6 +149,7 @@ private function injectGroup(Group $group, array &$tree, string $prefix = ''): v
      *
      * @param array $items
      * @param bool $routeAsString
+     *
      * @return array
      */
     private function buildTree(array $items, bool $routeAsString): array

diff --git a/src/RouteCollectionInterface.php b/src/RouteCollectionInterface.php
@@ -13,6 +13,7 @@ public function getRoutes(): array;
 
     /**
      * @param string $name
+     *
      * @return Route
      */
     public function getRoute(string $name): Route;

diff --git a/src/RouteCollectorInterface.php b/src/RouteCollectorInterface.php
@@ -12,6 +12,7 @@ interface RouteCollectorInterface
      * Add a route
      *
      * @param Route $route
+     *
      * @return self
      */
     public function addRoute(Route $route): self;
@@ -26,7 +27,9 @@ public function addRoute(Route $route): self;
      * ])->addMiddleware($myMiddleware);
      * $router->addGroup($group);
      * ```
+     *
      * @param Group $group a group to add
+     *
      * @return self
      */
     public function addGroup(Group $group): self;
@@ -36,6 +39,7 @@ public function addGroup(Group $group): self;
      * The container is be used to resolve dependencies in callback or action caller middleware.
      *
      * @param MiddlewareDispatcher $dispatcher container instance
+     *
      * @return RouteCollectorInterface
      */
     public function withDispatcher(MiddlewareDispatcher $dispatcher): self;
@@ -46,7 +50,7 @@ public function withDispatcher(MiddlewareDispatcher $dispatcher): self;
     public function hasDispatcher(): bool;
 
     /**
-     * @return Route|Group[]
+     * @return Group[]|Route
      */
     public function getItems(): array;
 }
diff --git a/src/UrlGeneratorInterface.php b/src/UrlGeneratorInterface.php
@@ -15,8 +15,10 @@ interface UrlGeneratorInterface
      *
      * @param string $name name of the route
      * @param array $parameters parameter-value set
-     * @return string URL generated
+     *
      * @throws RouteNotFoundException in case there is no route with the name specified
+     *
+     * @return string URL generated
      */
     public function generate(string $name, array $parameters = []): string;
 
@@ -27,8 +29,10 @@ public function generate(string $name, array $parameters = []): string;
      * @param array $parameters parameter-value set
      * @param string|null $scheme host scheme
      * @param string|null $host host for manual setup
-     * @return string URL generated
+     *
      * @throws RouteNotFoundException in case there is no route with the name specified
+     *
+     * @return string URL generated
      */
     public function generateAbsolute(string $name, array $parameters = [], string $scheme = null, string $host = null): string;