Add Laravel Jetstream to project

.github/workflows/phpunit-test.yaml

@@ -98,7 +98,7 @@ jobs:
       - name: Copy ENV Laravel Configuration for CI
         working-directory: ${{env.FOLDER}}
         run: |
-          php -r "file_exists('.env') || copy('.env.ci', '.env');"
+          php -r "file_exists('.env') || copy('.env.testing', '.env');"
       - name: Install Laravel Dependencies
         working-directory: ${{env.FOLDER}}
         if: steps.vendor-cache.outputs.cache-hit != 'true'

README.md

@@ -87,6 +87,10 @@ After this only do a Laravel migration to the database and you are ready!
 ```bash
 cd laravel && php artisan migrate
 ```
+
+```bash
+php artisan migrate:fresh --env=testing
+```
 </details>
 
 ## License

laravel/.env.example

@@ -30,7 +30,7 @@ BROADCAST_DRIVER=log
 CACHE_DRIVER=file
 FILESYSTEM_DISK=local
 QUEUE_CONNECTION=sync
-SESSION_DRIVER=file
+SESSION_DRIVER=database
 SESSION_LIFETIME=120
 
 MEMCACHED_HOST=127.0.0.1

laravel/.env.ci → laravel/.env.testing

@@ -1,5 +1,5 @@
 APP_NAME=Laravel
-APP_ENV=ci
+APP_ENV=testing
 APP_KEY=base64:D8P88umXHGl1Lmkl3ZcdsQ/4b6VanRKAL/tFH0angb4=
 APP_DEBUG=true
 APP_URL=http://localhost
@@ -23,7 +23,7 @@ BROADCAST_DRIVER=log
 CACHE_DRIVER=file
 FILESYSTEM_DISK=local
 QUEUE_CONNECTION=sync
-SESSION_DRIVER=file
+SESSION_DRIVER=database
 SESSION_LIFETIME=120
 
 MEMCACHED_HOST=127.0.0.1

laravel/.gitignore

@@ -10,7 +10,6 @@
 # Files
 .env
 .env.backup
-.env.testing
 .phpunit.result.cache
 Homestead.json
 Homestead.yaml

laravel/app/Actions/Fortify/CreateNewUser.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace App\Actions\Fortify;
+
+use App\Models\Team;
+use App\Models\User;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Hash;
+use Illuminate\Support\Facades\Validator;
+use Laravel\Fortify\Contracts\CreatesNewUsers;
+use Laravel\Jetstream\Jetstream;
+
+class CreateNewUser implements CreatesNewUsers
+{
+    use PasswordValidationRules;
+
+    /**
+     * Create a newly registered user.
+     *
+     * @param  array  $input
+     * @return \App\Models\User
+     */
+    public function create(array $input)
+    {
+        Validator::make($input, [
+            'name' => ['required', 'string', 'max:255'],
+            'email' => ['required', 'string', 'email', 'max:255', 'unique:users'],
+            'password' => $this->passwordRules(),
+            'terms' => Jetstream::hasTermsAndPrivacyPolicyFeature() ? ['accepted', 'required'] : '',
+        ])->validate();
+
+        return DB::transaction(function () use ($input) {
+            return tap(User::create([
+                'name' => $input['name'],
+                'email' => $input['email'],
+                'password' => Hash::make($input['password']),
+            ]), function (User $user) {
+                $this->createTeam($user);
+            });
+        });
+    }
+
+    /**
+     * Create a personal team for the user.
+     *
+     * @param  \App\Models\User  $user
+     * @return void
+     */
+    protected function createTeam(User $user)
+    {
+        $user->ownedTeams()->save(Team::forceCreate([
+            'user_id' => $user->id,
+            'name' => explode(' ', $user->name, 2)[0]."'s Team",
+            'personal_team' => true,
+        ]));
+    }
+}

