Adding a resident-extern role

app/Exports/UsersSheets/CollegistsExport.php

@@ -67,7 +67,8 @@ public function map($user): array
         return [
             '=HYPERLINK("'.route('users.show', ['user' => $user->id]).'", "'.$user->name.'")',
             $user->educationalInformation?->neptun,
-            $user->isResident() ? 'Bentlakó' : ($user->isExtern() ? 'Bejáró' : ($user->isAlumni() ? "Alumni" : ($user->isTenant() ? "Vendég" : ""))),
+            $user->isResident() ? 'Bentlakó' : ($user->isResidentExtern() ? 'Bentlakó-bejáró' :
+                ($user->isExtern() ? 'Bejáró' : ($user->isAlumni() ? "Alumni" : ($user->isTenant() ? "Vendég" : "")))),
             $user->getStatus($this->semester)?->translatedStatus(),
             $user->email,
             $user->educationalInformation?->email,

app/Exports/UsersSheets/SemesterEvaluationExport.php

@@ -86,7 +86,8 @@ public function map($evaluation): array
             $user->educationalInformation?->neptun,
             implode(" \n", $user->faculties->pluck('name')->toArray()),
             implode(" \n", $user->workshops->pluck('name')->toArray()),
-            $user->isResident() ? 'Bentlakó' : ($user->isExtern() ? 'Bejáró' : ($user->isAlumni() ? "Alumni" : ($user->isTenant() ? "Vendég" : ""))),
+            $user->isResident() ? 'Bentlakó' : ($user->isResidentExtern() ? 'Bentlakó-bejáró' :
+                ($user->isExtern() ? 'Bejáró' : ($user->isAlumni() ? "Alumni" : ($user->isTenant() ? "Vendég" : "")))),
             $evaluation->resign_residency ? 'Igen' : '',
             $user->getStatus($evaluation->semester)?->translatedStatus(),
             $user->getStatus($evaluation->semester->succ())?->translatedStatus(),

app/Http/Controllers/Dormitory/RoomController.php

@@ -57,7 +57,7 @@ public function index()
     public function modify()
     {
         $this->authorize('updateAny', Room::class);
-        $users = User::collegist()->active()->get();       // externs too (to solve the resident-extern problem temporarily)
+        $users = User::active()->resides()->get();
         $tenants = User::currentTenant()->get();
         $users = $users->concat($tenants)->unique();
         $rooms = Room::with('users')->get();

app/Http/Controllers/Secretariat/SemesterEvaluationController.php

@@ -157,7 +157,7 @@ public function store(Request $request)
                         return back()->with('error', "A státusz megadása kötelező!")->with('section', $request->section);
                     }
                     $user->setStatusFor(Semester::next(), $request->next_status, $request->next_status_note);
-                    if ($request->has('resign_residency') && $user->isResident()) {
+                    if ($request->has('resign_residency') && $user->resides()) {
                         $user->setExtern();
                     }
                 }

app/Http/Controllers/Secretariat/UserController.php

@@ -364,7 +364,7 @@ public function tenantToApplicant()
         $user->personalInformation()->update(['tenant_until' => null]);
         $user->update(['verified' => false]);
         $user->removeRole(Role::get(Role::TENANT));
-        $user->setExtern();
+        $user->setResidentExtern();
         $user->application()->create();
         Cache::forget('collegists');
         return back();

app/Models/ApplicationForm.php

@@ -119,6 +119,9 @@ public function user(): \Illuminate\Database\Eloquent\Relations\BelongsTo
         return $this->belongsTo('App\Models\User')->withoutGlobalScope('verified');
     }
 
+    /**
+     * Lists the files belonging to the application form.
+     */
     public function files(): \Illuminate\Database\Eloquent\Relations\HasMany
     {
         return $this->hasMany('App\Models\File');
@@ -286,7 +289,7 @@ public function missingData(): array
             $missingData[] =  'Megjelölt kar';
         }
 
