Fix code style

stevebauman · github-actions[bot] · commit 48f64f40418a · 2024-10-18T17:00:38.000Z
diff --git a/src/Auth/BindFailureListener.php b/src/Auth/BindFailureListener.php
@@ -33,7 +33,7 @@ public static function usingLaravelUi(string $controller = 'App\Http\Controllers
     /**
      * Register the bind failure listener upon resolving the given class.
      */
-    protected static function whenResolving(string $class, Closure $callback = null): void
+    protected static function whenResolving(string $class, ?Closure $callback = null): void
     {
         if (! class_exists($class)) {
             return;
diff --git a/src/Auth/ListensForLdapBindFailure.php b/src/Auth/ListensForLdapBindFailure.php
@@ -65,7 +65,7 @@ public function listenForLdapBindFailure(): void
      *
      * @throws ValidationException
      */
-    protected function ldapBindFailed(string $errorMessage, string $diagnosticMessage = null): void
+    protected function ldapBindFailed(string $errorMessage, ?string $diagnosticMessage = null): void
     {
         switch (true) {
             case $this->causedByLostConnection($errorMessage):
@@ -98,7 +98,7 @@ protected function ldapBindFailed(string $errorMessage, string $diagnosticMessag
      *
      * @throws ValidationException
      */
-    protected function handleLdapBindError(string $message, string $code = null): void
+    protected function handleLdapBindError(string $message, ?string $code = null): void
     {
         logger()->error($message, compact('code'));
 
diff --git a/src/Auth/Rule.php b/src/Auth/Rule.php
@@ -10,5 +10,5 @@ interface Rule
     /**
      * Determine if the rule passes validation.
      */
-    public function passes(LdapRecord $user, Eloquent $model = null): bool;
+    public function passes(LdapRecord $user, ?Eloquent $model = null): bool;
 }
diff --git a/src/Auth/Rules/OnlyImported.php b/src/Auth/Rules/OnlyImported.php
@@ -11,7 +11,7 @@ class OnlyImported implements Rule
     /**
      * {@inheritdoc}
      */
-    public function passes(LdapRecord $user, Eloquent $model = null): bool
+    public function passes(LdapRecord $user, ?Eloquent $model = null): bool
     {
         return $model?->exists;
     }
diff --git a/src/Auth/Validator.php b/src/Auth/Validator.php
@@ -29,7 +29,7 @@ public function __construct(iterable $rules = [])
     /**
      * Determine if all rules pass validation.
      */
-    public function passes(LdapRecord $user, Eloquent $model = null): bool
+    public function passes(LdapRecord $user, ?Eloquent $model = null): bool
     {
         foreach ($this->rules as $rule) {
             if (! $rule->passes($user, $model)) {
diff --git a/src/Events/Auth/Event.php b/src/Events/Auth/Event.php
@@ -20,7 +20,7 @@ abstract class Event
     /**
      * Constructor.
      */
-    public function __construct(LdapModel $object, EloquentModel $eloquent = null)
+    public function __construct(LdapModel $object, ?EloquentModel $eloquent = null)
     {
         $this->object = $object;
         $this->eloquent = $eloquent;
diff --git a/src/Events/Auth/RuleEvent.php b/src/Events/Auth/RuleEvent.php
@@ -16,7 +16,7 @@ abstract class RuleEvent extends Event
     /**
      * Constructor.
      */
-    public function __construct(Rule $rule, LdapModel $object, EloquentModel $eloquent = null)
+    public function __construct(Rule $rule, LdapModel $object, ?EloquentModel $eloquent = null)
     {
         parent::__construct($object, $eloquent);
 
diff --git a/src/Import/LdapUserImporter.php b/src/Import/LdapUserImporter.php
@@ -90,7 +90,7 @@ public function trashDisabledUsers(): static
     /**
      * Load the import's objects from the LDAP repository.
      */
-    public function loadObjectsFromRepository(string $username = null): Collection
+    public function loadObjectsFromRepository(?string $username = null): Collection
     {
         $query = $this->applyLdapQueryConstraints(
             $this->repository->query()
diff --git a/src/Import/Synchronizer.php b/src/Import/Synchronizer.php
@@ -166,7 +166,7 @@ protected function getSyncScopeOperatorAndValue(LdapModel $ldap, array|string $c
     /**
      * Get the sync scope option from the config array.
      */
-    protected function getSyncScopeOption(array|string $config, string $option, array|string $default = null): array|string
+    protected function getSyncScopeOption(array|string $config, string $option, array|string|null $default = null): array|string
     {
         return is_array($config) ? $config[$option] : $default;
     }
diff --git a/src/LdapUserAuthenticator.php b/src/LdapUserAuthenticator.php
@@ -49,7 +49,7 @@ public function __construct(array $rules = [])
     /**
      * Set the authenticating eloquent model.
      */
-    public function setEloquentModel(Eloquent $model = null): static
+    public function setEloquentModel(?Eloquent $model = null): static
     {
         $this->eloquentModel = $model;
 
@@ -59,7 +59,7 @@ public function setEloquentModel(Eloquent $model = null): static
     /**
      * Attempt authenticating against the LDAP domain.
      */
-    public function attempt(Model $user, string $password = null): bool
+    public function attempt(Model $user, ?string $password = null): bool
     {
         $this->attempting($user);
 
@@ -95,7 +95,7 @@ public function attempt(Model $user, string $password = null): bool
     /**
      * Attempt authentication using the given callback once.
      */
-    public function attemptOnceUsing(Closure $callback, Model $user, string $password = null): bool
+    public function attemptOnceUsing(Closure $callback, Model $user, ?string $password = null): bool
     {
         $authenticator = $this->authenticator;
 
diff --git a/src/LdapUserRepository.php b/src/LdapUserRepository.php
@@ -156,7 +156,7 @@ public function getModel(): string
     /**
      * Get a new query builder for the model instance.
      */
-    protected function newModelQuery(Model $model = null): Builder
+    protected function newModelQuery(?Model $model = null): Builder
     {
         $model = is_null($model) ? $this->createModel() : $model;
 
diff --git a/src/Middleware/UserDomainValidator.php b/src/Middleware/UserDomainValidator.php
@@ -10,7 +10,7 @@ class UserDomainValidator
     /**
      * Determine if the user passes domain validation.
      */
-    public function __invoke(Model $user, string $username, string $domain = null): bool
+    public function __invoke(Model $user, string $username, ?string $domain = null): bool
     {
         if (empty($domain)) {
             return false;
diff --git a/src/Middleware/WindowsAuthenticate.php b/src/Middleware/WindowsAuthenticate.php
@@ -146,7 +146,7 @@ public static function validateDomainUsing(Closure|string $callback): void
     /**
      * Set the callback to resolve users by when retrieving the authenticated user fails.
      */
-    public static function fallback(Closure|string $callback = null): void
+    public static function fallback(Closure|string|null $callback = null): void
     {
         static::$userResolverFallback = $callback;
     }
@@ -208,7 +208,7 @@ protected function authenticate(Request $request, array $guards): void
     /**
      * Attempt retrieving and logging in the authenticated user.
      */
-    protected function attempt(array $guards, string $username, string $domain = null): void
+    protected function attempt(array $guards, string $username, ?string $domain = null): void
     {
         foreach ($guards as $guard) {
             $provider = $this->auth->guard($guard)->getProvider();
@@ -258,7 +258,7 @@ protected function authenticated(array $guards): bool
     /**
      * Returns the authenticatable user instance if found.
      */
-    protected function retrieveAuthenticatedUser(UserProvider $provider, string $username, string $domain = null): ?Authenticatable
+    protected function retrieveAuthenticatedUser(UserProvider $provider, string $username, ?string $domain = null): ?Authenticatable
     {
         // First, we will attempt to retrieve the user from the LDAP server
         // by their username. If we don't get any result, we can bail
@@ -346,7 +346,7 @@ protected function getUserFromRepository(LdapUserRepository $repository, string
     /**
      * Determine if the located user is apart of the domain.
      */
-    protected function userIsApartOfDomain(Model $user, string $username, string $domain = null): bool
+    protected function userIsApartOfDomain(Model $user, string $username, ?string $domain = null): bool
     {
         if (! static::$domainVerification) {
             return true;
@@ -360,7 +360,7 @@ protected function userIsApartOfDomain(Model $user, string $username, string $do
     /**
      * Handle failure of retrieving the authenticated user.
      */
-    protected function failedRetrievingUser(UserProvider $provider, string $username, string $domain = null): ?Authenticatable
+    protected function failedRetrievingUser(UserProvider $provider, string $username, ?string $domain = null): ?Authenticatable
     {
         if (! static::$userResolverFallback) {
             return null;
diff --git a/src/Testing/DirectoryEmulator.php b/src/Testing/DirectoryEmulator.php
@@ -14,7 +14,7 @@ class DirectoryEmulator extends DirectoryFake
      *
      * @throws \LdapRecord\ContainerException
      */
-    public static function setup(string $name = null, array $config = []): ConnectionFake
+    public static function setup(?string $name = null, array $config = []): ConnectionFake
     {
         return tap(parent::setup($name), function (EmulatedConnectionFake $fake) use ($name, $config) {
             $fake->name($name);
diff --git a/src/Testing/Emulated/EmulatesModelQueries.php b/src/Testing/Emulated/EmulatesModelQueries.php
@@ -18,7 +18,7 @@ trait EmulatesModelQueries
     /**
      * {@inheritdoc}
      */
-    public function newInstance(string $baseDn = null): static
+    public function newInstance(?string $baseDn = null): static
     {
         return (new self($this->connection))
             ->setModel($this->model)
diff --git a/src/Testing/EmulatedConnectionFake.php b/src/Testing/EmulatedConnectionFake.php
@@ -14,7 +14,7 @@ class EmulatedConnectionFake extends ConnectionFake
     /**
      * Get or set the name of the connection fake.
      */
-    public function name(string $name = null): string|static|null
+    public function name(?string $name = null): string|static|null
     {
         if (is_null($name)) {
             return $this->name;
diff --git a/src/Testing/LdapDatabaseManager.php b/src/Testing/LdapDatabaseManager.php
@@ -57,7 +57,7 @@ public function __construct(DatabaseManager $db)
     /**
      * Create the eloquent database model.
      */
-    public function createModel(string $connection = null): Model
+    public function createModel(?string $connection = null): Model
     {
         $class = '\\'.ltrim(static::$model, '\\');
 
@@ -67,7 +67,7 @@ public function createModel(string $connection = null): Model
     /**
      * Get the LDAP database connection.
      */
-    public function connection(string $name = null, array $config = []): Connection
+    public function connection(?string $name = null, array $config = []): Connection
     {
         $name = $name ?? Config::get('ldap.default', 'default');
 
diff --git a/src/Testing/LdapObject.php b/src/Testing/LdapObject.php
@@ -46,15 +46,15 @@ public static function booted(): void
     /**
      * Find an object by its distinguished name.
      */
-    public static function findByDn(string $dn, string $connection = null): ?static
+    public static function findByDn(string $dn, ?string $connection = null): ?static
     {
         return static::on($connection)->firstWhere('dn', 'like', $dn);
     }
 
     /**
      * Find an object by its object guid.
      */
-    public static function findByGuid(string $guid, string $connection = null): ?static
+    public static function findByGuid(string $guid, ?string $connection = null): ?static
     {
         return static::on($connection)->firstWhere('guid', '=', $guid);
     }
diff --git a/tests/Feature/Commands/GetRootDseTest.php b/tests/Feature/Commands/GetRootDseTest.php
@@ -81,7 +81,7 @@ public function test_command_displays_no_attributes_error_when_rootdse_is_empty_
 
 class RootDse extends Entry
 {
-    public function getCreatableDn(string $name = null, string $attribute = null): string
+    public function getCreatableDn(?string $name = null, ?string $attribute = null): string
     {
         return '';
     }
diff --git a/tests/Feature/Commands/ImportLdapUsersTest.php b/tests/Feature/Commands/ImportLdapUsersTest.php
@@ -47,7 +47,7 @@ public function test_message_is_shown_when_no_users_are_found_for_importing()
 
         $repo = m::mock(LdapUserRepository::class, function ($repo) {
             $query = m::mock(Builder::class);
-            $query->shouldReceive('paginate')->once()->andReturn(new Collection());
+            $query->shouldReceive('paginate')->once()->andReturn(new Collection);
 
             $repo->shouldReceive('query')->once()->andReturn($query);
         });
diff --git a/tests/Feature/CreatesTestUsers.php b/tests/Feature/CreatesTestUsers.php
@@ -9,7 +9,7 @@ trait CreatesTestUsers
     /**
      * Create a new test user.
      */
-    protected function createTestUser(array $attributes = [], string $model = null): Model
+    protected function createTestUser(array $attributes = [], ?string $model = null): Model
     {
         $model = $model ?? TestUserModelStub::class;
 
diff --git a/tests/Feature/DatabaseTestCase.php b/tests/Feature/DatabaseTestCase.php
@@ -57,10 +57,10 @@ protected function getMockLdapModel(array $attributes = [])
     }
 
     protected function createDatabaseUserProvider(
-        LdapUserRepository $repo = null,
-        LdapUserAuthenticator $auth = null,
-        UserSynchronizer $synchronizer = null,
-        EloquentUserProvider $eloquent = null
+        ?LdapUserRepository $repo = null,
+        ?LdapUserAuthenticator $auth = null,
+        ?UserSynchronizer $synchronizer = null,
+        ?EloquentUserProvider $eloquent = null
     ) {
         return new DatabaseUserProvider(
             $repo ?? $this->createLdapUserRepository(),
@@ -77,7 +77,7 @@ protected function createLdapUserRepository($model = null)
 
     protected function createLdapUserAuthenticator()
     {
-        return new LdapUserAuthenticator();
+        return new LdapUserAuthenticator;
     }
 
     protected function createLdapUserSynchronizer($eloquentModel = null, array $config = [])
diff --git a/tests/Feature/Emulator/EmulatedDatabaseAuthenticationTest.php b/tests/Feature/Emulator/EmulatedDatabaseAuthenticationTest.php
@@ -231,7 +231,7 @@ public function test_database_authentication_fallback_is_not_performed_when_fall
 
 class TestEmulatorUserModelStub extends User implements LdapAuthenticatable
 {
-    use SoftDeletes, AuthenticatesWithLdap, HasLdapUser;
+    use AuthenticatesWithLdap, HasLdapUser, SoftDeletes;
 
     protected $guarded = [];
 
diff --git a/tests/Feature/ListenForLdapBindFailureTest.php b/tests/Feature/ListenForLdapBindFailureTest.php
@@ -63,13 +63,13 @@ public function test_validation_exception_is_not_thrown_until_all_connection_hos
             LdapFake::operation('bind')
                 ->with('user', 'secret')
                 ->once()
-                ->andReturn(new LdapResultResponse()),
+                ->andReturn(new LdapResultResponse),
 
             // Bind is attempted with the authenticating user and passes.
             LdapFake::operation('bind')
                 ->with('cn=jdoe,dc=local,dc=com', 'secret')
                 ->once()
-                ->andReturn(new LdapResultResponse()),
+                ->andReturn(new LdapResultResponse),
 
             // Rebind is attempted with configured user account.
             LdapFake::operation('bind')
@@ -85,7 +85,7 @@ public function test_validation_exception_is_not_thrown_until_all_connection_hos
 
             LdapFake::operation('parseResult')
                 ->once()
-                ->andReturn(new LdapResultResponse()),
+                ->andReturn(new LdapResultResponse),
         ])->shouldReturnError("Can't contact LDAP server");
 
         $result = Auth::attempt([
diff --git a/tests/Feature/NoDatabaseUserProviderTest.php b/tests/Feature/NoDatabaseUserProviderTest.php
@@ -48,7 +48,7 @@ public function test_retrieve_by_id_returns_model_instance()
 
         $repo->shouldReceive('findByGuid')->once()->withArgs(['id'])->andReturn($model);
 
-        $provider = new NoDatabaseUserProvider($repo, new LdapUserAuthenticator());
+        $provider = new NoDatabaseUserProvider($repo, new LdapUserAuthenticator);
 
         $this->assertSame($model, $provider->retrieveById('id'));
     }
@@ -61,7 +61,7 @@ public function test_retrieve_by_credentials_returns_model_instance()
 
         $repo->shouldReceive('findByCredentials')->once()->withArgs([['username' => 'foo']])->andReturn($model);
 
-        $provider = new NoDatabaseUserProvider($repo, new LdapUserAuthenticator());
+        $provider = new NoDatabaseUserProvider($repo, new LdapUserAuthenticator);
 
         $this->assertSame($model, $provider->retrieveByCredentials(['username' => 'foo']));
     }
diff --git a/tests/Feature/TestUserModelStub.php b/tests/Feature/TestUserModelStub.php
@@ -10,7 +10,7 @@
 
 class TestUserModelStub extends User implements LdapAuthenticatable
 {
-    use SoftDeletes, AuthenticatesWithLdap, HasLdapUser;
+    use AuthenticatesWithLdap, HasLdapUser, SoftDeletes;
 
     protected $guarded = [];
 
diff --git a/tests/Feature/WindowsAuthMiddlewareTest.php b/tests/Feature/WindowsAuthMiddlewareTest.php
@@ -493,7 +493,7 @@ public function test_fallback_is_used_when_failing_to_retrieve_user()
 
 class WindowsAuthRuleStub implements Rule
 {
-    public function passes(Model $user, Eloquent $model = null): bool
+    public function passes(Model $user, ?Eloquent $model = null): bool
     {
         $_SERVER[self::class] = true;
 
diff --git a/tests/Unit/EloquentHydratorTest.php b/tests/Unit/EloquentHydratorTest.php
diff --git a/tests/Unit/LdapUserAuthenticatorTest.php b/tests/Unit/LdapUserAuthenticatorTest.php
diff --git a/tests/Unit/LdapUserRepositoryTest.php b/tests/Unit/LdapUserRepositoryTest.php
diff --git a/tests/Unit/ValidatorRuleOnlyImportedTest.php b/tests/Unit/ValidatorRuleOnlyImportedTest.php
diff --git a/tests/Unit/ValidatorTest.php b/tests/Unit/ValidatorTest.php

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public static function usingLaravelUi(string $controller = 'App\Http\Controllers`
`33`	`33`	`/**`
`34`	`34`	`* Register the bind failure listener upon resolving the given class.`
`35`	`35`	`*/`
`36`		`- protected static function whenResolving(string $class, Closure $callback = null): void`
	`36`	`+ protected static function whenResolving(string $class, ?Closure $callback = null): void`
`37`	`37`	`{`
`38`	`38`	`if (! class_exists($class)) {`
`39`	`39`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public function listenForLdapBindFailure(): void`
`65`	`65`	`*`
`66`	`66`	`* @throws ValidationException`
`67`	`67`	`*/`
`68`		`- protected function ldapBindFailed(string $errorMessage, string $diagnosticMessage = null): void`
	`68`	`+ protected function ldapBindFailed(string $errorMessage, ?string $diagnosticMessage = null): void`
`69`	`69`	`{`
`70`	`70`	`switch (true) {`
`71`	`71`	`case $this->causedByLostConnection($errorMessage):`
`@@ -98,7 +98,7 @@ protected function ldapBindFailed(string $errorMessage, string $diagnosticMessag`
`98`	`98`	`*`
`99`	`99`	`* @throws ValidationException`
`100`	`100`	`*/`
`101`		`- protected function handleLdapBindError(string $message, string $code = null): void`
	`101`	`+ protected function handleLdapBindError(string $message, ?string $code = null): void`
`102`	`102`	`{`
`103`	`103`	`logger()->error($message, compact('code'));`
`104`	`104`
Original file line number	Diff line number	Diff line change
`@@ -10,5 +10,5 @@ interface Rule`
`10`	`10`	`/**`
`11`	`11`	`* Determine if the rule passes validation.`
`12`	`12`	`*/`
`13`		`- public function passes(LdapRecord $user, Eloquent $model = null): bool;`
	`13`	`+ public function passes(LdapRecord $user, ?Eloquent $model = null): bool;`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ class OnlyImported implements Rule`
`11`	`11`	`/**`
`12`	`12`	`* {@inheritdoc}`
`13`	`13`	`*/`
`14`		`- public function passes(LdapRecord $user, Eloquent $model = null): bool`
	`14`	`+ public function passes(LdapRecord $user, ?Eloquent $model = null): bool`
`15`	`15`	`{`
`16`	`16`	`return $model?->exists;`
`17`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public function __construct(iterable $rules = [])`
`29`	`29`	`/**`
`30`	`30`	`* Determine if all rules pass validation.`
`31`	`31`	`*/`
`32`		`- public function passes(LdapRecord $user, Eloquent $model = null): bool`
	`32`	`+ public function passes(LdapRecord $user, ?Eloquent $model = null): bool`
`33`	`33`	`{`
`34`	`34`	`foreach ($this->rules as $rule) {`
`35`	`35`	`if (! $rule->passes($user, $model)) {`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ abstract class Event`
`20`	`20`	`/**`
`21`	`21`	`* Constructor.`
`22`	`22`	`*/`
`23`		`- public function __construct(LdapModel $object, EloquentModel $eloquent = null)`
	`23`	`+ public function __construct(LdapModel $object, ?EloquentModel $eloquent = null)`
`24`	`24`	`{`
`25`	`25`	`$this->object = $object;`
`26`	`26`	`$this->eloquent = $eloquent;`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ abstract class RuleEvent extends Event`
`16`	`16`	`/**`
`17`	`17`	`* Constructor.`
`18`	`18`	`*/`
`19`		`- public function __construct(Rule $rule, LdapModel $object, EloquentModel $eloquent = null)`
	`19`	`+ public function __construct(Rule $rule, LdapModel $object, ?EloquentModel $eloquent = null)`
`20`	`20`	`{`
`21`	`21`	`parent::__construct($object, $eloquent);`
`22`	`22`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ public function trashDisabledUsers(): static`
`90`	`90`	`/**`
`91`	`91`	`* Load the import's objects from the LDAP repository.`
`92`	`92`	`*/`
`93`		`- public function loadObjectsFromRepository(string $username = null): Collection`
	`93`	`+ public function loadObjectsFromRepository(?string $username = null): Collection`
`94`	`94`	`{`
`95`	`95`	`$query = $this->applyLdapQueryConstraints(`
`96`	`96`	`$this->repository->query()`
Original file line number	Diff line number	Diff line change
`@@ -166,7 +166,7 @@ protected function getSyncScopeOperatorAndValue(LdapModel $ldap, array\|string $c`
`166`	`166`	`/**`
`167`	`167`	`* Get the sync scope option from the config array.`
`168`	`168`	`*/`
`169`		`- protected function getSyncScopeOption(array\|string $config, string $option, array\|string $default = null): array\|string`
	`169`	`+ protected function getSyncScopeOption(array\|string $config, string $option, array\|string\|null $default = null): array\|string`
`170`	`170`	`{`
`171`	`171`	`return is_array($config) ? $config[$option] : $default;`
`172`	`172`	`}`