Updated with latest styleci changes

diff --git a/app/Api/ApiDocsGenerator.php b/app/Api/ApiDocsGenerator.php
index 76157c9a5c8ad60924fc8907d598526bb05c6f95..671923ab1a21efc678c153f1693fdd8c5ee944ad 100644 (file)
--- a/app/Api/ApiDocsGenerator.php
+++ b/app/Api/ApiDocsGenerator.php
@@ -102,8 +102,8 @@ class ApiDocsGenerator
             $this->controllerClasses[$className] = $class;
         }
 
-        $rules = collect($class->getValidationRules()[$methodName] ?? [])->map(function($validations) {
-            return array_map(function($validation) {
+        $rules = collect($class->getValidationRules()[$methodName] ?? [])->map(function ($validations) {
+            return array_map(function ($validation) {
                 return $this->getValidationAsString($validation);
             }, $validations);
         })->toArray();
@@ -129,6 +129,7 @@ class ApiDocsGenerator
         }
 
         $class = get_class($validation);
+
         throw new Exception("Cannot provide string representation of rule for class: {$class}");
     }
 

diff --git a/app/Api/ListingResponseBuilder.php b/app/Api/ListingResponseBuilder.php
index 6da92040b4cc4a40679fa46abe2a842b087397eb..7de5ddf07b133302820396f8847dc70523ad096a 100644 (file)
--- a/app/Api/ListingResponseBuilder.php
+++ b/app/Api/ListingResponseBuilder.php
@@ -48,7 +48,7 @@ class ListingResponseBuilder
         $filteredQuery = $this->filterQuery($this->query);
 
         $total = $filteredQuery->count();
-        $data = $this->fetchData($filteredQuery)->each(function($model) {
+        $data = $this->fetchData($filteredQuery)->each(function ($model) {
             foreach ($this->resultModifiers as $modifier) {
                 $modifier($model);
             }
@@ -61,7 +61,8 @@ class ListingResponseBuilder
     }
 
     /**
-     * Add a callback to modify each element of the results
+     * Add a callback to modify each element of the results.
+     *
      * @param (callable(Model)) $modifier
      */
     public function modifyResults($modifier): void

diff --git a/app/Auth/UserRepo.php b/app/Auth/UserRepo.php
index f9cfc078ed0b6ed62c5fcedd0e09df0b03d6d220..606fd5d652ce74641ae209e9d0e1bd211957177f 100644 (file)
--- a/app/Auth/UserRepo.php
+++ b/app/Auth/UserRepo.php
@@ -60,7 +60,7 @@ class UserRepo
     }
 
     /**
-     * Get all users as Builder for API
+     * Get all users as Builder for API.
      */
     public function getApiUsersBuilder(): Builder
     {
@@ -159,6 +159,7 @@ class UserRepo
 
     /**
      * Create a new basic instance of user with the given pre-validated data.
+     *
      * @param array{name: string, email: string, password: ?string, external_auth_id: ?string, language: ?string, roles: ?array} $data
      */
     public function createWithoutActivity(array $data, bool $emailConfirmed = false): User
@@ -188,6 +189,7 @@ class UserRepo
 
     /**
      * As per "createWithoutActivity" but records a "create" activity.
+     *
      * @param array{name: string, email: string, password: ?string, external_auth_id: ?string, language: ?string, roles: ?array} $data
      */
     public function create(array $data, bool $sendInvite = false): User
@@ -199,12 +201,15 @@ class UserRepo
         }
 
         Activity::add(ActivityType::USER_CREATE, $user);
+
         return $user;
     }
 
     /**
      * Update the given user with the given data.
+     *
      * @param array{name: ?string, email: ?string, external_auth_id: ?string, password: ?string, roles: ?array<int>, language: ?string} $data
+     *
      * @throws UserUpdateException
      */
     public function update(User $user, array $data, bool $manageUsersAllowed): User
@@ -307,10 +312,10 @@ class UserRepo
         };
 
         return [
-            'pages' => $query(Page::visible()->where('draft', '=', false)),
+            'pages'    => $query(Page::visible()->where('draft', '=', false)),
             'chapters' => $query(Chapter::visible()),
-            'books' => $query(Book::visible()),
-            'shelves' => $query(Bookshelf::visible()),
+            'books'    => $query(Book::visible()),
+            'shelves'  => $query(Bookshelf::visible()),
         ];
     }
 
@@ -322,10 +327,10 @@ class UserRepo
         $createdBy = ['created_by' => $user->id];
 
         return [
-            'pages' => Page::visible()->where($createdBy)->count(),
+            'pages'    => Page::visible()->where($createdBy)->count(),
             'chapters' => Chapter::visible()->where($createdBy)->count(),
-            'books' => Book::visible()->where($createdBy)->count(),
-            'shelves' => Bookshelf::visible()->where($createdBy)->count(),
+            'books'    => Book::visible()->where($createdBy)->count(),
+            'shelves'  => Bookshelf::visible()->where($createdBy)->count(),
         ];
     }
 

