Merge pull request #12 from geerteltink/feat/coding-standard-2.2.0

feat: laminas coding standard 2.2.0
mezzio · May 26, 2021 · 979a7e8 · 979a7e8
2 parents 390f0e9 + 114c1d8
commit 979a7e8
Show file tree

Hide file tree

Showing 11 changed files with 371 additions and 131 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+/.phpcs-cache
 /.phpunit.result.cache
 /clover.xml
 /coveralls-upload.json

diff --git a/composer.json b/composer.json
@@ -36,10 +36,10 @@
         "psr/http-message": "^1.0.1"
     },
     "require-dev": {
-        "laminas/laminas-coding-standard": "~1.0.0",
+        "laminas/laminas-coding-standard": "~2.2.0",
         "laminas/laminas-servicemanager": "^3.3",
-        "phpspec/prophecy-phpunit": "^2.0",
         "phpspec/prophecy": "^1.12",
+        "phpspec/prophecy-phpunit": "^2.0",
         "phpunit/phpunit": "^9.3"
     },
     "conflict": {

diff --git a/composer.lock b/composer.lock
diff --git a/phpcs.xml b/phpcs.xml
@@ -1,8 +1,20 @@
 <?xml version="1.0"?>
-<ruleset name="Laminas Coding Standard">
-    <rule ref="./vendor/laminas/laminas-coding-standard/ruleset.xml"/>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">
+
+    <arg name="basepath" value="."/>
+    <arg name="cache" value=".phpcs-cache"/>
+    <arg name="colors"/>
+    <arg name="extensions" value="php"/>
+    <arg name="parallel" value="80"/>
+
+    <!-- Show progress -->
+    <arg value="p"/>
 
     <!-- Paths to check -->
     <file>src</file>
     <file>test</file>
+
+    <!-- Include all rules from the Laminas Coding Standard -->
+    <rule ref="LaminasCodingStandard"/>
 </ruleset>
diff --git a/src/ConfigProvider.php b/src/ConfigProvider.php
@@ -4,21 +4,23 @@
 
 namespace Mezzio\Authorization\Rbac;
 
+use Zend\Expressive\Authorization\Rbac\ZendRbac;
+
 class ConfigProvider
 {
-    public function __invoke() : array
+    public function __invoke(): array
     {
         return [
             'dependencies' => $this->getDependencies(),
         ];
     }
 
-    public function getDependencies() : array
+    public function getDependencies(): array
     {
         return [
             // Legacy Zend Framework aliases
-            'aliases' => [
-                \Zend\Expressive\Authorization\Rbac\ZendRbac::class => LaminasRbac::class,
+            'aliases'   => [
+                ZendRbac::class => LaminasRbac::class,
             ],
             'factories' => [
                 LaminasRbac::class => LaminasRbacFactory::class,

diff --git a/src/LaminasRbac.php b/src/LaminasRbac.php
@@ -15,19 +15,15 @@
 
 class LaminasRbac implements AuthorizationInterface
 {
-    /**
-     * @var Rbac
-     */
+    /** @var Rbac */
     private $rbac;
 
-    /**
-     * @var null|AssertionInterface
-     */
+    /** @var null|AssertionInterface */
     private $assertion;
 
-    public function __construct(Rbac $rbac, LaminasRbacAssertionInterface $assertion = null)
+    public function __construct(Rbac $rbac, ?LaminasRbacAssertionInterface $assertion = null)
     {
-        $this->rbac = $rbac;
+        $this->rbac      = $rbac;
         $this->assertion = $assertion;
     }
 
@@ -36,7 +32,7 @@ public function __construct(Rbac $rbac, LaminasRbacAssertionInterface $assertion
      *
      * @throws Exception\RuntimeException
      */
-    public function isGranted(string $role, ServerRequestInterface $request) : bool
+    public function isGranted(string $role, ServerRequestInterface $request): bool
     {
         $routeResult = $request->getAttribute(RouteResult::class, false);
         if (false === $routeResult) {

diff --git a/src/LaminasRbacAssertionInterface.php b/src/LaminasRbacAssertionInterface.php
@@ -9,5 +9,5 @@
 
 interface LaminasRbacAssertionInterface extends AssertionInterface
 {
-    public function setRequest(ServerRequestInterface $request) : void;
+    public function setRequest(ServerRequestInterface $request): void;
 }
diff --git a/src/LaminasRbacFactory.php b/src/LaminasRbacFactory.php
@@ -9,6 +9,7 @@
 use Mezzio\Authorization\AuthorizationInterface;
 use Mezzio\Authorization\Exception;
 use Psr\Container\ContainerInterface;
+use Zend\Expressive\Authorization\Rbac\ZendRbacAssertionInterface;
 
 use function sprintf;
 
@@ -17,7 +18,7 @@ class LaminasRbacFactory
     /**
      * @throws Exception\InvalidConfigException
      */
-    public function __invoke(ContainerInterface $container) : AuthorizationInterface
+    public function __invoke(ContainerInterface $container): AuthorizationInterface
     {
         $config = $container->get('config')['mezzio-authorization-rbac'] ?? null;
         if (null === $config) {
@@ -45,8 +46,8 @@ public function __invoke(ContainerInterface $container) : AuthorizationInterface
 
         $assertion = $container->has(LaminasRbacAssertionInterface::class)
             ? $container->get(LaminasRbacAssertionInterface::class)
-            : ($container->has(\Zend\Expressive\Authorization\Rbac\ZendRbacAssertionInterface::class)
-                ? $container->get(\Zend\Expressive\Authorization\Rbac\ZendRbacAssertionInterface::class)
+            : ($container->has(ZendRbacAssertionInterface::class)
+                ? $container->get(ZendRbacAssertionInterface::class)
                 : null);
 
         return new LaminasRbac($rbac, $assertion);
@@ -55,7 +56,7 @@ public function __invoke(ContainerInterface $container) : AuthorizationInterface
     /**
      * @throws Exception\InvalidConfigException
      */
-    private function injectRoles(Rbac $rbac, array $roles) : void
+    private function injectRoles(Rbac $rbac, array $roles): void
     {
         $rbac->setCreateMissingRoles(true);
 
@@ -72,7 +73,7 @@ private function injectRoles(Rbac $rbac, array $roles) : void
     /**
      * @throws Exception\InvalidConfigException
      */
-    private function injectPermissions(Rbac $rbac, array $specification) : void
+    private function injectPermissions(Rbac $rbac, array $specification): void
     {
         foreach ($specification as $role => $permissions) {
             foreach ($permissions as $permission) {

diff --git a/test/ConfigProviderTest.php b/test/ConfigProviderTest.php
@@ -19,12 +19,12 @@ class ConfigProviderTest extends TestCase
     /** @var ConfigProvider */
     private $provider;
 
-    protected function setUp() : void
+    protected function setUp(): void
     {
         $this->provider = new ConfigProvider();
     }
 
-    public function testInvocationReturnsArray()
+    public function testInvocationReturnsArray(): array
     {
         $config = ($this->provider)();
         $this->assertIsArray($config);
@@ -56,14 +56,14 @@ public function testServicesDefinedInConfigProvider()
         foreach ($json['packages'] as $package) {
             if (isset($package['extra']['laminas']['config-provider'])) {
                 $configProvider = new $package['extra']['laminas']['config-provider']();
-                $config = array_merge_recursive($config, $configProvider());
+                $config         = array_merge_recursive($config, $configProvider());
             }
         }
 
         $config['dependencies']['services']['config'] = [
             'mezzio-authorization-rbac' => ['roles' => [], 'permissions' => []],
         ];
-        $container = $this->getContainer($config['dependencies']);
+        $container                                    = $this->getContainer($config['dependencies']);
 
         $dependencies = $this->provider->getDependencies();
         foreach ($dependencies['factories'] as $name => $factory) {
@@ -75,7 +75,7 @@ public function testServicesDefinedInConfigProvider()
         }
     }
 
-    private function getContainer(array $dependencies) : ServiceManager
+    private function getContainer(array $dependencies): ServiceManager
     {
         return new ServiceManager($dependencies);
     }

diff --git a/test/LaminasRbacFactoryTest.php b/test/LaminasRbacFactoryTest.php
@@ -12,6 +12,7 @@
 use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Container\ContainerInterface;
+use Zend\Expressive\Authorization\Rbac\ZendRbacAssertionInterface;
 
 class LaminasRbacFactoryTest extends TestCase
 {
@@ -20,7 +21,7 @@ class LaminasRbacFactoryTest extends TestCase
     /** @var ContainerInterface|ObjectProphecy */
     private $container;
 
-    protected function setUp() : void
+    protected function setUp(): void
     {
         $this->container = $this->prophesize(ContainerInterface::class);
     }
@@ -51,8 +52,8 @@ public function testFactoryWithoutPermissions()
     {
         $this->container->get('config')->willReturn([
             'mezzio-authorization-rbac' => [
-                'roles' => []
-            ]
+                'roles' => [],
+            ],
         ]);
 
         $factory = new LaminasRbacFactory();
@@ -66,14 +67,14 @@ public function testFactoryWithEmptyRolesPermissionsWithoutAssertion()
     {
         $this->container->get('config')->willReturn([
             'mezzio-authorization-rbac' => [
-                'roles' => [],
-                'permissions' => []
-            ]
+                'roles'       => [],
+                'permissions' => [],
+            ],
         ]);
         $this->container->has(LaminasRbacAssertionInterface::class)->willReturn(false);
-        $this->container->has(\Zend\Expressive\Authorization\Rbac\ZendRbacAssertionInterface::class)->willReturn(false);
+        $this->container->has(ZendRbacAssertionInterface::class)->willReturn(false);
 
-        $factory = new LaminasRbacFactory();
+        $factory     = new LaminasRbacFactory();
         $laminasRbac = $factory($this->container->reveal());
         $this->assertInstanceOf(LaminasRbac::class, $laminasRbac);
     }
@@ -82,16 +83,16 @@ public function testFactoryWithEmptyRolesPermissionsWithAssertion()
     {
         $this->container->get('config')->willReturn([
             'mezzio-authorization-rbac' => [
-                'roles' => [],
-                'permissions' => []
-            ]
+                'roles'       => [],
+                'permissions' => [],
+            ],
         ]);
 
         $assertion = $this->prophesize(LaminasRbacAssertionInterface::class);
         $this->container->has(LaminasRbacAssertionInterface::class)->willReturn(true);
         $this->container->get(LaminasRbacAssertionInterface::class)->willReturn($assertion->reveal());
 
-        $factory = new LaminasRbacFactory();
+        $factory     = new LaminasRbacFactory();
         $laminasRbac = $factory($this->container->reveal());
         $this->assertInstanceOf(LaminasRbac::class, $laminasRbac);
     }
@@ -100,17 +101,17 @@ public function testFactoryWithoutAssertion()
     {
         $this->container->get('config')->willReturn([
             'mezzio-authorization-rbac' => [
-                'roles' => [
+                'roles'       => [
                     'administrator' => [],
                     'editor'        => ['administrator'],
                     'contributor'   => ['editor'],
                 ],
                 'permissions' => [
-                    'contributor' => [
+                    'contributor'   => [
                         'admin.dashboard',
                         'admin.posts',
                     ],
-                    'editor' => [
+                    'editor'        => [
                         'admin.publish',
                     ],
                     'administrator' => [
@@ -120,9 +121,9 @@ public function testFactoryWithoutAssertion()
             ],
         ]);
         $this->container->has(LaminasRbacAssertionInterface::class)->willReturn(false);
-        $this->container->has(\Zend\Expressive\Authorization\Rbac\ZendRbacAssertionInterface::class)->willReturn(false);
+        $this->container->has(ZendRbacAssertionInterface::class)->willReturn(false);
 
-        $factory = new LaminasRbacFactory();
+        $factory     = new LaminasRbacFactory();
         $laminasRbac = $factory($this->container->reveal());
         $this->assertInstanceOf(LaminasRbac::class, $laminasRbac);
     }
@@ -131,17 +132,17 @@ public function testFactoryWithAssertion()
     {
         $this->container->get('config')->willReturn([
             'mezzio-authorization-rbac' => [
-                'roles' => [
+                'roles'       => [
                     'administrator' => [],
                     'editor'        => ['administrator'],
                     'contributor'   => ['editor'],
                 ],
                 'permissions' => [
-                    'contributor' => [
+                    'contributor'   => [
                         'admin.dashboard',
                         'admin.posts',
                     ],
-                    'editor' => [
+                    'editor'        => [
                         'admin.publish',
                     ],
                     'administrator' => [
@@ -154,7 +155,7 @@ public function testFactoryWithAssertion()
         $this->container->has(LaminasRbacAssertionInterface::class)->willReturn(true);
         $this->container->get(LaminasRbacAssertionInterface::class)->willReturn($assertion->reveal());
 
-        $factory = new LaminasRbacFactory();
+        $factory     = new LaminasRbacFactory();
         $laminasRbac = $factory($this->container->reveal());
         $this->assertInstanceOf(LaminasRbac::class, $laminasRbac);
     }
@@ -163,14 +164,14 @@ public function testFactoryWithInvalidRole()
     {
         $this->container->get('config')->willReturn([
             'mezzio-authorization-rbac' => [
-                'roles' => [
+                'roles'       => [
                     1 => [],
                 ],
                 'permissions' => [],
             ],
         ]);
         $this->container->has(LaminasRbacAssertionInterface::class)->willReturn(false);
-        $this->container->has(\Zend\Expressive\Authorization\Rbac\ZendRbacAssertionInterface::class)->willReturn(false);
+        $this->container->has(ZendRbacAssertionInterface::class)->willReturn(false);
 
         $factory = new LaminasRbacFactory();
 
@@ -182,19 +183,19 @@ public function testFactoryWithUnknownRole()
     {
         $this->container->get('config')->willReturn([
             'mezzio-authorization-rbac' => [
-                'roles' => [
+                'roles'       => [
                     'administrator' => [],
                 ],
                 'permissions' => [
                     'contributor' => [
                         'admin.dashboard',
                         'admin.posts',
-                    ]
-                ]
-            ]
+                    ],
+                ],
+            ],
         ]);
         $this->container->has(LaminasRbacAssertionInterface::class)->willReturn(false);
-        $this->container->has(\Zend\Expressive\Authorization\Rbac\ZendRbacAssertionInterface::class)->willReturn(false);
+        $this->container->has(ZendRbacAssertionInterface::class)->willReturn(false);
 
         $factory = new LaminasRbacFactory();
 

diff --git a/test/LaminasRbacTest.php b/test/LaminasRbacTest.php
@@ -25,9 +25,9 @@ class LaminasRbacTest extends TestCase
     /** @var LaminasRbacAssertionInterface|ObjectProphecy */
     private $assertion;
 
-    protected function setUp() : void
+    protected function setUp(): void
     {
-        $this->rbac = $this->prophesize(Rbac::class);
+        $this->rbac      = $this->prophesize(Rbac::class);
         $this->assertion = $this->prophesize(LaminasRbacAssertionInterface::class);
     }