qa: update to laminas-coding-standard v2.1

Updates coding standard constraint to `~2.1.0` and applies it to the code base.

Signed-off-by: Matthew Weier O'Phinney <[email protected]>

Author: weierophinney

.gitignore

@@ -1,3 +1,4 @@
+/.phpcs-cache
 /.phpunit.result.cache
 /clover.xml
 /composer.lock

composer.json

@@ -34,7 +34,7 @@
         "psr/http-server-middleware": "^1.0"
     },
     "require-dev": {
-        "laminas/laminas-coding-standard": "~1.0.0",
+        "laminas/laminas-coding-standard": "~2.1.0",
         "laminas/laminas-diactoros": "^2.2",
         "phpunit/phpunit": "^9.3"
     },

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>

src/ConfigProvider.php

@@ -10,21 +10,23 @@
 
 namespace Mezzio\Session;
 
+use Zend\Expressive\Session\SessionMiddleware as LegacySessionMiddleware;
+
 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\Session\SessionMiddleware::class => SessionMiddleware::class,
+            'aliases'   => [
+                LegacySessionMiddleware::class => SessionMiddleware::class,
             ],
             'factories' => [
                 SessionMiddleware::class => SessionMiddlewareFactory::class,

src/Exception/InvalidHopsValueException.php

@@ -12,9 +12,11 @@
 
 use InvalidArgumentException;
 
+use function sprintf;
+
 class InvalidHopsValueException extends InvalidArgumentException implements ExceptionInterface
 {
-    public static function valueTooLow(string $key, int $hops) : self
+    public static function valueTooLow(string $key, int $hops): self
     {
         return new self(sprintf(
             'Hops value specified for flash message "%s" was too low; must be greater than 0, received %d',

src/Exception/InvalidSessionSegmentDataException.php

@@ -12,12 +12,17 @@
 
 use RuntimeException;
 
+use function get_class;
+use function gettype;
+use function is_object;
+use function sprintf;
+
 class InvalidSessionSegmentDataException extends RuntimeException implements ExceptionInterface
 {
     /**
      * @param mixed $data
      */
-    public static function whenRetrieving(string $name, $data) : self
+    public static function whenRetrieving(string $name, $data): self
     {
         return new self(sprintf(
             'Cannot retrieve session segment "%s"; data exists, but as a "%s" instead of an array',

src/Exception/NotInitializableException.php

@@ -14,9 +14,12 @@
 use Mezzio\Session\SessionPersistenceInterface;
 use RuntimeException;
 
+use function get_class;
+use function sprintf;
+
 final class NotInitializableException extends RuntimeException implements ExceptionInterface
 {
-    public static function invalidPersistence(SessionPersistenceInterface $persistence) : self
+    public static function invalidPersistence(SessionPersistenceInterface $persistence): self
     {
         return new self(sprintf(
             "Persistence '%s' does not implement '%s'",

src/Exception/SessionSegmentConflictException.php

@@ -12,25 +12,27 @@
 
 use RuntimeException;
 
+use function sprintf;
+
 class SessionSegmentConflictException extends RuntimeException implements ExceptionInterface
 {
-    public static function whenRetrieving(string $name) : self
+    public static function whenRetrieving(string $name): self
     {
         return new self(sprintf(
             'Retrieving session data "%s" via get(); however, this data refers to a session segment; aborting',
             $name
         ));
     }
 
-    public static function whenSetting(string $name) : self
+    public static function whenSetting(string $name): self
     {
         return new self(sprintf(
             'Attempting to set session data "%s"; however, this data refers to a session segment; aborting',
             $name
         ));
     }
 
-    public static function whenDeleting(string $name) : self
+    public static function whenDeleting(string $name): self
     {
         return new self(sprintf(
             'Attempting to unset session data "%s"; however, this data refers to a session segment. '

src/InitializePersistenceIdInterface.php

@@ -14,9 +14,6 @@ interface InitializePersistenceIdInterface
 {
     /**
      * Returns new instance with id generated / regenerated, if required
-     *
-     * @param SessionInterface $session
-     * @return SessionInterface
      */
-    public function initializeId(SessionInterface $session) : SessionInterface;
+    public function initializeId(SessionInterface $session): SessionInterface;
 }

src/InitializeSessionIdInterface.php

@@ -6,7 +6,6 @@
  * @license   https://github.com/mezzio/mezzio-session/blob/master/LICENSE.md New BSD License
  */
 
-
 declare(strict_types=1);
 
 namespace Mezzio\Session;
@@ -15,8 +14,6 @@ interface InitializeSessionIdInterface
 {
     /**
      * Returns id of session, generating / regenerating if required
-     *
-     * @return string
      */
-    public function initializeId() : string;
+    public function initializeId(): string;
 }

src/LazySession.php

@@ -27,14 +27,10 @@ final class LazySession implements
     SessionInterface,
     InitializeSessionIdInterface
 {
-    /**
-     * @var SessionPersistenceInterface
-     */
+    /** @var SessionPersistenceInterface */
     private $persistence;
 
-    /**
-     * @var null|SessionInterface
-     */
+    /** @var null|SessionInterface */
     private $proxiedSession;
 
     /**
@@ -47,16 +43,16 @@ final class LazySession implements
     public function __construct(SessionPersistenceInterface $persistence, ServerRequestInterface $request)
     {
         $this->persistence = $persistence;
-        $this->request = $request;
+        $this->request     = $request;
     }
 
-    public function regenerate() : SessionInterface
+    public function regenerate(): SessionInterface
     {
         $this->proxiedSession = $this->getProxiedSession()->regenerate();
         return $this;
     }
 
-    public function isRegenerated() : bool
+    public function isRegenerated(): bool
     {
         if (! $this->proxiedSession) {
             return false;
@@ -65,37 +61,44 @@ public function isRegenerated() : bool
         return $this->proxiedSession->isRegenerated();
     }
 
-    public function toArray() : array
+    public function toArray(): array
     {
         return $this->getProxiedSession()->toArray();
     }
 
+    /**
+     * @param null|mixed $default
+     * @return mixed
+     */
     public function get(string $name, $default = null)
     {
         return $this->getProxiedSession()->get($name, $default);
     }
 
-    public function has(string $name) : bool
+    public function has(string $name): bool
     {
         return $this->getProxiedSession()->has($name);
     }
 
-    public function set(string $name, $value) : void
+    /**
+     * @param mixed $value
+     */
+    public function set(string $name, $value): void
     {
         $this->getProxiedSession()->set($name, $value);
     }
 
-    public function unset(string $name) : void
+    public function unset(string $name): void
     {
         $this->getProxiedSession()->unset($name);
     }
 
-    public function clear() : void
+    public function clear(): void
     {
         $this->getProxiedSession()->clear();
     }
 
-    public function hasChanged() : bool
+    public function hasChanged(): bool
     {
         if (! $this->proxiedSession) {
             return false;
@@ -113,7 +116,7 @@ public function hasChanged() : bool
      *
      * @since 1.1.0
      */
-    public function getId() : string
+    public function getId(): string
     {
         $proxiedSession = $this->getProxiedSession();
         return $proxiedSession instanceof SessionIdentifierAwareInterface
@@ -126,7 +129,7 @@ public function getId() : string
      *
      * @since 1.2.0
      */
-    public function persistSessionFor(int $duration) : void
+    public function persistSessionFor(int $duration): void
     {
         $proxiedSession = $this->getProxiedSession();
         if ($proxiedSession instanceof SessionCookiePersistenceInterface) {
@@ -139,7 +142,7 @@ public function persistSessionFor(int $duration) : void
      *
      * @since 1.2.0
      */
-    public function getSessionLifetime() : int
+    public function getSessionLifetime(): int
     {
         $proxiedSession = $this->getProxiedSession();
         return $proxiedSession instanceof SessionCookiePersistenceInterface
@@ -157,8 +160,7 @@ public function initializeId(): string
         return $this->proxiedSession->getId();
     }
 
-
-    private function getProxiedSession() : SessionInterface
+    private function getProxiedSession(): SessionInterface
     {
         if ($this->proxiedSession) {
             return $this->proxiedSession;

src/Persistence/CacheHeadersGeneratorTrait.php

@@ -48,13 +48,13 @@ trait CacheHeadersGeneratorTrait
         'private_no_expire' => true,
     ];
 
-    /** @var false|string */
+    /** @var bool|string */
     private $lastModified;
 
     /**
      * Add cache headers to the response when needed.
      */
-    private function addCacheHeadersToResponse(ResponseInterface $response) : ResponseInterface
+    private function addCacheHeadersToResponse(ResponseInterface $response): ResponseInterface
     {
         if (! $this->cacheLimiter || $this->responseAlreadyHasCacheHeaders($response)) {
             return $response;
@@ -74,7 +74,7 @@ private function addCacheHeadersToResponse(ResponseInterface $response) : Respon
      * Generate cache http headers for this instance's session cache-limiter and
      * cache-expire values.
      */
-    private function generateCacheHeaders() : array
+    private function generateCacheHeaders(): array
     {
         // Unsupported cache_limiter => do not generate cache headers
         if (! isset(self::$supportedCacheLimiters[$this->cacheLimiter])) {
@@ -131,7 +131,7 @@ private function getLastModified()
             return $this->lastModified;
         }
 
-        $lastmod = getlastmod() ?: filemtime(__FILE__);
+        $lastmod            = getlastmod() ?: filemtime(__FILE__);
         $this->lastModified = $lastmod ? gmdate(Http::DATE_FORMAT, $lastmod) : false;
 
         return $this->lastModified;
@@ -140,7 +140,7 @@ private function getLastModified()
     /**
      * Check if the response already carries cache headers
      */
-    private function responseAlreadyHasCacheHeaders(ResponseInterface $response) : bool
+    private function responseAlreadyHasCacheHeaders(ResponseInterface $response): bool
     {
         return $response->hasHeader('Expires')
             || $response->hasHeader('Last-Modified')

src/Persistence/Http.php

@@ -20,6 +20,7 @@ class Http
      * values.
      *
      * òsee https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Date
+     *
      * @see https://tools.ietf.org/html/rfc7231#section-7.1.1.2
      */
     public const DATE_FORMAT = 'D, d M Y H:i:s T';