diff --git a/app/Http/Controllers/Api/UserApiController.php b/app/Http/Controllers/Api/UserApiController.php
index aa2a2481c8a191e66dd9d5f3abc000b67794f3b4..d58904938a9711654f768461106c6d6bde0dca14 100644 (file)
--- a/app/Http/Controllers/Api/UserApiController.php
+++ b/app/Http/Controllers/Api/UserApiController.php
@@ -16,7 +16,7 @@ class UserApiController extends ApiController
     protected $userRepo;
 
     protected $fieldsToExpose = [
-        'email', 'created_at', 'updated_at', 'last_activity_at', 'external_auth_id'
+        'email', 'created_at', 'updated_at', 'last_activity_at', 'external_auth_id',
     ];
 
     public function __construct(UserRepo $userRepo)
@@ -27,6 +27,7 @@ class UserApiController extends ApiController
         $this->middleware(function ($request, $next) {
             $this->checkPermission('users-manage');
             $this->preventAccessInDemoMode();
+
             return $next($request);
         });
     }
@@ -35,29 +36,29 @@ class UserApiController extends ApiController
     {
         return [
             'create' => [
-                'name' => ['required', 'min:2'],
+                'name'  => ['required', 'min:2'],
                 'email' => [
-                    'required', 'min:2', 'email', new Unique('users', 'email')
+                    'required', 'min:2', 'email', new Unique('users', 'email'),
                 ],
                 'external_auth_id' => ['string'],
-                'language' => ['string'],
-                'password' => [Password::default()],
-                'roles' => ['array'],
-                'roles.*' => ['integer'],
-                'send_invite' => ['boolean'],
+                'language'         => ['string'],
+                'password'         => [Password::default()],
+                'roles'            => ['array'],
+                'roles.*'          => ['integer'],
+                'send_invite'      => ['boolean'],
             ],
             'update' => [
-                'name' => ['min:2'],
+                'name'  => ['min:2'],
                 'email' => [
                     'min:2',
                     'email',
-                    (new Unique('users', 'email'))->ignore($userId ?? null)
+                    (new Unique('users', 'email'))->ignore($userId ?? null),
                 ],
                 'external_auth_id' => ['string'],
-                'language' => ['string'],
-                'password' => [Password::default()],
-                'roles' => ['array'],
-                'roles.*' => ['integer'],
+                'language'         => ['string'],
+                'password'         => [Password::default()],
+                'roles'            => ['array'],
+                'roles.*'          => ['integer'],
             ],
             'delete' => [
                 'migrate_ownership_id' => ['integer', 'exists:users,id'],
@@ -113,6 +114,7 @@ class UserApiController extends ApiController
     /**
      * Update an existing user in the system.
      * Requires permission to manage users.
+     *
      * @throws UserUpdateException
      */
     public function update(Request $request, string $id)

diff --git a/app/Http/Controllers/Controller.php b/app/Http/Controllers/Controller.php
index 13a86f6f7c78672ef99cdab9dedb566d1b148cec..d616974c6fd797c6bc063ca5989501c0a0f4024f 100644 (file)
--- a/app/Http/Controllers/Controller.php
+++ b/app/Http/Controllers/Controller.php
@@ -54,6 +54,7 @@ abstract class Controller extends BaseController
     protected function showPermissionError()
     {
         $message = request()->wantsJson() ? trans('errors.permissionJson') : trans('errors.permission');
+
         throw new NotifyException($message, '/', 403);
     }
 

diff --git a/app/Http/Controllers/UserController.php b/app/Http/Controllers/UserController.php
index 3b443aa81e029a3b4a102ca38c9a38336d164a61..a635bbaa65675cb61cc7ffafdc03c0bda702ae8b 100644 (file)
--- a/app/Http/Controllers/UserController.php
+++ b/app/Http/Controllers/UserController.php
@@ -75,12 +75,12 @@ class UserController extends Controller
         $passwordRequired = ($authMethod === 'standard' && !$sendInvite);
 
         $validationRules = [
-            'name'    => ['required'],
-            'email'   => ['required', 'email', 'unique:users,email'],
-            'language' => ['string'],
+            'name'             => ['required'],
+            'email'            => ['required', 'email', 'unique:users,email'],
+            'language'         => ['string'],
             'roles'            => ['array'],
             'roles.*'          => ['integer'],
-            'password' => $passwordRequired ? ['required', Password::default()] : null,
+            'password'         => $passwordRequired ? ['required', Password::default()] : null,
             'password-confirm' => $passwordRequired ? ['required', 'same:password'] : null,
             'external_auth_id' => $externalAuth ? ['required'] : null,
         ];

diff --git a/routes/api.php b/routes/api.php
index c7b8887b650ae761218fe815b74b212b33fedf5b..a87169ee51b805144f2bbfdda85dc9ba5e1b827b 100644 (file)
--- a/routes/api.php
+++ b/routes/api.php
@@ -71,4 +71,4 @@ Route::get('users', [UserApiController::class, 'list']);
 Route::post('users', [UserApiController::class, 'create']);
 Route::get('users/{id}', [UserApiController::class, 'read']);
 Route::put('users/{id}', [UserApiController::class, 'update']);
-Route::delete('users/{id}', [UserApiController::class, 'delete']);
\ No newline at end of file
+Route::delete('users/{id}', [UserApiController::class, 'delete']);

diff --git a/tests/Api/UsersApiTest.php b/tests/Api/UsersApiTest.php
index e1bcb02d57b1bb701e6c590e9a1baf224cd62a9e..ddbdac0f8320c0b90fbf57a5e9edcee18a528bf8 100644 (file)
--- a/tests/Api/UsersApiTest.php
+++ b/tests/Api/UsersApiTest.php
@@ -56,13 +56,13 @@ class UsersApiTest extends TestCase
         $resp = $this->getJson($this->baseEndpoint . '?count=1&sort=+id');
         $resp->assertJson(['data' => [
             [
-                'id'   => $firstUser->id,
-                'name' => $firstUser->name,
-                'slug' => $firstUser->slug,
-                'email' => $firstUser->email,
+                'id'          => $firstUser->id,
+                'name'        => $firstUser->name,
+                'slug'        => $firstUser->slug,
+                'email'       => $firstUser->email,
                 'profile_url' => $firstUser->getProfileUrl(),
-                'edit_url' => $firstUser->getEditUrl(),
-                'avatar_url' => $firstUser->getAvatar(),
+                'edit_url'    => $firstUser->getEditUrl(),
+                'avatar_url'  => $firstUser->getAvatar(),
             ],
         ]]);
     }
@@ -74,24 +74,24 @@ class UsersApiTest extends TestCase
         $role = Role::query()->first();
 
         $resp = $this->postJson($this->baseEndpoint, [
-            'name' => 'Benny Boris',
-            'email' => '[email protected]',
-            'password' => 'mysuperpass',
-            'language' => 'it',
-            'roles' => [$role->id],
+            'name'        => 'Benny Boris',
+            'email'       => '[email protected]',
+            'password'    => 'mysuperpass',
+            'language'    => 'it',
+            'roles'       => [$role->id],
             'send_invite' => false,
         ]);
 
         $resp->assertStatus(200);
         $resp->assertJson([
-            'name' => 'Benny Boris',
-            'email' => '[email protected]',
+            'name'             => 'Benny Boris',
+            'email'            => '[email protected]',
             'external_auth_id' => '',
-            'roles' => [
+            'roles'            => [
                 [
-                    'id' => $role->id,
+                    'id'           => $role->id,
                     'display_name' => $role->display_name,
-                ]
+                ],
             ],
         ]);
         $this->assertDatabaseHas('users', ['email' => '[email protected]']);
@@ -109,8 +109,8 @@ class UsersApiTest extends TestCase
         Notification::fake();
 
         $resp = $this->postJson($this->baseEndpoint, [
-            'name' => 'Benny Boris',
-            'email' => '[email protected]',
+            'name'        => 'Benny Boris',
+            'email'       => '[email protected]',
             'send_invite' => true,
         ]);
 
@@ -140,7 +140,7 @@ class UsersApiTest extends TestCase
 
         $resp = $this->postJson($this->baseEndpoint, [
             'email' => $existingUser->email,
-            'name' => 'Benny Boris',
+            'name'  => 'Benny Boris',
         ]);
         $resp->assertStatus(422);
         $resp->assertJson($this->validationResponse(['email' => ['The email has already been taken.']]));
@@ -158,15 +158,15 @@ class UsersApiTest extends TestCase
 
         $resp->assertStatus(200);
         $resp->assertJson([
-            'id'         => $user->id,
-            'slug'       => $user->slug,
-            'email'      => $user->email,
+            'id'               => $user->id,
+            'slug'             => $user->slug,
+            'email'            => $user->email,
             'external_auth_id' => $user->external_auth_id,
-            'roles' => [
+            'roles'            => [
                 [
-                    'id' => $userRole->id,
+                    'id'           => $userRole->id,
                     'display_name' => $userRole->display_name,
-                ]
+                ],
             ],
         ]);
     }
@@ -178,19 +178,19 @@ class UsersApiTest extends TestCase
         $user = $this->getAdmin();
         $roles = Role::query()->pluck('id');
         $resp = $this->putJson($this->baseEndpoint . "/{$user->id}", [
-            'name' => 'My updated user',
-            'email' => '[email protected]',
-            'roles' => $roles,
+            'name'             => 'My updated user',
+            'email'            => '[email protected]',
+            'roles'            => $roles,
             'external_auth_id' => 'btest',
-            'password' => 'barrytester',
-            'language' => 'fr',
+            'password'         => 'barrytester',
+            'language'         => 'fr',
         ]);
 
         $resp->assertStatus(200);
         $resp->assertJson([
-            'id' => $user->id,
-            'name' => 'My updated user',
-            'email' => '[email protected]',
+            'id'               => $user->id,
+            'name'             => 'My updated user',
+            'email'            => '[email protected]',
             'external_auth_id' => 'btest',
         ]);
         $user->refresh();
@@ -210,9 +210,9 @@ class UsersApiTest extends TestCase
 
         $resp->assertStatus(200);
         $this->assertDatabaseHas('users', [
-            'id' => $user->id,
-            'name' => $user->name,
-            'email' => $user->email,
+            'id'       => $user->id,
+            'name'     => $user->name,
+            'email'    => $user->email,
             'password' => $user->password,
         ]);
         $this->assertEquals($roleCount, $user->roles()->count());

diff --git a/tests/HelpTest.php b/tests/HelpTest.php
index 2e08abfbc14f4d9840dbd41d6cd1d3d17cafcd5d..bf883bd3966d3be711e3d00fe0bd7b6dc1030983 100644 (file)
--- a/tests/HelpTest.php
+++ b/tests/HelpTest.php
@@ -4,7 +4,6 @@ namespace Tests;
 
 class HelpTest extends TestCase
 {
-
     public function test_wysiwyg_help_shows_tiny_and_tiny_license_link()
     {
         $resp = $this->get('/help/wysiwyg');
@@ -21,5 +20,4 @@ class HelpTest extends TestCase
         $contents = file_get_contents($expectedPath);
         $this->assertStringContainsString('GNU LESSER GENERAL PUBLIC LICENSE', $contents);
     }
-
 }