Update

.gitattributes

@@ -5,4 +5,5 @@
 Dockerfile export-ignore
 docker-compose.yml export-ignore
 phpstan.dist.neon export-ignore
+phpcs.xml.dist export-ignore
 phpunit.xml export-ignore

.github/workflows/build.yml

@@ -7,11 +7,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: ['8.1', '8.2']
+        php: ['8.1', '8.2', '8.3']
     name: Testing on PHP ${{ matrix.php }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -26,5 +26,8 @@ jobs:
       - name: Run phpunit
         run: vendor/bin/phpunit
 
-      - name: Run phpstan
-        run: composer require --dev illuminate/support && vendor/bin/phpstan analyze --no-progress --autoload-file=tests/phpstan/bootstrap.php --level=5 src/
+      - name: Run analyzer
+        run: composer require --dev illuminate/support && vendor/bin/phpstan analyze --no-progress --autoload-file=tests/phpstan/bootstrap.php src/
+
+      - name: Validate coding standards
+        run: vendor/bin/phpcs

composer.json

@@ -19,17 +19,23 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^10.0",
-        "phpstan/phpstan": "^1"
+        "phpstan/phpstan": "^1",
+        "squizlabs/php_codesniffer": "^3.8",
+        "slevomat/coding-standard": "~8.0"
     },
     "autoload": {
         "psr-4": {
-            "Intervention\\HttpAuth\\": "src/"
+            "Intervention\\HttpAuth\\": "src"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Intervention\\HttpAuth\\Test\\": "tests/"
+            "Intervention\\HttpAuth\\Tests\\": "tests"
         }
     },
-    "minimum-stability": "stable"
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
+    }
 }

phpcs.xml.dist

@@ -0,0 +1,68 @@
+<?xml version="1.0"?>
+<ruleset name="Intervention">
+  <file>src/</file>
+  <file>tests/</file>
+  <arg name="colors"/>
+  <arg value="p"/>
+
+  <rule ref="PSR12"/>
+  <rule ref="Generic.Arrays.ArrayIndent"/>
+  <rule ref="Generic.ControlStructures.InlineControlStructure"/>
+  <rule ref="Generic.Formatting.SpaceAfterCast"/>
+  <rule ref="Generic.Formatting.SpaceAfterNot">
+    <properties>
+      <property name="spacing" value="0" />
+    </properties>
+  </rule>
+  <rule ref="Generic.Metrics.NestingLevel"/>
+  <rule ref="SlevomatCodingStandard.Arrays.SingleLineArrayWhitespace"/>
+  <rule ref="SlevomatCodingStandard.Arrays.DisallowImplicitArrayCreation"/>
+  <rule ref="SlevomatCodingStandard.Classes.ClassConstantVisibility"/>
+  <rule ref="SlevomatCodingStandard.Classes.ClassMemberSpacing"/>
+  <rule ref="SlevomatCodingStandard.Classes.ConstantSpacing"/>
+  <rule ref="SlevomatCodingStandard.Classes.MethodSpacing"/>
+  <rule ref="SlevomatCodingStandard.Classes.ModernClassNameReference"/>
+  <rule ref="SlevomatCodingStandard.Classes.ParentCallSpacing"/>
+  <rule ref="SlevomatCodingStandard.Classes.PropertyDeclaration"/>
+  <rule ref="SlevomatCodingStandard.Classes.RequireSelfReference"/>
+  <rule ref="SlevomatCodingStandard.Classes.TraitUseDeclaration"/>
+  <rule ref="SlevomatCodingStandard.Files.TypeNameMatchesFileName">
+    <properties>
+      <property name="rootNamespaces" type="array">
+        <element key="src" value="Intervention\HttpAuth"/>
+        <element key="tests" value="Intervention\HttpAuth\Tests"/>
+      </property>
+    </properties>
+  </rule>
+  <rule ref="SlevomatCodingStandard.Namespaces.DisallowGroupUse"/>
+  <rule ref="SlevomatCodingStandard.Namespaces.MultipleUsesPerLine"/>
+  <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">
+    <properties>
+      <property name="searchAnnotations" value="true" />
+    </properties>
+  </rule>
+  <rule ref="SlevomatCodingStandard.Namespaces.UseDoesNotStartWithBackslash"/>
+  <rule ref="SlevomatCodingStandard.Namespaces.UseFromSameNamespace"/>
+  <rule ref="SlevomatCodingStandard.Namespaces.UseSpacing"/>
+  <rule ref="SlevomatCodingStandard.Namespaces.UselessAlias"/>
+  <rule ref="SlevomatCodingStandard.Strings.DisallowVariableParsing"/>
+  <rule ref="SlevomatCodingStandard.TypeHints.DeclareStrictTypes">
+    <properties>
+      <property name="spacesCountAroundEqualsSign" value="0" />
+    </properties>
+  </rule>
+  <rule ref="SlevomatCodingStandard.TypeHints.LongTypeHints"/>
+  <rule ref="SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue"/>
+  <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHintSpacing"/>
+  <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing"/>
+  <rule ref="SlevomatCodingStandard.TypeHints.UnionTypeHintFormat">
+    <properties>
+      <property name="withSpaces" value="no" />
+      <property name="nullPosition" value="first" />
+    </properties>
+  </rule>
+  <rule ref="SlevomatCodingStandard.PHP.UselessSemicolon"/>
+  <rule ref="SlevomatCodingStandard.Whitespaces.DuplicateSpaces"/>
+  <rule ref="SlevomatCodingStandard.Variables.UnusedVariable"/>
+  <rule ref="SlevomatCodingStandard.Variables.UselessVariable"/>
+</ruleset>

