style: add BrainbitsCodingStandard and phpcs

timonf · timonf · commit 6b7819a82613 · 2021-10-15T16:42:41.000+02:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -44,3 +44,6 @@ jobs:
 
       - name: "Unit tests"
         run: "vendor/bin/phpunit"
+
+      - name: "Coding style"
+        run: "vendor/bin/phpcs --report=summary"
diff --git a/composer.json b/composer.json
@@ -19,7 +19,9 @@
         "symfony/http-foundation": ">=4.4",
         "symfony/security-core": ">=4.4",
         "phpspec/prophecy": "^1.14",
-        "phpspec/prophecy-phpunit": "^2.0.1"
+        "phpspec/prophecy-phpunit": "^2.0.1",
+        "squizlabs/php_codesniffer": "^3.6",
+        "brainbits/phpcs-standard": "^5.0"
     },
     "suggest": {
         "symfony/http-foundation": "If you want to use the SymfonySessionOwnerFactory",
diff --git a/phpcs.xml b/phpcs.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="PHP_CodeSniffer" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd">
+    <file extension="php">src/</file>
+    <arg name="basepath" value="." />
+    <arg name="colors" />
+    <rule ref="Brainbits">
+        <exclude name="SlevomatCodingStandard.Classes.SuperfluousExceptionNaming.SuperfluousSuffix" />
+        <exclude name="SlevomatCodingStandard.Classes.SuperfluousInterfaceNaming.SuperfluousSuffix" />
+    </rule>
+</ruleset>
diff --git a/src/Block.php b/src/Block.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
@@ -16,16 +16,17 @@
 use Brainbits\Blocking\Identity\IdentityInterface;
 use Brainbits\Blocking\Owner\OwnerInterface;
 use DateTimeImmutable;
+use DateTimeInterface;
 
 /**
  * Standard block.
  */
 class Block implements BlockInterface
 {
-    private $identifier;
-    private $owner;
-    private $createdAt;
-    private $updatedAt;
+    private IdentityInterface $identifier;
+    private OwnerInterface $owner;
+    private DateTimeInterface $createdAt;
+    private DateTimeInterface $updatedAt;
 
     public function __construct(IdentityInterface $identifier, OwnerInterface $owner, DateTimeImmutable $createdAt)
     {
diff --git a/src/BlockInterface.php b/src/BlockInterface.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
diff --git a/src/BlockableInterface.php b/src/BlockableInterface.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
@@ -22,8 +22,6 @@ interface BlockableInterface
 {
     /**
      * Return block identifier
-     *
-     * @return IdentityInterface
      */
-    public function getBlockIdentifier();
+    public function getBlockIdentifier(): IdentityInterface;
 }
diff --git a/src/Blocker.php b/src/Blocker.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
@@ -25,12 +25,15 @@
  */
 class Blocker
 {
-    private $storage;
-    private $ownerFactory;
-    private $validator;
-
-    public function __construct(StorageInterface $adapter, OwnerFactoryInterface $ownerFactory, ValidatorInterface $validator)
-    {
+    private StorageInterface $storage;
+    private OwnerFactoryInterface $ownerFactory;
+    private ValidatorInterface $validator;
+
+    public function __construct(
+        StorageInterface $adapter,
+        OwnerFactoryInterface $ownerFactory,
+        ValidatorInterface $validator
+    ) {
         $this->storage = $adapter;
         $this->ownerFactory = $ownerFactory;
         $this->validator = $validator;
@@ -56,6 +59,7 @@ public function tryBlock(IdentityInterface $identifier): ?BlockInterface
             if (!$block->isOwnedBy($owner)) {
                 return null;
             }
+
             $this->storage->touch($block);
 
             return $block;
@@ -71,7 +75,7 @@ public function tryBlock(IdentityInterface $identifier): ?BlockInterface
     public function unblock(IdentityInterface $identifier): ?BlockInterface
     {
         $block = $this->getBlock($identifier);
-        if (null === $block) {
+        if ($block === null) {
             return null;
         }
 
diff --git a/src/Exception/BlockFailedException.php b/src/Exception/BlockFailedException.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
@@ -15,13 +15,15 @@
 
 use Brainbits\Blocking\Identity\IdentityInterface;
 
+use function sprintf;
+
 /**
  * Block failed exception.
  */
 class BlockFailedException extends RuntimeException
 {
     public static function createAlreadyBlocked(IdentityInterface $identifier): self
     {
-        return new self("Identifier $identifier is already blocked.");
+        return new self(sprintf('Identifier %s is already blocked.', $identifier));
     }
 }
diff --git a/src/Exception/DirectoryNotWritableException.php b/src/Exception/DirectoryNotWritableException.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
@@ -13,13 +13,15 @@
 
 namespace Brainbits\Blocking\Exception;
 
+use function sprintf;
+
 /**
  * Directory not writable exception.
  */
 class DirectoryNotWritableException extends RuntimeException
 {
     public static function create(string $dirname): self
     {
-        return new self("Directory $dirname not writable.");
+        return new self(sprintf('Directory %s not writable.', $dirname));
     }
 }
diff --git a/src/Exception/ExceptionInterface.php b/src/Exception/ExceptionInterface.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
@@ -13,9 +13,11 @@
 
 namespace Brainbits\Blocking\Exception;
 
+use Throwable;
+
 /**
  * Exception interface.
  */
-interface ExceptionInterface extends \Throwable
+interface ExceptionInterface extends Throwable
 {
 }
diff --git a/src/Exception/FileNotWritableException.php b/src/Exception/FileNotWritableException.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
@@ -13,13 +13,15 @@
 
 namespace Brainbits\Blocking\Exception;
 
+use function sprintf;
+
 /**
  * File not writable exception.
  */
 class FileNotWritableException extends RuntimeException
 {
     public static function create(string $filename): self
     {
-        return new self("File $filename not writable.");
+        return new self(sprintf('File %s not writable.', $filename));
     }
 }
diff --git a/src/Exception/IOException.php b/src/Exception/IOException.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
@@ -13,23 +13,25 @@
 
 namespace Brainbits\Blocking\Exception;
 
+use function sprintf;
+
 /**
  * Input/output exception.
  */
 class IOException extends RuntimeException
 {
     public static function createWriteFailed(string $filename): self
     {
-        return new self("Write file $filename failed.");
+        return new self(sprintf('Write file %s failed.', $filename));
     }
 
     public static function createTouchFailed(string $filename): self
     {
-        return new self("Touch file $filename failed.");
+        return new self(sprintf('Touch file %s failed.', $filename));
     }
 
     public static function createUnlinkFailed(string $filename): self
     {
-        return new self("Unlink file $filename failed.");
+        return new self(sprintf('Unlink file %s failed.', $filename));
     }
 }
diff --git a/src/Exception/NoTokenFoundException.php b/src/Exception/NoTokenFoundException.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
@@ -20,6 +20,6 @@ class NoTokenFoundException extends RuntimeException
 {
     public static function create(): self
     {
-        return new self("No token found.");
+        return new self('No token found.');
     }
 }
diff --git a/src/Exception/NoUserFoundException.php b/src/Exception/NoUserFoundException.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
@@ -20,6 +20,6 @@ class NoUserFoundException extends RuntimeException
 {
     public static function create(): self
     {
-        return new self("No user found.");
+        return new self('No user found.');
     }
 }
diff --git a/src/Exception/RuntimeException.php b/src/Exception/RuntimeException.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
diff --git a/src/Exception/UnserializeFailedException.php b/src/Exception/UnserializeFailedException.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
@@ -20,7 +20,7 @@
  */
 final class UnserializeFailedException extends RuntimeException
 {
-    private $input;
+    private string $input;
 
     public function __construct(string $message, ?int $code, ?Throwable $previous, string $input)
     {
@@ -29,12 +29,9 @@ public function __construct(string $message, ?int $code, ?Throwable $previous, s
         $this->input = $input;
     }
 
-    /**
-     * @param mixed $input
-     */
-    public static function createFromInput($input): self
+    public static function createFromInput(mixed $input): self
     {
-        return new self("Unserialize failed.", null, null, (string) $input);
+        return new self('Unserialize failed.', null, null, (string) $input);
     }
 
     public function getInput(): string
diff --git a/src/Identity/Identity.php b/src/Identity/Identity.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
@@ -18,7 +18,7 @@
  */
 class Identity implements IdentityInterface
 {
-    private $identityValue;
+    private string $identityValue;
 
     public function __construct(string $identityValue)
     {
diff --git a/src/Identity/IdentityInterface.php b/src/Identity/IdentityInterface.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
diff --git a/src/Owner/Owner.php b/src/Owner/Owner.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
@@ -13,12 +13,9 @@
 
 namespace Brainbits\Blocking\Owner;
 
-/**
- * Owner.
- */
 class Owner implements OwnerInterface
 {
-    private $ownerValue;
+    private string $ownerValue;
 
     public function __construct(string $ownerValue)
     {
diff --git a/src/Owner/OwnerFactoryInterface.php b/src/Owner/OwnerFactoryInterface.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
diff --git a/src/Owner/OwnerInterface.php b/src/Owner/OwnerInterface.php
@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 /*
  * This file is part of the brainbits blocking package.
diff --git a/src/Owner/SymfonySessionOwnerFactory.php b/src/Owner/SymfonySessionOwnerFactory.php
diff --git a/src/Owner/SymfonyTokenOwnerFactory.php b/src/Owner/SymfonyTokenOwnerFactory.php
diff --git a/src/Owner/ValueOwnerFactory.php b/src/Owner/ValueOwnerFactory.php
diff --git a/src/Storage/FilesystemStorage.php b/src/Storage/FilesystemStorage.php
diff --git a/src/Storage/InMemoryStorage.php b/src/Storage/InMemoryStorage.php
diff --git a/src/Storage/StorageInterface.php b/src/Storage/StorageInterface.php
diff --git a/src/Validator/AlwaysInvalidateValidator.php b/src/Validator/AlwaysInvalidateValidator.php
diff --git a/src/Validator/ExpiredValidator.php b/src/Validator/ExpiredValidator.php
diff --git a/src/Validator/ValidatorInterface.php b/src/Validator/ValidatorInterface.php

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-declare(strict_types = 1);`
	`3`	`+declare(strict_types=1);`
`4`	`4`
`5`	`5`	`/*`
`6`	`6`	`* This file is part of the brainbits blocking package.`
`@@ -15,13 +15,15 @@`
`15`	`15`
`16`	`16`	`use Brainbits\Blocking\Identity\IdentityInterface;`
`17`	`17`
	`18`	`+use function sprintf;`
	`19`	`+`
`18`	`20`	`/**`
`19`	`21`	`* Block failed exception.`
`20`	`22`	`*/`
`21`	`23`	`class BlockFailedException extends RuntimeException`
`22`	`24`	`{`
`23`	`25`	`public static function createAlreadyBlocked(IdentityInterface $identifier): self`
`24`	`26`	`{`
`25`		`- return new self("Identifier $identifier is already blocked.");`
	`27`	`+ return new self(sprintf('Identifier %s is already blocked.', $identifier));`
`26`	`28`	`}`
`27`	`29`	`}`