-        if (!$user->isResident() && !$user->isExtern()) {
+        if (!$user->resides() && !$user->isExtern()) {
             $missingData[] =  'Megjelölt collegista státusz';
         }
 

app/Models/Role.php

@@ -104,7 +104,9 @@ class Role extends Model
 
     //collegist related roles
     public const RESIDENT = 'resident';
+    public const RESIDENT_EXTERN = 'resident-extern';
     public const EXTERN = 'extern';
+    public const STATUSES = [self::RESIDENT, self::RESIDENT_EXTERN, self::EXTERN];
 
     // all roles
     public const ALL = [

app/Models/User.php

@@ -60,6 +60,7 @@
  * @method collegist()
  * @method active()
  * @method resident()
+ * @method residentExtern()
  * @method extern()
  * @method currentTenant()
  * @method hasToPayKKTNetregInSemester(int $semester_id)
@@ -533,6 +534,28 @@ public function scopeResident(Builder $query): Builder
         return $query->withRole(Role::COLLEGIST, Role::RESIDENT);
     }
 
+    /**
+     * Scope a query to only include resident-extern users.
+     *
+     * @param Builder $query
+     * @return Builder
+     */
+    public function scopeResidentExtern(Builder $query): Builder
+    {
+        return $query->withRole(Role::COLLEGIST, RoleObject::firstWhere('name', Role::RESIDENT_EXTERN));
+    }
+
+    /**
+     * Scope a query to only include users who are either residents or resident-externs.
+     *
+     * @param Builder $query
+     * @return Builder
+     */
+    public function scopeResides(Builder $query): Builder
+    {
+        return $query->resident()->orWhere->residentExtern();
+    }
+
     /**
      * Scope a query to only include extern users.
      *
@@ -682,7 +705,7 @@ public function isCollegist($alumni = true): bool
     }
 
     /**
-     * Attach collegist role as extern or resident.
+     * Attach collegist role as extern, resident-extern or resident.
      * If the user is already a collegist, the object is updated.
      */
     public function setCollegist($objectName): void
@@ -721,6 +744,43 @@ public function setResident(): void
         $this->setCollegist(Role::RESIDENT);
     }
 
+    /**
+     * Decides if the user is a resident-extern currently.
+     *
+     * @return bool
+     */
+    public function isResidentExtern(): bool
+    {
+        //Is this 'if' for applications? Maybe it could be deleted then.
+        if($this->verified == false) {
+            return $this->roles()
+            ->where('role_id', Role::collegist()->id)
+            ->where('object_id', RoleObject::firstWhere('name', Role::RESIDENT_EXTERN)->id)
+            ->exists();
+        }
+        return $this->hasRole([Role::COLLEGIST => Role::RESIDENT_EXTERN]);
+    }
+
+    /**
+     * Set the collegist to be resident-extern.
+     * Only applies for collegists.
+     */
+    public function setResidentExtern(): void
+    {
+        $this->setCollegist(Role::RESIDENT_EXTERN);
+    }
+
+    /**
+     * Decides if the user is a resident or resident-extern.
+     * Returns true if the user is a collegist
+     * who effectively lives in the building
+     * (so has either of the two roles).
+     */
+    public function resides(): bool
+    {
+        return $this->isResident() || $this->isResidentExtern();
+    }
+
     /**
      * Decides if the user is an extern collegist currently.
      *

app/Models/Workshop.php

@@ -61,18 +61,37 @@ class Workshop extends Model
         self::TORTENESZ,
     ];
 
+    /**
+     * Lists all members of the workshop.
+     */
     public function users()
     {
         return $this->belongsToMany(User::class, 'workshop_users');
     }
 
+    /**
+     * Lists the workshop's residents.
+     */
     public function residents()
     {
         return $this->users->filter(function ($user, $key) {
             return $user->isResident();
         });
     }
 