src/AbstractVault.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Intervention\HttpAuth;
 
 abstract class AbstractVault
@@ -14,7 +16,7 @@ abstract public function getDirective(): Directive;
     /**
      * Determine if vault is accessible by given key
      *
-     * @param  Key    $key
+     * @param Key $key
      * @return bool
      */
     abstract public function unlocksWithKey(Key $key): bool;
@@ -129,8 +131,8 @@ public function getPassword(): string
     /**
      * Set username and password at once
      *
-     * @param  string $username
-     * @param  string $password
+     * @param string $username
+     * @param string $password
      * @return AbstractVault
      */
     public function withCredentials(string $username, string $password): self

src/Authenticator.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Intervention\HttpAuth;
 
 use Intervention\HttpAuth\Exception\NotSupportedException;
@@ -77,7 +79,7 @@ public function secure(?string $message = null): void
     /**
      * Set type of vault to configure
      *
-     * @param  string $type
+     * @param string $type
      * @return self
      */
     public function withType(string $type): self
@@ -90,7 +92,7 @@ public function withType(string $type): self
     /**
      * Set realm name of configured vault
      *
-     * @param  string $realm
+     * @param string $realm
      * @return Authenticator
      */
     public function withRealm(string $realm): self
@@ -103,7 +105,7 @@ public function withRealm(string $realm): self
     /**
      * Set username of configured vault
      *
-     * @param  string $username
+     * @param string $username
      * @return Authenticator
      */
     public function withUsername(string $username): self
@@ -116,7 +118,7 @@ public function withUsername(string $username): self
     /**
      * Set password of configured vault
      *
-     * @param  string $password
+     * @param string $password
      * @return Authenticator
      */
     public function withPassword(string $password): self
@@ -129,8 +131,8 @@ public function withPassword(string $password): self
     /**
      * Set credentials for configured vault
      *
-     * @param  string $username
-     * @param  string $password
+     * @param string $username
+     * @param string $password
      * @return Authenticator
      */
     public function withCredentials(string $username, string $password): self

src/Directive.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Intervention\HttpAuth;
 
 class Directive