laravel/app/Actions/Fortify/PasswordValidationRules.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Actions\Fortify;
+
+use Laravel\Fortify\Rules\Password;
+
+trait PasswordValidationRules
+{
+    /**
+     * Get the validation rules used to validate passwords.
+     *
+     * @return array
+     */
+    protected function passwordRules()
+    {
+        return ['required', 'string', new Password, 'confirmed'];
+    }
+}

laravel/app/Actions/Fortify/ResetUserPassword.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Actions\Fortify;
+
+use Illuminate\Support\Facades\Hash;
+use Illuminate\Support\Facades\Validator;
+use Laravel\Fortify\Contracts\ResetsUserPasswords;
+
+class ResetUserPassword implements ResetsUserPasswords
+{
+    use PasswordValidationRules;
+
+    /**
+     * Validate and reset the user's forgotten password.
+     *
+     * @param  mixed  $user
+     * @param  array  $input
+     * @return void
+     */
+    public function reset($user, array $input)
+    {
+        Validator::make($input, [
+            'password' => $this->passwordRules(),
+        ])->validate();
+
+        $user->forceFill([
+            'password' => Hash::make($input['password']),
+        ])->save();
+    }
+}

laravel/app/Actions/Fortify/UpdateUserPassword.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace App\Actions\Fortify;
+
+use Illuminate\Support\Facades\Hash;
+use Illuminate\Support\Facades\Validator;
+use Laravel\Fortify\Contracts\UpdatesUserPasswords;
+
+class UpdateUserPassword implements UpdatesUserPasswords
+{
+    use PasswordValidationRules;
+
+    /**
+     * Validate and update the user's password.
+     *
+     * @param  mixed  $user
+     * @param  array  $input
+     * @return void
+     */
+    public function update($user, array $input)
+    {
+        Validator::make($input, [
+            'current_password' => ['required', 'string'],
+            'password' => $this->passwordRules(),
+        ])->after(function ($validator) use ($user, $input) {
+            if (! isset($input['current_password']) || ! Hash::check($input['current_password'], $user->password)) {
+                $validator->errors()->add('current_password', __('The provided password does not match your current password.'));
+            }
+        })->validateWithBag('updatePassword');
+
+        $user->forceFill([
+            'password' => Hash::make($input['password']),
+        ])->save();
+    }
+}

laravel/app/Actions/Fortify/UpdateUserProfileInformation.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace App\Actions\Fortify;
+
+use Illuminate\Contracts\Auth\MustVerifyEmail;
+use Illuminate\Support\Facades\Validator;
+use Illuminate\Validation\Rule;
+use Laravel\Fortify\Contracts\UpdatesUserProfileInformation;
+
+class UpdateUserProfileInformation implements UpdatesUserProfileInformation
+{
+    /**
+     * Validate and update the given user's profile information.
+     *
+     * @param  mixed  $user
+     * @param  array  $input
+     * @return void
+     */
+    public function update($user, array $input)
+    {
+        Validator::make($input, [
+            'name' => ['required', 'string', 'max:255'],
+            'email' => ['required', 'email', 'max:255', Rule::unique('users')->ignore($user->id)],
+            'photo' => ['nullable', 'mimes:jpg,jpeg,png', 'max:1024'],
+        ])->validateWithBag('updateProfileInformation');
+
+        if (isset($input['photo'])) {
+            $user->updateProfilePhoto($input['photo']);
+        }
+
+        if ($input['email'] !== $user->email &&
+            $user instanceof MustVerifyEmail) {
+            $this->updateVerifiedUser($user, $input);
+        } else {
+            $user->forceFill([
+                'name' => $input['name'],
+                'email' => $input['email'],
+            ])->save();
+        }
+    }
+
+    /**
+     * Update the given verified user's profile information.
+     *
+     * @param  mixed  $user
+     * @param  array  $input
+     * @return void
+     */
+    protected function updateVerifiedUser($user, array $input)
+    {
+        $user->forceFill([
+            'name' => $input['name'],
+            'email' => $input['email'],
+            'email_verified_at' => null,
+        ])->save();
+
+        $user->sendEmailVerificationNotification();
+    }
+}