+    /**
+     * Lists the workshop's resident-externs.
+     */
+    public function residentExterns()
+    {
+        return $this->users->filter(function ($user, $key) {
+            return $user->isResidentExtern();
+        });
+    }
+
+    /**
+     * Lists the workshop's externs.
+     */
     public function externs()
     {
         return $this->users->filter(function ($user, $key) {
@@ -97,6 +116,9 @@ public function balance(int $semester = null): ?WorkshopBalance
         return $this->balances()->firstWhere('semester_id', $semester ?? Semester::current()->id);
     }
 
+    /**
+     * Returns the color of the workshop's badge to be displayed.
+     */
     public function color()
     {
         switch ($this->name) {

app/Models/WorkshopBalance.php

@@ -50,7 +50,7 @@ public function workshop()
     }
 
     /**
-     * Returns the semester the balance has been calculated for.
+     * Returns the semester the balance belongs to.
      */
     public function semester()
     {
@@ -113,6 +113,7 @@ public static function generateBalances(
                             $amount *= $workshop_balance_resident;
                             $resident++;
                         } else {
+                            // resident-externs belong here
                             $amount *= $workshop_balance_extern;
                             $extern++;
                         }

database/migrations/2023_10_28_160806_add_resident-extern_role.php

@@ -0,0 +1,34 @@
+<?php
+
+use App\Models\Role;
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class () extends Migration {
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        DB::table('role_objects')->insert([
+            'role_id' => Role::where('name', 'collegist')->first()->id,
+            'name' => 'resident-extern'
+        ]);
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        DB::table('role_objects')->where([
+            'role_id' => Role::where('name', 'collegist')->first()->id,
+            'name' => 'resident-extern'
+        ])->delete();
+    }
+};

database/seeders/UsersTableSeeder.php

@@ -97,10 +97,7 @@ private function createCollegist($user)
         $user->roles()->attach(
             Role::get(Role::COLLEGIST)->id,
             [
-                'object_id' => rand(
-                    RoleObject::firstWhere('name', 'resident')->id,
-                    RoleObject::firstWhere('name', 'extern')->id
-                )
+                'object_id' => RoleObject::firstWhere('name', Role::STATUSES[rand(0, count(Role::STATUSES) - 1)])->id
             ]
         );
         $user->educationalInformation()->save(EducationalInformation::factory()->make(['user_id' => $user->id]));

resources/lang/en/role.php

@@ -38,6 +38,7 @@
     'printer' => 'Printer',
     'reception' => 'Reception desk',
     'resident' => 'Resident',
+    'resident-extern' => 'Resident-extern',
     'role_attached' => 'New role: :role',
     'role_detached' => 'Role detached: :role',
     'roles' => 'Roles',

resources/lang/hu/role.php

@@ -38,6 +38,7 @@
     'printer' => 'Nyomtató',
     'reception' => 'Porta',
     'resident' => 'Bentlakó',
+    'resident-extern' => 'Bentlakó-bejáró',
     'role_attached' => 'Új jogosultság: :role',
     'role_detached' => 'Eltávolított jogosultság: :role',
     'roles' => 'Jogosultságok',

resources/views/auth/application/application.blade.php

@@ -48,14 +48,20 @@
                             @lang('role.resident')
                         </span>
                         @endif
+                        @if ($user->isResidentExtern())
+                            <span class="new badge cyan darken-4 tag" style="float:none;padding:4px;margin:0 10px 0px 2px;"
+                                  data-badge-caption="">
+                            @lang('role.resident-extern')
+                        </span>
+                        @endif
                         @if ($user->isExtern())
                             <span class="new badge coli orange tag"
                                   style="float:none;padding:4px;margin:0 10px 0px 2px;"
                                   data-badge-caption="">
                             @lang('role.extern')
                         </span>
                         @endif
-                        @if(!$user->isResident() && !$user->isExtern())
+                        @if(!$user->resides() && !$user->isExtern())
                             <span style="font-style:italic;color:red">hiányzó státusz</span>
                         @endif
                     </p>

resources/views/auth/application/questions.blade.php

@@ -58,6 +58,7 @@
                                 <span>@lang('role.resident')</span>
                             </label>
                         </p>
+                        {{-- resident-extern status is irrelevant here --}}
                         <p>
                             @php $checked = old('status') ?  old('status') == 'extern' : $user->isExtern() @endphp
                             <label>

tests/Unit/RoleTest.php

@@ -22,15 +22,22 @@ public function test_set_collegist()
         $user->setExtern();
 
         $this->assertTrue($user->isExtern());
+        $this->assertFalse($user->resides());
         $this->assertTrue($user->hasRole(Role::get(Role::COLLEGIST)));
         $this->assertTrue($user->hasRole([Role::COLLEGIST => Role::EXTERN]));
 
         $user->setCollegist(Role::RESIDENT);
 
         $this->assertTrue($user->isResident());
+        $this->assertTrue($user->resides());
         $this->assertTrue($user->hasRole(Role::get(Role::COLLEGIST)));
         $this->assertTrue($user->hasRole([Role::COLLEGIST => Role::RESIDENT]));
 
+        $user->setCollegist(Role::RESIDENT_EXTERN);
+        $this->assertTrue($user->isResidentExtern());
+        $this->assertTrue($user->resides());
+        $this->assertTrue($user->hasRole(Role::get(Role::COLLEGIST)));
+        $this->assertTrue($user->hasRole([Role::COLLEGIST => Role::RESIDENT_EXTERN]));
 
     }