src/Environment.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Intervention\HttpAuth;
 
 use Intervention\HttpAuth\Exception\AuthentificationException;
@@ -28,8 +30,7 @@ public function getKey(): Key
     {
         foreach ($this->tokenClassnames as $classname) {
             try {
-                $key = (new $classname())->getKey();
-                return $key;
+                return (new $classname())->getKey();
             } catch (AuthentificationException) {
                 // try next
             }

src/Exception/AuthentificationException.php

@@ -1,10 +1,11 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Intervention\HttpAuth\Exception;
 
 use RuntimeException;
 
 class AuthentificationException extends RuntimeException
 {
-    //
 }

src/Exception/NotSupportedException.php

@@ -1,10 +1,11 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Intervention\HttpAuth\Exception;
 
 use RuntimeException;
 
 class NotSupportedException extends RuntimeException
 {
-    //
 }

src/Key.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Intervention\HttpAuth;
 
 class Key
@@ -178,10 +180,10 @@ public function getResponse(): ?string
      * Set property to given value on current instance
      *
      * @param string $name
-     * @param mixed  $value
+     * @param mixed $value
      * @return Key
      */
-    public function setProperty($name, $value): Key
+    public function setProperty($name, $value): self
     {
         if (property_exists($this, $name)) {
             $this->{$name} = $value;

src/Token/AbstractToken.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Intervention\HttpAuth\Token;
 
 use Intervention\HttpAuth\Key;

src/Token/HttpAuthentification.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Intervention\HttpAuth\Token;
 
 use Intervention\HttpAuth\Exception\AuthentificationException;

src/Token/HttpAuthorization.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Intervention\HttpAuth\Token;
 
 use Intervention\HttpAuth\Exception\AuthentificationException;

src/Token/PhpAuthDigest.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Intervention\HttpAuth\Token;
 
 use Intervention\HttpAuth\Exception\AuthentificationException;

src/Token/PhpAuthUser.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Intervention\HttpAuth\Token;
 
 use Intervention\HttpAuth\Exception\AuthentificationException;

src/Token/RedirectHttpAuthorization.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Intervention\HttpAuth\Token;
 
 use Intervention\HttpAuth\Exception\AuthentificationException;

src/Vault/BasicVault.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Intervention\HttpAuth\Vault;
 
 use Intervention\HttpAuth\AbstractVault;
@@ -11,7 +13,7 @@ class BasicVault extends AbstractVault
     /**
      * Determine if given key is able to unlock (access) vault.
      *
-     * @param  Key    $key
+     * @param Key $key
      * @return bool
      */
     public function unlocksWithKey(Key $key): bool

src/Vault/DigestVault.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Intervention\HttpAuth\Vault;
 
 use Intervention\HttpAuth\AbstractVault;
@@ -11,7 +13,7 @@ class DigestVault extends AbstractVault
     /**
      * Determine if given key is able to unlock (access) vault.
      *
-     * @param  Key    $key
+     * @param Key $key
      * @return bool
      */
     public function unlocksWithKey(Key $key): bool
@@ -25,7 +27,7 @@ public function unlocksWithKey(Key $key): bool
     /**
      * Build and return hash from given key/vault
      *
-     * @param  Key    $key
+     * @param Key $key
      * @return string
      */
     private function getKeyHash(Key $key): string

tests/AbstractTokenTestCase.php

@@ -1,6 +1,8 @@
 <?php
 
-namespace Intervention\HttpAuth\Test;
+declare(strict_types=1);
+
+namespace Intervention\HttpAuth\Tests;
 
 use PHPUnit\Framework\TestCase;
 

tests/Unit/AbstractVaultTest.php

@@ -1,6 +1,8 @@
 <?php
 
-namespace Intervention\HttpAuth\Test\Unit;
+declare(strict_types=1);
+
+namespace Intervention\HttpAuth\Tests\Unit;
 
 use Intervention\HttpAuth\AbstractVault;
 use PHPUnit\Framework\TestCase;