laravel/app/Actions/Jetstream/AddTeamMember.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace App\Actions\Jetstream;
+
+use Illuminate\Support\Facades\Gate;
+use Illuminate\Support\Facades\Validator;
+use Laravel\Jetstream\Contracts\AddsTeamMembers;
+use Laravel\Jetstream\Events\AddingTeamMember;
+use Laravel\Jetstream\Events\TeamMemberAdded;
+use Laravel\Jetstream\Jetstream;
+use Laravel\Jetstream\Rules\Role;
+
+class AddTeamMember implements AddsTeamMembers
+{
+    /**
+     * Add a new team member to the given team.
+     *
+     * @param  mixed  $user
+     * @param  mixed  $team
+     * @param  string  $email
+     * @param  string|null  $role
+     * @return void
+     */
+    public function add($user, $team, string $email, string $role = null)
+    {
+        Gate::forUser($user)->authorize('addTeamMember', $team);
+
+        $this->validate($team, $email, $role);
+
+        $newTeamMember = Jetstream::findUserByEmailOrFail($email);
+
+        AddingTeamMember::dispatch($team, $newTeamMember);
+
+        $team->users()->attach(
+            $newTeamMember, ['role' => $role]
+        );
+
+        TeamMemberAdded::dispatch($team, $newTeamMember);
+    }
+
+    /**
+     * Validate the add member operation.
+     *
+     * @param  mixed  $team
+     * @param  string  $email
+     * @param  string|null  $role
+     * @return void
+     */
+    protected function validate($team, string $email, ?string $role)
+    {
+        Validator::make([
+            'email' => $email,
+            'role' => $role,
+        ], $this->rules(), [
+            'email.exists' => __('We were unable to find a registered user with this email address.'),
+        ])->after(
+            $this->ensureUserIsNotAlreadyOnTeam($team, $email)
+        )->validateWithBag('addTeamMember');
+    }
+
+    /**
+     * Get the validation rules for adding a team member.
+     *
+     * @return array
+     */
+    protected function rules()
+    {
+        return array_filter([
+            'email' => ['required', 'email', 'exists:users'],
+            'role' => Jetstream::hasRoles()
+                            ? ['required', 'string', new Role]
+                            : null,
+        ]);
+    }
+
+    /**
+     * Ensure that the user is not already on the team.
+     *
+     * @param  mixed  $team
+     * @param  string  $email
+     * @return \Closure
+     */
+    protected function ensureUserIsNotAlreadyOnTeam($team, string $email)
+    {
+        return function ($validator) use ($team, $email) {
+            $validator->errors()->addIf(
+                $team->hasUserWithEmail($email),
+                'email',
+                __('This user already belongs to the team.')
+            );
+        };
+    }
+}

laravel/app/Actions/Jetstream/CreateTeam.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace App\Actions\Jetstream;
+
+use Illuminate\Support\Facades\Gate;
+use Illuminate\Support\Facades\Validator;
+use Laravel\Jetstream\Contracts\CreatesTeams;
+use Laravel\Jetstream\Events\AddingTeam;
+use Laravel\Jetstream\Jetstream;
+
+class CreateTeam implements CreatesTeams
+{
+    /**
+     * Validate and create a new team for the given user.
+     *
+     * @param  mixed  $user
+     * @param  array  $input
+     * @return mixed
+     */
+    public function create($user, array $input)
+    {
+        Gate::forUser($user)->authorize('create', Jetstream::newTeamModel());
+
+        Validator::make($input, [
+            'name' => ['required', 'string', 'max:255'],
+        ])->validateWithBag('createTeam');
+
+        AddingTeam::dispatch($user);
+
+        $user->switchTeam($team = $user->ownedTeams()->create([
+            'name' => $input['name'],
+            'personal_team' => false,
+        ]));
+
+        return $team;
+    }
+}