feat: automatic slug when creating or renaming a company (#1239)

app/Http/ViewHelpers/Adminland/AdminGeneralViewHelper.php

@@ -63,6 +63,7 @@ public static function information($company, Employee $loggedEmployee): ?array
         return [
             'id' => $company->id,
             'name' => $name,
+            'slug' => $company->slug,
             'administrators' => $administratorsCollection,
             'creation_date' => $creationDate,
             'currency' => $company->currency,

app/Models/Company/Company.php

@@ -25,6 +25,7 @@ class Company extends Model
     protected $fillable = [
         'name',
         'currency',
+        'slug',
         'location',
         'has_dummy_data',
         'logo_file_id',

app/Services/Company/Adminland/Company/CreateCompany.php

@@ -45,6 +45,7 @@ public function execute(array $data): Company
         $this->createUniqueInvitationCodeForCompany();
         $this->addFirstEmployee();
         $this->provisionDefaultAccountData();
+        $this->generateSlug();
         $this->logAccountAudit();
 
         return $this->company;
@@ -104,6 +105,13 @@ private function provisionDefaultAccountData(): void
         ProvisionDefaultAccountData::dispatch($this->employee);
     }
 
+    private function generateSlug(): void
+    {
+        (new UpdateCompanySlug)->execute([
+            'company_id' => $this->company->id,
+        ]);
+    }
+
     private function logAccountAudit(): void
     {
         LogAccountAudit::dispatch([

app/Services/Company/Adminland/Company/RenameCompany.php

@@ -50,21 +50,27 @@ public function execute(array $data): Company
 
         $this->rename();
 
+        $this->generateSlug();
+
         $this->log($oldName);
 
         return $this->company;
     }
 
-    /**
-     * Rename the company.
-     */
     private function rename(): void
     {
         Company::where('id', $this->company->id)->update([
             'name' => $this->data['name'],
         ]);
     }
 
+    private function generateSlug(): void
+    {
+        (new UpdateCompanySlug)->execute([
+            'company_id' => $this->company->id,
+        ]);
+    }
+
     /**
      * Add an audit log entry for this action.
      *

app/Services/Company/Adminland/Company/UpdateCompanySlug.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace App\Services\Company\Adminland\Company;
+
+use Illuminate\Support\Str;
+use App\Services\BaseService;
+use App\Models\Company\Company;
+
+class UpdateCompanySlug extends BaseService
+{
+    private Company $company;
+
+    /**
+     * Get the validation rules that apply to the service.
+     *
+     * @return array
+     */
+    public function rules(): array
+    {
+        return [
+            'company_id' => 'required|integer|exists:companies,id',
+        ];
+    }
+
+    /**
+     * Updates the company slug.
+     *
+     * @param array $data
+     *
+     * @return Company
+     */
+    public function execute(array $data): Company
+    {
+        $this->company = Company::find($data['company_id']);
+
+        $slug = Str::slug($this->company->name, '-');
+
+        $isSlugUnique = false;
+        while ($isSlugUnique === false) {
+            $existingCompaniesWithThisSlug = Company::where('slug', '=', $slug)
+                ->where('id', '!=', $this->company->id)
+                ->count();
+
+            if ($existingCompaniesWithThisSlug > 0) {
+                $slug = $slug.'-'.rand(1, 999);
+            }
+
+            $isSlugUnique = Company::where('slug', $slug)
+                ->where('id', '!=', $this->company->id)
+                ->count() == 0;
+        }
+
+        $this->company->slug = $slug;
+        $this->company->save();
+
+        return $this->company->refresh();
+    }
+}

database/factories/Company/CompanyFactory.php

@@ -23,6 +23,7 @@ public function definition()
     {
         return [
             'name' => $this->faker->name,
+            'slug' => 'company-name',
             'currency' => 'USD',
             'code_to_join_company' => 'USD',
         ];

database/migrations/2021_08_02_184706_add_company_slug_to_companies.php

@@ -0,0 +1,30 @@
+<?php
+
+use Illuminate\Support\Str;
+use App\Models\Company\Company;
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class AddCompanySlugToCompanies extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up()
+    {
+        // necessary for SQLlite
+        Schema::enableForeignKeyConstraints();
+
+        Schema::table('companies', function (Blueprint $table) {
+            $table->string('slug')->after('name')->nullable();
+        });
+
+        Company::chunk(200, function ($companies) {
+            foreach ($companies as $company) {
+                $company->slug = Str::slug($company->name, '-');
+                $company->save();
+            }
+        });
+    }
+}

tests/Unit/Services/Company/Adminland/Company/CreateCompanyTest.php

@@ -31,6 +31,8 @@ public function it_creates_a_company(): void
 
         $company = (new CreateCompany)->execute($request);
 
+        $company->refresh();
+
         $michael = $dwight->getEmployeeObjectForCompany($company);
 
         $this->assertInstanceOf(
@@ -45,6 +47,11 @@ public function it_creates_a_company(): void
 
         $this->assertNotNull($company->code_to_join_company);
 
+        $this->assertEquals(
+            'dunder-mifflin',
+            $company->slug
+        );
+
         Queue::assertPushed(LogAccountAudit::class, function ($job) use ($michael) {
             return $job->auditLog['action'] === 'account_created' &&
                 $job->auditLog['author_id'] === $michael->id &&

tests/Unit/Services/Company/Adminland/Company/RenameCompanyTest.php

@@ -61,27 +61,32 @@ private function executeService(Employee $michael): void
         $request = [
             'company_id' => $michael->company_id,
             'author_id' => $michael->id,
-            'name' => 'Pyramid',
+            'name' => 'Dunder Mifflin 2',
         ];
 
         $company = (new RenameCompany)->execute($request);
 
         $this->assertDatabaseHas('companies', [
             'id' => $company->id,
-            'name' => 'Pyramid',
+            'name' => 'Dunder Mifflin 2',
         ]);
 
         $this->assertInstanceOf(
             Company::class,
             $company
         );
 
+        $this->assertEquals(
+            'dunder-mifflin-2',
+            $company->refresh()->slug
+        );
+
         Queue::assertPushed(LogAccountAudit::class, function ($job) use ($michael, $oldName) {
             return $job->auditLog['action'] === 'company_renamed' &&
                 $job->auditLog['author_id'] === $michael->id &&
                 $job->auditLog['objects'] === json_encode([
                     'old_name' => $oldName,
-                    'new_name' => 'Pyramid',
+                    'new_name' => 'Dunder Mifflin 2',
                 ]);
         });
     }

tests/Unit/Services/Company/Adminland/Company/UpdateCompanySlugTest.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace Tests\Unit\Services\Company\Adminland\Company;
+
+use Tests\TestCase;
+use App\Models\Company\Company;
+use Illuminate\Foundation\Testing\DatabaseTransactions;
+use App\Services\Company\Adminland\Company\UpdateCompanySlug;
+
+class UpdateCompanySlugTest extends TestCase
+{
+    use DatabaseTransactions;
+
+    /** @test */
+    public function it_updates_a_slug(): void
+    {
+        $company = Company::factory()->create([
+            'name' => 'Dunder Mifflin',
+        ]);
+
+        $request = [
+            'company_id' => $company->id,
+        ];
+
+        $company = (new UpdateCompanySlug)->execute($request);
+
+        $this->assertInstanceOf(
+            Company::class,
+            $company
+        );
+
+        $this->assertDatabaseHas('companies', [
+            'id' => $company->id,
+            'slug' => 'dunder-mifflin',
+        ]);
+    }
+
+    /** @test */
+    public function it_updates_a_slug_that_is_unique(): void
+    {
+        $company = Company::factory()->create([
+            'name' => 'Dunder Mifflin',
+        ]);
+        Company::factory()->create([
+            'slug' => 'dunder-mifflin',
+        ]);
+
+        $request = [
+            'company_id' => $company->id,
+        ];
+
+        $company = (new UpdateCompanySlug)->execute($request);
+
+        $this->assertInstanceOf(
+            Company::class,
+            $company
+        );
+
+        $this->assertEquals(
+            'dunder-mifflin-',
+            substr($company->slug, 0, 15)
+        );
+    }
+}

tests/Unit/ViewHelpers/Adminland/AdminGeneralViewHelperTest.php

@@ -49,6 +49,11 @@ public function it_gets_information_about_the_company(): void
             $response['name']
         );
 
+        $this->assertEquals(
+            $michael->company->slug,
+            $response['slug']
+        );
+
         $this->assertEquals(
             'Jan 01, 2018 12:00 AM',
             $response['creation_date']